]>
Commit | Line | Data |
---|---|---|
2b0cc3d3 EM |
1 | /* authd/provider.c - authentication provider framework |
2 | * Copyright (c) 2016 Elizabeth Myers <elizabeth@interlinked.me> | |
3 | * | |
4 | * Permission to use, copy, modify, and/or distribute this software for any | |
5 | * purpose with or without fee is hereby granted, provided that the above | |
6 | * copyright notice and this permission notice is present in all copies. | |
7 | * | |
8 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
9 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |
10 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
11 | * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, | |
12 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
13 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
14 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
15 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
16 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
17 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
18 | * POSSIBILITY OF SUCH DAMAGE. | |
19 | */ | |
20 | ||
89d22b9a EM |
21 | /* The basic design here is to have "authentication providers" that do things |
22 | * like query ident and blacklists and even open proxies. | |
2b0cc3d3 | 23 | * |
f7b37c1d EM |
24 | * Providers are registered in the auth_providers linked list. It is planned to |
25 | * use a bitmap to store provider ID's later. | |
2b0cc3d3 | 26 | * |
89d22b9a EM |
27 | * Providers can either return failure immediately, immediate acceptance, or do |
28 | * work in the background (calling set_provider to signal this). | |
2b0cc3d3 | 29 | * |
3e875f62 EM |
30 | * Provider-specific data for each client can be kept in an index of the data |
31 | * struct member (using the provider's ID). | |
2b0cc3d3 EM |
32 | * |
33 | * All providers must implement at a minimum a perform_provider function. You | |
34 | * don't have to implement the others if you don't need them. | |
35 | * | |
36 | * Providers may kick clients off by rejecting them. Upon rejection, all | |
37 | * providers are cancelled. They can also unconditionally accept them. | |
38 | * | |
39 | * When a provider is done and is neutral on accepting/rejecting a client, it | |
40 | * should call provider_done. Do NOT call this if you have accepted or rejected | |
41 | * the client. | |
42 | * | |
89d22b9a EM |
43 | * Eventually, stuff like *:line handling will be moved here, but that means we |
44 | * have to talk to bandb directly first. | |
45 | * | |
2b0cc3d3 EM |
46 | * --Elizafox, 9 March 2016 |
47 | */ | |
48 | ||
52d49164 | 49 | #include "stdinc.h" |
a71b65b1 | 50 | #include "rb_dictionary.h" |
d955cd9f | 51 | #include "rb_lib.h" |
2b0cc3d3 EM |
52 | #include "authd.h" |
53 | #include "provider.h" | |
db821ee9 | 54 | #include "notice.h" |
2b0cc3d3 | 55 | |
15c49abb EM |
56 | static EVH provider_timeout_event; |
57 | ||
a71b65b1 | 58 | rb_dictionary *auth_clients; |
d955cd9f | 59 | rb_dlink_list auth_providers; |
2b0cc3d3 | 60 | |
731d1289 EM |
61 | static rb_dlink_list free_pids; |
62 | static uint32_t pid; | |
15c49abb EM |
63 | static struct ev_entry *timeout_ev; |
64 | ||
731d1289 EM |
65 | /* Initalise all providers */ |
66 | void | |
67 | init_providers(void) | |
68 | { | |
a71b65b1 | 69 | auth_clients = rb_dictionary_create("pending auth clients", rb_uint32cmp); |
731d1289 EM |
70 | timeout_ev = rb_event_addish("provider_timeout_event", provider_timeout_event, NULL, 1); |
71 | ||
72 | load_provider(&rdns_provider); | |
73 | load_provider(&ident_provider); | |
74 | load_provider(&blacklist_provider); | |
75 | load_provider(&opm_provider); | |
76 | } | |
77 | ||
78 | /* Terminate all providers */ | |
79 | void | |
80 | destroy_providers(void) | |
81 | { | |
d955cd9f | 82 | rb_dlink_node *ptr, *nptr; |
a71b65b1 AC |
83 | rb_dictionary_iter iter; |
84 | struct auth_client *auth; | |
85 | struct auth_provider *provider; | |
731d1289 EM |
86 | |
87 | /* Cancel outstanding connections */ | |
a71b65b1 | 88 | RB_DICTIONARY_FOREACH(auth, &iter, auth_clients) |
731d1289 | 89 | { |
a71b65b1 | 90 | /* TBD - is this the right thing? */ |
4434f375 EM |
91 | reject_client(auth, UINT32_MAX, "destroy", |
92 | "Authentication system is down... try reconnecting in a few seconds"); | |
731d1289 EM |
93 | } |
94 | ||
d955cd9f | 95 | RB_DLINK_FOREACH_SAFE(ptr, nptr, auth_providers.head) |
731d1289 | 96 | { |
d955cd9f SA |
97 | struct auth_provider *provider = ptr->data; |
98 | ||
731d1289 EM |
99 | if(provider->destroy) |
100 | provider->destroy(); | |
d955cd9f SA |
101 | |
102 | rb_dlinkDelete(ptr, &auth_providers); | |
731d1289 EM |
103 | } |
104 | ||
a71b65b1 | 105 | rb_dictionary_destroy(auth_clients, NULL, NULL); |
731d1289 EM |
106 | rb_event_delete(timeout_ev); |
107 | } | |
108 | ||
2b0cc3d3 | 109 | /* Load a provider */ |
60374ac9 EM |
110 | void |
111 | load_provider(struct auth_provider *provider) | |
2b0cc3d3 | 112 | { |
731d1289 EM |
113 | /* Assign a PID */ |
114 | if(rb_dlink_list_length(&free_pids) > 0) | |
b2ede1aa | 115 | { |
731d1289 EM |
116 | /* use the free list */ |
117 | provider->id = RB_POINTER_TO_UINT(free_pids.head->data); | |
118 | rb_dlinkDestroy(free_pids.head, &free_pids); | |
b2ede1aa | 119 | } |
731d1289 | 120 | else |
4434f375 EM |
121 | { |
122 | if(pid == UINT32_MAX) | |
123 | { | |
124 | /* If this happens, well, I don't know what to say. Probably a bug. | |
125 | * In any case, UINT32_MAX is a special sentinel. */ | |
126 | warn_opers(L_WARN, "Cannot load additional provider, max reached!"); | |
127 | return; | |
128 | } | |
129 | ||
731d1289 | 130 | provider->id = pid++; |
4434f375 | 131 | } |
3e875f62 | 132 | |
a51487e0 EM |
133 | if(provider->opt_handlers != NULL) |
134 | { | |
135 | struct auth_opts_handler *handler; | |
136 | ||
137 | for(handler = provider->opt_handlers; handler->option != NULL; handler++) | |
138 | rb_dictionary_add(authd_option_handlers, handler->option, handler); | |
139 | } | |
140 | ||
ee7f9271 | 141 | if(provider->stats_handler.letter != '\0') |
1729f46e | 142 | authd_stat_handlers[(unsigned char)provider->stats_handler.letter] = provider->stats_handler.handler; |
ee7f9271 | 143 | |
9f9ab5c2 EM |
144 | if(provider->init != NULL) |
145 | provider->init(); | |
146 | ||
d955cd9f | 147 | rb_dlinkAdd(provider, &provider->node, &auth_providers); |
2b0cc3d3 EM |
148 | } |
149 | ||
60374ac9 EM |
150 | void |
151 | unload_provider(struct auth_provider *provider) | |
2b0cc3d3 | 152 | { |
a51487e0 EM |
153 | if(provider->opt_handlers != NULL) |
154 | { | |
155 | struct auth_opts_handler *handler; | |
156 | ||
157 | for(handler = provider->opt_handlers; handler->option != NULL; handler++) | |
158 | rb_dictionary_delete(authd_option_handlers, handler->option); | |
159 | } | |
ee7f9271 EM |
160 | |
161 | if(provider->stats_handler.letter != '\0') | |
1729f46e | 162 | authd_stat_handlers[(unsigned char)provider->stats_handler.letter] = NULL; |
ee7f9271 | 163 | |
9f9ab5c2 EM |
164 | if(provider->destroy != NULL) |
165 | provider->destroy(); | |
166 | ||
d955cd9f | 167 | rb_dlinkDelete(&provider->node, &auth_providers); |
2b0cc3d3 | 168 | |
731d1289 EM |
169 | /* Reclaim ID */ |
170 | rb_dlinkAddAlloc(RB_UINT_TO_POINTER(provider->id), &free_pids); | |
2b0cc3d3 EM |
171 | } |
172 | ||
b585278b AC |
173 | void |
174 | auth_client_free(struct auth_client *auth) | |
175 | { | |
176 | rb_dictionary_delete(auth_clients, RB_UINT_TO_POINTER(auth->cid)); | |
177 | rb_free(auth->data); | |
178 | rb_free(auth); | |
179 | } | |
2b0cc3d3 | 180 | |
b585278b | 181 | /* Cancel outstanding providers for a client (if any). */ |
60374ac9 EM |
182 | void |
183 | cancel_providers(struct auth_client *auth) | |
2b0cc3d3 | 184 | { |
4434f375 | 185 | if(auth->refcount > 0) |
2b0cc3d3 | 186 | { |
d955cd9f | 187 | rb_dlink_node *ptr; |
4434f375 | 188 | |
d955cd9f | 189 | RB_DLINK_FOREACH(ptr, auth_providers.head) |
4434f375 | 190 | { |
d955cd9f SA |
191 | struct auth_provider *provider = ptr->data; |
192 | ||
4434f375 EM |
193 | if(provider->cancel != NULL && is_provider_running(auth, provider->id)) |
194 | /* Cancel if required */ | |
195 | provider->cancel(auth); | |
196 | } | |
2b0cc3d3 EM |
197 | } |
198 | } | |
199 | ||
45e6c746 EM |
200 | /* Provider is done |
201 | * WARNING: do not use auth instance after calling! */ | |
60374ac9 | 202 | void |
731d1289 | 203 | provider_done(struct auth_client *auth, uint32_t id) |
2b0cc3d3 | 204 | { |
d955cd9f | 205 | rb_dlink_node *ptr; |
2b0cc3d3 | 206 | |
4434f375 EM |
207 | lrb_assert(is_provider_running(auth, id)); |
208 | lrb_assert(id != UINT32_MAX); | |
209 | lrb_assert(id <= pid); | |
210 | ||
211 | set_provider_done(auth, id); | |
212 | ||
213 | if(auth->refcount == 0 && !auth->providers_starting) | |
2b0cc3d3 | 214 | { |
4434f375 | 215 | /* All done */ |
3b0b4037 | 216 | accept_client(auth, UINT32_MAX); |
2b0cc3d3 EM |
217 | return; |
218 | } | |
219 | ||
d955cd9f | 220 | RB_DLINK_FOREACH(ptr, auth_providers.head) |
2b0cc3d3 | 221 | { |
d955cd9f SA |
222 | struct auth_provider *provider = ptr->data; |
223 | ||
376ae2e2 | 224 | if(provider->completed != NULL && is_provider_running(auth, provider->id)) |
2b0cc3d3 EM |
225 | /* Notify pending clients who asked for it */ |
226 | provider->completed(auth, id); | |
227 | } | |
228 | } | |
229 | ||
4434f375 | 230 | /* Reject a client and cancel any outstanding providers |
45e6c746 | 231 | * WARNING: do not use auth instance after calling! */ |
60374ac9 | 232 | void |
731d1289 | 233 | reject_client(struct auth_client *auth, uint32_t id, const char *data, const char *fmt, ...) |
2b0cc3d3 | 234 | { |
45e6c746 | 235 | unsigned int refcount = auth->refcount; |
64afc358 EM |
236 | char buf[BUFSIZE]; |
237 | va_list args; | |
2b0cc3d3 | 238 | |
a5ab1062 | 239 | va_start(args, fmt); |
64afc358 EM |
240 | vsnprintf(buf, sizeof(buf), fmt, args); |
241 | va_end(args); | |
242 | ||
3ad21f61 EM |
243 | /* We send back username and hostname in case ircd wants to overrule our decision. |
244 | * In the future this may not be the case. | |
245 | * --Elizafox | |
246 | */ | |
731d1289 EM |
247 | rb_helper_write(authd_helper, "R %x %c %s %s %s :%s", |
248 | auth->cid, auth->data[id].provider->letter, | |
249 | auth->username, auth->hostname, | |
4434f375 | 250 | data == NULL ? "*" : data, buf); |
2b0cc3d3 | 251 | |
4434f375 EM |
252 | if(id != UINT32_MAX) |
253 | set_provider_done(auth, id); | |
254 | ||
255 | cancel_providers(auth); | |
2b0cc3d3 EM |
256 | } |
257 | ||
4434f375 | 258 | /* Accept a client and cancel outstanding providers if any |
45e6c746 | 259 | * WARNING: do not use auth instance after calling! */ |
60374ac9 | 260 | void |
731d1289 | 261 | accept_client(struct auth_client *auth, uint32_t id) |
2b0cc3d3 | 262 | { |
45e6c746 EM |
263 | unsigned int refcount = auth->refcount; |
264 | ||
2b0cc3d3 EM |
265 | rb_helper_write(authd_helper, "A %x %s %s", auth->cid, auth->username, auth->hostname); |
266 | ||
4434f375 EM |
267 | if(id != UINT32_MAX) |
268 | set_provider_done(auth, id); | |
269 | ||
270 | cancel_providers(auth); | |
2b0cc3d3 EM |
271 | } |
272 | ||
2b0cc3d3 | 273 | /* Begin authenticating user */ |
60374ac9 EM |
274 | static void |
275 | start_auth(const char *cid, const char *l_ip, const char *l_port, const char *c_ip, const char *c_port) | |
2b0cc3d3 | 276 | { |
3e875f62 | 277 | struct auth_client *auth = rb_malloc(sizeof(struct auth_client)); |
2b0cc3d3 | 278 | long lcid = strtol(cid, NULL, 16); |
d955cd9f | 279 | rb_dlink_node *ptr; |
2b0cc3d3 | 280 | |
3e875f62 | 281 | if(lcid >= UINT32_MAX) |
2b0cc3d3 EM |
282 | return; |
283 | ||
3e875f62 | 284 | auth->cid = (uint32_t)lcid; |
2b0cc3d3 | 285 | |
a71b65b1 AC |
286 | if(rb_dictionary_find(auth_clients, RB_UINT_TO_POINTER(auth->cid)) == NULL) |
287 | rb_dictionary_add(auth_clients, RB_UINT_TO_POINTER(auth->cid), auth); | |
05fdc030 EM |
288 | else |
289 | { | |
c23f9755 EM |
290 | warn_opers(L_CRIT, "provider: duplicate client added via start_auth: %x", auth->cid); |
291 | exit(EX_PROVIDER_ERROR); | |
05fdc030 EM |
292 | } |
293 | ||
2b0cc3d3 EM |
294 | rb_strlcpy(auth->l_ip, l_ip, sizeof(auth->l_ip)); |
295 | auth->l_port = (uint16_t)atoi(l_port); /* should be safe */ | |
32f8c78b | 296 | (void) rb_inet_pton_sock(l_ip, (struct sockaddr *)&auth->l_addr); |
d86692fa | 297 | SET_SS_PORT(&auth->l_addr, htons(auth->l_port)); |
2b0cc3d3 EM |
298 | |
299 | rb_strlcpy(auth->c_ip, c_ip, sizeof(auth->c_ip)); | |
300 | auth->c_port = (uint16_t)atoi(c_port); | |
32f8c78b | 301 | (void) rb_inet_pton_sock(c_ip, (struct sockaddr *)&auth->c_addr); |
d86692fa | 302 | SET_SS_PORT(&auth->c_addr, htons(auth->c_port)); |
2b0cc3d3 | 303 | |
1345a41d EM |
304 | rb_strlcpy(auth->hostname, "*", sizeof(auth->hostname)); |
305 | rb_strlcpy(auth->username, "*", sizeof(auth->username)); | |
306 | ||
d955cd9f SA |
307 | /* FIXME this is unsafe, the list being allocated needs to |
308 | * support the maximum PID allocated, not just the current | |
309 | * length of auth_providers */ | |
310 | auth->data = rb_malloc(rb_dlink_list_length(&auth_providers) * | |
a68d9a2b | 311 | sizeof(struct auth_client_data)); |
0cff7adb | 312 | |
05fdc030 | 313 | auth->providers_starting = true; |
d955cd9f | 314 | RB_DLINK_FOREACH(ptr, auth_providers.head) |
2b0cc3d3 | 315 | { |
d955cd9f SA |
316 | struct auth_provider *provider = ptr->data; |
317 | ||
731d1289 | 318 | auth->data[provider->id].provider = provider; |
2b0cc3d3 | 319 | |
05fdc030 EM |
320 | lrb_assert(provider->start != NULL); |
321 | ||
2b0cc3d3 EM |
322 | /* Execute providers */ |
323 | if(!provider->start(auth)) | |
2b0cc3d3 | 324 | /* Rejected immediately */ |
2b0cc3d3 | 325 | return; |
2b0cc3d3 | 326 | } |
05fdc030 | 327 | auth->providers_starting = false; |
2b0cc3d3 EM |
328 | |
329 | /* If no providers are running, accept the client */ | |
4434f375 EM |
330 | if(auth->refcount == 0) |
331 | accept_client(auth, UINT32_MAX); | |
2b0cc3d3 EM |
332 | } |
333 | ||
334 | /* Callback for the initiation */ | |
60374ac9 EM |
335 | void |
336 | handle_new_connection(int parc, char *parv[]) | |
2b0cc3d3 | 337 | { |
0cff7adb | 338 | if(parc < 6) |
b2ede1aa | 339 | { |
c23f9755 EM |
340 | warn_opers(L_CRIT, "provider: received too few params for new connection (6 expected, got %d)", parc); |
341 | exit(EX_PROVIDER_ERROR); | |
b2ede1aa | 342 | } |
2b0cc3d3 EM |
343 | |
344 | start_auth(parv[1], parv[2], parv[3], parv[4], parv[5]); | |
345 | } | |
60374ac9 EM |
346 | |
347 | void | |
348 | handle_cancel_connection(int parc, char *parv[]) | |
349 | { | |
350 | struct auth_client *auth; | |
351 | long lcid; | |
352 | ||
353 | if(parc < 2) | |
354 | { | |
c23f9755 EM |
355 | warn_opers(L_CRIT, "provider: received too few params for new connection (2 expected, got %d)", parc); |
356 | exit(EX_PROVIDER_ERROR); | |
60374ac9 EM |
357 | } |
358 | ||
359 | if((lcid = strtol(parv[1], NULL, 16)) > UINT32_MAX) | |
360 | { | |
c23f9755 EM |
361 | warn_opers(L_CRIT, "provider: got a request to cancel a connection that can't exist: %lx", lcid); |
362 | exit(EX_PROVIDER_ERROR); | |
60374ac9 EM |
363 | } |
364 | ||
a71b65b1 | 365 | if((auth = rb_dictionary_retrieve(auth_clients, RB_UINT_TO_POINTER((uint32_t)lcid))) == NULL) |
60374ac9 | 366 | { |
5cbfed54 EM |
367 | /* This could happen as a race if we've accepted/rejected but they cancel, so don't die here. |
368 | * --Elizafox */ | |
a3b112f4 | 369 | return; |
60374ac9 EM |
370 | } |
371 | ||
372 | cancel_providers(auth); | |
373 | } | |
15c49abb EM |
374 | |
375 | static void | |
376 | provider_timeout_event(void *notused __unused) | |
377 | { | |
378 | struct auth_client *auth; | |
a71b65b1 | 379 | rb_dictionary_iter iter; |
15c49abb EM |
380 | const time_t curtime = rb_current_time(); |
381 | ||
a71b65b1 | 382 | RB_DICTIONARY_FOREACH(auth, &iter, auth_clients) |
15c49abb | 383 | { |
d955cd9f | 384 | rb_dlink_node *ptr; |
15c49abb | 385 | |
d955cd9f | 386 | RB_DLINK_FOREACH(ptr, auth_providers.head) |
15c49abb | 387 | { |
d955cd9f | 388 | struct auth_provider *provider = ptr->data; |
a68d9a2b | 389 | const time_t timeout = get_provider_timeout(auth, provider->id); |
15c49abb | 390 | |
376ae2e2 | 391 | if(is_provider_running(auth, provider->id) && provider->timeout != NULL && |
c23f9755 | 392 | timeout > 0 && timeout < curtime) |
15c49abb EM |
393 | { |
394 | provider->timeout(auth); | |
395 | } | |
396 | } | |
397 | } | |
398 | } |