version 1.17.2.6, 2002/03/08 17:04:43 |
version 1.18, 2000/11/10 05:10:40 |
|
|
.\" $OpenBSD$ |
|
.\" |
|
.\" -*- nroff -*- |
.\" -*- nroff -*- |
.\" |
.\" |
.\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
.\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
|
|
.\" called by a name other than "ssh" or "Secure Shell". |
.\" called by a name other than "ssh" or "Secure Shell". |
.\" |
.\" |
.\" |
.\" |
.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. |
.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. |
.\" Copyright (c) 1999 Aaron Campbell. All rights reserved. |
.\" Copyright (c) 1999 Aaron Campbell. All rights reserved. |
.\" Copyright (c) 1999 Theo de Raadt. All rights reserved. |
.\" Copyright (c) 1999 Theo de Raadt. All rights reserved. |
.\" |
.\" |
.\" Redistribution and use in source and binary forms, with or without |
.\" Redistribution and use in source and binary forms, with or without |
.\" modification, are permitted provided that the following conditions |
.\" modification, are permitted provided that the following conditions |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm ssh-add |
.Nm ssh-add |
.Nd adds RSA or DSA identities to the authentication agent |
.Nd adds RSA or DSA identities for the authentication agent |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm ssh-add |
.Nm ssh-add |
.Op Fl lLdD |
.Op Fl lLdD |
.Op Ar |
.Op Ar |
.Nm ssh-add |
|
.Fl s Ar reader |
|
.Nm ssh-add |
|
.Fl e Ar reader |
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
.Nm |
.Nm |
adds RSA or DSA identities to the authentication agent, |
adds RSA or DSA identities to the authentication agent, |
.Xr ssh-agent 1 . |
.Xr ssh-agent 1 . |
When run without arguments, it adds the files |
When run without arguments, it adds the file |
.Pa $HOME/.ssh/id_rsa , |
|
.Pa $HOME/.ssh/id_dsa |
|
and |
|
.Pa $HOME/.ssh/identity . |
.Pa $HOME/.ssh/identity . |
Alternative file names can be given on the command line. |
Alternative file names can be given on the command line. |
If any file requires a passphrase, |
If any file requires a passphrase, |
.Nm |
.Nm |
asks for the passphrase from the user. |
asks for the passphrase from the user. |
The passphrase is read from the user's tty. |
The Passphrase it is read from the user's tty. |
.Nm |
|
retries the last passphrase if multiple identity files are given. |
|
.Pp |
.Pp |
The authentication agent must be running and must be an ancestor of |
The authentication agent must be running and must be an ancestor of |
the current process for |
the current process for |
|
|
Instead of adding the identity, removes the identity from the agent. |
Instead of adding the identity, removes the identity from the agent. |
.It Fl D |
.It Fl D |
Deletes all identities from the agent. |
Deletes all identities from the agent. |
.It Fl s Ar reader |
|
Add key in smartcard |
|
.Ar reader . |
|
.It Fl e Ar reader |
|
Remove key in smartcard |
|
.Ar reader . |
|
.El |
.El |
.Sh FILES |
.Sh FILES |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Pa $HOME/.ssh/identity |
.It Pa $HOME/.ssh/identity |
Contains the protocol version 1 RSA authentication identity of the user. |
Contains the RSA authentication identity of the user. |
.It Pa $HOME/.ssh/id_dsa |
This file should not be readable by anyone but the user. |
Contains the protocol version 2 DSA authentication identity of the user. |
|
.It Pa $HOME/.ssh/id_rsa |
|
Contains the protocol version 2 RSA authentication identity of the user. |
|
.El |
|
.Pp |
|
Identity files should not be readable by anyone but the user. |
|
Note that |
Note that |
.Nm |
.Nm |
ignores identity files if they are accessible by others. |
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 file added by |
|
.Nm |
|
when no other files have been specified. |
|
.It Pa $HOME/.ssh/id_dsa |
|
Contains the DSA authentication identity of the user. |
|
.El |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Ev "DISPLAY" and "SSH_ASKPASS" |
.It Ev "DISPLAY" and "SSH_ASKPASS" |
|
|
.Pa /dev/null |
.Pa /dev/null |
to make this work.) |
to make this work.) |
.El |
.El |
.Sh DIAGNOSTICS |
|
Exit status is 0 on success, 1 if the specified command fails, |
|
and 2 if |
|
.Nm |
|
is unable to contact the authentication agent. |
|
.Sh AUTHORS |
.Sh AUTHORS |
OpenSSH is a derivative of the original and free |
Tatu Ylonen <ylo@cs.hut.fi> |
ssh 1.2.12 release by Tatu Ylonen. |
.Pp |
Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, |
OpenSSH |
Theo de Raadt and Dug Song |
is a derivative of the original (free) ssh 1.2.12 release, but with bugs |
removed many bugs, re-added newer features and |
removed and newer features re-added. |
created OpenSSH. |
Rapidly after the 1.2.12 release, |
Markus Friedl contributed the support for SSH |
newer versions bore successively more restrictive licenses. |
protocol versions 1.5 and 2.0. |
This version of OpenSSH |
|
.Bl -bullet |
|
.It |
|
has all components of a restrictive nature (i.e., patents, see |
|
.Xr ssl 8 ) |
|
directly removed from the source code; any licensed or patented components |
|
are chosen from |
|
external libraries. |
|
.It |
|
has been updated to support ssh protocol 1.5. |
|
.It |
|
contains added support for |
|
.Xr kerberos 8 |
|
authentication and ticket passing. |
|
.It |
|
supports one-time password authentication with |
|
.Xr skey 1 . |
|
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr ssh 1 , |
.Xr ssh 1 , |
.Xr ssh-agent 1 , |
.Xr ssh-agent 1 , |
.Xr ssh-keygen 1 , |
.Xr ssh-keygen 1 , |
.Xr sshd 8 |
.Xr sshd 8 , |
|
.Xr ssl 8 |