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