132 lines
4.4 KiB
Groff
132 lines
4.4 KiB
Groff
|
.\" -*- nroff -*-
|
||
|
|
.\"
|
||
|
|
.\" $NetBSD: ssh-add.1,v 1.1.1.1 2000/09/28 22:10:25 thorpej Exp $
|
||
|
|
.\"
|
||
|
|
.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
|
||
|
|
.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
|
||
|
|
.\" All rights reserved
|
||
|
|
.\"
|
||
|
|
.\" Created: Sat Apr 22 23:55:14 1995 ylo
|
||
|
|
.\"
|
||
|
|
.\" As far as I am concerned, the code I have written for this software
|
||
|
|
.\" can be used freely for any purpose. Any derived versions of this
|
||
|
|
.\" software must be clearly marked as such, and if the derived work is
|
||
|
|
.\" incompatible with the protocol description in the RFC file, it must be
|
||
|
|
.\" called by a name other than "ssh" or "Secure Shell".
|
||
|
|
.\"
|
||
|
|
.\"
|
||
|
|
.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
|
||
|
|
.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
|
||
|
|
.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
||
|
|
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||
|
|
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||
|
|
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||
|
|
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
||
|
|
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||
|
|
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||
|
|
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
|
|
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
||
|
|
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
.\"
|
||
|
|
.Dd August 6, 2000
|
||
|
|
.Dt SSH-ADD 1
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm ssh-add
|
||
|
|
.Nd add RSA or DSA identities to the Secure Shell authentication agent
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.Nm ssh-add
|
||
|
|
.Op Fl lLdD
|
||
|
|
.Op Ar
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
.Nm
|
||
|
|
adds RSA or DSA identities to the Secure Shell authentication agent,
|
||
|
|
.Xr ssh-agent 1 .
|
||
|
|
When run without arguments, it adds the file
|
||
|
|
.Pa $HOME/.ssh/identity .
|
||
|
|
Alternative file names can be given on the command line.
|
||
|
|
If any file requires a passphrase,
|
||
|
|
.Nm
|
||
|
|
asks for the passphrase from the user.
|
||
|
|
If
|
||
|
|
.Nm
|
||
|
|
was invoked from a tty, the Passphrase is read from the tty.
|
||
|
|
If
|
||
|
|
.Nm
|
||
|
|
was not invoked from a tty, the
|
||
|
|
.Ev DISPLAY
|
||
|
|
environment variable is consulted and, if set, an external
|
||
|
|
Passphrase prompting program is run on that display.
|
||
|
|
.Pp
|
||
|
|
The authentication agent must be running and must be an ancestor of
|
||
|
|
the current process for
|
||
|
|
.Nm
|
||
|
|
to work.
|
||
|
|
.Pp
|
||
|
|
The options are as follows:
|
||
|
|
.Bl -tag -width Ds
|
||
|
|
.It Fl l
|
||
|
|
Lists fingerprints of all identities currently represented by the agent.
|
||
|
|
.It Fl L
|
||
|
|
Lists public key parameters of all identities currently represented by
|
||
|
|
the agent.
|
||
|
|
.It Fl d
|
||
|
|
Instead of adding the identity, removes the identity from the agent.
|
||
|
|
.It Fl D
|
||
|
|
Deletes all identities from the agent.
|
||
|
|
.El
|
||
|
|
.Sh FILES
|
||
|
|
.Bl -tag -width "SSH_ASKPASS"
|
||
|
|
.It Pa $HOME/.ssh/identity
|
||
|
|
Contains the RSA authentication identity of the user.
|
||
|
|
This file should not be readable by anyone but the user.
|
||
|
|
Note that
|
||
|
|
.Nm
|
||
|
|
ignores this file if it is accessible by others.
|
||
|
|
It is possible to
|
||
|
|
specify a passphrase when generating the key; that passphrase will be
|
||
|
|
used to encrypt the private part of this file.
|
||
|
|
This is the default identity added by
|
||
|
|
.Nm
|
||
|
|
when no other files have been specified.
|
||
|
|
.It Pa $HOME/.ssh/id_dsa
|
||
|
|
Contains the DSA authentication identity of the user.
|
||
|
|
.Pp
|
||
|
|
.El
|
||
|
|
.Sh ENVIRONMENT
|
||
|
|
.Bl -tag -width "SSH_ASKPASS"
|
||
|
|
.It Ev DISPLAY
|
||
|
|
If set, indicates the X11 display associated with a session. This
|
||
|
|
is the display that the external Passphrase prompting program will
|
||
|
|
be run on.
|
||
|
|
.It Ev SSH_ASKPASS
|
||
|
|
If set, indicates the program to use as the external Passphrase
|
||
|
|
prompter. If unset,
|
||
|
|
.Nm
|
||
|
|
will use the default
|
||
|
|
.Pa /usr/X11R6/bin/ssh-askpass .
|
||
|
|
This environment variable is useful for selecting Passphrase prompters
|
||
|
|
that are part of integrated desktop environments, such as
|
||
|
|
.Em GNOME
|
||
|
|
or
|
||
|
|
.Em KDE .
|
||
|
|
.El
|
||
|
|
.Sh AUTHOR
|
||
|
|
Tatu Ylonen <ylo@cs.hut.fi>, Markus Friedl
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr ssh 1 ,
|
||
|
|
.Xr ssh-agent 1 ,
|
||
|
|
.Xr ssh-keygen 1 ,
|
||
|
|
.Xr sshd 8
|