xref: /freebsd/crypto/openssh/ssh-add.1 (revision a0ee8cc636cd5c2374ec44ca71226564ea0bca95)
1.\"	$OpenBSD: ssh-add.1,v 1.59 2013/12/07 11:58:46 naddy Exp $
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.\"
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.\"
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.
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.
26.\"
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.
37.\"
38.Dd $Mdocdate: December 7 2013 $
39.Dt SSH-ADD 1
40.Os
41.Sh NAME
42.Nm ssh-add
43.Nd adds private key identities to the authentication agent
44.Sh SYNOPSIS
45.Nm ssh-add
46.Op Fl cDdkLlXx
47.Op Fl t Ar life
48.Op Ar
49.Nm ssh-add
50.Fl s Ar pkcs11
51.Nm ssh-add
52.Fl e Ar pkcs11
53.Sh DESCRIPTION
54.Nm
55adds private key identities to the authentication agent,
56.Xr ssh-agent 1 .
57When run without arguments, it adds the files
58.Pa ~/.ssh/id_rsa ,
59.Pa ~/.ssh/id_dsa ,
60.Pa ~/.ssh/id_ecdsa ,
61.Pa ~/.ssh/id_ed25519
62and
63.Pa ~/.ssh/identity .
64After loading a private key,
65.Nm
66will try to load corresponding certificate information from the
67filename obtained by appending
68.Pa -cert.pub
69to the name of the private key file.
70Alternative file names can be given on the command line.
71.Pp
72If any file requires a passphrase,
73.Nm
74asks for the passphrase from the user.
75The passphrase is read from the user's tty.
76.Nm
77retries the last passphrase if multiple identity files are given.
78.Pp
79The authentication agent must be running and the
80.Ev SSH_AUTH_SOCK
81environment variable must contain the name of its socket for
82.Nm
83to work.
84.Pp
85The options are as follows:
86.Bl -tag -width Ds
87.It Fl c
88Indicates that added identities should be subject to confirmation before
89being used for authentication.
90Confirmation is performed by the
91.Ev SSH_ASKPASS
92program mentioned below.
93Successful confirmation is signaled by a zero exit status from the
94.Ev SSH_ASKPASS
95program, rather than text entered into the requester.
96.It Fl D
97Deletes all identities from the agent.
98.It Fl d
99Instead of adding identities, removes identities from the agent.
100If
101.Nm
102has been run without arguments, the keys for the default identities and
103their corresponding certificates will be removed.
104Otherwise, the argument list will be interpreted as a list of paths to
105public key files to specify keys and certificates to be removed from the agent.
106If no public key is found at a given path,
107.Nm
108will append
109.Pa .pub
110and retry.
111.It Fl e Ar pkcs11
112Remove keys provided by the PKCS#11 shared library
113.Ar pkcs11 .
114.It Fl k
115When loading keys into or deleting keys from the agent, process plain private
116keys only and skip certificates.
117.It Fl L
118Lists public key parameters of all identities currently represented
119by the agent.
120.It Fl l
121Lists fingerprints of all identities currently represented by the agent.
122.It Fl s Ar pkcs11
123Add keys provided by the PKCS#11 shared library
124.Ar pkcs11 .
125.It Fl t Ar life
126Set a maximum lifetime when adding identities to an agent.
127The lifetime may be specified in seconds or in a time format
128specified in
129.Xr sshd_config 5 .
130.It Fl X
131Unlock the agent.
132.It Fl x
133Lock the agent with a password.
134.El
135.Sh ENVIRONMENT
136.Bl -tag -width Ds
137.It Ev "DISPLAY" and "SSH_ASKPASS"
138If
139.Nm
140needs a passphrase, it will read the passphrase from the current
141terminal if it was run from a terminal.
142If
143.Nm
144does not have a terminal associated with it but
145.Ev DISPLAY
146and
147.Ev SSH_ASKPASS
148are set, it will execute the program specified by
149.Ev SSH_ASKPASS
150and open an X11 window to read the passphrase.
151This is particularly useful when calling
152.Nm
153from a
154.Pa .xsession
155or related script.
156(Note that on some machines it
157may be necessary to redirect the input from
158.Pa /dev/null
159to make this work.)
160.It Ev SSH_AUTH_SOCK
161Identifies the path of a
162.Ux Ns -domain
163socket used to communicate with the agent.
164.El
165.Sh FILES
166.Bl -tag -width Ds
167.It Pa ~/.ssh/identity
168Contains the protocol version 1 RSA authentication identity of the user.
169.It Pa ~/.ssh/id_dsa
170Contains the protocol version 2 DSA authentication identity of the user.
171.It Pa ~/.ssh/id_ecdsa
172Contains the protocol version 2 ECDSA authentication identity of the user.
173.It Pa ~/.ssh/id_ed25519
174Contains the protocol version 2 ED25519 authentication identity of the user.
175.It Pa ~/.ssh/id_rsa
176Contains the protocol version 2 RSA authentication identity of the user.
177.El
178.Pp
179Identity files should not be readable by anyone but the user.
180Note that
181.Nm
182ignores identity files if they are accessible by others.
183.Sh EXIT STATUS
184Exit status is 0 on success, 1 if the specified command fails,
185and 2 if
186.Nm
187is unable to contact the authentication agent.
188.Sh SEE ALSO
189.Xr ssh 1 ,
190.Xr ssh-agent 1 ,
191.Xr ssh-keygen 1 ,
192.Xr sshd 8
193.Sh AUTHORS
194OpenSSH is a derivative of the original and free
195ssh 1.2.12 release by Tatu Ylonen.
196Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
197Theo de Raadt and Dug Song
198removed many bugs, re-added newer features and
199created OpenSSH.
200Markus Friedl contributed the support for SSH
201protocol versions 1.5 and 2.0.
202