contrib/netcat/nc.1

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