security/nss/cmd/ssltap/ssltap-manual.html

   1 <HTML>
   2 <!-- ***** BEGIN LICENSE BLOCK *****
   3    - Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4    -
   5    - The contents of this file are subject to the Mozilla Public License Version
   6    - 1.1 (the "License"); you may not use this file except in compliance with
   7    - the License. You may obtain a copy of the License at
   8    - http://www.mozilla.org/MPL/
   9    -
  10    - Software distributed under the License is distributed on an "AS IS" basis,
  11    - WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12    - for the specific language governing rights and limitations under the
  13    - License.
  14    -
  15    - The Original Code is the Netscape security libraries.
  16    -
  17    - The Initial Developer of the Original Code is
  18    - Netscape Communications Corporation.
  19    - Portions created by the Initial Developer are Copyright (C) 1994-2000
  20    - the Initial Developer. All Rights Reserved.
  21    -
  22    - Contributor(s):
  23    -
  24    - Alternatively, the contents of this file may be used under the terms of
  25    - either the GNU General Public License Version 2 or later (the "GPL"), or
  26    - the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27    - in which case the provisions of the GPL or the LGPL are applicable instead
  28    - of those above. If you wish to allow use of your version of this file only
  29    - under the terms of either the GPL or the LGPL, and not to allow others to
  30    - use your version of this file under the terms of the MPL, indicate your
  31    - decision by deleting the provisions above and replace them with the notice
  32    - and other provisions required by the GPL or the LGPL. If you do not delete
  33    - the provisions above, a recipient may use your version of this file under
  34    - the terms of any one of the MPL, the GPL or the LGPL.
  35    -
  36    - ***** END LICENSE BLOCK ***** -->
  37 <HEAD>
  38    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
  39    <META NAME="GENERATOR" CONTENT="Mozilla/4.05 [en] (WinNT; U) [Netscape]">
  40    <META NAME="Author" CONTENT="Steve Parkinson">
  41    <TITLE>SSLTap - manual</TITLE>
  42 </HEAD>
  43 <BODY>
  44
  45 <H1>
  46 SSLTap Manual page</H1>
  47
  48 <H3>
  49 Summary</H3>
  50 A command-line proxy which is SSL-aware. It snoops on TCP connections,
  51 and displays the data going by, including SSL records and handshaking&nbsp;
  52 if the connection is SSL.
  53 <H3>
  54 Synopsis</H3>
  55 <TT>ssltap [-vhfsxl] [-p port] hostname:port</TT>
  56
  57 <P><TT>&nbsp;&nbsp; -v&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [prints version string]</TT>
  58 <BR><TT>&nbsp;&nbsp; -h&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [outputs hex instead
  59 of ASCII]</TT>
  60 <BR><TT>&nbsp;&nbsp; -f&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [turn on Fancy HTML
  61 coloring]</TT>
  62 <BR><TT>&nbsp;&nbsp; -s&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [turn on SSL decoding]</TT>
  63 <BR><TT>&nbsp;&nbsp; -x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [turn on extra SSL
  64 hex dumps]</TT>
  65 <BR><TT>&nbsp;&nbsp; -p port [specify rendezvous port (default 1924)]</TT>
  66 <BR><TT>&nbsp;&nbsp; -l&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [loop - continue
  67 to wait for more connections]</TT>
  68 <H3>
  69 Description</H3>
  70 SSLTap opens a socket on a rendezvous port, and waits for an incoming connection
  71 (client side). Once this connection arrives, SSLTap makes another connection
  72 to hostname:port (server side). It passes any data sent by the client to
  73 the server, and vice versa. However, SSLTap will also display the data
  74 to the console. It can do this for plain HTTP connections, or any TCP protocol.
  75 However, SSLTap can also work with SSL streams, as detailed below.
  76
  77 <P>Let's assume your development machine is called 'intercept'. The simplest
  78 usage of SSLTap is to run the command <TT>'ssltap www.netscape.com:80'</TT>
  79 on intercept. The program will wait for an incoming connection on port
  80 1924. Next you would want to go to your browser, and enter the URL http://intercept:1924.
  81 The page retrieved by the browser will actually be gotten from the server
  82 at www.netscape.com, but will go via SSLTap.
  83
  84 <P>Data sent from the client to the server is surrounded by a '--> [ ]'
  85 symbol, and data sent from the server to the client, a '&lt;---[&nbsp;
  86 ]' symbol.
  87
  88 <P>You'll notice that the page retrieved with this example looks incomplete.
  89 This is because SSLTap by default closes down after the first connection
  90 is complete, so the browser is not able to load images. To make the SSLTap
  91 continue to accept connections, switch on looping mode with the -l option.
  92
  93 <P>You can change the default rendezvous port to something else with the
  94 -p option.
  95
  96 <P>The remaining options change the way the output is produced.
  97
  98 <P>The -f option prints 'fancy' output - in colored HTML. Data sent from
  99 the client to the server is in blue. The server's reply is in red. This
 100 is designed so you can load the output up into a browser. When used with
 101 looping mode, the different connections are separated with horizontal lines.
 102
 103 <P>-x will turn on HEX printing. Instead of being output as ascii, the
 104 data is shown as Hex, like this:
 105 <UL><TT>&lt;-- [</TT>
 106 <BR><TT>&nbsp;&nbsp; 0: 56 d5 16 3e&nbsp; a1 6b b1 4a&nbsp; 8f 67 c4 d7&nbsp;
 107 21 2f 6f dd&nbsp; | V..>.k.J.g..!/o.</TT>
 108 <BR><TT>&nbsp; 10: bb 22 c4 75&nbsp; 8c f4 ce 28&nbsp; 16 a6 20 aa&nbsp;
 109 fb 9a 59 a1&nbsp; | .".u...(.. ...Y.</TT>
 110 <BR><TT>&nbsp; 20: 51 91 14 d2&nbsp; fc 9f a7 ea&nbsp; 4d 9c f7 3a&nbsp;
 111 9d 83 62 4a&nbsp; | Q.......M..:..bJ</TT>
 112 <BR><TT>]</TT>
 113 <BR>&nbsp;</UL>
 114
 115 <H4>
 116 SSL Parse mode</H4>
 117 The following options deal with SSL connections.
 118 <UL>-s will turn on SSL parsing. (SSLTap doesn't automatically detect SSL
 119 sessions.)
 120 <BR>-x will turn on extra SSL hexdumps. Mostly, if SSL can decode the data,
 121 it doesn't display the hex.</UL>
 122 The following SSL3 Data structures are parsed: Handshake, ClientHello,
 123 ServerHello, CertificateChain, Certificate. In addition, SSL2 ClientHello,
 124 ServerHello, ClientMasterKey are also partly parsed. NO DECRYPTION IS PERFORMED
 125 ON THE DATA. SSLTAP CANNOT DECRYPT the data.
 126
 127 <P>If a certificate chain is detected, DER-encoded certificates will be
 128 saved into files in the current directory called 'cert.0x' where x is the
 129 sequence number of the certificate.
 130 <BR>&nbsp;
 131 <H3>
 132 Operation Hints</H3>
 133 Often, you'll find that the server certificate does not get transferred,
 134 or other parts of the handshake do not happen. This is because the browser
 135 is taking advantage of session-id-reuse (using the handshake results from
 136 a previous session). If you restart the browser, it'll clear the session
 137 id cache.
 138
 139 <P>If you run the ssltap on a different machine that the ssl server you're
 140 trying to connect to, the browser will complain that the host name you're
 141 trying to connect to is different to the certificate, but it will still
 142 let you connect, after showing you a dialog.
 143 <H3>
 144 Bugs</H3>
 145 Please contact <A HREF="mailto:ssltap-support@netscape.com">ssltap-support@netscape.com</A>
 146 for bug reports.
 147 <H3>
 148 History</H3>
 149 2.1 - First public release (March 1998)
 150 <BR>&nbsp;
 151 <H3>
 152 Other</H3>
 153 For reference, here is a table of some well-known port numbers:
 154 <BR>&nbsp;
 155 <TABLE BORDER=2 >
 156 <TR>
 157 <TD>HTTP</TD>
 158
 159 <TD>80</TD>
 160 </TR>
 161
 162 <TR>
 163 <TD>SMTP</TD>
 164
 165 <TD>25</TD>
 166 </TR>
 167
 168 <TR>
 169 <TD>HTTPS</TD>
 170
 171 <TD>443</TD>
 172 </TR>
 173
 174 <TR>
 175 <TD>FTP</TD>
 176
 177 <TD>21</TD>
 178 </TR>
 179
 180 <TR>
 181 <TD>IMAPS</TD>
 182
 183 <TD>993</TD>
 184 </TR>
 185
 186 <TR>
 187 <TD>NNTP</TD>
 188
 189 <TD>119</TD>
 190 </TR>
 191
 192 <TR>
 193 <TD>NNTPS</TD>
 194
 195 <TD>563</TD>
 196 </TR>
 197 </TABLE>
 198 &nbsp;
 199
 200 <P>&nbsp;
 201 </BODY>
 202 </HTML>