version 1.31, 2002/02/04 20:41:16 |
version 1.31.2.2, 2003/04/03 22:35:17 |
|
|
.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 t Ar life |
.Op Fl d |
.Op Fl d |
.Op Ar command Op Ar args ... |
.Op Ar command Op Ar args ... |
.Nm ssh-agent |
.Nm ssh-agent |
|
|
.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 . |
|
|
Kill the current agent (given by the |
Kill the current agent (given by the |
.Ev SSH_AGENT_PID |
.Ev SSH_AGENT_PID |
environment variable). |
environment variable). |
|
.It Fl t Ar life |
|
Set a default value for the maximum lifetime of identities added to the agent. |
|
The lifetime may be specified in seconds or in a time format specified in |
|
.Xr sshd 8 . |
|
A lifetime specified for an identity with |
|
.Xr ssh-add 1 |
|
overrides this value. |
|
Without this option the default maximum lifetime is forever. |
.It Fl d |
.It Fl d |
Debug mode. When this option is specified |
Debug mode. |
|
When this option is specified |
.Nm |
.Nm |
will not fork. |
will not fork. |
.El |
.El |
|
|
.Xr ssh-add 1 |
.Xr ssh-add 1 |
adds the files |
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 . |
If the identity has a passphrase, |
If the identity has a passphrase, |
|
|
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 PID. |
environment variable holds the agent's process ID. |
.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. |
|
|
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.<pid> |
.It Pa /tmp/ssh-XXXXXXXX/agent.<ppid> |
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. |