2 * Copyright (c) 2016, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of JANET(UK) nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
31 * OF THE POSSIBILITY OF SUCH DAMAGE.
37 #include <trust_router/tr_dh.h>
38 #include <tid_internal.h>
39 #include <tr_filter.h>
46 #include <trp_internal.h>
47 #include <tr_config.h>
52 /* Structure to hold data for the tid response callback */
53 typedef struct tr_resp_cookie {
58 /* hold a tids instance and a config manager */
59 struct tr_tids_event_cookie {
65 static void tr_tidc_resp_handler(TIDC_INSTANCE *tidc,
70 TR_RESP_COOKIE *cookie=talloc_get_type_abort(resp_cookie, TR_RESP_COOKIE);
72 tr_debug("tr_tidc_resp_handler: Response received! Realm = %s, Community = %s.",
76 cookie->resp=tid_resp_dup(cookie, resp);
79 /* data for AAA req forwarding threads */
80 struct tr_tids_fwd_cookie {
82 pthread_mutex_t mutex; /* lock on the mq (separate from the locking within the mq, see below) */
83 TR_MQ *mq; /* messages from thread to main process; set to NULL to disable response */
84 TR_NAME *aaa_hostname;
86 TID_REQ *fwd_req; /* the req to duplicate */
89 static int tr_tids_fwd_cookie_destructor(void *obj)
91 struct tr_tids_fwd_cookie *c=talloc_get_type_abort(obj, struct tr_tids_fwd_cookie);
92 if (c->aaa_hostname!=NULL)
93 tr_free_name(c->aaa_hostname);
94 if (c->dh_params!=NULL)
95 tr_destroy_dh_params(c->dh_params);
99 /* Block until we get the lock, returns 0 on success.
100 * The mutex is used to protect changes to the mq pointer in
101 * a thread's cookie. The master thread sets this to null to indicate
102 * that it has abandoned the thread and the message queue is no longer
103 * valid. This is unrelated to the locking in the message queue
104 * implementation itself. */
105 static int tr_tids_fwd_get_mutex(struct tr_tids_fwd_cookie *cookie)
110 return (pthread_mutex_lock(&(cookie->mutex)));
113 static int tr_tids_fwd_release_mutex(struct tr_tids_fwd_cookie *cookie)
118 return (pthread_mutex_unlock(&(cookie->mutex)));
121 /* values for messages */
122 #define TR_TID_MQMSG_SUCCESS "tid success"
123 #define TR_TID_MQMSG_FAILURE "tid failure"
125 /* Thread main for sending and receiving a request to a single AAA server */
126 static void *tr_tids_req_fwd_thread(void *arg)
128 TALLOC_CTX *tmp_ctx=talloc_new(NULL);
129 struct tr_tids_fwd_cookie *args=talloc_get_type_abort(arg, struct tr_tids_fwd_cookie);
130 TIDC_INSTANCE *tidc=tidc_create(tmp_ctx);
132 TR_RESP_COOKIE *cookie=NULL;
136 talloc_steal(tmp_ctx, args); /* take responsibility for the cookie */
138 /* create the cookie we will use for our response */
139 cookie=talloc(tmp_ctx, TR_RESP_COOKIE);
141 tr_notice("tr_tids_req_fwd_thread: unable to allocate response cookie.");
145 cookie->thread_id=args->thread_id;
147 /* Create a TID client instance */
149 tr_crit("tr_tids_req_fwd_thread: Unable to allocate TIDC instance.");
150 /*tids_send_err_response(tids, orig_req, "Memory allocation failure");*/
151 /* TODO: encode reason for failure */
156 /* Set-up TID connection */
157 if (-1==(args->fwd_req->conn = tidc_open_connection(tidc,
158 args->aaa_hostname->buf,
159 TID_PORT, /* TODO: make this configurable */
160 &(args->fwd_req->gssctx)))) {
161 tr_notice("tr_tids_req_fwd_thread: Error in tidc_open_connection.");
162 /* tids_send_err_response(tids, orig_req, "Can't open connection to next hop TIDS"); */
163 /* TODO: encode reason for failure */
168 /* Send a TID request. */
169 if (0 > (rc = tidc_fwd_request(tidc, args->fwd_req, tr_tidc_resp_handler, (void *)cookie))) {
170 tr_notice("Error from tidc_fwd_request, rc = %d.", rc);
174 /* cookie->resp should now contain our copy of the response */
178 /* Notify parent thread of the response, if it's still listening. */
179 if (0!=tr_tids_fwd_get_mutex(args)) {
180 tr_notice("tr_tids_req_fwd_thread: Error acquiring mutex.");
181 } else if (NULL!=args->mq) {
182 /* mq is still valid, so we can queue our response */
184 msg=tr_mq_msg_new(tmp_ctx, TR_TID_MQMSG_SUCCESS, TR_MQ_PRIO_NORMAL);
186 msg=tr_mq_msg_new(tmp_ctx, TR_TID_MQMSG_FAILURE, TR_MQ_PRIO_NORMAL);
189 tr_notice("tr_tids_req_fwd_thread: unable to allocate response msg.");
191 tr_mq_msg_set_payload(msg, (void *)cookie, NULL);
193 talloc_steal(msg, cookie); /* attach this to the msg so we can forget about it */
194 tr_mq_add(args->mq, msg);
195 talloc_steal(NULL, args); /* take out of our tmp_ctx; master thread now responsible for freeing */
196 if (0!=tr_tids_fwd_release_mutex(args))
197 tr_notice("tr_tids_req_fwd_thread: Error releasing mutex.");
200 talloc_free(tmp_ctx);
204 /* Merges r2 into r1 if they are compatible. */
205 static TID_RC tr_tids_merge_resps(TID_RESP *r1, TID_RESP *r2)
207 /* ensure these are compatible replies */
208 if ((r1->result!=TID_SUCCESS) || (r2->result!=TID_SUCCESS))
211 if ((0!=tr_name_cmp(r1->rp_realm, r2->rp_realm)) ||
212 (0!=tr_name_cmp(r1->realm, r2->realm)) ||
213 (0!=tr_name_cmp(r1->comm, r2->comm)))
216 tid_srvr_blk_add(r1->servers, tid_srvr_blk_dup(r1, r2->servers));
220 static int tr_tids_req_handler(TIDS_INSTANCE *tids,
225 TALLOC_CTX *tmp_ctx=talloc_new(NULL);
226 TR_AAA_SERVER *aaa_servers=NULL, *this_aaa=NULL;
229 TR_AAA_SERVER_ITER *aaa_iter=NULL;
230 pthread_t aaa_thread[TR_TID_MAX_AAA_SERVERS];
231 struct tr_tids_fwd_cookie *aaa_cookie[TR_TID_MAX_AAA_SERVERS]={NULL};
233 TID_REQ *fwd_req = NULL;
234 TR_COMM *cfg_comm = NULL;
235 TR_COMM *cfg_apc = NULL;
236 int oaction = TR_FILTER_ACTION_REJECT;
237 time_t expiration_interval=0;
238 struct tr_tids_event_cookie *cookie=talloc_get_type_abort(cookie_in, struct tr_tids_event_cookie);
239 TR_CFG_MGR *cfg_mgr=cookie->cfg_mgr;
240 TRPS_INSTANCE *trps=cookie->trps;
241 TRP_ROUTE *route=NULL;
244 unsigned int n_responses=0;
245 unsigned int n_failed=0;
246 struct timespec ts_abort={0};
247 unsigned int resp_frac_numer=cfg_mgr->active->internal->tid_resp_numer;
248 unsigned int resp_frac_denom=cfg_mgr->active->internal->tid_resp_denom;
249 TR_RESP_COOKIE *payload=NULL;
253 if ((!tids) || (!orig_req) || (!resp)) {
254 tr_debug("tr_tids_req_handler: Bad parameters");
259 tr_debug("tr_tids_req_handler: Request received (conn = %d)! Realm = %s, Comm = %s", orig_req->conn,
260 orig_req->realm->buf, orig_req->comm->buf);
263 /* Duplicate the request, so we can modify and forward it */
264 if (NULL == (fwd_req=tid_dup_req(tmp_ctx, orig_req))) {
265 tr_debug("tr_tids_req_handler: Unable to duplicate request.");
270 if (NULL == (cfg_comm=tr_comm_table_find_comm(cfg_mgr->active->ctable, orig_req->comm))) {
271 tr_notice("tr_tids_req_hander: Request for unknown comm: %s.", orig_req->comm->buf);
272 tids_send_err_response(tids, orig_req, "Unknown community");
277 /* Check that the rp_realm matches the filter for the GSS name that
278 * was received. N.B. that tids->rp_gss was pointed at the correct
279 * rp_client when we received its GSS name. It is only set within
280 * the TIDS handler subprocess. */
282 if ((!tids->rp_gss) ||
283 (!tids->rp_gss->filter)) {
284 tr_notice("tr_tids_req_handler: No GSS name for incoming request.");
285 tids_send_err_response(tids, orig_req, "No GSS name for request");
290 if ((TR_FILTER_NO_MATCH == tr_filter_process_rp_permitted(orig_req->rp_realm,
291 tids->rp_gss->filter,
295 (TR_FILTER_ACTION_REJECT == oaction)) {
296 tr_notice("tr_tids_req_handler: RP realm (%s) does not match RP Realm filter for GSS name", orig_req->rp_realm->buf);
297 tids_send_err_response(tids, orig_req, "RP Realm filter error");
301 /* Check that the rp_realm is a member of the community in the request */
302 if (NULL == tr_comm_find_rp(cfg_mgr->active->ctable, cfg_comm, orig_req->rp_realm)) {
303 tr_notice("tr_tids_req_handler: RP Realm (%s) not member of community (%s).", orig_req->rp_realm->buf, orig_req->comm->buf);
304 tids_send_err_response(tids, orig_req, "RP COI membership error");
309 /* Map the comm in the request from a COI to an APC, if needed */
310 if (TR_COMM_COI == cfg_comm->type) {
311 if (orig_req->orig_coi!=NULL) {
312 tr_notice("tr_tids_req_handler: community %s is COI but COI to APC mapping already occurred. Dropping request.",
313 orig_req->comm->buf);
314 tids_send_err_response(tids, orig_req, "Second COI to APC mapping would result, permitted only once.");
319 tr_debug("tr_tids_req_handler: Community was a COI, switching.");
320 /* TBD -- In theory there can be more than one? How would that work? */
321 if ((!cfg_comm->apcs) || (!cfg_comm->apcs->id)) {
322 tr_notice("No valid APC for COI %s.", orig_req->comm->buf);
323 tids_send_err_response(tids, orig_req, "No valid APC for community");
327 apc = tr_dup_name(cfg_comm->apcs->id);
329 /* Check that the APC is configured */
330 if (NULL == (cfg_apc = tr_comm_table_find_comm(cfg_mgr->active->ctable, apc))) {
331 tr_notice("tr_tids_req_hander: Request for unknown comm: %s.", apc->buf);
332 tids_send_err_response(tids, orig_req, "Unknown APC");
338 fwd_req->orig_coi = orig_req->comm;
340 /* Check that rp_realm is a member of this APC */
341 if (NULL == (tr_comm_find_rp(cfg_mgr->active->ctable, cfg_apc, orig_req->rp_realm))) {
342 tr_notice("tr_tids_req_hander: RP Realm (%s) not member of community (%s).", orig_req->rp_realm->buf, orig_req->comm->buf);
343 tids_send_err_response(tids, orig_req, "RP APC membership error");
349 /* Look up the route for this community/realm. */
350 tr_debug("tr_tids_req_handler: looking up route.");
351 route=trps_get_selected_route(trps, orig_req->comm, orig_req->realm);
353 tr_notice("tr_tids_req_handler: no route table entry found for realm (%s) in community (%s).",
354 orig_req->realm->buf, orig_req->comm->buf);
355 tids_send_err_response(tids, orig_req, "Missing trust route error");
359 tr_debug("tr_tids_req_handler: found route.");
360 if (trp_route_is_local(route)) {
361 tr_debug("tr_tids_req_handler: route is local.");
362 aaa_servers = tr_idp_aaa_server_lookup(cfg_mgr->active->ctable->idp_realms,
367 tr_debug("tr_tids_req_handler: route not local.");
368 aaa_servers = tr_aaa_server_new(tmp_ctx, trp_route_get_next_hop(route));
372 /* Find the AAA server(s) for this request */
373 if (NULL == aaa_servers) {
374 tr_debug("tr_tids_req_handler: No AAA Servers for realm %s, defaulting.", orig_req->realm->buf);
375 if (NULL == (aaa_servers = tr_default_server_lookup (cfg_mgr->active->default_servers,
377 tr_notice("tr_tids_req_handler: No default AAA servers, discarded.");
378 tids_send_err_response(tids, orig_req, "No path to AAA Server(s) for realm");
384 /* if we aren't defaulting, check idp coi and apc membership */
385 if (NULL == (tr_comm_find_idp(cfg_mgr->active->ctable, cfg_comm, fwd_req->realm))) {
386 tr_notice("tr_tids_req_handler: IDP Realm (%s) not member of community (%s).", orig_req->realm->buf, orig_req->comm->buf);
387 tids_send_err_response(tids, orig_req, "IDP community membership error");
391 if ( cfg_apc && (NULL == (tr_comm_find_idp(cfg_mgr->active->ctable, cfg_apc, fwd_req->realm)))) {
392 tr_notice("tr_tids_req_handler: IDP Realm (%s) not member of APC (%s).", orig_req->realm->buf, orig_req->comm->buf);
393 tids_send_err_response(tids, orig_req, "IDP APC membership error");
399 /* send a TID request to the AAA server(s), and get the answer(s) */
401 expiration_interval = cfg_apc->expiration_interval;
402 else expiration_interval = cfg_comm->expiration_interval;
403 if (fwd_req->expiration_interval)
404 fwd_req->expiration_interval = (expiration_interval < fwd_req->expiration_interval) ? expiration_interval : fwd_req->expiration_interval;
405 else fwd_req->expiration_interval = expiration_interval;
407 /* Set up message queue for replies from req forwarding threads */
408 mq=tr_mq_new(tmp_ctx);
410 tr_notice("tr_tids_req_handler: unable to allocate message queue.");
416 aaa_iter=tr_aaa_server_iter_new(tmp_ctx);
417 if (aaa_iter==NULL) {
418 tr_notice("tr_tids_req_handler: unable to allocate AAA server iterator.");
422 for (n_aaa=0, this_aaa=tr_aaa_server_iter_first(aaa_iter, aaa_servers);
424 n_aaa++, this_aaa=tr_aaa_server_iter_next(aaa_iter)) {
425 aaa_cookie[n_aaa]=talloc(tmp_ctx, struct tr_tids_fwd_cookie);
426 if (aaa_cookie[n_aaa]==NULL) {
427 tr_notice("tr_tids_req_handler: unable to allocate cookie for AAA thread %d.", n_aaa);
431 talloc_set_destructor((void *)(aaa_cookie[n_aaa]), tr_tids_fwd_cookie_destructor);
432 /* fill in the cookie. To ensure the thread has valid data even if we exit first and
433 * abandon it, duplicate anything pointed to (except the mq). */
434 aaa_cookie[n_aaa]->thread_id=n_aaa;
435 if (0!=pthread_mutex_init(&(aaa_cookie[n_aaa]->mutex), NULL)) {
436 tr_notice("tr_tids_req_handler: unable to init mutex for AAA thread %d.", n_aaa);
440 aaa_cookie[n_aaa]->mq=mq;
441 aaa_cookie[n_aaa]->aaa_hostname=tr_dup_name(this_aaa->hostname);
442 aaa_cookie[n_aaa]->dh_params=tr_dh_dup(orig_req->tidc_dh);
443 aaa_cookie[n_aaa]->fwd_req=tid_dup_req(aaa_cookie[n_aaa], fwd_req);
445 /* Take the cookie out of tmp_ctx before starting thread. If thread starts, it becomes
446 * responsible for freeing it until it queues a response. */
447 talloc_steal(NULL, aaa_cookie[n_aaa]);
448 if (0!=pthread_create(&(aaa_thread[n_aaa]), NULL, tr_tids_req_fwd_thread, aaa_cookie[n_aaa])) {
449 talloc_steal(tmp_ctx, aaa_cookie[n_aaa]); /* thread start failed; steal this back */
450 tr_notice("tr_tids_req_handler: unable to start AAA thread %d.", n_aaa);
456 /* determine expiration time */
457 if (0!=tr_mq_pop_timeout(cfg_mgr->active->internal->tid_req_timeout, &ts_abort)) {
458 tr_notice("tr_tids_req_handler: unable to read clock for timeout.");
463 /* wait for responses */
466 while (((n_responses+n_failed)<n_aaa) &&
467 (NULL!=(msg=tr_mq_pop(mq, &ts_abort)))) {
468 /* process message */
469 if (0==strcmp(tr_mq_msg_get_message(msg), TR_TID_MQMSG_SUCCESS)) {
470 payload=talloc_get_type_abort(tr_mq_msg_get_payload(msg), TR_RESP_COOKIE);
471 if (payload->resp->result==TID_SUCCESS) {
472 tr_tids_merge_resps(resp, payload->resp);
476 tr_notice("tr_tids_req_handler: TID error received from AAA server %d: %.*s",
478 payload->resp->err_msg->len,
479 payload->resp->err_msg->buf);
481 } else if (0==strcmp(tr_mq_msg_get_message(msg), TR_TID_MQMSG_FAILURE)) {
484 payload=talloc_get_type(tr_mq_msg_get_payload(msg), TR_RESP_COOKIE);
486 /* this means the thread was unable to allocate a response cookie, and we thus cannot determine which thread it was. This is bad and should never happen in a working system.. Give up. */
487 tr_notice("tr_tids_req_handler: TID request thread sent invalid reply. Aborting!");
491 tr_notice("tr_tids_req_handler: TID request for AAA server %d failed.",
494 /* unexpected message */
495 tr_err("tr_tids_req_handler: Unexpected message received. Aborting!");
500 /* Now free the cookie for this thread. Null it so we know we've dealt with it. */
501 talloc_free(aaa_cookie[payload->thread_id]);
502 aaa_cookie[payload->thread_id]=NULL;
506 /* check whether we've received enough responses to exit */
507 if ((idp_shared && (n_responses>0)) ||
508 (resp_frac_denom*n_responses>=resp_frac_numer*n_aaa))
512 /* Inform any remaining threads that we will no longer handle their responses. */
513 for (ii=0; ii<n_aaa; ii++) {
514 if (aaa_cookie[ii]!=NULL) {
515 if (0!=tr_tids_fwd_get_mutex(aaa_cookie[ii]))
516 tr_notice("tr_tids_req_handler: unable to get mutex for AAA thread %d.", ii);
518 aaa_cookie[ii]->mq=NULL; /* threads will not try to respond through a null mq */
520 if (0!=tr_tids_fwd_release_mutex(aaa_cookie[ii]))
521 tr_notice("tr_tids_req_handler: unable to release mutex for AAA thread %d.", ii);
525 /* Now all threads have either replied (and aaa_cookie[ii] is null) or have been told not to
526 * reply (by setting their mq pointer to null). However, some may have responded by placing
527 * a message on the mq after we last checked but before we set their mq pointer to null. These
528 * will not know that we gave up on them, so we must free their cookies for them. We can just
529 * go through any remaining messages on the mq to identify these threads. */
530 while (NULL!=(msg=tr_mq_pop(mq, NULL))) {
531 payload=(TR_RESP_COOKIE *)tr_mq_msg_get_payload(msg);
532 if (aaa_cookie[payload->thread_id]!=NULL)
533 talloc_free(aaa_cookie[payload->thread_id]);
538 if (n_responses==0) {
539 tid_resp_set_result(resp, TID_ERROR);
540 tid_resp_set_err_msg(resp, tr_new_name("No successful response from AAA server(s)."));
541 tid_resp_set_error_path(resp, orig_req->path);
548 talloc_free(tmp_ctx);
552 static int tr_tids_gss_handler(gss_name_t client_name, TR_NAME *gss_name,
556 struct tr_tids_event_cookie *cookie=talloc_get_type_abort(data, struct tr_tids_event_cookie);
557 TIDS_INSTANCE *tids = cookie->tids;
558 TR_CFG_MGR *cfg_mgr = cookie->cfg_mgr;
560 if ((!client_name) || (!gss_name) || (!tids) || (!cfg_mgr)) {
561 tr_debug("tr_tidc_gss_handler: Bad parameters.");
565 /* look up the RP client matching the GSS name */
566 if ((NULL == (rp = tr_rp_client_lookup(cfg_mgr->active->rp_clients, gss_name)))) {
567 tr_debug("tr_tids_gss_handler: Unknown GSS name %s", gss_name->buf);
571 /* Store the rp client */
573 tr_debug("Client's GSS Name: %s", gss_name->buf);
579 /***** TIDS event handling *****/
581 /* called when a connection to the TIDS port is received */
582 static void tr_tids_event_cb(int listener, short event, void *arg)
584 TIDS_INSTANCE *tids = (TIDS_INSTANCE *)arg;
586 if (0==(event & EV_READ))
587 tr_debug("tr_tids_event_cb: unexpected event on TIDS socket (event=0x%X)", event);
589 tids_accept(tids, listener);
592 /* Configure the tids instance and set up its event handler.
593 * Returns 0 on success, nonzero on failure. Fills in
594 * *tids_event (which should be allocated by caller). */
595 int tr_tids_event_init(struct event_base *base,
599 struct tr_socket_event *tids_ev)
601 TALLOC_CTX *tmp_ctx=talloc_new(NULL);
602 struct tr_tids_event_cookie *cookie=NULL;
606 if (tids_ev == NULL) {
607 tr_debug("tr_tids_event_init: Null tids_ev.");
612 /* Create the cookie for callbacks. We'll put it in the tids context, so it will
613 * be cleaned up when tids is freed by talloc_free. */
614 cookie=talloc(tmp_ctx, struct tr_tids_event_cookie);
615 if (cookie == NULL) {
616 tr_debug("tr_tids_event_init: Unable to allocate cookie.");
621 cookie->cfg_mgr=cfg_mgr;
623 talloc_steal(tids, cookie);
625 /* get a tids listener */
626 tids_ev->n_sock_fd=tids_get_listener(tids,
629 cfg_mgr->active->internal->hostname,
630 cfg_mgr->active->internal->tids_port,
634 if (tids_ev->n_sock_fd==0) {
635 tr_crit("Error opening TID server socket.");
641 for (ii=0; ii<tids_ev->n_sock_fd; ii++) {
642 tids_ev->ev[ii]=event_new(base,
643 tids_ev->sock_fd[ii],
647 event_add(tids_ev->ev[ii], NULL);
651 talloc_free(tmp_ctx);