| | 1 | .\" $OpenBSD: ssh-add.1,v 1.22 2001/03/02 18:54:31 deraadt Exp $ |
| | 2 | .\" |
| | 3 | .\" -*- nroff -*- |
| | 4 | .\" |
| | 5 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
| | 6 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| | 7 | .\" All rights reserved |
| | 8 | .\" |
| | 9 | .\" As far as I am concerned, the code I have written for this software |
| | 10 | .\" can be used freely for any purpose. Any derived versions of this |
| | 11 | .\" software must be clearly marked as such, and if the derived work is |
| | 12 | .\" incompatible with the protocol description in the RFC file, it must be |
| | 13 | .\" called by a name other than "ssh" or "Secure Shell". |
| | 14 | .\" |
| | 15 | .\" |
| | 16 | .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. |
| | 17 | .\" Copyright (c) 1999 Aaron Campbell. All rights reserved. |
| | 18 | .\" Copyright (c) 1999 Theo de Raadt. All rights reserved. |
| | 19 | .\" |
| | 20 | .\" Redistribution and use in source and binary forms, with or without |
| | 21 | .\" modification, are permitted provided that the following conditions |
| | 22 | .\" are met: |
| | 23 | .\" 1. Redistributions of source code must retain the above copyright |
| | 24 | .\" notice, this list of conditions and the following disclaimer. |
| | 25 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| | 26 | .\" notice, this list of conditions and the following disclaimer in the |
| | 27 | .\" documentation and/or other materials provided with the distribution. |
| | 28 | .\" |
| | 29 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| | 30 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| | 31 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| | 32 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| | 33 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| | 34 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| | 35 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| | 36 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| | 37 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| | 38 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| | 39 | .\" |
| | 40 | .Dd September 25, 1999 |
| | 41 | .Dt SSH-ADD 1 |
| | 42 | .Os |
| | 43 | .Sh NAME |
| | 44 | .Nm ssh-add |
| | 45 | .Nd adds RSA or DSA identities for the authentication agent |
| | 46 | .Sh SYNOPSIS |
| | 47 | .Nm ssh-add |
| | 48 | .Op Fl lLdD |
| | 49 | .Op Ar |
| | 50 | .Sh DESCRIPTION |
| | 51 | .Nm |
| | 52 | adds RSA or DSA identities to the authentication agent, |
| | 53 | .Xr ssh-agent 1 . |
| | 54 | When run without arguments, it adds the file |
| | 55 | .Pa $HOME/.ssh/identity . |
| | 56 | Alternative file names can be given on the command line. |
| | 57 | If any file requires a passphrase, |
| | 58 | .Nm |
| | 59 | asks for the passphrase from the user. |
| | 60 | The Passphrase it is read from the user's tty. |
| | 61 | .Pp |
| | 62 | The authentication agent must be running and must be an ancestor of |
| | 63 | the current process for |
| | 64 | .Nm |
| | 65 | to work. |
| | 66 | .Pp |
| | 67 | The options are as follows: |
| | 68 | .Bl -tag -width Ds |
| | 69 | .It Fl l |
| | 70 | Lists fingerprints of all identities currently represented by the agent. |
| | 71 | .It Fl L |
| | 72 | Lists public key parameters of all identities currently represented by the agent. |
| | 73 | .It Fl d |
| | 74 | Instead of adding the identity, removes the identity from the agent. |
| | 75 | .It Fl D |
| | 76 | Deletes all identities from the agent. |
| | 77 | .El |
| | 78 | .Sh FILES |
| | 79 | .Bl -tag -width Ds |
| | 80 | .It Pa $HOME/.ssh/identity |
| | 81 | Contains the RSA authentication identity of the user. |
| | 82 | This file should not be readable by anyone but the user. |
| | 83 | Note that |
| | 84 | .Nm |
| | 85 | ignores this file if it is accessible by others. |
| | 86 | It is possible to |
| | 87 | specify a passphrase when generating the key; that passphrase will be |
| | 88 | used to encrypt the private part of this file. |
| | 89 | This is the default file added by |
| | 90 | .Nm |
| | 91 | when no other files have been specified. |
| | 92 | .It Pa $HOME/.ssh/id_dsa |
| | 93 | Contains the DSA authentication identity of the user. |
| | 94 | .El |
| | 95 | .Sh ENVIRONMENT |
| | 96 | .Bl -tag -width Ds |
| | 97 | .It Ev "DISPLAY" and "SSH_ASKPASS" |
| | 98 | If |
| | 99 | .Nm |
| | 100 | needs a passphrase, it will read the passphrase from the current |
| | 101 | terminal if it was run from a terminal. |
| | 102 | If |
| | 103 | .Nm |
| | 104 | does not have a terminal associated with it but |
| | 105 | .Ev DISPLAY |
| | 106 | and |
| | 107 | .Ev SSH_ASKPASS |
| | 108 | are set, it will execute the program specified by |
| | 109 | .Ev SSH_ASKPASS |
| | 110 | and open an X11 window to read the passphrase. |
| | 111 | This is particularly useful when calling |
| | 112 | .Nm |
| | 113 | from a |
| | 114 | .Pa .Xsession |
| | 115 | or related script. |
| | 116 | (Note that on some machines it |
| | 117 | may be necessary to redirect the input from |
| | 118 | .Pa /dev/null |
| | 119 | to make this work.) |
| | 120 | .El |
| | 121 | .Sh AUTHORS |
| | 122 | OpenSSH is a derivative of the original and free |
| | 123 | ssh 1.2.12 release by Tatu Ylonen. |
| | 124 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, |
| | 125 | Theo de Raadt and Dug Song |
| | 126 | removed many bugs, re-added newer features and |
| | 127 | created OpenSSH. |
| | 128 | Markus Friedl contributed the support for SSH |
| | 129 | protocol versions 1.5 and 2.0. |
| | 130 | .Sh SEE ALSO |
| | 131 | .Xr ssh 1 , |
| | 132 | .Xr ssh-agent 1 , |
| | 133 | .Xr ssh-keygen 1 , |
| | 134 | .Xr sshd 8 |
andersk / openssh.git / blame_incremental