xref: /netbsd-src/crypto/external/bsd/openssh/dist/ssh-pkcs11-helper.8 (revision 154bfe8e089c1a0a4e9ed8414f08d3da90949162)
1.\" $NetBSD: ssh-pkcs11-helper.8,v 1.10 2020/02/27 00:24:40 christos Exp $
2.\" $OpenBSD: ssh-pkcs11-helper.8,v 1.5 2019/01/21 12:53:35 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 November 30 2019
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-agent 1
31to access keys provided by a PKCS#11 token.
32.Pp
33.Nm
34is not intended to be invoked by the user, but from
35.Xr ssh-agent 1 .
36.Pp
37A single option is supported:
38.Bl -tag -width Ds
39.It Fl v
40Verbose mode.
41Causes
42.Nm
43to print debugging messages about its progress.
44This is helpful in debugging problems.
45Multiple
46.Fl v
47options increase the verbosity.
48The maximum is 3.
49.Pp
50Note that
51.Xr ssh-agent 1
52will automatically pass the
53.Fl v
54flag to
55.Nm
56when it has itself been placed in debug mode.
57.El
58.Sh SEE ALSO
59.Xr ssh 1 ,
60.Xr ssh-add 1 ,
61.Xr ssh-agent 1
62.Sh HISTORY
63.Nm
64first appeared in
65.Ox 4.7 .
66.Sh AUTHORS
67.An Markus Friedl Aq Mt markus@openbsd.org
68