diff options
Diffstat (limited to 'ssh-agent.0')
-rw-r--r-- | ssh-agent.0 | 53 |
1 files changed, 14 insertions, 39 deletions
diff --git a/ssh-agent.0 b/ssh-agent.0 index c11523db3..cac40e048 100644 --- a/ssh-agent.0 +++ b/ssh-agent.0 | |||
@@ -1,4 +1,4 @@ | |||
1 | SSH-AGENT(1) OpenBSD Reference Manual SSH-AGENT(1) | 1 | SSH-AGENT(1) General Commands Manual SSH-AGENT(1) |
2 | 2 | ||
3 | NAME | 3 | NAME |
4 | ssh-agent - authentication agent | 4 | ssh-agent - authentication agent |
@@ -9,12 +9,18 @@ SYNOPSIS | |||
9 | 9 | ||
10 | DESCRIPTION | 10 | DESCRIPTION |
11 | ssh-agent is a program to hold private keys used for public key | 11 | ssh-agent is a program to hold private keys used for public key |
12 | authentication (RSA, DSA, ECDSA, ED25519). The idea is that ssh-agent is | 12 | authentication (RSA, DSA, ECDSA, ED25519). ssh-agent is usually started |
13 | started in the beginning of an X-session or a login session, and all | 13 | in the beginning of an X-session or a login session, and all other |
14 | other windows or programs are started as clients to the ssh-agent | 14 | windows or programs are started as clients to the ssh-agent program. |
15 | program. Through use of environment variables the agent can be located | 15 | Through use of environment variables the agent can be located and |
16 | and automatically used for authentication when logging in to other | 16 | automatically used for authentication when logging in to other machines |
17 | machines using ssh(1). | 17 | using ssh(1). |
18 | |||
19 | The agent initially does not have any private keys. Keys are added using | ||
20 | ssh-add(1). Multiple identities may be stored in ssh-agent concurrently | ||
21 | and ssh(1) will automatically use them if present. ssh-add(1) is also | ||
22 | used to remove keys from ssh-agent and to query the keys that are held in | ||
23 | one. | ||
18 | 24 | ||
19 | The options are as follows: | 25 | The options are as follows: |
20 | 26 | ||
@@ -44,17 +50,6 @@ DESCRIPTION | |||
44 | If a commandline is given, this is executed as a subprocess of the agent. | 50 | If a commandline is given, this is executed as a subprocess of the agent. |
45 | When the command dies, so does the agent. | 51 | When the command dies, so does the agent. |
46 | 52 | ||
47 | The agent initially does not have any private keys. Keys are added using | ||
48 | ssh-add(1). When executed without arguments, ssh-add(1) adds the files | ||
49 | ~/.ssh/id_rsa, ~/.ssh/id_dsa, ~/.ssh/id_ecdsa, ~/.ssh/id_ed25519 and | ||
50 | ~/.ssh/identity. If the identity has a passphrase, ssh-add(1) asks for | ||
51 | the passphrase on the terminal if it has one or from a small X11 program | ||
52 | if running under X11. If neither of these is the case then the | ||
53 | authentication will fail. It then sends the identity to the agent. | ||
54 | Several identities can be stored in the agent; the agent can | ||
55 | automatically use any of these identities. ssh-add -l displays the | ||
56 | identities currently held by the agent. | ||
57 | |||
58 | The idea is that the agent is run in the user's local PC, laptop, or | 53 | The idea is that the agent is run in the user's local PC, laptop, or |
59 | terminal. Authentication data need not be stored on any other machine, | 54 | terminal. Authentication data need not be stored on any other machine, |
60 | and authentication passphrases never go over the network. However, the | 55 | and authentication passphrases never go over the network. However, the |
@@ -89,26 +84,6 @@ DESCRIPTION | |||
89 | terminates. | 84 | terminates. |
90 | 85 | ||
91 | FILES | 86 | FILES |
92 | ~/.ssh/identity | ||
93 | Contains the protocol version 1 RSA authentication identity of | ||
94 | the user. | ||
95 | |||
96 | ~/.ssh/id_dsa | ||
97 | Contains the protocol version 2 DSA authentication identity of | ||
98 | the user. | ||
99 | |||
100 | ~/.ssh/id_ecdsa | ||
101 | Contains the protocol version 2 ECDSA authentication identity of | ||
102 | the user. | ||
103 | |||
104 | ~/.ssh/id_ed25519 | ||
105 | Contains the protocol version 2 ED25519 authentication identity | ||
106 | of the user. | ||
107 | |||
108 | ~/.ssh/id_rsa | ||
109 | Contains the protocol version 2 RSA authentication identity of | ||
110 | the user. | ||
111 | |||
112 | $TMPDIR/ssh-XXXXXXXXXX/agent.<ppid> | 87 | $TMPDIR/ssh-XXXXXXXXXX/agent.<ppid> |
113 | UNIX-domain sockets used to contain the connection to the | 88 | UNIX-domain sockets used to contain the connection to the |
114 | authentication agent. These sockets should only be readable by | 89 | authentication agent. These sockets should only be readable by |
@@ -125,4 +100,4 @@ AUTHORS | |||
125 | created OpenSSH. Markus Friedl contributed the support for SSH protocol | 100 | created OpenSSH. Markus Friedl contributed the support for SSH protocol |
126 | versions 1.5 and 2.0. | 101 | versions 1.5 and 2.0. |
127 | 102 | ||
128 | OpenBSD 5.5 December 7, 2013 OpenBSD 5.5 | 103 | OpenBSD 5.6 April 16, 2014 OpenBSD 5.6 |