1 .\" $OpenBSD: ssh-add.1,v 1.59 2013/12/07 11:58:46 naddy 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.
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
64 After loading a private key,
66 will try to load corresponding certificate information from the
67 filename obtained by appending
69 to the name of the private key file.
70 Alternative file names can be given on the command line.
72 If any file requires a passphrase,
74 asks for the passphrase from the user.
75 The passphrase is read from the user's tty.
77 retries the last passphrase if multiple identity files are given.
79 The authentication agent must be running and the
81 environment variable must contain the name of its socket for
85 The options are as follows:
88 Indicates that added identities should be subject to confirmation before
89 being used for authentication.
90 Confirmation is performed by the
92 program mentioned below.
93 Successful confirmation is signaled by a zero exit status from the
95 program, rather than text entered into the requester.
97 Deletes all identities from the agent.
99 Instead of adding identities, removes identities from the agent.
102 has been run without arguments, the keys for the default identities and
103 their corresponding certificates will be removed.
104 Otherwise, the argument list will be interpreted as a list of paths to
105 public key files to specify keys and certificates to be removed from the agent.
106 If no public key is found at a given path,
112 Remove keys provided by the PKCS#11 shared library
115 When loading keys into or deleting keys from the agent, process plain private
116 keys only and skip certificates.
118 Lists public key parameters of all identities currently represented
121 Lists fingerprints of all identities currently represented by the agent.
123 Add keys provided by the PKCS#11 shared library
126 Set a maximum lifetime when adding identities to an agent.
127 The lifetime may be specified in seconds or in a time format
133 Lock the agent with a password.
137 .It Ev "DISPLAY" and "SSH_ASKPASS"
140 needs a passphrase, it will read the passphrase from the current
141 terminal if it was run from a terminal.
144 does not have a terminal associated with it but
148 are set, it will execute the program specified by
150 and open an X11 window to read the passphrase.
151 This is particularly useful when calling
156 (Note that on some machines it
157 may be necessary to redirect the input from
161 Identifies the path of a
163 socket used to communicate with the agent.
167 .It Pa ~/.ssh/identity
168 Contains the protocol version 1 RSA authentication identity of the user.
170 Contains the protocol version 2 DSA authentication identity of the user.
171 .It Pa ~/.ssh/id_ecdsa
172 Contains the protocol version 2 ECDSA authentication identity of the user.
173 .It Pa ~/.ssh/id_ed25519
174 Contains the protocol version 2 ED25519 authentication identity of the user.
176 Contains the protocol version 2 RSA authentication identity of the user.
179 Identity files should not be readable by anyone but the user.
182 ignores identity files if they are accessible by others.
184 Exit status is 0 on success, 1 if the specified command fails,
187 is unable to contact the authentication agent.
194 OpenSSH is a derivative of the original and free
195 ssh 1.2.12 release by Tatu Ylonen.
196 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
197 Theo de Raadt and Dug Song
198 removed many bugs, re-added newer features and
200 Markus Friedl contributed the support for SSH
201 protocol versions 1.5 and 2.0.