contrib/netcat/nc.1

   1 .\"     $OpenBSD: nc.1,v 1.44 2006/12/02 01:08:30 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 1996 David Sacerdote
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd May 21, 2006
  31 .Dt NC 1
  32 .Os
  33 .Sh NAME
  34 .Nm nc
  35 .Nd arbitrary TCP and UDP connections and listens
  36 .Sh SYNOPSIS
  37 .Nm nc
  38 .Bk -words
  39 .Op Fl 46DEdhklnorStUuvz
  40 .Op Fl e Ar IPsec_policy
  41 .Op Fl i Ar interval
  42 .Op Fl P Ar proxy_username
  43 .Op Fl p Ar source_port
  44 .Op Fl s Ar source_ip_address
  45 .Op Fl T Ar ToS
  46 .Op Fl w Ar timeout
  47 .Op Fl X Ar proxy_protocol
  48 .Oo Xo
  49 .Fl x Ar proxy_address Ns Oo : Ns
  50 .Ar port Oc Oc
  51 .Xc
  52 .Op Ar hostname
  53 .Op Ar port Ns Bq Ar s
  54 .Ek
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 (or
  59 .Nm netcat )
  60 utility is used for just about anything under the sun involving TCP
  61 or UDP.
  62 It can open TCP connections, send UDP packets, listen on arbitrary
  63 TCP and UDP ports, do port scanning, and deal with both IPv4 and
  64 IPv6.
  65 Unlike
  66 .Xr telnet 1 ,
  67 .Nm
  68 scripts nicely, and separates error messages onto standard error instead
  69 of sending them to standard output, as
  70 .Xr telnet 1
  71 does with some.
  72 .Pp
  73 Common uses include:
  74 .Pp
  75 .Bl -bullet -offset indent -compact
  76 .It
  77 simple TCP proxies
  78 .It
  79 shell-script based HTTP clients and servers
  80 .It
  81 network daemon testing
  82 .It
  83 a SOCKS or HTTP ProxyCommand for
  84 .Xr ssh 1
  85 .It
  86 and much, much more
  87 .El
  88 .Pp
  89 The options are as follows:
  90 .Bl -tag -width Ds
  91 .It Fl 4
  92 Forces
  93 .Nm
  94 to use IPv4 addresses only.
  95 .It Fl 6
  96 Forces
  97 .Nm
  98 to use IPv6 addresses only.
  99 .It Fl D
 100 Enable debugging on the socket.
 101 .It Fl d
 102 Do not attempt to read from stdin.
 103 .It Fl h
 104 Prints out
 105 .Nm
 106 help.
 107 .It Fl E
 108 Shortcut for
 109 .Qo
 110 .Li "-e 'in ipsec esp/transport//require'"
 111 .Li "-e 'out ipsec esp/transport//require'"
 112 .Qc ,
 113 which enables IPsec ESP transport mode in both
 114 directions.
 115 .It Fl e
 116 If IPsec support is available, then one can specify the IPsec policies
 117 to be used using the syntax described in
 118 .Xr ipsec_set_policy 3 .
 119 This flag can be specified up to two times, as typically one policy for
 120 each direction is needed.
 121 .It Fl i Ar interval
 122 Specifies a delay time interval between lines of text sent and received.
 123 Also causes a delay time between connections to multiple ports.
 124 .It Fl k
 125 Forces
 126 .Nm
 127 to stay listening for another connection after its current connection
 128 is completed.
 129 It is an error to use this option without the
 130 .Fl l
 131 option.
 132 .It Fl l
 133 Used to specify that
 134 .Nm
 135 should listen for an incoming connection rather than initiate a
 136 connection to a remote host.
 137 It is an error to use this option in conjunction with the
 138 .Fl p ,
 139 .Fl s ,
 140 or
 141 .Fl z
 142 options.
 143 Additionally, any timeouts specified with the
 144 .Fl w
 145 option are ignored.
 146 .It Fl n
 147 Do not do any DNS or service lookups on any specified addresses,
 148 hostnames or ports.
 149 .It Fl o
 150 .Dq Once-only mode .
 151 By default,
 152 .Nm
 153 does not terminate on EOF condition on input,
 154 but continues until the network side has been closed down.
 155 Specifying
 156 .Fl o
 157 will make it terminate on EOF as well.
 158 .It Fl P Ar proxy_username
 159 Specifies a username to present to a proxy server that requires authentication.
 160 If no username is specified then authentication will not be attempted.
 161 Proxy authentication is only supported for HTTP CONNECT proxies at present.
 162 .It Fl p Ar source_port
 163 Specifies the source port
 164 .Nm
 165 should use, subject to privilege restrictions and availability.
 166 It is an error to use this option in conjunction with the
 167 .Fl l
 168 option.
 169 .It Fl r
 170 Specifies that source and/or destination ports should be chosen randomly
 171 instead of sequentially within a range or in the order that the system
 172 assigns them.
 173 .It Fl S
 174 Enables the RFC 2385 TCP MD5 signature option.
 175 .It Fl s Ar source_ip_address
 176 Specifies the IP of the interface which is used to send the packets.
 177 It is an error to use this option in conjunction with the
 178 .Fl l
 179 option.
 180 .It Fl T Ar ToS
 181 Specifies IP Type of Service (ToS) for the connection.
 182 Valid values are the tokens
 183 .Dq lowdelay ,
 184 .Dq throughput ,
 185 .Dq reliability ,
 186 or an 8-bit hexadecimal value preceded by
 187 .Dq 0x .
 188 .It Fl t
 189 Causes
 190 .Nm
 191 to send RFC 854 DON'T and WON'T responses to RFC 854 DO and WILL requests.
 192 This makes it possible to use
 193 .Nm
 194 to script telnet sessions.
 195 .It Fl U
 196 Specifies to use Unix Domain Sockets.
 197 .It Fl u
 198 Use UDP instead of the default option of TCP.
 199 .It Fl v
 200 Have
 201 .Nm
 202 give more verbose output.
 203 .It Fl w Ar timeout
 204 If a connection and stdin are idle for more than
 205 .Ar timeout
 206 seconds, then the connection is silently closed.
 207 The
 208 .Fl w
 209 flag has no effect on the
 210 .Fl l
 211 option, i.e.\&
 212 .Nm
 213 will listen forever for a connection, with or without the
 214 .Fl w
 215 flag.
 216 The default is no timeout.
 217 .It Fl X Ar proxy_protocol
 218 Requests that
 219 .Nm
 220 should use the specified protocol when talking to the proxy server.
 221 Supported protocols are
 222 .Dq 4
 223 (SOCKS v.4),
 224 .Dq 5
 225 (SOCKS v.5)
 226 and
 227 .Dq connect
 228 (HTTPS proxy).
 229 If the protocol is not specified, SOCKS version 5 is used.
 230 .It Xo
 231 .Fl x Ar proxy_address Ns Oo : Ns
 232 .Ar port Oc
 233 .Xc
 234 Requests that
 235 .Nm
 236 should connect to
 237 .Ar hostname
 238 using a proxy at
 239 .Ar proxy_address
 240 and
 241 .Ar port .
 242 If
 243 .Ar port
 244 is not specified, the well-known port for the proxy protocol is used (1080
 245 for SOCKS, 3128 for HTTPS).
 246 .It Fl z
 247 Specifies that
 248 .Nm
 249 should just scan for listening daemons, without sending any data to them.
 250 It is an error to use this option in conjunction with the
 251 .Fl l
 252 option.
 253 .El
 254 .Pp
 255 .Ar hostname
 256 can be a numerical IP address or a symbolic hostname
 257 (unless the
 258 .Fl n
 259 option is given).
 260 In general, a hostname must be specified,
 261 unless the
 262 .Fl l
 263 option is given
 264 (in which case the local host is used).
 265 .Pp
 266 .Ar port Ns Op Ar s
 267 can be single integers or ranges.
 268 Ranges are in the form nn-mm.
 269 In general,
 270 a destination port must be specified,
 271 unless the
 272 .Fl U
 273 option is given
 274 (in which case a socket must be specified).
 275 .Sh CLIENT/SERVER MODEL
 276 It is quite simple to build a very basic client/server model using
 277 .Nm .
 278 On one console, start
 279 .Nm
 280 listening on a specific port for a connection.
 281 For example:
 282 .Pp
 283 .Dl $ nc -l 1234
 284 .Pp
 285 .Nm
 286 is now listening on port 1234 for a connection.
 287 On a second console
 288 .Pq or a second machine ,
 289 connect to the machine and port being listened on:
 290 .Pp
 291 .Dl $ nc 127.0.0.1 1234
 292 .Pp
 293 There should now be a connection between the ports.
 294 Anything typed at the second console will be concatenated to the first,
 295 and vice-versa.
 296 After the connection has been set up,
 297 .Nm
 298 does not really care which side is being used as a
 299 .Sq server
 300 and which side is being used as a
 301 .Sq client .
 302 The connection may be terminated using an
 303 .Dv EOF
 304 .Pq Sq ^D .
 305 .Sh DATA TRANSFER
 306 The example in the previous section can be expanded to build a
 307 basic data transfer model.
 308 Any information input into one end of the connection will be output
 309 to the other end, and input and output can be easily captured in order to
 310 emulate file transfer.
 311 .Pp
 312 Start by using
 313 .Nm
 314 to listen on a specific port, with output captured into a file:
 315 .Pp
 316 .Dl $ nc -l 1234 \*(Gt filename.out
 317 .Pp
 318 Using a second machine, connect to the listening
 319 .Nm
 320 process, feeding it the file which is to be transferred:
 321 .Pp
 322 .Dl $ nc host.example.com 1234 \*(Lt filename.in
 323 .Pp
 324 After the file has been transferred, the connection will close automatically.
 325 .Sh TALKING TO SERVERS
 326 It is sometimes useful to talk to servers
 327 .Dq by hand
 328 rather than through a user interface.
 329 It can aid in troubleshooting,
 330 when it might be necessary to verify what data a server is sending
 331 in response to commands issued by the client.
 332 For example, to retrieve the home page of a web site:
 333 .Bd -literal -offset indent
 334 $ echo -n "GET / HTTP/1.0\er\en\er\en" | nc host.example.com 80
 335 .Ed
 336 .Pp
 337 Note that this also displays the headers sent by the web server.
 338 They can be filtered, using a tool such as
 339 .Xr sed 1 ,
 340 if necessary.
 341 .Pp
 342 More complicated examples can be built up when the user knows the format
 343 of requests required by the server.
 344 As another example, an email may be submitted to an SMTP server using:
 345 .Bd -literal -offset indent
 346 $ nc localhost 25 \*(Lt\*(Lt EOF
 347 HELO host.example.com
 348 MAIL FROM:\*(Ltuser@host.example.com\*(Gt
 349 RCPT TO:\*(Ltuser2@host.example.com\*(Gt
 350 DATA
 351 Body of email.
 352 \&.
 353 QUIT
 354 EOF
 355 .Ed
 356 .Sh PORT SCANNING
 357 It may be useful to know which ports are open and running services on
 358 a target machine.
 359 The
 360 .Fl z
 361 flag can be used to tell
 362 .Nm
 363 to report open ports,
 364 rather than initiate a connection.
 365 For example:
 366 .Bd -literal -offset indent
 367 $ nc -z host.example.com 20-30
 368 Connection to host.example.com 22 port [tcp/ssh] succeeded!
 369 Connection to host.example.com 25 port [tcp/smtp] succeeded!
 370 .Ed
 371 .Pp
 372 The port range was specified to limit the search to ports 20 \- 30.
 373 .Pp
 374 Alternatively, it might be useful to know which server software
 375 is running, and which versions.
 376 This information is often contained within the greeting banners.
 377 In order to retrieve these, it is necessary to first make a connection,
 378 and then break the connection when the banner has been retrieved.
 379 This can be accomplished by specifying a small timeout with the
 380 .Fl w
 381 flag, or perhaps by issuing a
 382 .Qq Dv QUIT
 383 command to the server:
 384 .Bd -literal -offset indent
 385 $ echo "QUIT" | nc host.example.com 20-30
 386 SSH-1.99-OpenSSH_3.6.1p2
 387 Protocol mismatch.
 388 220 host.example.com IMS SMTP Receiver Version 0.84 Ready
 389 .Ed
 390 .Sh EXAMPLES
 391 Open a TCP connection to port 42 of host.example.com, using port 31337 as
 392 the source port, with a timeout of 5 seconds:
 393 .Pp
 394 .Dl $ nc -p 31337 -w 5 host.example.com 42
 395 .Pp
 396 Open a UDP connection to port 53 of host.example.com:
 397 .Pp
 398 .Dl $ nc -u host.example.com 53
 399 .Pp
 400 Open a TCP connection to port 42 of host.example.com using 10.1.2.3 as the
 401 IP for the local end of the connection:
 402 .Pp
 403 .Dl $ nc -s 10.1.2.3 host.example.com 42
 404 .Pp
 405 Open a TCP connection to port 42 of host.example.com using IPsec ESP for
 406 incoming and outgoing traffic.
 407 .Pp
 408 .Dl $ nc -E host.example.com 42
 409 .Pp
 410 Open a TCP connection to port 42 of host.example.com using IPsec ESP for
 411 outgoing traffic only.
 412 .Pp
 413 .Dl $ nc -e 'out ipsec esp/transport//require' host.example.com 42
 414 .Pp
 415 Create and listen on a Unix Domain Socket:
 416 .Pp
 417 .Dl $ nc -lU /var/tmp/dsocket
 418 .Pp
 419 Connect to port 42 of host.example.com via an HTTP proxy at 10.2.3.4,
 420 port 8080.
 421 This example could also be used by
 422 .Xr ssh 1 ;
 423 see the
 424 .Cm ProxyCommand
 425 directive in
 426 .Xr ssh_config 5
 427 for more information.
 428 .Pp
 429 .Dl $ nc -x10.2.3.4:8080 -Xconnect host.example.com 42
 430 .Pp
 431 The same example again, this time enabling proxy authentication with username
 432 .Dq ruser
 433 if the proxy requires it:
 434 .Pp
 435 .Dl $ nc -x10.2.3.4:8080 -Xconnect -Pruser host.example.com 42
 436 .Sh SEE ALSO
 437 .Xr cat 1 ,
 438 .Xr ssh 1
 439 .Sh AUTHORS
 440 Original implementation by *Hobbit*
 441 .Aq hobbit@avian.org .
 442 .br
 443 Rewritten with IPv6 support by
 444 .An Eric Jackson Aq ericj@monkey.org .
 445 .Sh CAVEATS
 446 UDP port scans will always succeed
 447 (i.e. report the port as open),
 448 rendering the
 449 .Fl uz
 450 combination of flags relatively useless.