1 .\" $OpenBSD: ssh-add.1,v 1.56 2011/10/18 05:00:48 djm Exp $
3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 .\" All rights reserved
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".
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.
18 .\" Redistribution and use in source and binary forms, with or without
19 .\" modification, are permitted provided that the following conditions
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.
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.
38 .Dd $Mdocdate: October 18 2011 $
43 .Nd adds private key identities to the authentication agent
55 adds private key identities to the authentication agent,
57 When run without arguments, it adds the files
63 After loading a private key,
65 will try to load corresponding certificate information from the
66 filename obtained by appending
68 to the name of the private key file.
69 Alternative file names can be given on the command line.
71 If any file requires a passphrase,
73 asks for the passphrase from the user.
74 The passphrase is read from the user's tty.
76 retries the last passphrase if multiple identity files are given.
78 The authentication agent must be running and the
80 environment variable must contain the name of its socket for
84 The options are as follows:
87 Indicates that added identities should be subject to confirmation before
88 being used for authentication.
89 Confirmation is performed by the
91 program mentioned below.
92 Successful confirmation is signaled by a zero exit status from the
94 program, rather than text entered into the requester.
96 Deletes all identities from the agent.
98 Instead of adding identities, removes identities from the agent.
101 has been run without arguments, the keys for the default identities will
103 Otherwise, the argument list will be interpreted as a list of paths to
104 public key files and matching keys will be removed from the agent.
105 If no public key is found at a given path,
111 Remove keys provided by the PKCS#11 shared library
114 When loading keys into the agent, load plain private keys only and skip
117 Lists public key parameters of all identities currently represented
120 Lists fingerprints of all identities currently represented by the agent.
122 Add keys provided by the PKCS#11 shared library
125 Set a maximum lifetime when adding identities to an agent.
126 The lifetime may be specified in seconds or in a time format
132 Lock the agent with a password.
136 .It Ev "DISPLAY" and "SSH_ASKPASS"
139 needs a passphrase, it will read the passphrase from the current
140 terminal if it was run from a terminal.
143 does not have a terminal associated with it but
147 are set, it will execute the program specified by
149 and open an X11 window to read the passphrase.
150 This is particularly useful when calling
155 (Note that on some machines it
156 may be necessary to redirect the input from
160 Identifies the path of a
162 socket used to communicate with the agent.
166 .It Pa ~/.ssh/identity
167 Contains the protocol version 1 RSA authentication identity of the user.
169 Contains the protocol version 2 DSA authentication identity of the user.
170 .It Pa ~/.ssh/id_ecdsa
171 Contains the protocol version 2 ECDSA authentication identity of the user.
173 Contains the protocol version 2 RSA authentication identity of the user.
176 Identity files should not be readable by anyone but the user.
179 ignores identity files if they are accessible by others.
181 Exit status is 0 on success, 1 if the specified command fails,
184 is unable to contact the authentication agent.
191 OpenSSH is a derivative of the original and free
192 ssh 1.2.12 release by Tatu Ylonen.
193 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
194 Theo de Raadt and Dug Song
195 removed many bugs, re-added newer features and
197 Markus Friedl contributed the support for SSH
198 protocol versions 1.5 and 2.0.