version 1.27.2.2, 2002/06/22 07:23:17 |
version 1.28, 2001/12/21 10:06:43 |
|
|
.Nd adds RSA or DSA identities to the authentication agent |
.Nd adds RSA or DSA identities to the authentication agent |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm ssh-add |
.Nm ssh-add |
.Op Fl lLdDxX |
.Op Fl lLdD |
.Op Fl t Ar life |
|
.Op Ar |
.Op Ar |
.Nm ssh-add |
.Nm ssh-add |
.Fl s Ar reader |
.Fl s Ar reader |
|
|
.Xr ssh-agent 1 . |
.Xr ssh-agent 1 . |
When run without arguments, it adds the files |
When run without arguments, it adds the files |
.Pa $HOME/.ssh/id_rsa , |
.Pa $HOME/.ssh/id_rsa , |
.Pa $HOME/.ssh/id_dsa |
.Pa $HOME/.ssh/id_dsa |
and |
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. |
|
|
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 x |
|
Lock the agent with a password. |
|
.It Fl X |
|
Unlock the agent. |
|
.It Fl t Ar life |
|
Set a maximum lifetime when adding identities to an agent. |
|
The lifetime may be specified in seconds or in a time format |
|
specified in |
|
.Xr sshd 8 . |
|
.It Fl s Ar reader |
.It Fl s Ar reader |
Add key in smartcard |
Add key in smartcard |
.Ar reader . |
.Ar reader . |
|
|
.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 protocol version 1 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 file added by |
|
.Nm |
|
when no other files have been specified. |
.It Pa $HOME/.ssh/id_dsa |
.It Pa $HOME/.ssh/id_dsa |
Contains the protocol version 2 DSA authentication identity of the user. |
Contains the protocol version 2 DSA authentication identity of the user. |
.It Pa $HOME/.ssh/id_rsa |
.It Pa $HOME/.ssh/id_rsa |
Contains the protocol version 2 RSA authentication identity of the user. |
Contains the protocol version 2 RSA authentication identity of the user. |
.El |
.El |
.Pp |
|
Identity files should not be readable by anyone but the user. |
|
Note that |
|
.Nm |
|
ignores identity files if they are accessible by others. |
|
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Ev "DISPLAY" and "SSH_ASKPASS" |
.It Ev "DISPLAY" and "SSH_ASKPASS" |
|
|
may be necessary to redirect the input from |
may be necessary to redirect the input from |
.Pa /dev/null |
.Pa /dev/null |
to make this work.) |
to make this work.) |
.It Ev SSH_AUTH_SOCK |
|
Identifies the path of a unix-domain socket used to communicate with the |
|
agent. |
|
.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 |
OpenSSH is a derivative of the original and free |
ssh 1.2.12 release by Tatu Ylonen. |
ssh 1.2.12 release by Tatu Ylonen. |