Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / openssh / a8f3972ce6fd3a7104e2cb33e261b43238af2e96 / . / ssh-add.1
blob: d7725c6e3652c0b0c14b73c4963f1482fe97651c [file] [log] [blame]
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000[diff] [blame]1.\" $OpenBSD: ssh-add.1,v 1.24 2001/04/10 09:13:21 itojun 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
Damien Millerad833b32000-08-23 10:46:23 +1000[diff] [blame]45.Nd adds RSA or DSA identities for the authentication agent
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]46.Sh SYNOPSIS
47.Nm ssh-add
Damien Miller10f6f6b1999-11-17 17:29:08 +1100[diff] [blame]48.Op Fl lLdD
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]49.Op Ar
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]50.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]51.Nm
Damien Millerad833b32000-08-23 10:46:23 +1000[diff] [blame]52adds RSA or DSA identities to the authentication agent,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]53.Xr ssh-agent 1 .
54When run without arguments, it adds the file
55.Pa $HOME/.ssh/identity .
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]56Alternative file names can be given on the command line.
57If any file requires a passphrase,
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]58.Nm
Damien Miller22c77262000-04-13 12:26:34 +1000[diff] [blame]59asks for the passphrase from the user.
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]60The Passphrase it is read from the user's tty.
Ben Lindstrom12de6162001-04-10 02:46:54 +0000[diff] [blame]61.Nm
62retries the last passphrase if multiple identity files are given.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]63.Pp
64The authentication agent must be running and must be an ancestor of
65the current process for
66.Nm
67to work.
68.Pp
69The options are as follows:
70.Bl -tag -width Ds
71.It Fl l
Damien Miller10f6f6b1999-11-17 17:29:08 +1100[diff] [blame]72Lists fingerprints of all identities currently represented by the agent.
73.It Fl L
74Lists public key parameters of all identities currently represented by the agent.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]75.It Fl d
76Instead of adding the identity, removes the identity from the agent.
77.It Fl D
78Deletes all identities from the agent.
79.El
80.Sh FILES
81.Bl -tag -width Ds
Damien Milleraae6c611999-12-06 11:47:28 +1100[diff] [blame]82.It Pa $HOME/.ssh/identity
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000[diff] [blame]83Contains the protocol version 1 RSA authentication identity of the user.
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]84This file should not be readable by anyone but the user.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]85Note that
86.Nm
87ignores this file if it is accessible by others.
88It is possible to
89specify a passphrase when generating the key; that passphrase will be
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]90used to encrypt the private part of this file.
91This is the default file added by
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]92.Nm
93when no other files have been specified.
Damien Millerad833b32000-08-23 10:46:23 +1000[diff] [blame]94.It Pa $HOME/.ssh/id_dsa
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000[diff] [blame]95Contains the protocol version 2 DSA authentication identity of the user.
96.It Pa $HOME/.ssh/id_rsa
97Contains the protocol version 2 RSA authentication identity of the user.
Damien Miller7b28dc52000-09-05 13:34:53 +1100[diff] [blame]98.El
Damien Milleraae6c611999-12-06 11:47:28 +1100[diff] [blame]99.Sh ENVIRONMENT
100.Bl -tag -width Ds
101.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]102If
103.Nm
104needs a passphrase, it will read the passphrase from the current
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]105terminal if it was run from a terminal.
106If
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]107.Nm
108does not have a terminal associated with it but
109.Ev DISPLAY
Damien Miller5428f641999-11-25 11:54:57 +1100[diff] [blame]110and
111.Ev SSH_ASKPASS
112are set, it will execute the program specified by
113.Ev SSH_ASKPASS
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]114and open an X11 window to read the passphrase.
115This is particularly useful when calling
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]116.Nm
117from a
118.Pa .Xsession
Damien Miller450a7a12000-03-26 13:04:51 +1000[diff] [blame]119or related script.
120(Note that on some machines it
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]121may be necessary to redirect the input from
122.Pa /dev/null
123to make this work.)
Damien Miller7b28dc52000-09-05 13:34:53 +1100[diff] [blame]124.El
Damien Miller0bc1bd82000-11-13 22:57:25 +1100[diff] [blame]125.Sh AUTHORS
Ben Lindstrom035782e2001-01-29 08:34:16 +0000[diff] [blame]126OpenSSH is a derivative of the original and free
127ssh 1.2.12 release by Tatu Ylonen.
128Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
129Theo de Raadt and Dug Song
130removed many bugs, re-added newer features and
131created OpenSSH.
132Markus Friedl contributed the support for SSH
133protocol versions 1.5 and 2.0.
Damien Miller32aa1441999-10-29 09:15:49 +1000[diff] [blame]134.Sh SEE ALSO
135.Xr ssh 1 ,
136.Xr ssh-agent 1 ,
137.Xr ssh-keygen 1 ,
Ben Lindstrome5b3fb32001-02-10 23:56:35 +0000[diff] [blame]138.Xr sshd 8