Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / ef767acfb7b5f379739802aacd22ff0abbb8c810 / . / ssh-add.1
blob: aa12ef34d453bb0d0ad73777bae2780f5f7ab215 [file] [log] [blame]
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]1.\" -*- nroff -*-
2.\"
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
Damien Millere4340be2000-09-16 13:29:08 +1100[diff] [blame]7.\" 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 +1000[diff] [blame]12.\"
Damien Millere4340be2000-09-16 13:29:08 +1100[diff] [blame]13.\"
14.\" 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.
17.\"
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 +1000[diff] [blame]37.\"
38.Dd September 25, 1999
39.Dt SSH-ADD 1
40.Os
41.Sh NAME
42.Nm ssh-add
Damien Millerad833b32000-08-23 10:46:23 +1000[diff] [blame]43.Nd adds RSA or DSA identities for the authentication agent
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]44.Sh SYNOPSIS
45.Nm ssh-add
Damien Miller10f6f6b1999-11-17 17:29:08 +1100[diff] [blame]46.Op Fl lLdD
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]47.Op Ar
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]48.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]49.Nm
Damien Millerad833b32000-08-23 10:46:23 +1000[diff] [blame]50adds RSA or DSA identities to the authentication agent,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]51.Xr ssh-agent 1 .
52When run without arguments, it adds the file
53.Pa $HOME/.ssh/identity .
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]54Alternative file names can be given on the command line.
55If any file requires a passphrase,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]56.Nm
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]57asks for the passphrase from the user.
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]58The Passphrase it is read from the user's tty.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]59.Pp
60The authentication agent must be running and must be an ancestor of
61the current process for
62.Nm
63to work.
64.Pp
65The options are as follows:
66.Bl -tag -width Ds
67.It Fl l
Damien Miller10f6f6b1999-11-17 17:29:08 +1100[diff] [blame]68Lists fingerprints of all identities currently represented by the agent.
69.It Fl L
70Lists public key parameters of all identities currently represented by the agent.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]71.It Fl d
72Instead of adding the identity, removes the identity from the agent.
73.It Fl D
74Deletes all identities from the agent.
75.El
76.Sh FILES
77.Bl -tag -width Ds
Damien Milleraae6c611999-12-06 11:47:28 +1100[diff] [blame]78.It Pa $HOME/.ssh/identity
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]79Contains the RSA authentication identity of the user.
80This file should not be readable by anyone but the user.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]81Note that
82.Nm
83ignores this file if it is accessible by others.
84It is possible to
85specify a passphrase when generating the key; that passphrase will be
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]86used to encrypt the private part of this file.
87This is the default file added by
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]88.Nm
89when no other files have been specified.
Damien Millerad833b32000-08-23 10:46:23 +1000[diff] [blame]90.It Pa $HOME/.ssh/id_dsa
91Contains the DSA authentication identity of the user.
Damien Miller7b28dc52000-09-05 13:34:53 +1100[diff] [blame]92.El
Damien Milleraae6c611999-12-06 11:47:28 +1100[diff] [blame]93.Sh ENVIRONMENT
94.Bl -tag -width Ds
95.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]96If
97.Nm
98needs a passphrase, it will read the passphrase from the current
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]99terminal if it was run from a terminal.
100If
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]101.Nm
102does not have a terminal associated with it but
103.Ev DISPLAY
Damien Miller5428f641999-11-25 11:54:57 +1100[diff] [blame]104and
105.Ev SSH_ASKPASS
106are set, it will execute the program specified by
107.Ev SSH_ASKPASS
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]108and open an X11 window to read the passphrase.
109This is particularly useful when calling
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]110.Nm
111from a
112.Pa .Xsession
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]113or related script.
114(Note that on some machines it
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]115may be necessary to redirect the input from
116.Pa /dev/null
117to make this work.)
Damien Miller7b28dc52000-09-05 13:34:53 +1100[diff] [blame]118.El
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]119.Sh AUTHOR
120Tatu Ylonen <ylo@cs.hut.fi>
121.Pp
122OpenSSH
123is a derivative of the original (free) ssh 1.2.12 release, but with bugs
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]124removed and newer features re-added.
125Rapidly after the 1.2.12 release,
126newer versions bore successively more restrictive licenses.
127This version of OpenSSH
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]128.Bl -bullet
129.It
Damien Millere4340be2000-09-16 13:29:08 +1100[diff] [blame]130has all components of a restrictive nature (i.e., patents, see
131.Xr crypto 3 )
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]132directly removed from the source code; any licensed or patented components
133are chosen from
134external libraries.
135.It
136has been updated to support ssh protocol 1.5.
137.It
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]138contains added support for
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]139.Xr kerberos 8
140authentication and ticket passing.
141.It
142supports one-time password authentication with
143.Xr skey 1 .
144.El
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]145.Sh SEE ALSO
146.Xr ssh 1 ,
147.Xr ssh-agent 1 ,
148.Xr ssh-keygen 1 ,
149.Xr sshd 8 ,
Damien Millere4340be2000-09-16 13:29:08 +1100[diff] [blame]150.Xr crypto 3