1 /* authd/provider.c - authentication provider framework
2 * Copyright (c) 2016 Elizabeth Myers <elizabeth@interlinked.me>
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.
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.
21 /* The basic design here is to have "authentication providers" that do things
22 * like query ident and blacklists and even open proxies.
24 * Providers are registered in the auth_providers linked list. It is planned to
25 * use a bitmap to store provider ID's later.
27 * Providers can either return failure immediately, immediate acceptance, or do
28 * work in the background (calling set_provider to signal this).
30 * Provider-specific data for each client can be kept in an index of the data
31 * struct member (using the provider's ID).
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.
36 * Providers may kick clients off by rejecting them. Upon rejection, all
37 * providers are cancelled. They can also unconditionally accept them.
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
43 * Eventually, stuff like *:line handling will be moved here, but that means we
44 * have to talk to bandb directly first.
46 * --Elizafox, 9 March 2016
50 #include "rb_dictionary.h"
55 static EVH provider_timeout_event
;
57 rb_dlink_list auth_providers
;
60 rb_dictionary
*auth_clients
;
62 static struct ev_entry
*timeout_ev
;
66 load_provider(struct auth_provider
*provider
)
68 if(rb_dlink_list_length(&auth_providers
) >= MAX_PROVIDERS
)
70 warn_opers(L_WARN
, "provider: cannot load provider with id %d: maximum reached (%d)",
71 provider
->id
, MAX_PROVIDERS
);
75 if(provider
->opt_handlers
!= NULL
)
77 struct auth_opts_handler
*handler
;
79 for(handler
= provider
->opt_handlers
; handler
->option
!= NULL
; handler
++)
80 rb_dictionary_add(authd_option_handlers
, handler
->option
, handler
);
83 if(provider
->stats_handler
.letter
!= '\0')
84 authd_stat_handlers
[provider
->stats_handler
.letter
] = provider
->stats_handler
.handler
;
86 if(provider
->init
!= NULL
)
89 rb_dlinkAdd(provider
, &provider
->node
, &auth_providers
);
93 unload_provider(struct auth_provider
*provider
)
95 if(provider
->opt_handlers
!= NULL
)
97 struct auth_opts_handler
*handler
;
99 for(handler
= provider
->opt_handlers
; handler
->option
!= NULL
; handler
++)
100 rb_dictionary_delete(authd_option_handlers
, handler
->option
);
103 if(provider
->stats_handler
.letter
!= '\0')
104 authd_stat_handlers
[provider
->stats_handler
.letter
] = NULL
;
106 if(provider
->destroy
!= NULL
)
109 rb_dlinkDelete(&provider
->node
, &auth_providers
);
112 /* Initalise all providers */
116 auth_clients
= rb_dictionary_create("pending auth clients", rb_uint32cmp
);
117 timeout_ev
= rb_event_addish("provider_timeout_event", provider_timeout_event
, NULL
, 1);
118 load_provider(&rdns_provider
);
119 load_provider(&ident_provider
);
120 load_provider(&blacklist_provider
);
121 load_provider(&opm_provider
);
124 /* Terminate all providers */
126 destroy_providers(void)
129 rb_dictionary_iter iter
;
130 struct auth_client
*auth
;
131 struct auth_provider
*provider
;
133 /* Cancel outstanding connections */
134 RB_DICTIONARY_FOREACH(auth
, &iter
, auth_clients
)
136 /* TBD - is this the right thing? */
137 reject_client(auth
, -1, "destroy", "Authentication system is down... try reconnecting in a few seconds");
140 RB_DLINK_FOREACH(ptr
, auth_providers
.head
)
142 provider
= ptr
->data
;
144 if(provider
->destroy
)
148 rb_event_delete(timeout_ev
);
151 /* Cancel outstanding providers for a client */
153 cancel_providers(struct auth_client
*auth
)
156 struct auth_provider
*provider
;
158 RB_DLINK_FOREACH(ptr
, auth_providers
.head
)
160 provider
= ptr
->data
;
162 if(provider
->cancel
&& is_provider_on(auth
, provider
->id
))
163 /* Cancel if required */
164 provider
->cancel(auth
);
167 rb_dictionary_delete(auth_clients
, RB_UINT_TO_POINTER(auth
->cid
));
171 /* Provider is done - WARNING: do not use auth instance after calling! */
173 provider_done(struct auth_client
*auth
, provider_t id
)
176 struct auth_provider
*provider
;
178 set_provider_off(auth
, id
);
179 set_provider_done(auth
, id
);
183 if(!auth
->providers_starting
)
184 /* Only do this when there are no providers left */
185 accept_client(auth
, -1);
189 RB_DLINK_FOREACH(ptr
, auth_providers
.head
)
191 provider
= ptr
->data
;
193 if(provider
->completed
!= NULL
&& is_provider_on(auth
, provider
->id
))
194 /* Notify pending clients who asked for it */
195 provider
->completed(auth
, id
);
199 /* Reject a client - WARNING: do not use auth instance after calling! */
201 reject_client(struct auth_client
*auth
, provider_t id
, const char *data
, const char *fmt
, ...)
215 case PROVIDER_BLACKLIST
:
230 vsnprintf(buf
, sizeof(buf
), fmt
, args
);
233 /* We send back username and hostname in case ircd wants to overrule our decision.
234 * In the future this may not be the case.
237 rb_helper_write(authd_helper
, "R %x %c %s %s %s :%s", auth
->cid
, reject
, auth
->username
, auth
->hostname
, data
, buf
);
239 set_provider_off(auth
, id
);
240 cancel_providers(auth
);
243 /* Accept a client, cancel outstanding providers if any - WARNING: do nto use auth instance after calling! */
245 accept_client(struct auth_client
*auth
, provider_t id
)
247 rb_helper_write(authd_helper
, "A %x %s %s", auth
->cid
, auth
->username
, auth
->hostname
);
249 set_provider_off(auth
, id
);
250 cancel_providers(auth
);
253 /* Begin authenticating user */
255 start_auth(const char *cid
, const char *l_ip
, const char *l_port
, const char *c_ip
, const char *c_port
)
257 struct auth_provider
*provider
;
258 struct auth_client
*auth
= rb_malloc(sizeof(struct auth_client
));
259 long lcid
= strtol(cid
, NULL
, 16);
262 if(lcid
>= UINT32_MAX
)
265 auth
->cid
= (uint32_t)lcid
;
267 if(rb_dictionary_find(auth_clients
, RB_UINT_TO_POINTER(auth
->cid
)) == NULL
)
268 rb_dictionary_add(auth_clients
, RB_UINT_TO_POINTER(auth
->cid
), auth
);
271 warn_opers(L_CRIT
, "provider: duplicate client added via start_auth: %x", auth
->cid
);
272 exit(EX_PROVIDER_ERROR
);
275 rb_strlcpy(auth
->l_ip
, l_ip
, sizeof(auth
->l_ip
));
276 auth
->l_port
= (uint16_t)atoi(l_port
); /* should be safe */
277 (void) rb_inet_pton_sock(l_ip
, (struct sockaddr
*)&auth
->l_addr
);
278 SET_SS_PORT(&auth
->l_addr
, htons(auth
->l_port
));
280 rb_strlcpy(auth
->c_ip
, c_ip
, sizeof(auth
->c_ip
));
281 auth
->c_port
= (uint16_t)atoi(c_port
);
282 (void) rb_inet_pton_sock(c_ip
, (struct sockaddr
*)&auth
->c_addr
);
283 SET_SS_PORT(&auth
->c_addr
, htons(auth
->c_port
));
285 rb_strlcpy(auth
->hostname
, "*", sizeof(auth
->hostname
));
286 rb_strlcpy(auth
->username
, "*", sizeof(auth
->username
));
288 memset(auth
->data
, 0, sizeof(auth
->data
));
290 auth
->providers_starting
= true;
291 RB_DLINK_FOREACH(ptr
, auth_providers
.head
)
293 provider
= ptr
->data
;
295 lrb_assert(provider
->start
!= NULL
);
297 /* Execute providers */
298 if(!provider
->start(auth
))
300 /* Rejected immediately */
301 cancel_providers(auth
);
305 auth
->providers_starting
= false;
307 /* If no providers are running, accept the client */
309 accept_client(auth
, -1);
312 /* Callback for the initiation */
314 handle_new_connection(int parc
, char *parv
[])
318 warn_opers(L_CRIT
, "provider: received too few params for new connection (6 expected, got %d)", parc
);
319 exit(EX_PROVIDER_ERROR
);
322 start_auth(parv
[1], parv
[2], parv
[3], parv
[4], parv
[5]);
326 handle_cancel_connection(int parc
, char *parv
[])
328 struct auth_client
*auth
;
333 warn_opers(L_CRIT
, "provider: received too few params for new connection (2 expected, got %d)", parc
);
334 exit(EX_PROVIDER_ERROR
);
337 if((lcid
= strtol(parv
[1], NULL
, 16)) > UINT32_MAX
)
339 warn_opers(L_CRIT
, "provider: got a request to cancel a connection that can't exist: %lx", lcid
);
340 exit(EX_PROVIDER_ERROR
);
343 if((auth
= rb_dictionary_retrieve(auth_clients
, RB_UINT_TO_POINTER((uint32_t)lcid
))) == NULL
)
345 /* This could happen as a race if we've accepted/rejected but they cancel, so don't die here.
350 cancel_providers(auth
);
354 provider_timeout_event(void *notused __unused
)
356 struct auth_client
*auth
;
357 rb_dictionary_iter iter
;
358 const time_t curtime
= rb_current_time();
360 RB_DICTIONARY_FOREACH(auth
, &iter
, auth_clients
)
364 RB_DLINK_FOREACH(ptr
, auth_providers
.head
)
366 struct auth_provider
*provider
= ptr
->data
;
367 const time_t timeout
= auth
->timeout
[provider
->id
];
369 if(is_provider_on(auth
, provider
->id
) && provider
->timeout
!= NULL
&&
370 timeout
> 0 && timeout
< curtime
)
372 provider
->timeout(auth
);