xref: /netbsd-src/crypto/external/bsd/openssh/dist/ssh-pkcs11-helper.8 (revision aef5eb5f59cdfe8314f1b5f78ac04eb144e44010)
1.\" $NetBSD: ssh-pkcs11-helper.8,v 1.11 2022/10/05 22:39:36 christos Exp $
2.\" $OpenBSD: ssh-pkcs11-helper.8,v 1.7 2022/04/29 03:24:30 djm Exp $
3
4.\"
5.\" Copyright (c) 2010 Markus Friedl.  All rights reserved.
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.Dd April 29 2022
20.Dt SSH-PKCS11-HELPER 8
21.Os
22.Sh NAME
23.Nm ssh-pkcs11-helper
24.Nd OpenSSH helper for PKCS#11 support
25.Sh SYNOPSIS
26.Nm
27.Op Fl v
28.Sh DESCRIPTION
29.Nm
30is used by
31.Xr ssh 1 ,
32.Xr ssh-agent 1 ,
33and
34.Xr ssh-keygen 1
35to access keys provided by a PKCS#11 token.
36.Pp
37.Nm
38is not intended to be invoked directly by the user.
39.Pp
40A single option is supported:
41.Bl -tag -width Ds
42.It Fl v
43Verbose mode.
44Causes
45.Nm
46to print debugging messages about its progress.
47This is helpful in debugging problems.
48Multiple
49.Fl v
50options increase the verbosity.
51The maximum is 3.
52.Pp
53Note that
54.Xr ssh 1 ,
55.Xr ssh-agent 1 ,
56and
57.Xr ssh-keygen 1
58will automatically pass the
59.Fl v
60flag to
61.Nm
62when they have themselves been placed in debug mode.
63.El
64.Sh SEE ALSO
65.Xr ssh 1 ,
66.Xr ssh-agent 1 ,
67.Xr ssh-keygen 1
68.Sh HISTORY
69.Nm
70first appeared in
71.Ox 4.7 .
72.Sh AUTHORS
73.An Markus Friedl Aq Mt markus@openbsd.org
74