Annotation of src/usr.bin/ssh/ssh-add.1, Revision 1.62
1.62 ! jmc 1: .\" $OpenBSD: ssh-add.1,v 1.61 2014/12/21 22:27:56 djm 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.62 ! jmc 38: .Dd $Mdocdate: December 21 2014 $
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.56 djm 46: .Op Fl cDdkLlXx
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.12 aaron 54: .Sh DESCRIPTION
1.2 deraadt 55: .Nm
1.53 djm 56: adds private key identities to the authentication agent,
1.2 deraadt 57: .Xr ssh-agent 1 .
1.28 djm 58: When run without arguments, it adds the files
1.43 djm 59: .Pa ~/.ssh/id_rsa ,
1.53 djm 60: .Pa ~/.ssh/id_dsa ,
1.59 naddy 61: .Pa ~/.ssh/id_ecdsa ,
62: .Pa ~/.ssh/id_ed25519
1.28 djm 63: and
1.43 djm 64: .Pa ~/.ssh/identity .
1.52 djm 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.
1.11 aaron 71: Alternative file names can be given on the command line.
1.52 djm 72: .Pp
1.11 aaron 73: If any file requires a passphrase,
1.2 deraadt 74: .Nm
1.12 aaron 75: asks for the passphrase from the user.
1.25 stevesk 76: The passphrase is read from the user's tty.
1.23 markus 77: .Nm
78: retries the last passphrase if multiple identity files are given.
1.2 deraadt 79: .Pp
1.40 matthieu 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
1.2 deraadt 83: .Nm
1.1 deraadt 84: to work.
1.2 deraadt 85: .Pp
86: The options are as follows:
87: .Bl -tag -width Ds
1.36 markus 88: .It Fl c
89: Indicates that added identities should be subject to confirmation before
1.38 jmc 90: being used for authentication.
1.62 ! jmc 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.
1.42 jmc 96: .It Fl D
97: Deletes all identities from the agent.
98: .It Fl d
1.46 jmc 99: Instead of adding identities, removes identities from the agent.
1.45 djm 100: If
101: .Nm
1.57 djm 102: has been run without arguments, the keys for the default identities and
1.58 jmc 103: their corresponding certificates will be removed.
1.45 djm 104: Otherwise, the argument list will be interpreted as a list of paths to
1.57 djm 105: public key files to specify keys and certificates to be removed from the agent.
1.45 djm 106: If no public key is found at a given path,
107: .Nm
108: will append
109: .Pa .pub
110: and retry.
1.61 djm 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 .
1.49 markus 119: .It Fl e Ar pkcs11
1.51 markus 120: Remove keys provided by the PKCS#11 shared library
1.49 markus 121: .Ar pkcs11 .
1.56 djm 122: .It Fl k
1.57 djm 123: When loading keys into or deleting keys from the agent, process plain private
124: keys only and skip certificates.
1.42 jmc 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.
1.49 markus 130: .It Fl s Ar pkcs11
1.51 markus 131: Add keys provided by the PKCS#11 shared library
1.49 markus 132: .Ar pkcs11 .
1.42 jmc 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.
1.2 deraadt 142: .El
1.9 markus 143: .Sh ENVIRONMENT
144: .Bl -tag -width Ds
145: .It Ev "DISPLAY" and "SSH_ASKPASS"
1.1 deraadt 146: If
1.2 deraadt 147: .Nm
1.1 deraadt 148: needs a passphrase, it will read the passphrase from the current
1.11 aaron 149: terminal if it was run from a terminal.
150: If
1.2 deraadt 151: .Nm
1.1 deraadt 152: does not have a terminal associated with it but
1.2 deraadt 153: .Ev DISPLAY
1.8 markus 154: and
155: .Ev SSH_ASKPASS
156: are set, it will execute the program specified by
157: .Ev SSH_ASKPASS
1.62 ! jmc 158: (by default
! 159: .Dq ssh-askpass )
1.11 aaron 160: and open an X11 window to read the passphrase.
161: This is particularly useful when calling
1.2 deraadt 162: .Nm
163: from a
1.41 jmc 164: .Pa .xsession
1.11 aaron 165: or related script.
166: (Note that on some machines it
1.2 deraadt 167: may be necessary to redirect the input from
168: .Pa /dev/null
169: to make this work.)
1.31 markus 170: .It Ev SSH_AUTH_SOCK
1.47 sobrado 171: Identifies the path of a
1.48 sobrado 172: .Ux Ns -domain
173: socket used to communicate with the agent.
1.16 itojun 174: .El
1.39 jmc 175: .Sh FILES
176: .Bl -tag -width Ds
1.43 djm 177: .It Pa ~/.ssh/identity
1.39 jmc 178: Contains the protocol version 1 RSA authentication identity of the user.
1.43 djm 179: .It Pa ~/.ssh/id_dsa
1.39 jmc 180: Contains the protocol version 2 DSA authentication identity of the user.
1.53 djm 181: .It Pa ~/.ssh/id_ecdsa
182: Contains the protocol version 2 ECDSA authentication identity of the user.
1.59 naddy 183: .It Pa ~/.ssh/id_ed25519
1.60 sobrado 184: Contains the protocol version 2 Ed25519 authentication identity of the user.
1.43 djm 185: .It Pa ~/.ssh/id_rsa
1.39 jmc 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.
1.54 jmc 193: .Sh EXIT STATUS
1.29 markus 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.
1.39 jmc 198: .Sh SEE ALSO
199: .Xr ssh 1 ,
200: .Xr ssh-agent 1 ,
1.62 ! jmc 201: .Xr ssh-askpass 1 ,
1.39 jmc 202: .Xr ssh-keygen 1 ,
203: .Xr sshd 8
1.18 aaron 204: .Sh AUTHORS
1.19 markus 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.