crypto/openssh/ssh-add.1

   1 .\"     $OpenBSD: ssh-add.1,v 1.62 2015/03/30 18:28:37 jmc Exp $
   2 .\"
   3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   5 .\"                    All rights reserved
   6 .\"
   7 .\" As far as I am concerned, the code I have written for this software
   8 .\" can be used freely for any purpose.  Any derived versions of this
   9 .\" software must be clearly marked as such, and if the derived work is
  10 .\" incompatible with the protocol description in the RFC file, it must be
  11 .\" called by a name other than "ssh" or "Secure Shell".
  12 .\"
  13 .\"
  14 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
  15 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
  16 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
  17 .\"
  18 .\" Redistribution and use in source and binary forms, with or without
  19 .\" modification, are permitted provided that the following conditions
  20 .\" are met:
  21 .\" 1. Redistributions of source code must retain the above copyright
  22 .\"    notice, this list of conditions and the following disclaimer.
  23 .\" 2. Redistributions in binary form must reproduce the above copyright
  24 .\"    notice, this list of conditions and the following disclaimer in the
  25 .\"    documentation and/or other materials provided with the distribution.
  26 .\"
  27 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  28 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  29 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  30 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  31 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  32 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  33 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  34 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  35 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  36 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37 .\"
  38 .Dd $Mdocdate: March 30 2015 $
  39 .Dt SSH-ADD 1
  40 .Os
  41 .Sh NAME
  42 .Nm ssh-add
  43 .Nd adds private key identities to the authentication agent
  44 .Sh SYNOPSIS
  45 .Nm ssh-add
  46 .Op Fl cDdkLlXx
  47 .Op Fl E Ar fingerprint_hash
  48 .Op Fl t Ar life
  49 .Op Ar
  50 .Nm ssh-add
  51 .Fl s Ar pkcs11
  52 .Nm ssh-add
  53 .Fl e Ar pkcs11
  54 .Sh DESCRIPTION
  55 .Nm
  56 adds private key identities to the authentication agent,
  57 .Xr ssh-agent 1 .
  58 When run without arguments, it adds the files
  59 .Pa ~/.ssh/id_rsa ,
  60 .Pa ~/.ssh/id_dsa ,
  61 .Pa ~/.ssh/id_ecdsa ,
  62 .Pa ~/.ssh/id_ed25519
  63 and
  64 .Pa ~/.ssh/identity .
  65 After loading a private key,
  66 .Nm
  67 will try to load corresponding certificate information from the
  68 filename obtained by appending
  69 .Pa -cert.pub
  70 to the name of the private key file.
  71 Alternative file names can be given on the command line.
  72 .Pp
  73 If any file requires a passphrase,
  74 .Nm
  75 asks for the passphrase from the user.
  76 The passphrase is read from the user's tty.
  77 .Nm
  78 retries the last passphrase if multiple identity files are given.
  79 .Pp
  80 The authentication agent must be running and the
  81 .Ev SSH_AUTH_SOCK
  82 environment variable must contain the name of its socket for
  83 .Nm
  84 to work.
  85 .Pp
  86 The options are as follows:
  87 .Bl -tag -width Ds
  88 .It Fl c
  89 Indicates that added identities should be subject to confirmation before
  90 being used for authentication.
  91 Confirmation is performed by
  92 .Xr ssh-askpass 1 .
  93 Successful confirmation is signaled by a zero exit status from
  94 .Xr ssh-askpass 1 ,
  95 rather than text entered into the requester.
  96 .It Fl D
  97 Deletes all identities from the agent.
  98 .It Fl d
  99 Instead of adding identities, removes identities from the agent.
 100 If
 101 .Nm
 102 has been run without arguments, the keys for the default identities and
 103 their corresponding certificates will be removed.
 104 Otherwise, the argument list will be interpreted as a list of paths to
 105 public key files to specify keys and certificates to be removed from the agent.
 106 If no public key is found at a given path,
 107 .Nm
 108 will append
 109 .Pa .pub
 110 and retry.
 111 .It Fl E Ar fingerprint_hash
 112 Specifies the hash algorithm used when displaying key fingerprints.
 113 Valid options are:
 114 .Dq md5
 115 and
 116 .Dq sha256 .
 117 The default is
 118 .Dq sha256 .
 119 .It Fl e Ar pkcs11
 120 Remove keys provided by the PKCS#11 shared library
 121 .Ar pkcs11 .
 122 .It Fl k
 123 When loading keys into or deleting keys from the agent, process plain private
 124 keys only and skip certificates.
 125 .It Fl L
 126 Lists public key parameters of all identities currently represented
 127 by the agent.
 128 .It Fl l
 129 Lists fingerprints of all identities currently represented by the agent.
 130 .It Fl s Ar pkcs11
 131 Add keys provided by the PKCS#11 shared library
 132 .Ar pkcs11 .
 133 .It Fl t Ar life
 134 Set a maximum lifetime when adding identities to an agent.
 135 The lifetime may be specified in seconds or in a time format
 136 specified in
 137 .Xr sshd_config 5 .
 138 .It Fl X
 139 Unlock the agent.
 140 .It Fl x
 141 Lock the agent with a password.
 142 .El
 143 .Sh ENVIRONMENT
 144 .Bl -tag -width Ds
 145 .It Ev "DISPLAY" and "SSH_ASKPASS"
 146 If
 147 .Nm
 148 needs a passphrase, it will read the passphrase from the current
 149 terminal if it was run from a terminal.
 150 If
 151 .Nm
 152 does not have a terminal associated with it but
 153 .Ev DISPLAY
 154 and
 155 .Ev SSH_ASKPASS
 156 are set, it will execute the program specified by
 157 .Ev SSH_ASKPASS
 158 (by default
 159 .Dq ssh-askpass )
 160 and open an X11 window to read the passphrase.
 161 This is particularly useful when calling
 162 .Nm
 163 from a
 164 .Pa .xsession
 165 or related script.
 166 (Note that on some machines it
 167 may be necessary to redirect the input from
 168 .Pa /dev/null
 169 to make this work.)
 170 .It Ev SSH_AUTH_SOCK
 171 Identifies the path of a
 172 .Ux Ns -domain
 173 socket used to communicate with the agent.
 174 .El
 175 .Sh FILES
 176 .Bl -tag -width Ds
 177 .It Pa ~/.ssh/identity
 178 Contains the protocol version 1 RSA authentication identity of the user.
 179 .It Pa ~/.ssh/id_dsa
 180 Contains the protocol version 2 DSA authentication identity of the user.
 181 .It Pa ~/.ssh/id_ecdsa
 182 Contains the protocol version 2 ECDSA authentication identity of the user.
 183 .It Pa ~/.ssh/id_ed25519
 184 Contains the protocol version 2 Ed25519 authentication identity of the user.
 185 .It Pa ~/.ssh/id_rsa
 186 Contains the protocol version 2 RSA authentication identity of the user.
 187 .El
 188 .Pp
 189 Identity files should not be readable by anyone but the user.
 190 Note that
 191 .Nm
 192 ignores identity files if they are accessible by others.
 193 .Sh EXIT STATUS
 194 Exit status is 0 on success, 1 if the specified command fails,
 195 and 2 if
 196 .Nm
 197 is unable to contact the authentication agent.
 198 .Sh SEE ALSO
 199 .Xr ssh 1 ,
 200 .Xr ssh-agent 1 ,
 201 .Xr ssh-askpass 1 ,
 202 .Xr ssh-keygen 1 ,
 203 .Xr sshd 8
 204 .Sh AUTHORS
 205 OpenSSH is a derivative of the original and free
 206 ssh 1.2.12 release by Tatu Ylonen.
 207 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
 208 Theo de Raadt and Dug Song
 209 removed many bugs, re-added newer features and
 210 created OpenSSH.
 211 Markus Friedl contributed the support for SSH
 212 protocol versions 1.5 and 2.0.