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 April 2, 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 46DEdhklnoOrStUuvz
  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 .\"
 150 .It Fl o
 151 .Dq Once-only mode .
 152 By default,
 153 .Nm
 154 does not terminate on EOF condition on input,
 155 but continues until the network side has been closed down.
 156 Specifying
 157 .Fl o
 158 will make it terminate on EOF as well.
 159 .It Fl o
 160 Disables the use of TCP options on the socket, by setting the boolean
 161 TCP_NOOPT
 162 socket option.
 163 .It Fl P Ar proxy_username
 164 Specifies a username to present to a proxy server that requires authentication.
 165 If no username is specified then authentication will not be attempted.
 166 Proxy authentication is only supported for HTTP CONNECT proxies at present.
 167 .It Fl p Ar source_port
 168 Specifies the source port
 169 .Nm
 170 should use, subject to privilege restrictions and availability.
 171 It is an error to use this option in conjunction with the
 172 .Fl l
 173 option.
 174 .It Fl r
 175 Specifies that source and/or destination ports should be chosen randomly
 176 instead of sequentially within a range or in the order that the system
 177 assigns them.
 178 .It Fl S
 179 Enables the RFC 2385 TCP MD5 signature option.
 180 .It Fl s Ar source_ip_address
 181 Specifies the IP of the interface which is used to send the packets.
 182 It is an error to use this option in conjunction with the
 183 .Fl l
 184 option.
 185 .It Fl T Ar ToS
 186 Specifies IP Type of Service (ToS) for the connection.
 187 Valid values are the tokens
 188 .Dq lowdelay ,
 189 .Dq throughput ,
 190 .Dq reliability ,
 191 or an 8-bit hexadecimal value preceded by
 192 .Dq 0x .
 193 .It Fl t
 194 Causes
 195 .Nm
 196 to send RFC 854 DON'T and WON'T responses to RFC 854 DO and WILL requests.
 197 This makes it possible to use
 198 .Nm
 199 to script telnet sessions.
 200 .It Fl U
 201 Specifies to use Unix Domain Sockets.
 202 .It Fl u
 203 Use UDP instead of the default option of TCP.
 204 .It Fl v
 205 Have
 206 .Nm
 207 give more verbose output.
 208 .It Fl w Ar timeout
 209 If a connection and stdin are idle for more than
 210 .Ar timeout
 211 seconds, then the connection is silently closed.
 212 The
 213 .Fl w
 214 flag has no effect on the
 215 .Fl l
 216 option, i.e.\&
 217 .Nm
 218 will listen forever for a connection, with or without the
 219 .Fl w
 220 flag.
 221 The default is no timeout.
 222 .It Fl X Ar proxy_protocol
 223 Requests that
 224 .Nm
 225 should use the specified protocol when talking to the proxy server.
 226 Supported protocols are
 227 .Dq 4
 228 (SOCKS v.4),
 229 .Dq 5
 230 (SOCKS v.5)
 231 and
 232 .Dq connect
 233 (HTTPS proxy).
 234 If the protocol is not specified, SOCKS version 5 is used.
 235 .It Xo
 236 .Fl x Ar proxy_address Ns Oo : Ns
 237 .Ar port Oc
 238 .Xc
 239 Requests that
 240 .Nm
 241 should connect to
 242 .Ar hostname
 243 using a proxy at
 244 .Ar proxy_address
 245 and
 246 .Ar port .
 247 If
 248 .Ar port
 249 is not specified, the well-known port for the proxy protocol is used (1080
 250 for SOCKS, 3128 for HTTPS).
 251 .It Fl z
 252 Specifies that
 253 .Nm
 254 should just scan for listening daemons, without sending any data to them.
 255 It is an error to use this option in conjunction with the
 256 .Fl l
 257 option.
 258 .El
 259 .Pp
 260 .Ar hostname
 261 can be a numerical IP address or a symbolic hostname
 262 (unless the
 263 .Fl n
 264 option is given).
 265 In general, a hostname must be specified,
 266 unless the
 267 .Fl l
 268 option is given
 269 (in which case the local host is used).
 270 .Pp
 271 .Ar port Ns Op Ar s
 272 can be single integers or ranges.
 273 Ranges are in the form nn-mm.
 274 In general,
 275 a destination port must be specified,
 276 unless the
 277 .Fl U
 278 option is given
 279 (in which case a socket must be specified).
 280 .Sh CLIENT/SERVER MODEL
 281 It is quite simple to build a very basic client/server model using
 282 .Nm .
 283 On one console, start
 284 .Nm
 285 listening on a specific port for a connection.
 286 For example:
 287 .Pp
 288 .Dl $ nc -l 1234
 289 .Pp
 290 .Nm
 291 is now listening on port 1234 for a connection.
 292 On a second console
 293 .Pq or a second machine ,
 294 connect to the machine and port being listened on:
 295 .Pp
 296 .Dl $ nc 127.0.0.1 1234
 297 .Pp
 298 There should now be a connection between the ports.
 299 Anything typed at the second console will be concatenated to the first,
 300 and vice-versa.
 301 After the connection has been set up,
 302 .Nm
 303 does not really care which side is being used as a
 304 .Sq server
 305 and which side is being used as a
 306 .Sq client .
 307 The connection may be terminated using an
 308 .Dv EOF
 309 .Pq Sq ^D .
 310 .Sh DATA TRANSFER
 311 The example in the previous section can be expanded to build a
 312 basic data transfer model.
 313 Any information input into one end of the connection will be output
 314 to the other end, and input and output can be easily captured in order to
 315 emulate file transfer.
 316 .Pp
 317 Start by using
 318 .Nm
 319 to listen on a specific port, with output captured into a file:
 320 .Pp
 321 .Dl $ nc -l 1234 \*(Gt filename.out
 322 .Pp
 323 Using a second machine, connect to the listening
 324 .Nm
 325 process, feeding it the file which is to be transferred:
 326 .Pp
 327 .Dl $ nc host.example.com 1234 \*(Lt filename.in
 328 .Pp
 329 After the file has been transferred, the connection will close automatically.
 330 .Sh TALKING TO SERVERS
 331 It is sometimes useful to talk to servers
 332 .Dq by hand
 333 rather than through a user interface.
 334 It can aid in troubleshooting,
 335 when it might be necessary to verify what data a server is sending
 336 in response to commands issued by the client.
 337 For example, to retrieve the home page of a web site:
 338 .Bd -literal -offset indent
 339 $ echo -n "GET / HTTP/1.0\er\en\er\en" | nc host.example.com 80
 340 .Ed
 341 .Pp
 342 Note that this also displays the headers sent by the web server.
 343 They can be filtered, using a tool such as
 344 .Xr sed 1 ,
 345 if necessary.
 346 .Pp
 347 More complicated examples can be built up when the user knows the format
 348 of requests required by the server.
 349 As another example, an email may be submitted to an SMTP server using:
 350 .Bd -literal -offset indent
 351 $ nc localhost 25 \*(Lt\*(Lt EOF
 352 HELO host.example.com
 353 MAIL FROM:\*(Ltuser@host.example.com\*(Gt
 354 RCPT TO:\*(Ltuser2@host.example.com\*(Gt
 355 DATA
 356 Body of email.
 357 \&.
 358 QUIT
 359 EOF
 360 .Ed
 361 .Sh PORT SCANNING
 362 It may be useful to know which ports are open and running services on
 363 a target machine.
 364 The
 365 .Fl z
 366 flag can be used to tell
 367 .Nm
 368 to report open ports,
 369 rather than initiate a connection.
 370 For example:
 371 .Bd -literal -offset indent
 372 $ nc -z host.example.com 20-30
 373 Connection to host.example.com 22 port [tcp/ssh] succeeded!
 374 Connection to host.example.com 25 port [tcp/smtp] succeeded!
 375 .Ed
 376 .Pp
 377 The port range was specified to limit the search to ports 20 \- 30.
 378 .Pp
 379 Alternatively, it might be useful to know which server software
 380 is running, and which versions.
 381 This information is often contained within the greeting banners.
 382 In order to retrieve these, it is necessary to first make a connection,
 383 and then break the connection when the banner has been retrieved.
 384 This can be accomplished by specifying a small timeout with the
 385 .Fl w
 386 flag, or perhaps by issuing a
 387 .Qq Dv QUIT
 388 command to the server:
 389 .Bd -literal -offset indent
 390 $ echo "QUIT" | nc host.example.com 20-30
 391 SSH-1.99-OpenSSH_3.6.1p2
 392 Protocol mismatch.
 393 220 host.example.com IMS SMTP Receiver Version 0.84 Ready
 394 .Ed
 395 .Sh EXAMPLES
 396 Open a TCP connection to port 42 of host.example.com, using port 31337 as
 397 the source port, with a timeout of 5 seconds:
 398 .Pp
 399 .Dl $ nc -p 31337 -w 5 host.example.com 42
 400 .Pp
 401 Open a UDP connection to port 53 of host.example.com:
 402 .Pp
 403 .Dl $ nc -u host.example.com 53
 404 .Pp
 405 Open a TCP connection to port 42 of host.example.com using 10.1.2.3 as the
 406 IP for the local end of the connection:
 407 .Pp
 408 .Dl $ nc -s 10.1.2.3 host.example.com 42
 409 .Pp
 410 Open a TCP connection to port 42 of host.example.com using IPsec ESP for
 411 incoming and outgoing traffic.
 412 .Pp
 413 .Dl $ nc -E host.example.com 42
 414 .Pp
 415 Open a TCP connection to port 42 of host.example.com using IPsec ESP for
 416 outgoing traffic only.
 417 .Pp
 418 .Dl $ nc -e 'out ipsec esp/transport//require' host.example.com 42
 419 .Pp
 420 Create and listen on a Unix Domain Socket:
 421 .Pp
 422 .Dl $ nc -lU /var/tmp/dsocket
 423 .Pp
 424 Connect to port 42 of host.example.com via an HTTP proxy at 10.2.3.4,
 425 port 8080.
 426 This example could also be used by
 427 .Xr ssh 1 ;
 428 see the
 429 .Cm ProxyCommand
 430 directive in
 431 .Xr ssh_config 5
 432 for more information.
 433 .Pp
 434 .Dl $ nc -x10.2.3.4:8080 -Xconnect host.example.com 42
 435 .Pp
 436 The same example again, this time enabling proxy authentication with username
 437 .Dq ruser
 438 if the proxy requires it:
 439 .Pp
 440 .Dl $ nc -x10.2.3.4:8080 -Xconnect -Pruser host.example.com 42
 441 .Sh SEE ALSO
 442 .Xr cat 1 ,
 443 .Xr ssh 1 ,
 444 .Xr tcp 4
 445 .Sh AUTHORS
 446 Original implementation by *Hobbit*
 447 .Aq hobbit@avian.org .
 448 .br
 449 Rewritten with IPv6 support by
 450 .An Eric Jackson Aq ericj@monkey.org .
 451 .Sh CAVEATS
 452 UDP port scans will always succeed
 453 (i.e. report the port as open),
 454 rendering the
 455 .Fl uz
 456 combination of flags relatively useless.