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