Annotation of src/usr.bin/ssh/ssh-add.1, Revision 1.65
1.65 ! dlg 1: .\" $OpenBSD: ssh-add.1,v 1.64 2017/05/05 10:41:58 naddy 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.65 ! dlg 38: .Dd $Mdocdate: May 5 2017 $
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.65 ! dlg 46: .Op Fl cDdkLlqXx
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 ,
1.28 djm 62: and
1.63 jmc 63: .Pa ~/.ssh/id_ed25519 .
1.52 djm 64: After loading a private key,
65: .Nm
66: will try to load corresponding certificate information from the
67: filename obtained by appending
68: .Pa -cert.pub
69: to the name of the private key file.
1.11 aaron 70: Alternative file names can be given on the command line.
1.52 djm 71: .Pp
1.11 aaron 72: If any file requires a passphrase,
1.2 deraadt 73: .Nm
1.12 aaron 74: asks for the passphrase from the user.
1.25 stevesk 75: The passphrase is read from the user's tty.
1.23 markus 76: .Nm
77: retries the last passphrase if multiple identity files are given.
1.2 deraadt 78: .Pp
1.40 matthieu 79: The authentication agent must be running and the
80: .Ev SSH_AUTH_SOCK
81: environment variable must contain the name of its socket for
1.2 deraadt 82: .Nm
1.1 deraadt 83: to work.
1.2 deraadt 84: .Pp
85: The options are as follows:
86: .Bl -tag -width Ds
1.36 markus 87: .It Fl c
88: Indicates that added identities should be subject to confirmation before
1.38 jmc 89: being used for authentication.
1.62 jmc 90: Confirmation is performed by
91: .Xr ssh-askpass 1 .
92: Successful confirmation is signaled by a zero exit status from
93: .Xr ssh-askpass 1 ,
94: rather than text entered into the requester.
1.42 jmc 95: .It Fl D
96: Deletes all identities from the agent.
97: .It Fl d
1.46 jmc 98: Instead of adding identities, removes identities from the agent.
1.45 djm 99: If
100: .Nm
1.57 djm 101: has been run without arguments, the keys for the default identities and
1.58 jmc 102: their corresponding certificates will be removed.
1.45 djm 103: Otherwise, the argument list will be interpreted as a list of paths to
1.57 djm 104: public key files to specify keys and certificates to be removed from the agent.
1.45 djm 105: If no public key is found at a given path,
106: .Nm
107: will append
108: .Pa .pub
109: and retry.
1.61 djm 110: .It Fl E Ar fingerprint_hash
111: Specifies the hash algorithm used when displaying key fingerprints.
112: Valid options are:
113: .Dq md5
114: and
115: .Dq sha256 .
116: The default is
117: .Dq sha256 .
1.49 markus 118: .It Fl e Ar pkcs11
1.51 markus 119: Remove keys provided by the PKCS#11 shared library
1.49 markus 120: .Ar pkcs11 .
1.56 djm 121: .It Fl k
1.57 djm 122: When loading keys into or deleting keys from the agent, process plain private
123: keys only and skip certificates.
1.42 jmc 124: .It Fl L
125: Lists public key parameters of all identities currently represented
126: by the agent.
127: .It Fl l
128: Lists fingerprints of all identities currently represented by the agent.
1.49 markus 129: .It Fl s Ar pkcs11
1.51 markus 130: Add keys provided by the PKCS#11 shared library
1.49 markus 131: .Ar pkcs11 .
1.42 jmc 132: .It Fl t Ar life
133: Set a maximum lifetime when adding identities to an agent.
134: The lifetime may be specified in seconds or in a time format
135: specified in
136: .Xr sshd_config 5 .
1.65 ! dlg 137: .It Fl q
! 138: Be quiet after a successful operation.
1.42 jmc 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.62 jmc 159: (by default
160: .Dq ssh-askpass )
1.11 aaron 161: and open an X11 window to read the passphrase.
162: This is particularly useful when calling
1.2 deraadt 163: .Nm
164: from a
1.41 jmc 165: .Pa .xsession
1.11 aaron 166: or related script.
167: (Note that on some machines it
1.2 deraadt 168: may be necessary to redirect the input from
169: .Pa /dev/null
170: to make this work.)
1.31 markus 171: .It Ev SSH_AUTH_SOCK
1.47 sobrado 172: Identifies the path of a
1.48 sobrado 173: .Ux Ns -domain
174: socket used to communicate with the agent.
1.16 itojun 175: .El
1.39 jmc 176: .Sh FILES
177: .Bl -tag -width Ds
1.43 djm 178: .It Pa ~/.ssh/id_dsa
1.64 naddy 179: Contains the DSA authentication identity of the user.
1.53 djm 180: .It Pa ~/.ssh/id_ecdsa
1.64 naddy 181: Contains the ECDSA authentication identity of the user.
1.59 naddy 182: .It Pa ~/.ssh/id_ed25519
1.64 naddy 183: Contains the Ed25519 authentication identity of the user.
1.43 djm 184: .It Pa ~/.ssh/id_rsa
1.64 naddy 185: Contains the RSA authentication identity of the user.
1.39 jmc 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 ,
1.62 jmc 200: .Xr ssh-askpass 1 ,
1.39 jmc 201: .Xr ssh-keygen 1 ,
202: .Xr sshd 8
1.18 aaron 203: .Sh AUTHORS
1.19 markus 204: OpenSSH is a derivative of the original and free
205: ssh 1.2.12 release by Tatu Ylonen.
206: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
207: Theo de Raadt and Dug Song
208: removed many bugs, re-added newer features and
209: created OpenSSH.
210: Markus Friedl contributed the support for SSH
211: 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