Initial import from FreeBSD RELENG_4:
[games.git] / share / man / man4 / blackhole.4
1 .\"
2 .\" blackhole - drop refused TCP or UDP connects
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\"
14 .\" $FreeBSD: src/share/man/man4/blackhole.4,v 1.4.2.4 2001/12/17 11:30:11 ru Exp $
15 .Dd August 17, 1999
16 .Dt BLACKHOLE 4
17 .Os
18 .Sh NAME
19 .Nm blackhole
20 .Nd a
21 .Xr sysctl 8
22 MIB for manipulating behaviour in respect of refused TCP or UDP connection
23 attempts
24 .Sh SYNOPSIS
25 .Cd sysctl net.inet.tcp.blackhole[=[0 | 1 | 2]]
26 .Cd sysctl net.inet.udp.blackhole[=[0 | 1]]
27 .Sh DESCRIPTION
28 The
29 .Nm
30 .Xr sysctl 8
31 MIB is used to control system behaviour when connection requests
32 are received on TCP or UDP ports where there is no socket listening.
33 .Pp
34 Normal behaviour, when a TCP SYN segment is received on a port where
35 there is no socket accepting connections, is for the system to return
36 a RST segment, and drop the connection.  The connecting system will
37 see this as a "Connection reset by peer".  By setting the TCP blackhole
38 MIB to a numeric value of one, the incoming SYN segment
39 is merely dropped, and no RST is sent, making the system appear
40 as a blackhole.  By setting the MIB value to two, any segment arriving
41 on a closed port is dropped without returning a RST.  This provides
42 some degree of protection against stealth port scans.
43 .Pp
44 In the UDP instance, enabling blackhole behaviour turns off the sending
45 of an ICMP port unreachable message in response to a UDP datagram which
46 arrives on a port where there is no socket listening.  It must be noted
47 that this behaviour will prevent remote systems from running
48 .Xr traceroute 8
49 to a system.
50 .Pp
51 The blackhole behaviour is useful to slow down anyone who is port scanning
52 a system, attempting to detect vulnerable services on a system.
53 It could potentially also slow down someone who is attempting a denial
54 of service attack.
55 .Sh WARNING
56 The TCP and UDP blackhole features should not be regarded as a replacement
57 for
58 .Xr ipfw 8
59 as a tool for firewalling a system.  In order to create a highly
60 secure system,
61 .Xr ipfw 8
62 should be used for protection, not the blackhole feature.
63 .Pp
64 This mechanism is not a substitute for securing a system.
65 It should be used together with other security mechanisms.
66 .Sh SEE ALSO
67 .Xr ip 4 ,
68 .Xr tcp 4 ,
69 .Xr udp 4 ,
70 .Xr ipfw 8 ,
71 .Xr sysctl 8
72 .Sh AUTHORS
73 .An Geoffrey M. Rehmet
74 .Sh HISTORY
75 The TCP and UDP
76 .Nm
77 MIBs
78 first appeared in
79 .Fx 4.0 .