Annotation of src/usr.bin/ssh/ssh-add.1, Revision 1.61
1.61 ! djm 1: .\" $OpenBSD: ssh-add.1,v 1.60 2014/08/30 15:33:50 sobrado 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.61 ! djm 38: .Dd $Mdocdate: August 30 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.
91: Confirmation is performed by the
1.36 markus 92: .Ev SSH_ASKPASS
1.38 jmc 93: program mentioned below.
94: Successful confirmation is signaled by a zero exit status from the
1.36 markus 95: .Ev SSH_ASKPASS
96: program, rather than text entered into the requester.
1.42 jmc 97: .It Fl D
98: Deletes all identities from the agent.
99: .It Fl d
1.46 jmc 100: Instead of adding identities, removes identities from the agent.
1.45 djm 101: If
102: .Nm
1.57 djm 103: has been run without arguments, the keys for the default identities and
1.58 jmc 104: their corresponding certificates will be removed.
1.45 djm 105: Otherwise, the argument list will be interpreted as a list of paths to
1.57 djm 106: public key files to specify keys and certificates to be removed from the agent.
1.45 djm 107: If no public key is found at a given path,
108: .Nm
109: will append
110: .Pa .pub
111: and retry.
1.61 ! djm 112: .It Fl E Ar fingerprint_hash
! 113: Specifies the hash algorithm used when displaying key fingerprints.
! 114: Valid options are:
! 115: .Dq md5
! 116: and
! 117: .Dq sha256 .
! 118: The default is
! 119: .Dq sha256 .
1.49 markus 120: .It Fl e Ar pkcs11
1.51 markus 121: Remove keys provided by the PKCS#11 shared library
1.49 markus 122: .Ar pkcs11 .
1.56 djm 123: .It Fl k
1.57 djm 124: When loading keys into or deleting keys from the agent, process plain private
125: keys only and skip certificates.
1.42 jmc 126: .It Fl L
127: Lists public key parameters of all identities currently represented
128: by the agent.
129: .It Fl l
130: Lists fingerprints of all identities currently represented by the agent.
1.49 markus 131: .It Fl s Ar pkcs11
1.51 markus 132: Add keys provided by the PKCS#11 shared library
1.49 markus 133: .Ar pkcs11 .
1.42 jmc 134: .It Fl t Ar life
135: Set a maximum lifetime when adding identities to an agent.
136: The lifetime may be specified in seconds or in a time format
137: specified in
138: .Xr sshd_config 5 .
139: .It Fl X
140: Unlock the agent.
141: .It Fl x
142: Lock the agent with a password.
1.2 deraadt 143: .El
1.9 markus 144: .Sh ENVIRONMENT
145: .Bl -tag -width Ds
146: .It Ev "DISPLAY" and "SSH_ASKPASS"
1.1 deraadt 147: If
1.2 deraadt 148: .Nm
1.1 deraadt 149: needs a passphrase, it will read the passphrase from the current
1.11 aaron 150: terminal if it was run from a terminal.
151: If
1.2 deraadt 152: .Nm
1.1 deraadt 153: does not have a terminal associated with it but
1.2 deraadt 154: .Ev DISPLAY
1.8 markus 155: and
156: .Ev SSH_ASKPASS
157: are set, it will execute the program specified by
158: .Ev SSH_ASKPASS
1.11 aaron 159: and open an X11 window to read the passphrase.
160: This is particularly useful when calling
1.2 deraadt 161: .Nm
162: from a
1.41 jmc 163: .Pa .xsession
1.11 aaron 164: or related script.
165: (Note that on some machines it
1.2 deraadt 166: may be necessary to redirect the input from
167: .Pa /dev/null
168: to make this work.)
1.31 markus 169: .It Ev SSH_AUTH_SOCK
1.47 sobrado 170: Identifies the path of a
1.48 sobrado 171: .Ux Ns -domain
172: socket used to communicate with the agent.
1.16 itojun 173: .El
1.39 jmc 174: .Sh FILES
175: .Bl -tag -width Ds
1.43 djm 176: .It Pa ~/.ssh/identity
1.39 jmc 177: Contains the protocol version 1 RSA authentication identity of the user.
1.43 djm 178: .It Pa ~/.ssh/id_dsa
1.39 jmc 179: Contains the protocol version 2 DSA authentication identity of the user.
1.53 djm 180: .It Pa ~/.ssh/id_ecdsa
181: Contains the protocol version 2 ECDSA authentication identity of the user.
1.59 naddy 182: .It Pa ~/.ssh/id_ed25519
1.60 sobrado 183: Contains the protocol version 2 Ed25519 authentication identity of the user.
1.43 djm 184: .It Pa ~/.ssh/id_rsa
1.39 jmc 185: Contains the protocol version 2 RSA authentication identity of the user.
186: .El
187: .Pp
188: Identity files should not be readable by anyone but the user.
189: Note that
190: .Nm
191: ignores identity files if they are accessible by others.
1.54 jmc 192: .Sh EXIT STATUS
1.29 markus 193: Exit status is 0 on success, 1 if the specified command fails,
194: and 2 if
195: .Nm
196: is unable to contact the authentication agent.
1.39 jmc 197: .Sh SEE ALSO
198: .Xr ssh 1 ,
199: .Xr ssh-agent 1 ,
200: .Xr ssh-keygen 1 ,
201: .Xr sshd 8
1.18 aaron 202: .Sh AUTHORS
1.19 markus 203: OpenSSH is a derivative of the original and free
204: ssh 1.2.12 release by Tatu Ylonen.
205: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
206: Theo de Raadt and Dug Song
207: removed many bugs, re-added newer features and
208: created OpenSSH.
209: Markus Friedl contributed the support for SSH
210: protocol versions 1.5 and 2.0.