version 1.28.2.3, 2002/06/26 18:22:36 |
version 1.29, 2001/11/19 18:40:46 |
|
|
.Nd authentication agent |
.Nd authentication agent |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm ssh-agent |
.Nm ssh-agent |
.Op Fl a Ar bind_address |
|
.Op Fl c Li | Fl s |
.Op Fl c Li | Fl s |
.Op Fl d |
.Op Fl d |
.Op Ar command Op Ar args ... |
.Op Ar command Op Ar args ... |
|
|
.Pp |
.Pp |
The options are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl a Ar bind_address |
|
Bind the agent to the unix-domain socket |
|
.Ar bind_address . |
|
The default is |
|
.Pa /tmp/ssh-XXXXXXXX/agent.<ppid> . |
|
.It Fl c |
.It Fl c |
Generate C-shell commands on |
Generate C-shell commands on |
.Dv stdout . |
.Dv stdout . |
|
|
.Xr ssh-add 1 . |
.Xr ssh-add 1 . |
When executed without arguments, |
When executed without arguments, |
.Xr ssh-add 1 |
.Xr ssh-add 1 |
adds the files |
adds the |
.Pa $HOME/.ssh/id_rsa , |
.Pa $HOME/.ssh/identity |
.Pa $HOME/.ssh/id_dsa |
file. |
and |
|
.Pa $HOME/.ssh/identity . |
|
If the identity has a passphrase, |
If the identity has a passphrase, |
.Xr ssh-add 1 |
.Xr ssh-add 1 |
asks for the passphrase (using a small X11 application if running |
asks for the passphrase (using a small X11 application if running |
|
|
This way, private keys are not exposed to clients using the agent. |
This way, private keys are not exposed to clients using the agent. |
.Pp |
.Pp |
A unix-domain socket is created |
A unix-domain socket is created |
|
.Pq Pa /tmp/ssh-XXXXXXXX/agent.<pid> , |
and the name of this socket is stored in the |
and the name of this socket is stored in the |
.Ev SSH_AUTH_SOCK |
.Ev SSH_AUTH_SOCK |
environment |
environment |
|
|
.Pp |
.Pp |
The |
The |
.Ev SSH_AGENT_PID |
.Ev SSH_AGENT_PID |
environment variable holds the agent's process ID. |
environment variable holds the agent's PID. |
.Pp |
.Pp |
The agent exits automatically when the command given on the command |
The agent exits automatically when the command given on the command |
line terminates. |
line terminates. |
|
|
.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. |
|
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 file is not used by |
|
.Nm |
|
but is normally added to the agent using |
|
.Xr ssh-add 1 |
|
at login time. |
.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. |
.It Pa /tmp/ssh-XXXXXXXX/agent.<ppid> |
.It Pa /tmp/ssh-XXXXXXXX/agent.<pid> |
Unix-domain sockets used to contain the connection to the |
Unix-domain sockets used to contain the connection to the |
authentication agent. |
authentication agent. |
These sockets should only be readable by the owner. |
These sockets should only be readable by the owner. |