blob: fd48ff98fa3fa7acefb70632d31345f4b5530b80 [file] [log] [blame]
Damien Miller55fa5652010-11-05 10:20:14 +11001.\" $OpenBSD: ssh-add.1,v 1.55 2010/10/28 18:33:28 jmc Exp $
Damien Miller32aa1441999-10-29 09:15:49 +10002.\"
Damien Miller32aa1441999-10-29 09:15:49 +10003.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller32aa1441999-10-29 09:15:49 +10004.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
Damien Millere4340be2000-09-16 13:29:08 +11007.\" 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".
Damien Miller32aa1441999-10-29 09:15:49 +100012.\"
Damien Millere4340be2000-09-16 13:29:08 +110013.\"
Ben Lindstrom92a2e382001-03-05 06:59:27 +000014.\" 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.
Damien Millere4340be2000-09-16 13:29:08 +110017.\"
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.
Damien Miller32aa1441999-10-29 09:15:49 +100037.\"
Damien Miller55fa5652010-11-05 10:20:14 +110038.Dd $Mdocdate: October 28 2010 $
Damien Miller32aa1441999-10-29 09:15:49 +100039.Dt SSH-ADD 1
40.Os
41.Sh NAME
42.Nm ssh-add
Damien Millereb8b60e2010-08-31 22:41:14 +100043.Nd adds private key identities to the authentication agent
Damien Miller32aa1441999-10-29 09:15:49 +100044.Sh SYNOPSIS
45.Nm ssh-add
Damien Miller792c0172005-03-02 12:04:50 +110046.Op Fl cDdLlXx
Ben Lindstrom61d328a2002-06-06 21:54:57 +000047.Op Fl t Ar life
Damien Miller32aa1441999-10-29 09:15:49 +100048.Op Ar
Ben Lindstrome6901212001-08-06 22:03:08 +000049.Nm ssh-add
Damien Miller048dc932010-02-12 09:22:04 +110050.Fl s Ar pkcs11
Ben Lindstrome6901212001-08-06 22:03:08 +000051.Nm ssh-add
Damien Miller048dc932010-02-12 09:22:04 +110052.Fl e Ar pkcs11
Damien Miller22c77262000-04-13 12:26:34 +100053.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +100054.Nm
Damien Millereb8b60e2010-08-31 22:41:14 +100055adds private key identities to the authentication agent,
Damien Miller32aa1441999-10-29 09:15:49 +100056.Xr ssh-agent 1 .
Damien Miller6e1057c2002-01-22 23:05:59 +110057When run without arguments, it adds the files
Damien Miller167ea5d2005-05-26 12:04:02 +100058.Pa ~/.ssh/id_rsa ,
Damien Millereb8b60e2010-08-31 22:41:14 +100059.Pa ~/.ssh/id_dsa ,
60.Pa ~/.ssh/id_ecdsa
Damien Miller6e1057c2002-01-22 23:05:59 +110061and
Damien Miller167ea5d2005-05-26 12:04:02 +100062.Pa ~/.ssh/identity .
Damien Miller5059d8d2010-03-05 21:31:11 +110063After loading a private key,
64.Nm
65will try to load corresponding certificate information from the
66filename obtained by appending
67.Pa -cert.pub
68to the name of the private key file.
Damien Miller450a7a12000-03-26 13:04:51 +100069Alternative file names can be given on the command line.
Damien Miller5059d8d2010-03-05 21:31:11 +110070.Pp
Damien Miller450a7a12000-03-26 13:04:51 +100071If any file requires a passphrase,
Damien Miller32aa1441999-10-29 09:15:49 +100072.Nm
Damien Miller22c77262000-04-13 12:26:34 +100073asks for the passphrase from the user.
Ben Lindstromaafff9c2001-05-06 03:01:02 +000074The passphrase is read from the user's tty.
Ben Lindstrom12de6162001-04-10 02:46:54 +000075.Nm
76retries the last passphrase if multiple identity files are given.
Damien Miller32aa1441999-10-29 09:15:49 +100077.Pp
Darren Tucker4c568432003-12-09 19:01:51 +110078The authentication agent must be running and the
79.Ev SSH_AUTH_SOCK
80environment variable must contain the name of its socket for
Damien Miller32aa1441999-10-29 09:15:49 +100081.Nm
82to work.
83.Pp
84The options are as follows:
85.Bl -tag -width Ds
Damien Miller6c711792003-01-24 11:36:23 +110086.It Fl c
87Indicates that added identities should be subject to confirmation before
Damien Miller495dca32003-04-01 21:42:14 +100088being used for authentication.
89Confirmation is performed by the
Damien Miller6c711792003-01-24 11:36:23 +110090.Ev SSH_ASKPASS
Damien Miller495dca32003-04-01 21:42:14 +100091program mentioned below.
92Successful confirmation is signaled by a zero exit status from the
Damien Miller6c711792003-01-24 11:36:23 +110093.Ev SSH_ASKPASS
94program, rather than text entered into the requester.
Damien Miller792c0172005-03-02 12:04:50 +110095.It Fl D
96Deletes all identities from the agent.
97.It Fl d
Darren Tucker930cb0b2007-06-13 00:00:27 +100098Instead of adding identities, removes identities from the agent.
Darren Tucker29a57072007-06-12 23:39:52 +100099If
100.Nm
Darren Tucker930cb0b2007-06-13 00:00:27 +1000101has been run without arguments, the keys for the default identities will
Darren Tucker29a57072007-06-12 23:39:52 +1000102be removed.
103Otherwise, the argument list will be interpreted as a list of paths to
104public key files and matching keys will be removed from the agent.
105If no public key is found at a given path,
106.Nm
107will append
108.Pa .pub
109and retry.
Damien Miller7ea845e2010-02-12 09:21:02 +1100110.It Fl e Ar pkcs11
Damien Millera7618442010-02-12 09:26:02 +1100111Remove keys provided by the PKCS#11 shared library
Damien Miller7ea845e2010-02-12 09:21:02 +1100112.Ar pkcs11 .
Damien Miller792c0172005-03-02 12:04:50 +1100113.It Fl L
114Lists public key parameters of all identities currently represented
115by the agent.
116.It Fl l
117Lists fingerprints of all identities currently represented by the agent.
Damien Miller7ea845e2010-02-12 09:21:02 +1100118.It Fl s Ar pkcs11
Damien Millera7618442010-02-12 09:26:02 +1100119Add keys provided by the PKCS#11 shared library
Damien Miller7ea845e2010-02-12 09:21:02 +1100120.Ar pkcs11 .
Damien Miller792c0172005-03-02 12:04:50 +1100121.It Fl t Ar life
122Set a maximum lifetime when adding identities to an agent.
123The lifetime may be specified in seconds or in a time format
124specified in
125.Xr sshd_config 5 .
126.It Fl X
127Unlock the agent.
128.It Fl x
129Lock the agent with a password.
Damien Miller32aa1441999-10-29 09:15:49 +1000130.El
Damien Milleraae6c611999-12-06 11:47:28 +1100131.Sh ENVIRONMENT
132.Bl -tag -width Ds
133.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller32aa1441999-10-29 09:15:49 +1000134If
135.Nm
136needs a passphrase, it will read the passphrase from the current
Damien Miller450a7a12000-03-26 13:04:51 +1000137terminal if it was run from a terminal.
138If
Damien Miller32aa1441999-10-29 09:15:49 +1000139.Nm
140does not have a terminal associated with it but
141.Ev DISPLAY
Damien Miller5428f641999-11-25 11:54:57 +1100142and
143.Ev SSH_ASKPASS
144are set, it will execute the program specified by
145.Ev SSH_ASKPASS
Damien Miller450a7a12000-03-26 13:04:51 +1000146and open an X11 window to read the passphrase.
147This is particularly useful when calling
Damien Miller32aa1441999-10-29 09:15:49 +1000148.Nm
149from a
Darren Tucker4e4fe002004-11-05 20:01:03 +1100150.Pa .xsession
Damien Miller450a7a12000-03-26 13:04:51 +1000151or related script.
152(Note that on some machines it
Damien Miller32aa1441999-10-29 09:15:49 +1000153may be necessary to redirect the input from
154.Pa /dev/null
155to make this work.)
Ben Lindstromb7788f32002-06-06 21:46:08 +0000156.It Ev SSH_AUTH_SOCK
Darren Tuckerae69e1d2009-10-24 11:41:34 +1100157Identifies the path of a
Darren Tucker98c9aec2009-10-24 11:42:44 +1100158.Ux Ns -domain
159socket used to communicate with the agent.
Damien Miller7b28dc52000-09-05 13:34:53 +1100160.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000161.Sh FILES
162.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +1000163.It Pa ~/.ssh/identity
Damien Millerf1ce5052003-06-11 22:04:39 +1000164Contains the protocol version 1 RSA authentication identity of the user.
Damien Miller167ea5d2005-05-26 12:04:02 +1000165.It Pa ~/.ssh/id_dsa
Damien Millerf1ce5052003-06-11 22:04:39 +1000166Contains the protocol version 2 DSA authentication identity of the user.
Damien Millereb8b60e2010-08-31 22:41:14 +1000167.It Pa ~/.ssh/id_ecdsa
168Contains the protocol version 2 ECDSA authentication identity of the user.
Damien Miller167ea5d2005-05-26 12:04:02 +1000169.It Pa ~/.ssh/id_rsa
Damien Millerf1ce5052003-06-11 22:04:39 +1000170Contains the protocol version 2 RSA authentication identity of the user.
171.El
172.Pp
173Identity files should not be readable by anyone but the user.
174Note that
175.Nm
176ignores identity files if they are accessible by others.
Damien Millerdaa7b222010-09-10 11:19:33 +1000177.Sh EXIT STATUS
Damien Millerc313be22002-02-05 12:14:41 +1100178Exit status is 0 on success, 1 if the specified command fails,
179and 2 if
180.Nm
181is unable to contact the authentication agent.
Damien Millerf1ce5052003-06-11 22:04:39 +1000182.Sh SEE ALSO
183.Xr ssh 1 ,
184.Xr ssh-agent 1 ,
185.Xr ssh-keygen 1 ,
186.Xr sshd 8
Damien Miller0bc1bd82000-11-13 22:57:25 +1100187.Sh AUTHORS
Ben Lindstrom035782e2001-01-29 08:34:16 +0000188OpenSSH is a derivative of the original and free
189ssh 1.2.12 release by Tatu Ylonen.
190Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
191Theo de Raadt and Dug Song
192removed many bugs, re-added newer features and
193created OpenSSH.
194Markus Friedl contributed the support for SSH
195protocol versions 1.5 and 2.0.