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