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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/*
Authors:
Pavel Březina <pbrezina@redhat.com>
Copyright (C) 2016 Red Hat
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _CACHE_REQ_PLUGIN_H_
#define _CACHE_REQ_PLUGIN_H_
#include "responder/common/cache_req/cache_req_private.h"
enum cache_object_status {
CACHE_OBJECT_VALID,
CACHE_OBJECT_EXPIRED,
CACHE_OBJECT_MISSING,
CACHE_OBJECT_MIDPOINT
};
/**
* Create cache request result manually, if the searched object is well known
* and thus can not be found in the cache.
*
*
* @return EOK If it is a well known object and a result was created.
* @return ENOENT If it is not a well known object.
* @return Other errno code in case of an error.
*/
typedef errno_t
(*cache_req_is_well_known_result_fn)(TALLOC_CTX *mem_ctx,
struct cache_req *cr,
struct cache_req_data *data,
struct cache_req_result **_result);
/**
* Prepare domain data. Some plug-ins may require to alter lookup data
* per specific domain rules, such as case sensitivity, fully qualified
* format etc.
*
* @return EOK If everything went fine.
* @return Other errno code in case of an error.
*/
typedef errno_t
(*cache_req_prepare_domain_data_fn)(struct cache_req *cr,
struct cache_req_data *data,
struct sss_domain_info *domain);
/**
* Create an object debug name that is used in debug messages to identify
* this object.
*
* @return Debug name or NULL in case of an error.
**/
typedef const char *
(*cache_req_create_debug_name_fn)(TALLOC_CTX *mem_ctx,
struct cache_req_data *data,
struct sss_domain_info *domain);
/**
* Check if an object is stored in negative cache.
*
* @return EOK If the object is not found.
* @return EEXIST If the object is found in negative cache.
* @return Other errno code in case of an error.
*/
typedef errno_t
(*cache_req_ncache_check_fn)(struct sss_nc_ctx *ncache,
struct sss_domain_info *domain,
struct cache_req_data *data);
/**
* Add an object into negative cache.
*
* @return EOK If everything went fine.
* @return Other errno code in case of an error.
*/
typedef errno_t
(*cache_req_ncache_add_fn)(struct sss_nc_ctx *ncache,
struct sss_domain_info *domain,
struct cache_req_data *data);
/**
* Add an object into global negative cache.
*
* @return EOK If everything went fine.
* @return Other errno code in case of an error.
*/
typedef errno_t
(*cache_req_global_ncache_add_fn)(struct sss_nc_ctx *ncache,
struct cache_req_data *data);
/**
* Lookup object in sysdb.
*
* @return EOK If the object is found.
* @return ENOENT If the object is not found.
* @return Other errno code in case of an error.
*/
typedef errno_t
(*cache_req_lookup_fn)(TALLOC_CTX *mem_ctx,
struct cache_req *cr,
struct cache_req_data *data,
struct sss_domain_info *domain,
struct ldb_result **_result);
/**
* Send Data Provider request.
*
* @return Tevent request on success.
* @return NULL on error.
*/
typedef struct tevent_req *
(*cache_req_dp_send_fn)(TALLOC_CTX *mem_ctx,
struct cache_req *cr,
struct cache_req_data *data,
struct sss_domain_info *domain,
struct ldb_result *result);
/**
* Process result of Data Provider request.
*
* Do not free subreq! It will be freed in the caller.
*
* @return True if data provider request succeeded.
* @return False if there was an error.
*/
typedef bool
(*cache_req_dp_recv_fn)(struct tevent_req *subreq,
struct cache_req *cr);
struct cache_req_plugin {
/**
* Plugin name.
*/
const char *name;
/**
* Expiration timestamp attribute name.
*/
const char *attr_expiration;
/**
* Flags that are passed to get_next_domain().
*/
uint32_t get_next_domain_flags;
/**
* True if input name should be parsed for domain.
*/
bool parse_name;
/**
* True if default domain suffix should be ignored when parsing name.
*/
bool ignore_default_domain;
/**
* True if we always contact data provider.
*/
bool bypass_cache;
/**
* True if only one result is expected.
*/
bool only_one_result;
/**
* If true, cache request will iterate over all domains on domain-less
* search and merge acquired results.
*/
bool search_all_domains;
/**
* True if only domains with enumeration enabled are searched.
*/
bool require_enumeration;
/**
* Allow missing domain part even if domain requires fully qualified name
* on domain less searches.
*/
bool allow_missing_fqn;
/**
* True if this plugin can be swapped for equivalent search with UPN.
*/
bool allow_switch_to_upn;
enum cache_req_type upn_equivalent;
/* Operations */
cache_req_is_well_known_result_fn is_well_known_fn;
cache_req_prepare_domain_data_fn prepare_domain_data_fn;
cache_req_create_debug_name_fn create_debug_name_fn;
cache_req_global_ncache_add_fn global_ncache_add_fn;
cache_req_ncache_check_fn ncache_check_fn;
cache_req_ncache_add_fn ncache_add_fn;
cache_req_lookup_fn lookup_fn;
cache_req_dp_send_fn dp_send_fn;
cache_req_dp_recv_fn dp_recv_fn;
};
extern const struct cache_req_plugin cache_req_user_by_name;
extern const struct cache_req_plugin cache_req_user_by_upn;
extern const struct cache_req_plugin cache_req_user_by_id;
extern const struct cache_req_plugin cache_req_group_by_name;
extern const struct cache_req_plugin cache_req_group_by_id;
extern const struct cache_req_plugin cache_req_initgroups_by_name;
extern const struct cache_req_plugin cache_req_initgroups_by_upn;
extern const struct cache_req_plugin cache_req_user_by_cert;
extern const struct cache_req_plugin cache_req_user_by_filter;
extern const struct cache_req_plugin cache_req_group_by_filter;
extern const struct cache_req_plugin cache_req_object_by_sid;
extern const struct cache_req_plugin cache_req_object_by_name;
extern const struct cache_req_plugin cache_req_object_by_id;
extern const struct cache_req_plugin cache_req_enum_users;
extern const struct cache_req_plugin cache_req_enum_groups;
extern const struct cache_req_plugin cache_req_enum_svc;
extern const struct cache_req_plugin cache_req_svc_by_name;
extern const struct cache_req_plugin cache_req_svc_by_port;
extern const struct cache_req_plugin cache_req_netgroup_by_name;
extern const struct cache_req_plugin cache_req_host_by_name;
#endif /* _CACHE_REQ_PLUGIN_H_ */
|
