PuTTY commandline tools ======================= The Manual Site: http://www.chiark.greenend.org.uk/~sgtatham/putty/docs.html please have a look on this. PuTTY is a free implementation of Telnet and SSH for Win32 and Unix platforms, along with an xterm terminal emulator. It is written and maintained primarily by Simon Tatham. The PuTTY executables and source code are distributed under the MIT licence Please have a look on this http://www.chiark.greenend.org.uk/~sgtatham/putty/licence.html Internal Version 0.65 ------------------------------------------------------------------------------ plink(1) PuTTY tool suite plink(1) NAME plink - PuTTY link, command line network connection tool SYNOPSIS plink [options] [user@]host [command] DESCRIPTION plink is a network connection tool supporting several protocols. OPTIONS The command-line options supported by plink are: -V Show version information and exit. -pgpfp Display the fingerprints of the PuTTY PGP Master Keys and exit, to aid in verifying new files released by the PuTTY team. -v Show verbose messages. -load session Load settings from saved session. -ssh Force use of SSH protocol (default). -telnet Force use of Telnet protocol. -rlogin Force use of rlogin protocol. -raw Force raw mode. -serial Force serial mode. -P port Connect to port port. -l user Set remote username to user. -m path Read remote command(s) from local file path. -batch Disable interactive prompts. -pw password Set remote password to password. CAUTION: this will likely make the password visible to other users of the local machine (via commands such as `w'). -L [srcaddr:]srcport:desthost:destport Set up a local port forwarding: listen on srcport (or srcaddr:srcport if specified), and forward any connections over the SSH connection to the destination address desthost:destport. Only works in SSH. -R [srcaddr:]srcport:desthost:destport Set up a remote port forwarding: ask the SSH server to listen on srcport (or srcaddr:srcport if specified), and to forward any connections back over the SSH connection where the client will pass them on to the destination address desthost:destport. Only works in SSH. -D [srcaddr:]srcport Set up dynamic port forwarding. The client listens on srcport (or srcaddr:srcport if specified), and implements a SOCKS server. So you can point SOCKS-aware applications at this port and they will automatically use the SSH connection to tunnel all their connections. Only works in SSH. -X Enable X11 forwarding. -x Disable X11 forwarding (default). -A Enable agent forwarding. -a Disable agent forwarding (default). -t Enable pty allocation (default if a command is NOT specified). -T Disable pty allocation (default if a command is specified). -1 Force use of SSH protocol version 1. -2 Force use of SSH protocol version 2. -C Enable SSH compression. -i path Private key file for authentication. -s Remote command is SSH subsystem (SSH-2 only). -N Don't start a remote command or shell at all (SSH-2 only). -sercfg configuration-string Specify the configuration parameters for the serial port, in -serial mode. configuration-string should be a comma-separated list of configuration parameters as follows: . Any single digit from 5 to 9 sets the number of data bits. . `1', `1.5' or `2' sets the number of stop bits. . Any other numeric string is interpreted as a baud rate. . A single lower-case letter specifies the parity: `n' for none, `o' for odd, `e' for even, `m' for mark and `s' for space. . A single upper-case letter specifies the flow control: `N' for none, `X' for XON/XOFF, `R' for RTS/CTS and `D' for DSR/DTR. MORE INFORMATION For more information on plink, it's probably best to go and look at the manual on the PuTTY web page: http://www.chiark.greenend.org.uk/~sgtatham/putty/ BUGS This man page isn't terribly complete. See the above web link for bet- ter documentation. ------------------------------------------------------------------------------ pscp(1) PuTTY tool suite pscp(1) NAME pscp - command-line SCP (secure copy) / SFTP client SYNOPSIS pscp [options] [user@]host:source target pscp [options] source [source...] [user@]host:target pscp [options] -ls [user@]host:filespec DESCRIPTION pscp is a command-line client for the SSH-based SCP (secure copy) and SFTP (secure file transfer protocol) protocols. OPTIONS The command-line options supported by pscp are: -V Show version information and exit. -pgpfp Display the fingerprints of the PuTTY PGP Master Keys and exit, to aid in verifying new files released by the PuTTY team. -ls Remote directory listing. -p Preserve file attributes. -q Quiet, don't show statistics. -r Copy directories recursively. -unsafe Allow server-side wildcards (DANGEROUS). -v Show verbose messages. -load session Load settings from saved session. -P port Connect to port port. -l user Set remote username to user. -batch Disable interactive prompts. -pw password Set remote password to password. CAUTION: this will likely make the password visible to other users of the local machine (via commands such as `w'). -1 Force use of SSH protocol version 1. -2 Force use of SSH protocol version 2. -C Enable SSH compression. -i path Private key file for authentication. -scp Force use of SCP protocol. -sftp Force use of SFTP protocol. MORE INFORMATION For more information on pscp it's probably best to go and look at the manual on the PuTTY web page: http://www.chiark.greenend.org.uk/~sgtatham/putty/ BUGS This man page isn't terribly complete. See the above web link for bet- ter documentation. ------------------------------------------------------------------------------ psftp(1) PuTTY tool suite psftp(1) NAME psftp - interactive SFTP (secure file transfer protocol) client SYNOPSIS psftp [options] [user@]host DESCRIPTION psftp is an interactive text-based client for the SSH-based SFTP (secure file transfer) protocol. OPTIONS The command-line options supported by psftp are: -V Show version information and exit. -pgpfp Display the fingerprints of the PuTTY PGP Master Keys and exit, to aid in verifying new files released by the PuTTY team. -b batchfile Use specified batchfile. -bc Output batchfile commands. -be Don't stop batchfile processing on errors. -v Show verbose messages. -load session Load settings from saved session. -P port Connect to port port. -l user Set remote username to user. -batch Disable interactive prompts. -pw password Set remote password to password. CAUTION: this will likely make the password visible to other users of the local machine (via commands such as `w'). -1 Force use of SSH protocol version 1. -2 Force use of SSH protocol version 2. -C Enable SSH compression. -i path Private key file for authentication. COMMANDS For a list of commands available inside psftp, type help at the psftp> prompt. MORE INFORMATION For more information on psftp it's probably best to go and look at the manual on the PuTTY web page: http://www.chiark.greenend.org.uk/~sgtatham/putty/ BUGS This man page isn't terribly complete. See the above web link for bet- ter documentation. ------------------------------------------------------------------------------ puttygen(1) PuTTY tool suite puttygen(1) NAME puttygen - public-key generator for the PuTTY tools SYNOPSIS puttygen ( keyfile | -t keytype [ -b bits ] ) [ -C new-comment ] [ -P ] [ -q ] [ -O output-type | -l | -L | -p ] [ -o output-file ] DESCRIPTION puttygen is a tool to generate and manipulate SSH public and private key pairs. It is part of the PuTTY suite, although it can also interop- erate with the private key formats used by some other SSH clients. When you run puttygen, it does three things. Firstly, it either loads an existing key file (if you specified keyfile), or generates a new key (if you specified keytype). Then, it optionally makes modifications to the key (changing the comment and/or the passphrase); finally, it out- puts the key, or some information about the key, to a file. All three of these phases are controlled by the options described in the following section. OPTIONS In the first phase, puttygen either loads or generates a key. Note that generating a key requires random data (from /dev/random), which can cause puttygen to pause, possibly for some time if your system does not have much randomness available. The options to control this phase are: keyfile Specify a private key file to be loaded. This private key file can be in the (de facto standard) SSH-1 key format, or in PuTTY's SSH-2 key format, or in either of the SSH-2 private key formats used by OpenSSH and ssh.com's implementation. -t keytype Specify a type of key to generate. The acceptable values here are rsa and dsa (to generate SSH-2 keys), and rsa1 (to generate SSH-1 keys). -b bits Specify the size of the key to generate, in bits. Default is 1024. -q Suppress the progress display when generating a new key. In the second phase, puttygen optionally alters properties of the key it has loaded or generated. The options to control this are: -C new-comment Specify a comment string to describe the key. This comment string will be used by PuTTY to identify the key to you (when asking you to enter the passphrase, for example, so that you know which passphrase to type). -P Indicate that you want to change the key's passphrase. This is automatic when you are generating a new key, but not when you are modifying an existing key. In the third phase, puttygen saves the key or information about it. The options to control this are: -O output-type Specify the type of output you want puttygen to produce. Accept- able options are: private Save the private key in a format usable by PuTTY. This will either be the standard SSH-1 key format, or PuTTY's own SSH-2 key format. public Save the public key only. For SSH-1 keys, the standard public key format will be used (`1024 37 5698745...'). For SSH-2 keys, the public key will be output in the for- mat specified by RFC 4716, which is a multi-line text file beginning with the line `---- BEGIN SSH2 PUBLIC KEY ----'. public-openssh Save the public key only, in a format usable by OpenSSH. For SSH-1 keys, this output format behaves identically to public. For SSH-2 keys, the public key will be output in the OpenSSH format, which is a single line (`ssh-rsa AAAAB3NzaC1yc2...'). fingerprint Print the fingerprint of the public key. All fingerprint- ing algorithms are believed compatible with OpenSSH. private-openssh Save an SSH-2 private key in OpenSSH's format. This option is not permitted for SSH-1 keys. private-sshcom Save an SSH-2 private key in ssh.com's format. This option is not permitted for SSH-1 keys. If no output type is specified, the default is private. -o output-file Specify the file where puttygen should write its output. If this option is not specified, puttygen will assume you want to over- write the original file if the input and output file types are the same (changing a comment or passphrase), and will assume you want to output to stdout if you are asking for a public key or fingerprint. Otherwise, the -o option is required. -l Synonym for `-O fingerprint'. -L Synonym for `-O public-openssh'. -p Synonym for `-O public'. The following options do not run PuTTYgen as normal, but print informa- tional messages and then quit: -h, --help Display a message summarizing the available options. -V, --version Display the version of PuTTYgen. --pgpfp Display the fingerprints of the PuTTY PGP Master Keys, to aid in verifying new files released by the PuTTY team. EXAMPLES To generate an SSH-2 RSA key pair and save it in PuTTY's own format (you will be prompted for the passphrase): puttygen -t rsa -C "my home key" -o mykey.ppk To generate a larger (2048-bit) key: puttygen -t rsa -b 2048 -C "my home key" -o mykey.ppk To change the passphrase on a key (you will be prompted for the old and new passphrases): puttygen -P mykey.ppk To change the comment on a key: puttygen -C "new comment" mykey.ppk To convert a key into OpenSSH's private key format: puttygen mykey.ppk -O private-openssh -o my-openssh-key To convert a key from another format (puttygen will automatically detect the input key type): puttygen my-ssh.com-key -o mykey.ppk To display the fingerprint of a key (some key types require a passphrase to extract even this much information): puttygen -l mykey.ppk To add the OpenSSH-format public half of a key to your authorised keys file: puttygen -L mykey.ppk >> $HOME/.ssh/authorized_keys BUGS There's currently no way to supply passphrases in batch mode, or even just to specify that you don't want a passphrase at all. ------------------------------------------------------------------------------