contrib/netcat/nc.1

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