doc/conch/man/conch.1

   1 .Dd May 22, 2004
   2 .Dt CONCH 1
   3 .Os
   4 .Sh NAME
   5 .Nm conch
   6 .Nd Conch SSH client
   7 .Sh SYNOPSIS
   8 .Nm conch
   9 .Op Fl AaCfINnrsTtVvx
  10 .Op Fl c Ar cipher_spec
  11 .Op Fl e Ar escape_char
  12 .Op Fl i Ar identity_file
  13 .Op Fl K Ar connection_spec
  14 .Bk -words
  15 .Oo Fl L Xo
  16 .Sm off
  17 .Ar port :
  18 .Ar host :
  19 .Ar hostport
  20 .Sm on
  21 .Xc
  22 .Oc
  23 .Ek
  24 .Op Fl l Ar user
  25 .Op Fl m Ar mac_spec
  26 .Op Fl o Ar openssh_option
  27 .Op Fl p Ar port
  28 .Bk -words
  29 .Oo Fl R Xo
  30 .Sm off
  31 .Ar port :
  32 .Ar host :
  33 .Ar hostport
  34 .Sm on
  35 .Xc
  36 .Oc
  37 .Ek
  38 .Oo Ar user Ns @ Ns Oc Ar hostname
  39 .Op Ar command
  40 .Sh DESCRIPTION
  41 .Nm
  42 is a SSHv2 client for logging into a remote machine and executing commands.  It provides encrypted and secure communications across a possibly insecure network.  Arbitrary TCP/IP ports can also be forwarded over the secure connection.
  43 .Pp
  44 .Nm
  45 connects and logs into
  46 .Ar hostname
  47 (as
  48 .Ar user
  49 or the current username).  The user must prove her/his identity through a public\-key or a password.  Alternatively, if a connection is already open to a server, a new shell can be opened over the connection without having to reauthenticate.
  50 .Pp
  51 If
  52 .Ar command
  53 is specified,
  54 .Ar command
  55 is executed instead of a shell.  If the
  56 .Fl s
  57 option is given,
  58 .Ar command
  59 is treated as an SSHv2 subsystem name.
  60 .Ss Authentication
  61 Conch supports the public-key, keyboard-interactive, and password authentications.
  62 .Pp
  63 The public-key method allows the RSA or DSA algorithm to be used.  The client uses his/her private key,
  64 .Pa $HOME/.ssh/id_rsa
  65 or
  66 .Pa $HOME/.ssh/id_dsa
  67 to sign the session identifier, known only by the client and server.  The server checks that the matching public key is valid for the user, and that the signature is correct.
  68 .Pp
  69 If public-key authentication fails,
  70 .Nm
  71 can authenticate by sending an encrypted password over the connection.
  72 .Ss Connection sharing
  73 .Nm
  74 has the ability to multiplex multiple shells, commands and TCP/IP ports over the same secure connection.  To disable multiplexing for a connection, use the
  75 .Fl I
  76 flag.
  77 .Pp
  78 The
  79 .Fl K
  80 option determines how the client connects to the remote host.  It is a comma-separated list of the methods to use, in order of preference.  The two connection methods are
  81 .Ql unix
  82 (for connecting over a multiplexed connection) and
  83 .Ql direct
  84 (to connect directly).
  85 To disable connecting over a multiplexed connection, do not include
  86 .Ql unix
  87 in the preference list.
  88 .Pp
  89 As an example of how connection sharing works, to speed up CVS over SSH:
  90 .Pp
  91 .Nm
  92 --noshell --fork -l cvs_user cvs_host
  93 .br
  94 set CVS_RSH=\fBconch\fR
  95 .Pp
  96 Now, when CVS connects to cvs_host as cvs_user, instead of making a new connection to the server,
  97 .Nm
  98 will add a new channel to the existing connection.  This saves the cost of repeatedly negotiating the cryptography and authentication.
  99 .Pp
 100 The options are as follows:
 101 .Bl -tag -width Ds
 102 .It Fl A
 103 Enables authentication agent forwarding.
 104 .It Fl a
 105 Disables authentication agent forwarding (default).
 106 .It Fl C
 107 Enable compression.
 108 .It Fl c Ar cipher_spec
 109 Selects encryption algorithms to be used for this connection, as a comma-separated list of ciphers in order of preference.  The list that
 110 .Nm
 111 supports is (in order of default preference): aes256-ctr, aes256-cbc, aes192-ctr, aes192-cbc, aes128-ctr, aes128-cbc, cast128-ctr, cast128-cbc, blowfish-ctr, blowfish, idea-ctr, idea-cbc, 3des-ctr, 3des-cbc.
 112 .It Fl e Ar ch | ^ch | none
 113 Sets the escape character for sessions with a PTY (default:
 114 .Ql ~ ) .
 115 The escape character is only recognized at the beginning of a line (after a newline).
 116 The escape character followed by a dot
 117 .Pq Ql \&.
 118 closes the connection;
 119 followed by ^Z suspends the connection;
 120 and followed by the escape character sends the escape character once.
 121 Setting the character to
 122 .Dq none
 123 disables any escapes.
 124 .It Fl f
 125 Fork to background after authentication.
 126 .It Fl I
 127 Do not allow connection sharing over this connection.
 128 .It Fl i Ar identity_spec
 129 The file from which the identity (private key) for RSA or DSA authentication is read.
 130 The defaults are
 131 .Pa $HOME/.ssh/id_rsa
 132 and
 133 .Pa $HOME/.ssh/id_dsa .
 134 It is possible to use this option more than once to use more than one private key.
 135 .It Fl K Ar connection_spec
 136 Selects methods for connection to the server, as a comma-separated list of methods in order of preference.  See
 137 .Cm Connection sharing
 138 for more information.
 139 .It Fl L Xo
 140 .Sm off
 141 .Ar port : host : hostport
 142 .Sm on
 143 .Xc
 144 Specifies that the given port on the client host is to be forwarded to the given host and port on the remote side.  This allocates a socket to listen to
 145 .Ar port
 146 on the local side, and when connections are made to that socket, they are forwarded over the secure channel and a connection is made to
 147 .Ar host
 148 port
 149 .Ar hostport
 150 from the remote machine.
 151 Only root can forward privieged ports.
 152 .It Fl l Ar user
 153 Log in using this username.
 154 .It Fl m Ar mac_spec
 155 Selects MAC (message authentication code) algorithms, as a comma-separated list in order of preference.  The list that
 156 .Nm
 157 supports is (in order of preference): hmac-sha1, hmac-md5.
 158 .It Fl N
 159 Do not execute a shell or command.
 160 .It Fl n
 161 Redirect input from /dev/null.
 162 .It Fl o Ar openssh_option
 163 Ignored OpenSSH options.
 164 .It Fl p Ar port
 165 The port to connect to on the server.
 166 .It Fl R Xo
 167 .Sm off
 168 .Ar port : host : hostport
 169 .Sm on
 170 .Xc
 171 Specifies that the given port on the remote host is to be forwarded to the given host and port on the local side.  This allocates a socket to listen to
 172 .Ar port
 173 on the remote side, and when connections are made to that socket, they are forwarded over the secure channel and a connection is made to
 174 .Ar host
 175 port
 176 .Ar hostport
 177 from the client host.
 178 Only root can forward privieged ports.
 179 .It Fl s
 180 Reconnect to the server if the connection is lost.
 181 .It Fl s
 182 Invoke
 183 .Ar command
 184 (mandatory) as a SSHv2 subsystem.
 185 .It Fl T
 186 Do not allocate a TTY.
 187 .It Fl t
 188 Allocate a TTY even if command is given.
 189 .It Fl V
 190 Display version number only.
 191 .It Fl v
 192 Log to stderr.
 193 .It Fl x
 194 Disable X11 connection forwarding (default).
 195 .El
 196 .Sh AUTHOR
 197 Written by Paul Swartz <z3p@twistedmatrix.com>.
 198 .Sh "REPORTING BUGS"
 199 To report a bug, visit \fIhttp://twistedmatrix.com/bugs/\fR
 200 .Sh COPYRIGHT
 201 Copyright \(co 2002-2008 Twisted Matrix Laboratories.
 202 .br
 203 This is free software; see the source for copying conditions.  There is NO
 204 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 205 .Sh SEE ALSO
 206 ssh(1)