blob: 9da7a283568d363c7fa10f4c93ddc8b5861452df [file] [log] [blame]
sobrado@openbsd.orgf70b22b2014-08-30 15:33:50 +00001.\" $OpenBSD: ssh-add.1,v 1.60 2014/08/30 15:33:50 sobrado 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.\"
sobrado@openbsd.orgf70b22b2014-08-30 15:33:50 +000038.Dd $Mdocdate: August 30 2014 $
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 Miller8f4279e2011-10-18 16:06:33 +110046.Op Fl cDdkLlXx
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 ,
Damien Miller8ba0ead2013-12-18 17:46:27 +110060.Pa ~/.ssh/id_ecdsa ,
61.Pa ~/.ssh/id_ed25519
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
Damien Miller33a81362012-12-03 09:50:24 +1100102has been run without arguments, the keys for the default identities and
Darren Tuckerf9333d52012-12-07 13:06:13 +1100103their corresponding certificates will be removed.
Darren Tucker29a57072007-06-12 23:39:52 +1000104Otherwise, the argument list will be interpreted as a list of paths to
Damien Miller33a81362012-12-03 09:50:24 +1100105public key files to specify keys and certificates to be removed from the agent.
Darren Tucker29a57072007-06-12 23:39:52 +1000106If 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 Miller8f4279e2011-10-18 16:06:33 +1100114.It Fl k
Damien Miller33a81362012-12-03 09:50:24 +1100115When loading keys into or deleting keys from the agent, process plain private
116keys only and skip certificates.
Damien Miller792c0172005-03-02 12:04:50 +1100117.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.
Damien Miller7ea845e2010-02-12 09:21:02 +1100122.It Fl s Ar pkcs11
Damien Millera7618442010-02-12 09:26:02 +1100123Add keys provided by the PKCS#11 shared library
Damien Miller7ea845e2010-02-12 09:21:02 +1100124.Ar pkcs11 .
Damien Miller792c0172005-03-02 12:04:50 +1100125.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.
Damien Miller32aa1441999-10-29 09:15:49 +1000134.El
Damien Milleraae6c611999-12-06 11:47:28 +1100135.Sh ENVIRONMENT
136.Bl -tag -width Ds
137.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller32aa1441999-10-29 09:15:49 +1000138If
139.Nm
140needs a passphrase, it will read the passphrase from the current
Damien Miller450a7a12000-03-26 13:04:51 +1000141terminal if it was run from a terminal.
142If
Damien Miller32aa1441999-10-29 09:15:49 +1000143.Nm
144does not have a terminal associated with it but
145.Ev DISPLAY
Damien Miller5428f641999-11-25 11:54:57 +1100146and
147.Ev SSH_ASKPASS
148are set, it will execute the program specified by
149.Ev SSH_ASKPASS
Damien Miller450a7a12000-03-26 13:04:51 +1000150and open an X11 window to read the passphrase.
151This is particularly useful when calling
Damien Miller32aa1441999-10-29 09:15:49 +1000152.Nm
153from a
Darren Tucker4e4fe002004-11-05 20:01:03 +1100154.Pa .xsession
Damien Miller450a7a12000-03-26 13:04:51 +1000155or related script.
156(Note that on some machines it
Damien Miller32aa1441999-10-29 09:15:49 +1000157may be necessary to redirect the input from
158.Pa /dev/null
159to make this work.)
Ben Lindstromb7788f32002-06-06 21:46:08 +0000160.It Ev SSH_AUTH_SOCK
Darren Tuckerae69e1d2009-10-24 11:41:34 +1100161Identifies the path of a
Darren Tucker98c9aec2009-10-24 11:42:44 +1100162.Ux Ns -domain
163socket used to communicate with the agent.
Damien Miller7b28dc52000-09-05 13:34:53 +1100164.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000165.Sh FILES
166.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +1000167.It Pa ~/.ssh/identity
Damien Millerf1ce5052003-06-11 22:04:39 +1000168Contains the protocol version 1 RSA authentication identity of the user.
Damien Miller167ea5d2005-05-26 12:04:02 +1000169.It Pa ~/.ssh/id_dsa
Damien Millerf1ce5052003-06-11 22:04:39 +1000170Contains the protocol version 2 DSA authentication identity of the user.
Damien Millereb8b60e2010-08-31 22:41:14 +1000171.It Pa ~/.ssh/id_ecdsa
172Contains the protocol version 2 ECDSA authentication identity of the user.
Damien Miller8ba0ead2013-12-18 17:46:27 +1100173.It Pa ~/.ssh/id_ed25519
sobrado@openbsd.orgf70b22b2014-08-30 15:33:50 +0000174Contains the protocol version 2 Ed25519 authentication identity of the user.
Damien Miller167ea5d2005-05-26 12:04:02 +1000175.It Pa ~/.ssh/id_rsa
Damien Millerf1ce5052003-06-11 22:04:39 +1000176Contains 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.
Damien Millerdaa7b222010-09-10 11:19:33 +1000183.Sh EXIT STATUS
Damien Millerc313be22002-02-05 12:14:41 +1100184Exit status is 0 on success, 1 if the specified command fails,
185and 2 if
186.Nm
187is unable to contact the authentication agent.
Damien Millerf1ce5052003-06-11 22:04:39 +1000188.Sh SEE ALSO
189.Xr ssh 1 ,
190.Xr ssh-agent 1 ,
191.Xr ssh-keygen 1 ,
192.Xr sshd 8
Damien Miller0bc1bd82000-11-13 22:57:25 +1100193.Sh AUTHORS
Ben Lindstrom035782e2001-01-29 08:34:16 +0000194OpenSSH 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.