Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / 2ab1968da288e0b32f639d5e7d79ab0b61d42bc3 / . / ssh-add.1
blob: 350d1031dcd4ec8b09c83bef3a6a9445273af654 [file] [log] [blame]
Ben Lindstrom61d328a2002-06-06 21:54:57 +0000[diff] [blame]1.\" $OpenBSD: ssh-add.1,v 1.33 2002/06/05 21:55:44 markus Exp $
Ben Lindstrom36579d32001-01-29 07:39:26 +0000[diff] [blame]2.\"
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]3.\" -*- nroff -*-
4.\"
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]5.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]6.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7.\" All rights reserved
8.\"
Damien Millere4340be2000-09-16 13:29:08 +1100[diff] [blame]9.\" 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 +1000[diff] [blame]14.\"
Damien Millere4340be2000-09-16 13:29:08 +1100[diff] [blame]15.\"
Ben Lindstrom92a2e382001-03-05 06:59:27 +0000[diff] [blame]16.\" 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 +1100[diff] [blame]19.\"
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 +1000[diff] [blame]39.\"
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 +0000[diff] [blame]45.Nd adds RSA or DSA identities to the authentication agent
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]46.Sh SYNOPSIS
47.Nm ssh-add
Ben Lindstrom2f717042002-06-06 21:52:03 +0000[diff] [blame]48.Op Fl lLdDxX
Ben Lindstrom61d328a2002-06-06 21:54:57 +0000[diff] [blame]49.Op Fl t Ar life
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]50.Op Ar
Ben Lindstrome6901212001-08-06 22:03:08 +0000[diff] [blame]51.Nm ssh-add
52.Fl s Ar reader
53.Nm ssh-add
54.Fl e Ar reader
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]55.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]56.Nm
Damien Millerad833b32000-08-23 10:46:23 +1000[diff] [blame]57adds RSA or DSA identities to the authentication agent,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]58.Xr ssh-agent 1 .
Damien Miller6e1057c2002-01-22 23:05:59 +1100[diff] [blame]59When run without arguments, it adds the files
60.Pa $HOME/.ssh/id_rsa ,
61.Pa $HOME/.ssh/id_dsa
62and
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]63.Pa $HOME/.ssh/identity .
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]64Alternative file names can be given on the command line.
65If any file requires a passphrase,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]66.Nm
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]67asks for the passphrase from the user.
Ben Lindstromaafff9c2001-05-06 03:01:02 +0000[diff] [blame]68The passphrase is read from the user's tty.
Ben Lindstrom12de6162001-04-10 02:46:54 +0000[diff] [blame]69.Nm
70retries the last passphrase if multiple identity files are given.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]71.Pp
72The authentication agent must be running and must be an ancestor of
73the current process for
74.Nm
75to work.
76.Pp
77The options are as follows:
78.Bl -tag -width Ds
79.It Fl l
Damien Miller10f6f6b1999-11-17 17:29:08 +1100[diff] [blame]80Lists fingerprints of all identities currently represented by the agent.
81.It Fl L
82Lists public key parameters of all identities currently represented by the agent.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]83.It Fl d
84Instead of adding the identity, removes the identity from the agent.
85.It Fl D
86Deletes all identities from the agent.
Ben Lindstrom2f717042002-06-06 21:52:03 +0000[diff] [blame]87.It Fl x
88Lock the agent with a password.
89.It Fl X
90Unlock the agent.
Ben Lindstrom61d328a2002-06-06 21:54:57 +0000[diff] [blame]91.It Fl t Ar life
92Set a maximum lifetime when adding identities to an agent.
93The lifetime is specified in seconds.
Ben Lindstrome6901212001-08-06 22:03:08 +0000[diff] [blame]94.It Fl s Ar reader
95Add key in smartcard
96.Ar reader .
97.It Fl e Ar reader
98Remove key in smartcard
99.Ar reader .
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]100.El
101.Sh FILES
102.Bl -tag -width Ds
Damien Milleraae6c611999-12-06 11:47:28 +1100[diff] [blame]103.It Pa $HOME/.ssh/identity
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000[diff] [blame]104Contains the protocol version 1 RSA authentication identity of the user.
Damien Millerad833b32000-08-23 10:46:23 +1000[diff] [blame]105.It Pa $HOME/.ssh/id_dsa
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000[diff] [blame]106Contains the protocol version 2 DSA authentication identity of the user.
107.It Pa $HOME/.ssh/id_rsa
108Contains the protocol version 2 RSA authentication identity of the user.
Damien Miller7b28dc52000-09-05 13:34:53 +1100[diff] [blame]109.El
Damien Millerab57f352002-02-05 12:26:58 +1100[diff] [blame]110.Pp
111Identity files should not be readable by anyone but the user.
112Note that
113.Nm
114ignores identity files if they are accessible by others.
Damien Milleraae6c611999-12-06 11:47:28 +1100[diff] [blame]115.Sh ENVIRONMENT
116.Bl -tag -width Ds
117.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]118If
119.Nm
120needs a passphrase, it will read the passphrase from the current
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]121terminal if it was run from a terminal.
122If
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]123.Nm
124does not have a terminal associated with it but
125.Ev DISPLAY
Damien Miller5428f641999-11-25 11:54:57 +1100[diff] [blame]126and
127.Ev SSH_ASKPASS
128are set, it will execute the program specified by
129.Ev SSH_ASKPASS
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]130and open an X11 window to read the passphrase.
131This is particularly useful when calling
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]132.Nm
133from a
134.Pa .Xsession
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]135or related script.
136(Note that on some machines it
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]137may be necessary to redirect the input from
138.Pa /dev/null
139to make this work.)
Ben Lindstromb7788f32002-06-06 21:46:08 +0000[diff] [blame]140.It Ev SSH_AUTH_SOCK
141Identifies the path of a unix-domain socket used to communicate with the
142agent.
Damien Miller7b28dc52000-09-05 13:34:53 +1100[diff] [blame]143.El
Damien Millerc313be22002-02-05 12:14:41 +1100[diff] [blame]144.Sh DIAGNOSTICS
145Exit status is 0 on success, 1 if the specified command fails,
146and 2 if
147.Nm
148is unable to contact the authentication agent.
Damien Miller0bc1bd82000-11-13 22:57:25 +1100[diff] [blame]149.Sh AUTHORS
Ben Lindstrom035782e2001-01-29 08:34:16 +0000[diff] [blame]150OpenSSH is a derivative of the original and free
151ssh 1.2.12 release by Tatu Ylonen.
152Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
153Theo de Raadt and Dug Song
154removed many bugs, re-added newer features and
155created OpenSSH.
156Markus Friedl contributed the support for SSH
157protocol versions 1.5 and 2.0.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]158.Sh SEE ALSO
159.Xr ssh 1 ,
160.Xr ssh-agent 1 ,
161.Xr ssh-keygen 1 ,
Ben Lindstrome5b3fb32001-02-10 23:56:35 +0000[diff] [blame]162.Xr sshd 8