Annotation of src/usr.bin/ssh/ssh-add.1, Revision 1.69
1.69 ! djm 1: .\" $OpenBSD: ssh-add.1,v 1.68 2019/01/21 07:09:10 jmc Exp $
1.1 deraadt 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: .\"
1.17 deraadt 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: .\"
1.22 deraadt 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.
1.17 deraadt 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.
1.1 deraadt 26: .\"
1.17 deraadt 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.
1.1 deraadt 37: .\"
1.69 ! djm 38: .Dd $Mdocdate: January 21 2019 $
1.2 deraadt 39: .Dt SSH-ADD 1
40: .Os
41: .Sh NAME
42: .Nm ssh-add
1.53 djm 43: .Nd adds private key identities to the authentication agent
1.2 deraadt 44: .Sh SYNOPSIS
45: .Nm ssh-add
1.69 ! djm 46: .Op Fl cDdkLlqvXx
1.61 djm 47: .Op Fl E Ar fingerprint_hash
1.33 markus 48: .Op Fl t Ar life
1.2 deraadt 49: .Op Ar
1.26 jakob 50: .Nm ssh-add
1.50 jmc 51: .Fl s Ar pkcs11
1.26 jakob 52: .Nm ssh-add
1.50 jmc 53: .Fl e Ar pkcs11
1.67 djm 54: .Nm ssh-add
55: .Fl T
1.68 jmc 56: .Ar pubkey ...
1.12 aaron 57: .Sh DESCRIPTION
1.2 deraadt 58: .Nm
1.53 djm 59: adds private key identities to the authentication agent,
1.2 deraadt 60: .Xr ssh-agent 1 .
1.28 djm 61: When run without arguments, it adds the files
1.43 djm 62: .Pa ~/.ssh/id_rsa ,
1.53 djm 63: .Pa ~/.ssh/id_dsa ,
1.59 naddy 64: .Pa ~/.ssh/id_ecdsa ,
1.28 djm 65: and
1.63 jmc 66: .Pa ~/.ssh/id_ed25519 .
1.52 djm 67: After loading a private key,
68: .Nm
69: will try to load corresponding certificate information from the
70: filename obtained by appending
71: .Pa -cert.pub
72: to the name of the private key file.
1.11 aaron 73: Alternative file names can be given on the command line.
1.52 djm 74: .Pp
1.11 aaron 75: If any file requires a passphrase,
1.2 deraadt 76: .Nm
1.12 aaron 77: asks for the passphrase from the user.
1.25 stevesk 78: The passphrase is read from the user's tty.
1.23 markus 79: .Nm
80: retries the last passphrase if multiple identity files are given.
1.2 deraadt 81: .Pp
1.40 matthieu 82: The authentication agent must be running and the
83: .Ev SSH_AUTH_SOCK
84: environment variable must contain the name of its socket for
1.2 deraadt 85: .Nm
1.1 deraadt 86: to work.
1.2 deraadt 87: .Pp
88: The options are as follows:
89: .Bl -tag -width Ds
1.36 markus 90: .It Fl c
91: Indicates that added identities should be subject to confirmation before
1.38 jmc 92: being used for authentication.
1.62 jmc 93: Confirmation is performed by
94: .Xr ssh-askpass 1 .
95: Successful confirmation is signaled by a zero exit status from
96: .Xr ssh-askpass 1 ,
97: rather than text entered into the requester.
1.42 jmc 98: .It Fl D
99: Deletes all identities from the agent.
100: .It Fl d
1.46 jmc 101: Instead of adding identities, removes identities from the agent.
1.45 djm 102: If
103: .Nm
1.57 djm 104: has been run without arguments, the keys for the default identities and
1.58 jmc 105: their corresponding certificates will be removed.
1.45 djm 106: Otherwise, the argument list will be interpreted as a list of paths to
1.57 djm 107: public key files to specify keys and certificates to be removed from the agent.
1.45 djm 108: If no public key is found at a given path,
109: .Nm
110: will append
111: .Pa .pub
112: and retry.
1.61 djm 113: .It Fl E Ar fingerprint_hash
114: Specifies the hash algorithm used when displaying key fingerprints.
115: Valid options are:
116: .Dq md5
117: and
118: .Dq sha256 .
119: The default is
120: .Dq sha256 .
1.49 markus 121: .It Fl e Ar pkcs11
1.51 markus 122: Remove keys provided by the PKCS#11 shared library
1.49 markus 123: .Ar pkcs11 .
1.56 djm 124: .It Fl k
1.57 djm 125: When loading keys into or deleting keys from the agent, process plain private
126: keys only and skip certificates.
1.42 jmc 127: .It Fl L
128: Lists public key parameters of all identities currently represented
129: by the agent.
130: .It Fl l
131: Lists fingerprints of all identities currently represented by the agent.
1.66 jmc 132: .It Fl q
133: Be quiet after a successful operation.
1.49 markus 134: .It Fl s Ar pkcs11
1.51 markus 135: Add keys provided by the PKCS#11 shared library
1.49 markus 136: .Ar pkcs11 .
1.68 jmc 137: .It Fl T Ar pubkey ...
1.67 djm 138: Tests whether the private keys that correspond to the specified
139: .Ar pubkey
140: files are usable by performing sign and verify operations on each.
1.42 jmc 141: .It Fl t Ar life
142: Set a maximum lifetime when adding identities to an agent.
143: The lifetime may be specified in seconds or in a time format
144: specified in
145: .Xr sshd_config 5 .
1.69 ! djm 146: .It Fl v
! 147: Verbose mode.
! 148: Causes
! 149: .Nm
! 150: to print debugging messages about its progress.
! 151: This is helpful in debugging problems.
! 152: Multiple
! 153: .Fl v
! 154: options increase the verbosity.
! 155: The maximum is 3.
1.42 jmc 156: .It Fl X
157: Unlock the agent.
158: .It Fl x
159: Lock the agent with a password.
1.2 deraadt 160: .El
1.9 markus 161: .Sh ENVIRONMENT
162: .Bl -tag -width Ds
163: .It Ev "DISPLAY" and "SSH_ASKPASS"
1.1 deraadt 164: If
1.2 deraadt 165: .Nm
1.1 deraadt 166: needs a passphrase, it will read the passphrase from the current
1.11 aaron 167: terminal if it was run from a terminal.
168: If
1.2 deraadt 169: .Nm
1.1 deraadt 170: does not have a terminal associated with it but
1.2 deraadt 171: .Ev DISPLAY
1.8 markus 172: and
173: .Ev SSH_ASKPASS
174: are set, it will execute the program specified by
175: .Ev SSH_ASKPASS
1.62 jmc 176: (by default
177: .Dq ssh-askpass )
1.11 aaron 178: and open an X11 window to read the passphrase.
179: This is particularly useful when calling
1.2 deraadt 180: .Nm
181: from a
1.41 jmc 182: .Pa .xsession
1.11 aaron 183: or related script.
184: (Note that on some machines it
1.2 deraadt 185: may be necessary to redirect the input from
186: .Pa /dev/null
187: to make this work.)
1.31 markus 188: .It Ev SSH_AUTH_SOCK
1.47 sobrado 189: Identifies the path of a
1.48 sobrado 190: .Ux Ns -domain
191: socket used to communicate with the agent.
1.16 itojun 192: .El
1.39 jmc 193: .Sh FILES
194: .Bl -tag -width Ds
1.43 djm 195: .It Pa ~/.ssh/id_dsa
1.64 naddy 196: Contains the DSA authentication identity of the user.
1.53 djm 197: .It Pa ~/.ssh/id_ecdsa
1.64 naddy 198: Contains the ECDSA authentication identity of the user.
1.59 naddy 199: .It Pa ~/.ssh/id_ed25519
1.64 naddy 200: Contains the Ed25519 authentication identity of the user.
1.43 djm 201: .It Pa ~/.ssh/id_rsa
1.64 naddy 202: Contains the RSA authentication identity of the user.
1.39 jmc 203: .El
204: .Pp
205: Identity files should not be readable by anyone but the user.
206: Note that
207: .Nm
208: ignores identity files if they are accessible by others.
1.54 jmc 209: .Sh EXIT STATUS
1.29 markus 210: Exit status is 0 on success, 1 if the specified command fails,
211: and 2 if
212: .Nm
213: is unable to contact the authentication agent.
1.39 jmc 214: .Sh SEE ALSO
215: .Xr ssh 1 ,
216: .Xr ssh-agent 1 ,
1.62 jmc 217: .Xr ssh-askpass 1 ,
1.39 jmc 218: .Xr ssh-keygen 1 ,
219: .Xr sshd 8
1.18 aaron 220: .Sh AUTHORS
1.19 markus 221: OpenSSH is a derivative of the original and free
222: ssh 1.2.12 release by Tatu Ylonen.
223: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
224: Theo de Raadt and Dug Song
225: removed many bugs, re-added newer features and
226: created OpenSSH.
227: Markus Friedl contributed the support for SSH
228: protocol versions 1.5 and 2.0.
![[BACK]](/icons/back.gif){kind=icon}
Return to ssh-add.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh