blob: d7cc53101f8d39cdecc12318d3f16dc31df88d0d [file] [log] [blame]
Damien Miller5059d8d2010-03-05 21:31:11 +11001.\" $OpenBSD: ssh-add.1,v 1.52 2010/03/05 10:28:21 djm 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.\"
Damien Miller5059d8d2010-03-05 21:31:11 +110040.Dd $Mdocdate: March 5 2010 $
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
Damien Miller048dc932010-02-12 09:22:04 +110052.Fl s Ar pkcs11
Ben Lindstrome6901212001-08-06 22:03:08 +000053.Nm ssh-add
Damien Miller048dc932010-02-12 09:22:04 +110054.Fl e Ar pkcs11
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 Miller5059d8d2010-03-05 21:31:11 +110064After 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.
Damien Miller450a7a12000-03-26 13:04:51 +100070Alternative file names can be given on the command line.
Damien Miller5059d8d2010-03-05 21:31:11 +110071.Pp
Damien Miller450a7a12000-03-26 13:04:51 +100072If any file requires a passphrase,
Damien Miller32aa1441999-10-29 09:15:49 +100073.Nm
Damien Miller22c77262000-04-13 12:26:34 +100074asks for the passphrase from the user.
Ben Lindstromaafff9c2001-05-06 03:01:02 +000075The passphrase is read from the user's tty.
Ben Lindstrom12de6162001-04-10 02:46:54 +000076.Nm
77retries the last passphrase if multiple identity files are given.
Damien Miller32aa1441999-10-29 09:15:49 +100078.Pp
Darren Tucker4c568432003-12-09 19:01:51 +110079The authentication agent must be running and the
80.Ev SSH_AUTH_SOCK
81environment variable must contain the name of its socket for
Damien Miller32aa1441999-10-29 09:15:49 +100082.Nm
83to work.
84.Pp
85The options are as follows:
86.Bl -tag -width Ds
Damien Miller6c711792003-01-24 11:36:23 +110087.It Fl c
88Indicates that added identities should be subject to confirmation before
Damien Miller495dca32003-04-01 21:42:14 +100089being used for authentication.
90Confirmation is performed by the
Damien Miller6c711792003-01-24 11:36:23 +110091.Ev SSH_ASKPASS
Damien Miller495dca32003-04-01 21:42:14 +100092program mentioned below.
93Successful confirmation is signaled by a zero exit status from the
Damien Miller6c711792003-01-24 11:36:23 +110094.Ev SSH_ASKPASS
95program, rather than text entered into the requester.
Damien Miller792c0172005-03-02 12:04:50 +110096.It Fl D
97Deletes all identities from the agent.
98.It Fl d
Darren Tucker930cb0b2007-06-13 00:00:27 +100099Instead of adding identities, removes identities from the agent.
Darren Tucker29a57072007-06-12 23:39:52 +1000100If
101.Nm
Darren Tucker930cb0b2007-06-13 00:00:27 +1000102has been run without arguments, the keys for the default identities will
Darren Tucker29a57072007-06-12 23:39:52 +1000103be removed.
104Otherwise, the argument list will be interpreted as a list of paths to
105public key files and matching keys will be removed from the agent.
106If no public key is found at a given path,
107.Nm
108will append
109.Pa .pub
110and retry.
Damien Miller7ea845e2010-02-12 09:21:02 +1100111.It Fl e Ar pkcs11
Damien Millera7618442010-02-12 09:26:02 +1100112Remove keys provided by the PKCS#11 shared library
Damien Miller7ea845e2010-02-12 09:21:02 +1100113.Ar pkcs11 .
Damien Miller792c0172005-03-02 12:04:50 +1100114.It Fl L
115Lists public key parameters of all identities currently represented
116by the agent.
117.It Fl l
118Lists fingerprints of all identities currently represented by the agent.
Damien Miller7ea845e2010-02-12 09:21:02 +1100119.It Fl s Ar pkcs11
Damien Millera7618442010-02-12 09:26:02 +1100120Add keys provided by the PKCS#11 shared library
Damien Miller7ea845e2010-02-12 09:21:02 +1100121.Ar pkcs11 .
Damien Miller792c0172005-03-02 12:04:50 +1100122.It Fl t Ar life
123Set a maximum lifetime when adding identities to an agent.
124The lifetime may be specified in seconds or in a time format
125specified in
126.Xr sshd_config 5 .
127.It Fl X
128Unlock the agent.
129.It Fl x
130Lock the agent with a password.
Damien Miller32aa1441999-10-29 09:15:49 +1000131.El
Damien Milleraae6c611999-12-06 11:47:28 +1100132.Sh ENVIRONMENT
133.Bl -tag -width Ds
134.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller32aa1441999-10-29 09:15:49 +1000135If
136.Nm
137needs a passphrase, it will read the passphrase from the current
Damien Miller450a7a12000-03-26 13:04:51 +1000138terminal if it was run from a terminal.
139If
Damien Miller32aa1441999-10-29 09:15:49 +1000140.Nm
141does not have a terminal associated with it but
142.Ev DISPLAY
Damien Miller5428f641999-11-25 11:54:57 +1100143and
144.Ev SSH_ASKPASS
145are set, it will execute the program specified by
146.Ev SSH_ASKPASS
Damien Miller450a7a12000-03-26 13:04:51 +1000147and open an X11 window to read the passphrase.
148This is particularly useful when calling
Damien Miller32aa1441999-10-29 09:15:49 +1000149.Nm
150from a
Darren Tucker4e4fe002004-11-05 20:01:03 +1100151.Pa .xsession
Damien Miller450a7a12000-03-26 13:04:51 +1000152or related script.
153(Note that on some machines it
Damien Miller32aa1441999-10-29 09:15:49 +1000154may be necessary to redirect the input from
155.Pa /dev/null
156to make this work.)
Ben Lindstromb7788f32002-06-06 21:46:08 +0000157.It Ev SSH_AUTH_SOCK
Darren Tuckerae69e1d2009-10-24 11:41:34 +1100158Identifies the path of a
Darren Tucker98c9aec2009-10-24 11:42:44 +1100159.Ux Ns -domain
160socket used to communicate with the agent.
Damien Miller7b28dc52000-09-05 13:34:53 +1100161.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000162.Sh FILES
163.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +1000164.It Pa ~/.ssh/identity
Damien Millerf1ce5052003-06-11 22:04:39 +1000165Contains the protocol version 1 RSA authentication identity of the user.
Damien Miller167ea5d2005-05-26 12:04:02 +1000166.It Pa ~/.ssh/id_dsa
Damien Millerf1ce5052003-06-11 22:04:39 +1000167Contains the protocol version 2 DSA authentication identity of the user.
Damien Miller167ea5d2005-05-26 12:04:02 +1000168.It Pa ~/.ssh/id_rsa
Damien Millerf1ce5052003-06-11 22:04:39 +1000169Contains the protocol version 2 RSA authentication identity of the user.
170.El
171.Pp
172Identity files should not be readable by anyone but the user.
173Note that
174.Nm
175ignores identity files if they are accessible by others.
Damien Millerc313be22002-02-05 12:14:41 +1100176.Sh DIAGNOSTICS
177Exit status is 0 on success, 1 if the specified command fails,
178and 2 if
179.Nm
180is unable to contact the authentication agent.
Damien Millerf1ce5052003-06-11 22:04:39 +1000181.Sh SEE ALSO
182.Xr ssh 1 ,
183.Xr ssh-agent 1 ,
184.Xr ssh-keygen 1 ,
185.Xr sshd 8
Damien Miller0bc1bd82000-11-13 22:57:25 +1100186.Sh AUTHORS
Ben Lindstrom035782e2001-01-29 08:34:16 +0000187OpenSSH is a derivative of the original and free
188ssh 1.2.12 release by Tatu Ylonen.
189Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
190Theo de Raadt and Dug Song
191removed many bugs, re-added newer features and
192created OpenSSH.
193Markus Friedl contributed the support for SSH
194protocol versions 1.5 and 2.0.