openssh/ssh-add.1

   1 .\"     $OpenBSD: ssh-add.1,v 1.27 2001/08/23 18:08:59 stevesk 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 to the authentication agent
  46 .Sh SYNOPSIS
  47 .Nm ssh-add
  48 .Op Fl lLdD
  49 .Op Ar
  50 .Nm ssh-add
  51 .Fl s Ar reader
  52 .Nm ssh-add
  53 .Fl e Ar reader
  54 .Sh DESCRIPTION
  55 .Nm
  56 adds RSA or DSA identities to the authentication agent,
  57 .Xr ssh-agent 1 .
  58 When run without arguments, it adds the file
  59 .Pa $HOME/.ssh/identity .
  60 Alternative file names can be given on the command line.
  61 If any file requires a passphrase,
  62 .Nm
  63 asks for the passphrase from the user.
  64 The passphrase is read from the user's tty.
  65 .Nm
  66 retries the last passphrase if multiple identity files are given.
  67 .Pp
  68 The authentication agent must be running and must be an ancestor of
  69 the current process for
  70 .Nm
  71 to work.
  72 .Pp
  73 The options are as follows:
  74 .Bl -tag -width Ds
  75 .It Fl l
  76 Lists fingerprints of all identities currently represented by the agent.
  77 .It Fl L
  78 Lists public key parameters of all identities currently represented by the agent.
  79 .It Fl d
  80 Instead of adding the identity, removes the identity from the agent.
  81 .It Fl D
  82 Deletes all identities from the agent.
  83 .It Fl s Ar reader
  84 Add key in smartcard
  85 .Ar reader .
  86 .It Fl e Ar reader
  87 Remove key in smartcard
  88 .Ar reader .
  89 .El
  90 .Sh FILES
  91 .Bl -tag -width Ds
  92 .It Pa $HOME/.ssh/identity
  93 Contains the protocol version 1 RSA authentication identity of the user.
  94 This file should not be readable by anyone but the user.
  95 Note that
  96 .Nm
  97 ignores this file if it is accessible by others.
  98 It is possible to
  99 specify a passphrase when generating the key; that passphrase will be
 100 used to encrypt the private part of this file.
 101 This is the default file added by
 102 .Nm
 103 when no other files have been specified.
 104 .It Pa $HOME/.ssh/id_dsa
 105 Contains the protocol version 2 DSA authentication identity of the user.
 106 .It Pa $HOME/.ssh/id_rsa
 107 Contains the protocol version 2 RSA authentication identity of the user.
 108 .El
 109 .Sh ENVIRONMENT
 110 .Bl -tag -width Ds
 111 .It Ev "DISPLAY" and "SSH_ASKPASS"
 112 If
 113 .Nm
 114 needs a passphrase, it will read the passphrase from the current
 115 terminal if it was run from a terminal.
 116 If
 117 .Nm
 118 does not have a terminal associated with it but
 119 .Ev DISPLAY
 120 and
 121 .Ev SSH_ASKPASS
 122 are set, it will execute the program specified by
 123 .Ev SSH_ASKPASS
 124 and open an X11 window to read the passphrase.
 125 This is particularly useful when calling
 126 .Nm
 127 from a
 128 .Pa .Xsession
 129 or related script.
 130 (Note that on some machines it
 131 may be necessary to redirect the input from
 132 .Pa /dev/null
 133 to make this work.)
 134 .El
 135 .Sh AUTHORS
 136 OpenSSH is a derivative of the original and free
 137 ssh 1.2.12 release by Tatu Ylonen.
 138 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
 139 Theo de Raadt and Dug Song
 140 removed many bugs, re-added newer features and
 141 created OpenSSH.
 142 Markus Friedl contributed the support for SSH
 143 protocol versions 1.5 and 2.0.
 144 .Sh SEE ALSO
 145 .Xr ssh 1 ,
 146 .Xr ssh-agent 1 ,
 147 .Xr ssh-keygen 1 ,
 148 .Xr sshd 8