blob: b6dd601a841c46878484f21f9e39f174dcd4f66f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
/*
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
*
* SPDX-License-Identifier: MPL-2.0
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, you can obtain one at https://mozilla.org/MPL/2.0/.
*
* See the COPYRIGHT file distributed with this work for additional
* information regarding copyright ownership.
*/
#pragma once
/*****
***** Module Info
*****/
/*! \file dns/clientinfo.h
* \brief
* The DNS clientinfo interface allows libdns to retrieve information
* about the client from the caller.
*
* The clientinfo interface is used by the DNS DB and DLZ interfaces;
* it allows databases to modify their answers on the basis of information
* about the client, such as source IP address.
*
* dns_clientinfo_t contains a pointer to an opaque structure containing
* client information in some form. dns_clientinfomethods_t contains a
* list of methods which operate on that opaque structure to return
* potentially useful data. Both structures also contain versioning
* information.
*/
/*****
***** Imports
*****/
#include <inttypes.h>
#include <isc/sockaddr.h>
#include <isc/types.h>
#include <dns/ecs.h>
ISC_LANG_BEGINDECLS
/*****
***** Types
*****/
#define DNS_CLIENTINFO_VERSION 3
/*
* Any updates to this structure should also be applied in
* contrib/modules/dlz/dlz_minmal.h.
*/
typedef struct dns_clientinfo {
uint16_t version;
void *data;
void *dbversion;
dns_ecs_t ecs;
} dns_clientinfo_t;
typedef isc_result_t (*dns_clientinfo_sourceip_t)(dns_clientinfo_t *client,
isc_sockaddr_t **addrp);
#define DNS_CLIENTINFOMETHODS_VERSION 2
#define DNS_CLIENTINFOMETHODS_AGE 1
/*
* Any updates to this structure should also be applied in
* contrib/modules/dlz/dlz_minmal.h.
*/
typedef struct dns_clientinfomethods {
uint16_t version;
uint16_t age;
dns_clientinfo_sourceip_t sourceip;
} dns_clientinfomethods_t;
/*****
***** Methods
*****/
void
dns_clientinfomethods_init(dns_clientinfomethods_t *methods,
dns_clientinfo_sourceip_t sourceip);
void
dns_clientinfo_init(dns_clientinfo_t *ci, void *data, void *versionp);
/*%<
* Initialize a clientinfo object, setting the data to 'data' and the
* database version to 'versionp'. ECS data is initialized to 0/0/0.
*/
void
dns_clientinfo_setecs(dns_clientinfo_t *ci, dns_ecs_t *ecs);
/*%<
* Set the ECS client data associated with a clientinfo object 'ci'.
* If 'ecs' is NULL, initialize ci->ecs to 0/0/0; otherwise copy it.
*/
ISC_LANG_ENDDECLS
|
