blob: 005041b689785e7653dbed6cd3f2351c675330c5 [file] [log] [blame]
Darren Tucker930cb0b2007-06-13 00:00:27 +10001.\" $OpenBSD: ssh-add.1,v 1.46 2007/06/12 13:41:03 jmc 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.\"
Darren Tucker930cb0b2007-06-13 00:00:27 +100040.Dd $Mdocdate: June 12 2007 $
Damien Miller32aa1441999-10-29 09:15:49 +100041.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 Miller792c0172005-03-02 12:04:50 +110048.Op Fl cDdLlXx
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
Damien Miller167ea5d2005-05-26 12:04:02 +100060.Pa ~/.ssh/id_rsa ,
61.Pa ~/.ssh/id_dsa
Damien Miller6e1057c2002-01-22 23:05:59 +110062and
Damien Miller167ea5d2005-05-26 12:04:02 +100063.Pa ~/.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
Damien Miller6c711792003-01-24 11:36:23 +110080.It Fl c
81Indicates that added identities should be subject to confirmation before
Damien Miller495dca32003-04-01 21:42:14 +100082being used for authentication.
83Confirmation is performed by the
Damien Miller6c711792003-01-24 11:36:23 +110084.Ev SSH_ASKPASS
Damien Miller495dca32003-04-01 21:42:14 +100085program mentioned below.
86Successful confirmation is signaled by a zero exit status from the
Damien Miller6c711792003-01-24 11:36:23 +110087.Ev SSH_ASKPASS
88program, rather than text entered into the requester.
Damien Miller792c0172005-03-02 12:04:50 +110089.It Fl D
90Deletes all identities from the agent.
91.It Fl d
Darren Tucker930cb0b2007-06-13 00:00:27 +100092Instead of adding identities, removes identities from the agent.
Darren Tucker29a57072007-06-12 23:39:52 +100093If
94.Nm
Darren Tucker930cb0b2007-06-13 00:00:27 +100095has been run without arguments, the keys for the default identities will
Darren Tucker29a57072007-06-12 23:39:52 +100096be removed.
97Otherwise, the argument list will be interpreted as a list of paths to
98public key files and matching keys will be removed from the agent.
99If no public key is found at a given path,
100.Nm
101will append
102.Pa .pub
103and retry.
Ben Lindstrome6901212001-08-06 22:03:08 +0000104.It Fl e Ar reader
105Remove key in smartcard
106.Ar reader .
Damien Miller792c0172005-03-02 12:04:50 +1100107.It Fl L
108Lists public key parameters of all identities currently represented
109by the agent.
110.It Fl l
111Lists fingerprints of all identities currently represented by the agent.
112.It Fl s Ar reader
113Add key in smartcard
114.Ar reader .
115.It Fl t Ar life
116Set a maximum lifetime when adding identities to an agent.
117The lifetime may be specified in seconds or in a time format
118specified in
119.Xr sshd_config 5 .
120.It Fl X
121Unlock the agent.
122.It Fl x
123Lock the agent with a password.
Damien Miller32aa1441999-10-29 09:15:49 +1000124.El
Damien Milleraae6c611999-12-06 11:47:28 +1100125.Sh ENVIRONMENT
126.Bl -tag -width Ds
127.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller32aa1441999-10-29 09:15:49 +1000128If
129.Nm
130needs a passphrase, it will read the passphrase from the current
Damien Miller450a7a12000-03-26 13:04:51 +1000131terminal if it was run from a terminal.
132If
Damien Miller32aa1441999-10-29 09:15:49 +1000133.Nm
134does not have a terminal associated with it but
135.Ev DISPLAY
Damien Miller5428f641999-11-25 11:54:57 +1100136and
137.Ev SSH_ASKPASS
138are set, it will execute the program specified by
139.Ev SSH_ASKPASS
Damien Miller450a7a12000-03-26 13:04:51 +1000140and open an X11 window to read the passphrase.
141This is particularly useful when calling
Damien Miller32aa1441999-10-29 09:15:49 +1000142.Nm
143from a
Darren Tucker4e4fe002004-11-05 20:01:03 +1100144.Pa .xsession
Damien Miller450a7a12000-03-26 13:04:51 +1000145or related script.
146(Note that on some machines it
Damien Miller32aa1441999-10-29 09:15:49 +1000147may be necessary to redirect the input from
148.Pa /dev/null
149to make this work.)
Ben Lindstromb7788f32002-06-06 21:46:08 +0000150.It Ev SSH_AUTH_SOCK
151Identifies the path of a unix-domain socket used to communicate with the
152agent.
Damien Miller7b28dc52000-09-05 13:34:53 +1100153.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000154.Sh FILES
155.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +1000156.It Pa ~/.ssh/identity
Damien Millerf1ce5052003-06-11 22:04:39 +1000157Contains the protocol version 1 RSA authentication identity of the user.
Damien Miller167ea5d2005-05-26 12:04:02 +1000158.It Pa ~/.ssh/id_dsa
Damien Millerf1ce5052003-06-11 22:04:39 +1000159Contains the protocol version 2 DSA authentication identity of the user.
Damien Miller167ea5d2005-05-26 12:04:02 +1000160.It Pa ~/.ssh/id_rsa
Damien Millerf1ce5052003-06-11 22:04:39 +1000161Contains the protocol version 2 RSA authentication identity of the user.
162.El
163.Pp
164Identity files should not be readable by anyone but the user.
165Note that
166.Nm
167ignores identity files if they are accessible by others.
Damien Millerc313be22002-02-05 12:14:41 +1100168.Sh DIAGNOSTICS
169Exit status is 0 on success, 1 if the specified command fails,
170and 2 if
171.Nm
172is unable to contact the authentication agent.
Damien Millerf1ce5052003-06-11 22:04:39 +1000173.Sh SEE ALSO
174.Xr ssh 1 ,
175.Xr ssh-agent 1 ,
176.Xr ssh-keygen 1 ,
177.Xr sshd 8
Damien Miller0bc1bd82000-11-13 22:57:25 +1100178.Sh AUTHORS
Ben Lindstrom035782e2001-01-29 08:34:16 +0000179OpenSSH is a derivative of the original and free
180ssh 1.2.12 release by Tatu Ylonen.
181Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
182Theo de Raadt and Dug Song
183removed many bugs, re-added newer features and
184created OpenSSH.
185Markus Friedl contributed the support for SSH
186protocol versions 1.5 and 2.0.