crypto/openssh/ssh-pkcs11-helper.8

   1 .\" $OpenBSD: ssh-pkcs11-helper.8,v 1.7 2022/04/29 03:24:30 djm 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: April 29 2022 $
  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
  28 is used by
  29 .Xr ssh 1 ,
  30 .Xr ssh-agent 1 ,
  31 and
  32 .Xr ssh-keygen 1
  33 to access keys provided by a PKCS#11 token.
  34 .Pp
  35 .Nm
  36 is not intended to be invoked directly by the user.
  37 .Pp
  38 A single option is supported:
  39 .Bl -tag -width Ds
  40 .It Fl v
  41 Verbose mode.
  42 Causes
  43 .Nm
  44 to print debugging messages about its progress.
  45 This is helpful in debugging problems.
  46 Multiple
  47 .Fl v
  48 options increase the verbosity.
  49 The maximum is 3.
  50 .Pp
  51 Note that
  52 .Xr ssh 1 ,
  53 .Xr ssh-agent 1 ,
  54 and
  55 .Xr ssh-keygen 1
  56 will automatically pass the
  57 .Fl v
  58 flag to
  59 .Nm
  60 when they have themselves been placed in debug mode.
  61 .El
  62 .Sh SEE ALSO
  63 .Xr ssh 1 ,
  64 .Xr ssh-agent 1 ,
  65 .Xr ssh-keygen 1
  66 .Sh HISTORY
  67 .Nm
  68 first appeared in
  69 .Ox 4.7 .
  70 .Sh AUTHORS
  71 .An Markus Friedl Aq Mt markus@openbsd.org