contrib/netcat/nc.1

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