blob: 6348197b332aa3493905bf854a9c7b00b32e2185 [file] [log] [blame]
Darren Tucker4c568432003-12-09 19:01:51 +11001.\" $OpenBSD: ssh-add.1,v 1.40 2003/11/25 23:10:08 matthieu Exp $
Ben Lindstrom36579d32001-01-29 07:39:26 +00002.\"
Damien Miller32aa1441999-10-29 09:15:49 +10003.\" -*- nroff -*-
4.\"
Damien Miller32aa1441999-10-29 09:15:49 +10005.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller32aa1441999-10-29 09:15:49 +10006.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7.\" All rights reserved
8.\"
Damien Millere4340be2000-09-16 13:29:08 +11009.\" As far as I am concerned, the code I have written for this software
10.\" can be used freely for any purpose. Any derived versions of this
11.\" software must be clearly marked as such, and if the derived work is
12.\" incompatible with the protocol description in the RFC file, it must be
13.\" called by a name other than "ssh" or "Secure Shell".
Damien Miller32aa1441999-10-29 09:15:49 +100014.\"
Damien Millere4340be2000-09-16 13:29:08 +110015.\"
Ben Lindstrom92a2e382001-03-05 06:59:27 +000016.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
17.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
18.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
Damien Millere4340be2000-09-16 13:29:08 +110019.\"
20.\" Redistribution and use in source and binary forms, with or without
21.\" modification, are permitted provided that the following conditions
22.\" are met:
23.\" 1. Redistributions of source code must retain the above copyright
24.\" notice, this list of conditions and the following disclaimer.
25.\" 2. Redistributions in binary form must reproduce the above copyright
26.\" notice, this list of conditions and the following disclaimer in the
27.\" documentation and/or other materials provided with the distribution.
28.\"
29.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
30.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
31.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
32.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
33.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
34.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
38.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Damien Miller32aa1441999-10-29 09:15:49 +100039.\"
40.Dd September 25, 1999
41.Dt SSH-ADD 1
42.Os
43.Sh NAME
44.Nm ssh-add
Ben Lindstrom8d066fb2001-09-12 17:06:13 +000045.Nd adds RSA or DSA identities to the authentication agent
Damien Miller32aa1441999-10-29 09:15:49 +100046.Sh SYNOPSIS
47.Nm ssh-add
Damien Miller6c711792003-01-24 11:36:23 +110048.Op Fl lLdDxXc
Ben Lindstrom61d328a2002-06-06 21:54:57 +000049.Op Fl t Ar life
Damien Miller32aa1441999-10-29 09:15:49 +100050.Op Ar
Ben Lindstrome6901212001-08-06 22:03:08 +000051.Nm ssh-add
52.Fl s Ar reader
53.Nm ssh-add
54.Fl e Ar reader
Damien Miller22c77262000-04-13 12:26:34 +100055.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +100056.Nm
Damien Millerad833b32000-08-23 10:46:23 +100057adds RSA or DSA identities to the authentication agent,
Damien Miller32aa1441999-10-29 09:15:49 +100058.Xr ssh-agent 1 .
Damien Miller6e1057c2002-01-22 23:05:59 +110059When run without arguments, it adds the files
60.Pa $HOME/.ssh/id_rsa ,
Ben Lindstromcb72e4f2002-06-21 00:41:51 +000061.Pa $HOME/.ssh/id_dsa
Damien Miller6e1057c2002-01-22 23:05:59 +110062and
Damien Miller32aa1441999-10-29 09:15:49 +100063.Pa $HOME/.ssh/identity .
Damien Miller450a7a12000-03-26 13:04:51 +100064Alternative file names can be given on the command line.
65If any file requires a passphrase,
Damien Miller32aa1441999-10-29 09:15:49 +100066.Nm
Damien Miller22c77262000-04-13 12:26:34 +100067asks for the passphrase from the user.
Ben Lindstromaafff9c2001-05-06 03:01:02 +000068The passphrase is read from the user's tty.
Ben Lindstrom12de6162001-04-10 02:46:54 +000069.Nm
70retries the last passphrase if multiple identity files are given.
Damien Miller32aa1441999-10-29 09:15:49 +100071.Pp
Darren Tucker4c568432003-12-09 19:01:51 +110072The authentication agent must be running and the
73.Ev SSH_AUTH_SOCK
74environment variable must contain the name of its socket for
Damien Miller32aa1441999-10-29 09:15:49 +100075.Nm
76to work.
77.Pp
78The options are as follows:
79.Bl -tag -width Ds
80.It Fl l
Damien Miller10f6f6b1999-11-17 17:29:08 +110081Lists fingerprints of all identities currently represented by the agent.
82.It Fl L
83Lists public key parameters of all identities currently represented by the agent.
Damien Miller32aa1441999-10-29 09:15:49 +100084.It Fl d
85Instead of adding the identity, removes the identity from the agent.
86.It Fl D
87Deletes all identities from the agent.
Ben Lindstrom2f717042002-06-06 21:52:03 +000088.It Fl x
89Lock the agent with a password.
90.It Fl X
91Unlock the agent.
Ben Lindstrom61d328a2002-06-06 21:54:57 +000092.It Fl t Ar life
93Set a maximum lifetime when adding identities to an agent.
Ben Lindstrom1775c9c2002-06-11 15:51:54 +000094The lifetime may be specified in seconds or in a time format
95specified in
Damien Miller7b406272003-02-24 12:00:16 +110096.Xr sshd_config 5 .
Damien Miller6c711792003-01-24 11:36:23 +110097.It Fl c
98Indicates that added identities should be subject to confirmation before
Damien Miller495dca32003-04-01 21:42:14 +100099being used for authentication.
100Confirmation is performed by the
Damien Miller6c711792003-01-24 11:36:23 +1100101.Ev SSH_ASKPASS
Damien Miller495dca32003-04-01 21:42:14 +1000102program mentioned below.
103Successful confirmation is signaled by a zero exit status from the
Damien Miller6c711792003-01-24 11:36:23 +1100104.Ev SSH_ASKPASS
105program, rather than text entered into the requester.
Ben Lindstrome6901212001-08-06 22:03:08 +0000106.It Fl s Ar reader
107Add key in smartcard
108.Ar reader .
109.It Fl e Ar reader
110Remove key in smartcard
111.Ar reader .
Damien Miller32aa1441999-10-29 09:15:49 +1000112.El
Damien Milleraae6c611999-12-06 11:47:28 +1100113.Sh ENVIRONMENT
114.Bl -tag -width Ds
115.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller32aa1441999-10-29 09:15:49 +1000116If
117.Nm
118needs a passphrase, it will read the passphrase from the current
Damien Miller450a7a12000-03-26 13:04:51 +1000119terminal if it was run from a terminal.
120If
Damien Miller32aa1441999-10-29 09:15:49 +1000121.Nm
122does not have a terminal associated with it but
123.Ev DISPLAY
Damien Miller5428f641999-11-25 11:54:57 +1100124and
125.Ev SSH_ASKPASS
126are set, it will execute the program specified by
127.Ev SSH_ASKPASS
Damien Miller450a7a12000-03-26 13:04:51 +1000128and open an X11 window to read the passphrase.
129This is particularly useful when calling
Damien Miller32aa1441999-10-29 09:15:49 +1000130.Nm
131from a
132.Pa .Xsession
Damien Miller450a7a12000-03-26 13:04:51 +1000133or related script.
134(Note that on some machines it
Damien Miller32aa1441999-10-29 09:15:49 +1000135may be necessary to redirect the input from
136.Pa /dev/null
137to make this work.)
Ben Lindstromb7788f32002-06-06 21:46:08 +0000138.It Ev SSH_AUTH_SOCK
139Identifies the path of a unix-domain socket used to communicate with the
140agent.
Damien Miller7b28dc52000-09-05 13:34:53 +1100141.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000142.Sh FILES
143.Bl -tag -width Ds
144.It Pa $HOME/.ssh/identity
145Contains the protocol version 1 RSA authentication identity of the user.
146.It Pa $HOME/.ssh/id_dsa
147Contains the protocol version 2 DSA authentication identity of the user.
148.It Pa $HOME/.ssh/id_rsa
149Contains the protocol version 2 RSA authentication identity of the user.
150.El
151.Pp
152Identity files should not be readable by anyone but the user.
153Note that
154.Nm
155ignores identity files if they are accessible by others.
Damien Millerc313be22002-02-05 12:14:41 +1100156.Sh DIAGNOSTICS
157Exit status is 0 on success, 1 if the specified command fails,
158and 2 if
159.Nm
160is unable to contact the authentication agent.
Damien Millerf1ce5052003-06-11 22:04:39 +1000161.Sh SEE ALSO
162.Xr ssh 1 ,
163.Xr ssh-agent 1 ,
164.Xr ssh-keygen 1 ,
165.Xr sshd 8
Damien Miller0bc1bd82000-11-13 22:57:25 +1100166.Sh AUTHORS
Ben Lindstrom035782e2001-01-29 08:34:16 +0000167OpenSSH is a derivative of the original and free
168ssh 1.2.12 release by Tatu Ylonen.
169Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
170Theo de Raadt and Dug Song
171removed many bugs, re-added newer features and
172created OpenSSH.
173Markus Friedl contributed the support for SSH
174protocol versions 1.5 and 2.0.