diff options
Diffstat (limited to 'other/openssh-2.1.1p4/ssh-agent.0')
| -rw-r--r-- | other/openssh-2.1.1p4/ssh-agent.0 | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/other/openssh-2.1.1p4/ssh-agent.0 b/other/openssh-2.1.1p4/ssh-agent.0 new file mode 100644 index 0000000..d87c6ec --- /dev/null +++ b/other/openssh-2.1.1p4/ssh-agent.0 | |||
| @@ -0,0 +1,104 @@ | |||
| 1 | |||
| 2 | SSH-AGENT(1) System Reference Manual SSH-AGENT(1) | ||
| 3 | |||
| 4 | NAME | ||
| 5 | ssh-agent - authentication agent | ||
| 6 | |||
| 7 | SYNOPSIS | ||
| 8 | ssh-agent [-c | -s] [-k] [command [args ...]] | ||
| 9 | |||
| 10 | DESCRIPTION | ||
| 11 | ssh-agent is a program to hold private keys used for RSA authentication. | ||
| 12 | The idea is that ssh-agent is started in the beginning of an X-session or | ||
| 13 | a login session, and all other windows or programs are started as clients | ||
| 14 | to the ssh-agent program. Through use of environment variables the agent | ||
| 15 | can be located and automatically used for RSA authentication when logging | ||
| 16 | in to other machines using ssh(1). | ||
| 17 | |||
| 18 | The options are as follows: | ||
| 19 | |||
| 20 | -c Generate C-shell commands on stdout. This is the default if SHELL | ||
| 21 | looks like it's a csh style of shell. | ||
| 22 | |||
| 23 | -s Generate Bourne shell commands on stdout. This is the default if | ||
| 24 | SHELL does not look like it's a csh style of shell. | ||
| 25 | |||
| 26 | -k Kill the current agent (given by the SSH_AGENT_PID environment | ||
| 27 | variable). | ||
| 28 | |||
| 29 | If a commandline is given, this is executed as a subprocess of the agent. | ||
| 30 | When the command dies, so does the agent. | ||
| 31 | |||
| 32 | The agent initially does not have any private keys. Keys are added using | ||
| 33 | ssh-add(1). When executed without arguments, ssh-add(1) adds the | ||
| 34 | $HOME/.ssh/identity file. If the identity has a passphrase, ssh-add(1) | ||
| 35 | asks for the passphrase (using a small X11 application if running under | ||
| 36 | X11, or from the terminal if running without X). It then sends the iden- | ||
| 37 | tity to the agent. Several identities can be stored in the agent; the | ||
| 38 | agent can automatically use any of these identities. ssh-add -l displays | ||
| 39 | the identities currently held by the agent. | ||
| 40 | |||
| 41 | The idea is that the agent is run in the user's local PC, laptop, or ter- | ||
| 42 | minal. Authentication data need not be stored on any other machine, and | ||
| 43 | authentication passphrases never go over the network. However, the con- | ||
| 44 | nection to the agent is forwarded over SSH remote logins, and the user | ||
| 45 | can thus use the privileges given by the identities anywhere in the net- | ||
| 46 | work in a secure way. | ||
| 47 | |||
| 48 | There are two main ways to get an agent setup: Either you let the agent | ||
| 49 | start a new subcommand into which some environment variables are export- | ||
| 50 | ed, or you let the agent print the needed shell commands (either sh(1) or | ||
| 51 | csh(1) syntax can be generated) which can be evalled in the calling | ||
| 52 | shell. Later ssh(1) look at these variables and use them to establish a | ||
| 53 | connection to the agent. | ||
| 54 | |||
| 55 | A unix-domain socket is created (/tmp/ssh-XXXXXXXX/agent.<pid>), and the | ||
| 56 | name of this socket is stored in the SSH_AUTH_SOCK environment variable. | ||
| 57 | The socket is made accessible only to the current user. This method is | ||
| 58 | easily abused by root or another instance of the same user. | ||
| 59 | |||
| 60 | The SSH_AGENT_PID environment variable holds the agent's PID. | ||
| 61 | |||
| 62 | The agent exits automatically when the command given on the command line | ||
| 63 | terminates. | ||
| 64 | |||
| 65 | FILES | ||
| 66 | |||
| 67 | |||
| 68 | $HOME/.ssh/identity | ||
| 69 | Contains the RSA authentication identity of the user. This file | ||
| 70 | should not be readable by anyone but the user. It is possible to | ||
| 71 | specify a passphrase when generating the key; that passphrase | ||
| 72 | will be used to encrypt the private part of this file. This file | ||
| 73 | is not used by ssh-agent but is normally added to the agent using | ||
| 74 | ssh-add(1) at login time. | ||
| 75 | |||
| 76 | /tmp/ssh-XXXX/agent.<pid>, | ||
| 77 | Unix-domain sockets used to contain the connection to the authen- | ||
| 78 | tication agent. These sockets should only be readable by the | ||
| 79 | owner. The sockets should get automatically removed when the | ||
| 80 | agent exits. | ||
| 81 | |||
| 82 | AUTHOR | ||
| 83 | Tatu Ylonen <ylo@cs.hut.fi> | ||
| 84 | |||
| 85 | OpenSSH is a derivative of the original (free) ssh 1.2.12 release, but | ||
| 86 | with bugs removed and newer features re-added. Rapidly after the 1.2.12 | ||
| 87 | release, newer versions bore successively more restrictive licenses. | ||
| 88 | This version of OpenSSH | ||
| 89 | |||
| 90 | o has all components of a restrictive nature (i.e., patents) directly | ||
| 91 | removed from the source code; any licensed or patented components are | ||
| 92 | chosen from external libraries. | ||
| 93 | |||
| 94 | o has been updated to support ssh protocol 1.5. | ||
| 95 | |||
| 96 | o contains added support for kerberos(8) authentication and ticket | ||
| 97 | passing. | ||
| 98 | |||
| 99 | o supports one-time password authentication with skey(1). | ||
| 100 | |||
| 101 | SEE ALSO | ||
| 102 | ssh(1), ssh-add(1), ssh-keygen(1), sshd(8), | ||
| 103 | |||
| 104 | BSD Experimental September 25, 1999 2 | ||
