Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / 0100627fc8fda8b3be42789972a8d9f0e339134c / . / ssh-add.1
blob: 5d2f2497af3a44df2e534f0da24c34bd8e033b92 [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 Millere247cc42000-05-07 12:03:14 +1000[diff] [blame]12.\" $Id: ssh-add.1,v 1.13 2000/05/07 02:03:18 damien 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 Millere247cc42000-05-07 12:03:14 +1000[diff] [blame]19.Nd adds RSA 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 Millere247cc42000-05-07 12:03:14 +1000[diff] [blame]26adds RSA 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.
66.Pp
Damien Milleraae6c611999-12-06 11:47:28 +1100[diff] [blame]67.Sh ENVIRONMENT
68.Bl -tag -width Ds
69.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]70If
71.Nm
72needs a passphrase, it will read the passphrase from the current
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]73terminal if it was run from a terminal.
74If
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]75.Nm
76does not have a terminal associated with it but
77.Ev DISPLAY
Damien Miller5428f641999-11-25 11:54:57 +1100[diff] [blame]78and
79.Ev SSH_ASKPASS
80are set, it will execute the program specified by
81.Ev SSH_ASKPASS
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]82and open an X11 window to read the passphrase.
83This is particularly useful when calling
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]84.Nm
85from a
86.Pa .Xsession
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]87or related script.
88(Note that on some machines it
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]89may be necessary to redirect the input from
90.Pa /dev/null
91to make this work.)
92.Sh AUTHOR
93Tatu Ylonen <ylo@cs.hut.fi>
94.Pp
95OpenSSH
96is a derivative of the original (free) ssh 1.2.12 release, but with bugs
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]97removed and newer features re-added.
98Rapidly after the 1.2.12 release,
99newer versions bore successively more restrictive licenses.
100This version of OpenSSH
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]101.Bl -bullet
102.It
Damien Millercfabe862000-04-20 23:27:27 +1000[diff] [blame]103has all components of a restrictive nature (i.e., patents)
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]104directly removed from the source code; any licensed or patented components
105are chosen from
106external libraries.
107.It
108has been updated to support ssh protocol 1.5.
109.It
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]110contains added support for
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]111.Xr kerberos 8
112authentication and ticket passing.
113.It
114supports one-time password authentication with
115.Xr skey 1 .
116.El
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]117.Sh SEE ALSO
118.Xr ssh 1 ,
119.Xr ssh-agent 1 ,
120.Xr ssh-keygen 1 ,
121.Xr sshd 8 ,