Cross Reference: /freebsd-9.3-release/crypto/openssh/ssh-add.0

1SSH-ADD(1) OpenBSD Reference Manual SSH-ADD(1)
2
3NAME
4 ssh-add - adds RSA or DSA identities to the authentication agent
5
6SYNOPSIS
7 ssh-add [-cDdLlXx] [-t life] [file ...]
8 ssh-add -s pkcs11
9 ssh-add -e pkcs11
10
11DESCRIPTION
12 ssh-add adds RSA or DSA identities to the authentication agent,
13 ssh-agent(1). When run without arguments, it adds the files

14 ~/.ssh/id_rsa, ~/.ssh/id_dsa and ~/.ssh/identity. After loading a pri-
15 vate key, ssh-add will try to load corresponding certificate information
16 from the filename obtained by appending -cert.pub to the name of the pri-
17 vate key file. Alternative file names can be given on the command line.

14 ~/.ssh/id_rsa, ~/.ssh/id_dsa and ~/.ssh/identity. After loading a
15 private key, ssh-add will try to load corresponding certificate
16 information from the filename obtained by appending -cert.pub to the name
17 of the private key file. Alternative file names can be given on the
18 command line.

18
19 If any file requires a passphrase, ssh-add asks for the passphrase from
20 the user. The passphrase is read from the user's tty. ssh-add retries
21 the last passphrase if multiple identity files are given.
22

19
20 If any file requires a passphrase, ssh-add asks for the passphrase from
21 the user. The passphrase is read from the user's tty. ssh-add retries
22 the last passphrase if multiple identity files are given.
23

23 The authentication agent must be running and the SSH_AUTH_SOCK environ-
24 ment variable must contain the name of its socket for ssh-add to work.

24 The authentication agent must be running and the SSH_AUTH_SOCK
25 environment variable must contain the name of its socket for ssh-add to
26 work.

25
26 The options are as follows:
27
28 -c Indicates that added identities should be subject to confirmation
29 before being used for authentication. Confirmation is performed

27
28 The options are as follows:
29
30 -c Indicates that added identities should be subject to confirmation
31 before being used for authentication. Confirmation is performed

30 by the SSH_ASKPASS program mentioned below. Successful confirma-
31 tion is signaled by a zero exit status from the SSH_ASKPASS pro-
32 gram, rather than text entered into the requester.

32 by the SSH_ASKPASS program mentioned below. Successful
33 confirmation is signaled by a zero exit status from the
34 SSH_ASKPASS program, rather than text entered into the requester.

33
34 -D Deletes all identities from the agent.
35
36 -d Instead of adding identities, removes identities from the agent.

35
36 -D Deletes all identities from the agent.
37
38 -d Instead of adding identities, removes identities from the agent.

37 If ssh-add has been run without arguments, the keys for the de-
38 fault identities will be removed. Otherwise, the argument list

39 If ssh-add has been run without arguments, the keys for the
40 default identities will be removed. Otherwise, the argument list

39 will be interpreted as a list of paths to public key files and
40 matching keys will be removed from the agent. If no public key
41 is found at a given path, ssh-add will append .pub and retry.
42
43 -e pkcs11
44 Remove keys provided by the PKCS#11 shared library pkcs11.
45

41 will be interpreted as a list of paths to public key files and
42 matching keys will be removed from the agent. If no public key
43 is found at a given path, ssh-add will append .pub and retry.
44
45 -e pkcs11
46 Remove keys provided by the PKCS#11 shared library pkcs11.
47

46 -L Lists public key parameters of all identities currently repre-
47 sented by the agent.

48 -L Lists public key parameters of all identities currently
49 represented by the agent.

48
49 -l Lists fingerprints of all identities currently represented by the
50 agent.
51
52 -s pkcs11
53 Add keys provided by the PKCS#11 shared library pkcs11.
54
55 -t life
56 Set a maximum lifetime when adding identities to an agent. The

50
51 -l Lists fingerprints of all identities currently represented by the
52 agent.
53
54 -s pkcs11
55 Add keys provided by the PKCS#11 shared library pkcs11.
56
57 -t life
58 Set a maximum lifetime when adding identities to an agent. The

57 lifetime may be specified in seconds or in a time format speci-
58 fied in sshd_config(5).

59 lifetime may be specified in seconds or in a time format
60 specified in sshd_config(5).

59
60 -X Unlock the agent.
61
62 -x Lock the agent with a password.
63
64ENVIRONMENT
65 DISPLAY and SSH_ASKPASS
66 If ssh-add needs a passphrase, it will read the passphrase from

--- 30 unchanged lines hidden (view full) ---

97 ssh-add is unable to contact the authentication agent.
98
99SEE ALSO
100 ssh(1), ssh-agent(1), ssh-keygen(1), sshd(8)
101
102AUTHORS
103 OpenSSH is a derivative of the original and free ssh 1.2.12 release by
104 Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo

61
62 -X Unlock the agent.
63
64 -x Lock the agent with a password.
65
66ENVIRONMENT
67 DISPLAY and SSH_ASKPASS
68 If ssh-add needs a passphrase, it will read the passphrase from

--- 30 unchanged lines hidden (view full) ---

99 ssh-add is unable to contact the authentication agent.
100
101SEE ALSO
102 ssh(1), ssh-agent(1), ssh-keygen(1), sshd(8)
103
104AUTHORS
105 OpenSSH is a derivative of the original and free ssh 1.2.12 release by
106 Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo

105 de Raadt and Dug Song removed many bugs, re-added newer features and cre-
106 ated OpenSSH. Markus Friedl contributed the support for SSH protocol

107 de Raadt and Dug Song removed many bugs, re-added newer features and
108 created OpenSSH. Markus Friedl contributed the support for SSH protocol

107 versions 1.5 and 2.0.
108

109 versions 1.5 and 2.0.
110

109OpenBSD 4.7 March 5, 2010 2

111OpenBSD 4.8 March 5, 2010 OpenBSD 4.8