xref: /freebsd/share/man/man9/accf_dns.9 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1.\"
2.\" Copyright (c) 2008 David Malone
3.\"
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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\" "
26.Dd July 16, 2008
27.Dt ACCF_DNS 9
28.Os
29.Sh NAME
30.Nm accf_dns
31.Nd buffer incoming DNS requests until the whole first request is present
32.Sh SYNOPSIS
33.Nm options INET
34.Nm options ACCEPT_FILTER_DNS
35.Nm kldload accf_dns
36.Sh DESCRIPTION
37This is a filter to be placed on a socket that will be using
38.Fn accept
39to receive incoming connections.
40.Pp
41It prevents the application from receiving the connected descriptor via
42.Fn accept
43until a whole DNS request is available on the socket.
44It does this by reading the first two bytes of the request,
45to determine its size,
46and waiting until the required amount of data is available to be read.
47.Pp
48The
49.Fa ACCEPT_FILTER_DNS
50kernel option is also a module that can be enabled at runtime via
51.Xr kldload 8
52if the INET option has been compiled into the kernel.
53.Sh EXAMPLES
54If the
55.Nm
56module is available in the kernel,
57the following code will enable the DNS accept filter
58on a socket
59.Fa sok .
60.Bd -literal -offset 0i
61	struct accept_filter_arg afa;
62
63	bzero(&afa, sizeof(afa));
64	strcpy(afa.af_name, "dnsready");
65	setsockopt(sok, SOL_SOCKET, SO_ACCEPTFILTER, &afa, sizeof(afa));
66.Ed
67.Sh SEE ALSO
68.Xr setsockopt 2 ,
69.Xr accept_filter 9 ,
70.Xr accf_data 9 ,
71.Xr accf_http 9
72.Sh HISTORY
73The accept filter mechanism was introduced in
74.Fx 4.0 .
75.Sh AUTHORS
76This manual page and the filter were written by
77.An David Malone .
78