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);
80 /* Old one, obsolete. */
82 static void tr_tidc_resp_handler (TIDC_INSTANCE *tidc,
87 tr_debug("tr_tidc_resp_handler: Response received (conn = %d)! Realm = %s, Community = %s.", ((TR_RESP_COOKIE *)resp_cookie)->orig_req->conn, resp->realm->buf, resp->comm->buf);
90 /* TBD -- handle concatentation of multiple responses to single req */
91 tids_send_response(((TR_RESP_COOKIE *)resp_cookie)->tids,
92 ((TR_RESP_COOKIE *)resp_cookie)->orig_req,
100 /* data for AAA req forwarding threads */
101 struct tr_tids_fwd_cookie {
103 pthread_mutex_t mutex; /* lock on the mq (separate from the locking within the mq, see below) */
104 TR_MQ *mq; /* messages from thread to main process; set to NULL to disable response */
105 TR_NAME *aaa_hostname;
107 TID_REQ *fwd_req; /* the req to duplicate */
110 static int tr_tids_fwd_cookie_destructor(void *obj)
112 struct tr_tids_fwd_cookie *c=talloc_get_type_abort(obj, struct tr_tids_fwd_cookie);
113 if (c->aaa_hostname!=NULL)
114 tr_free_name(c->aaa_hostname);
115 if (c->dh_params!=NULL)
116 tr_destroy_dh_params(c->dh_params);
120 /* Block until we get the lock, returns 0 on success.
121 * The mutex is used to protect changes to the mq pointer in
122 * a thread's cookie. The master thread sets this to null to indicate
123 * that it has abandoned the thread and the message queue is no longer
124 * valid. This is unrelated to the locking in the message queue
125 * implementation itself. */
126 static int tr_tids_fwd_get_mutex(struct tr_tids_fwd_cookie *cookie)
131 return (pthread_mutex_lock(&(cookie->mutex)));
134 static int tr_tids_fwd_release_mutex(struct tr_tids_fwd_cookie *cookie)
139 return (pthread_mutex_unlock(&(cookie->mutex)));
142 /* values for messages */
143 #define TR_TID_MQMSG_SUCCESS "tid success"
144 #define TR_TID_MQMSG_FAILURE "tid failure"
146 /* Thread main for sending and receiving a request to a single AAA server */
147 static void *tr_tids_req_fwd_thread(void *arg)
149 TALLOC_CTX *tmp_ctx=talloc_new(NULL);
150 struct tr_tids_fwd_cookie *args=talloc_get_type_abort(arg, struct tr_tids_fwd_cookie);
151 TIDC_INSTANCE *tidc=tidc_create(tmp_ctx);
153 TR_RESP_COOKIE *cookie=NULL;
157 talloc_steal(tmp_ctx, args); /* take responsibility for the cookie */
159 /* Create a TID client instance */
161 tr_crit("tr_tids_req_fwd_thread: Unable to allocate TIDC instance.");
162 /*tids_send_err_response(tids, orig_req, "Memory allocation failure");*/
163 /* TODO: encode reason for failure */
168 /* Set-up TID connection */
169 if (-1==(args->fwd_req->conn = tidc_open_connection(tidc,
170 args->aaa_hostname->buf,
171 TID_PORT, /* TODO: make this configurable */
172 &(args->fwd_req->gssctx)))) {
173 tr_notice("tr_tids_req_fwd_thread: Error in tidc_open_connection.");
174 /* tids_send_err_response(tids, orig_req, "Can't open connection to next hop TIDS"); */
175 /* TODO: encode reason for failure */
180 /* Send a TID request. */
181 cookie=talloc(tmp_ctx, TR_RESP_COOKIE);
183 tr_notice("tr_tids_req_fwd_thread: unable to allocate response cookie.");
187 cookie->thread_id=args->thread_id;
188 if (0 > (rc = tidc_fwd_request(tidc, args->fwd_req, &tr_tidc_resp_handler, (void *)cookie))) {
189 tr_notice("Error from tidc_fwd_request, rc = %d.", rc);
193 /* cookie->resp should now contain our copy of the response */
197 /* Notify parent thread of the response, if it's still listening. */
198 if (0!=tr_tids_fwd_get_mutex(args)) {
199 tr_notice("tr_tids_req_fwd_thread: Error acquiring mutex.");
200 } else if (NULL!=args->mq) {
201 /* mq is still valid, so we can queue our response */
203 msg=tr_mq_msg_new(tmp_ctx, TR_TID_MQMSG_SUCCESS, TR_MQ_PRIO_NORMAL);
205 msg=tr_mq_msg_new(tmp_ctx, TR_TID_MQMSG_FAILURE, TR_MQ_PRIO_NORMAL);
208 tr_notice("tr_tids_req_fwd_thread: unable to allocate response msg.");
210 tr_mq_msg_set_payload(msg, (void *)cookie, NULL);
212 talloc_steal(msg, cookie); /* attach this to the msg so we can forget about it */
213 tr_mq_add(args->mq, msg);
214 talloc_steal(NULL, args); /* take out of our tmp_ctx; master thread now responsible for freeing */
215 if (0!=tr_tids_fwd_release_mutex(args))
216 tr_notice("tr_tids_req_fwd_thread: Error releasing mutex.");
219 talloc_free(tmp_ctx);
223 /* Merges r2 into r1 if they are compatible. */
224 static TID_RC tr_tids_merge_resps(TID_RESP *r1, TID_RESP *r2)
226 /* ensure these are compatible replies */
227 if ((r1->result!=TID_SUCCESS) || (r2->result!=TID_SUCCESS))
230 if ((0!=tr_name_cmp(r1->rp_realm, r2->rp_realm)) ||
231 (0!=tr_name_cmp(r1->realm, r2->realm)) ||
232 (0!=tr_name_cmp(r1->comm, r2->comm)))
235 tid_srvr_blk_add(r1->servers, tid_srvr_blk_dup(r1, r2->servers));
239 static int tr_tids_req_handler(TIDS_INSTANCE *tids,
244 TALLOC_CTX *tmp_ctx=talloc_new(NULL);
245 TR_AAA_SERVER *aaa_servers=NULL, *this_aaa=NULL;
248 TR_AAA_SERVER_ITER *aaa_iter=NULL;
249 pthread_t aaa_thread[TR_TID_MAX_AAA_SERVERS];
250 struct tr_tids_fwd_cookie *aaa_cookie[TR_TID_MAX_AAA_SERVERS]={NULL};
252 TID_REQ *fwd_req = NULL;
253 TR_COMM *cfg_comm = NULL;
254 TR_COMM *cfg_apc = NULL;
255 int oaction = TR_FILTER_ACTION_REJECT;
256 time_t expiration_interval=0;
257 struct tr_tids_event_cookie *cookie=talloc_get_type_abort(cookie_in, struct tr_tids_event_cookie);
258 TR_CFG_MGR *cfg_mgr=cookie->cfg_mgr;
259 TRPS_INSTANCE *trps=cookie->trps;
260 TRP_ROUTE *route=NULL;
263 unsigned int n_responses=0;
264 unsigned int n_failed=0;
265 struct timespec ts_abort={0};
266 unsigned int resp_frac_numer=cfg_mgr->active->internal->tid_resp_numer;
267 unsigned int resp_frac_denom=cfg_mgr->active->internal->tid_resp_denom;
268 TR_RESP_COOKIE *payload=NULL;
272 if ((!tids) || (!orig_req) || (!resp)) {
273 tr_debug("tr_tids_req_handler: Bad parameters");
278 tr_debug("tr_tids_req_handler: Request received (conn = %d)! Realm = %s, Comm = %s", orig_req->conn,
279 orig_req->realm->buf, orig_req->comm->buf);
282 /* Duplicate the request, so we can modify and forward it */
283 if (NULL == (fwd_req=tid_dup_req(tmp_ctx, orig_req))) {
284 tr_debug("tr_tids_req_handler: Unable to duplicate request.");
289 if (NULL == (cfg_comm=tr_comm_table_find_comm(cfg_mgr->active->ctable, orig_req->comm))) {
290 tr_notice("tr_tids_req_hander: Request for unknown comm: %s.", orig_req->comm->buf);
291 tids_send_err_response(tids, orig_req, "Unknown community");
296 /* Check that the rp_realm matches the filter for the GSS name that
297 * was received. N.B. that tids->rp_gss was pointed at the correct
298 * rp_client when we received its GSS name. It is only set within
299 * the TIDS handler subprocess. */
301 if ((!tids->rp_gss) ||
302 (!tids->rp_gss->filter)) {
303 tr_notice("tr_tids_req_handler: No GSS name for incoming request.");
304 tids_send_err_response(tids, orig_req, "No GSS name for request");
309 if ((TR_FILTER_NO_MATCH == tr_filter_process_rp_permitted(orig_req->rp_realm,
310 tids->rp_gss->filter,
314 (TR_FILTER_ACTION_REJECT == oaction)) {
315 tr_notice("tr_tids_req_handler: RP realm (%s) does not match RP Realm filter for GSS name", orig_req->rp_realm->buf);
316 tids_send_err_response(tids, orig_req, "RP Realm filter error");
320 /* Check that the rp_realm is a member of the community in the request */
321 if (NULL == tr_comm_find_rp(cfg_mgr->active->ctable, cfg_comm, orig_req->rp_realm)) {
322 tr_notice("tr_tids_req_handler: RP Realm (%s) not member of community (%s).", orig_req->rp_realm->buf, orig_req->comm->buf);
323 tids_send_err_response(tids, orig_req, "RP COI membership error");
328 /* Map the comm in the request from a COI to an APC, if needed */
329 if (TR_COMM_COI == cfg_comm->type) {
330 if (orig_req->orig_coi!=NULL) {
331 tr_notice("tr_tids_req_handler: community %s is COI but COI to APC mapping already occurred. Dropping request.",
332 orig_req->comm->buf);
333 tids_send_err_response(tids, orig_req, "Second COI to APC mapping would result, permitted only once.");
338 tr_debug("tr_tids_req_handler: Community was a COI, switching.");
339 /* TBD -- In theory there can be more than one? How would that work? */
340 if ((!cfg_comm->apcs) || (!cfg_comm->apcs->id)) {
341 tr_notice("No valid APC for COI %s.", orig_req->comm->buf);
342 tids_send_err_response(tids, orig_req, "No valid APC for community");
346 apc = tr_dup_name(cfg_comm->apcs->id);
348 /* Check that the APC is configured */
349 if (NULL == (cfg_apc = tr_comm_table_find_comm(cfg_mgr->active->ctable, apc))) {
350 tr_notice("tr_tids_req_hander: Request for unknown comm: %s.", apc->buf);
351 tids_send_err_response(tids, orig_req, "Unknown APC");
357 fwd_req->orig_coi = orig_req->comm;
359 /* Check that rp_realm is a member of this APC */
360 if (NULL == (tr_comm_find_rp(cfg_mgr->active->ctable, cfg_apc, orig_req->rp_realm))) {
361 tr_notice("tr_tids_req_hander: RP Realm (%s) not member of community (%s).", orig_req->rp_realm->buf, orig_req->comm->buf);
362 tids_send_err_response(tids, orig_req, "RP APC membership error");
368 /* Look up the route for this community/realm. */
369 tr_debug("tr_tids_req_handler: looking up route.");
370 route=trps_get_selected_route(trps, orig_req->comm, orig_req->realm);
372 tr_notice("tr_tids_req_handler: no route table entry found for realm (%s) in community (%s).",
373 orig_req->realm->buf, orig_req->comm->buf);
374 tids_send_err_response(tids, orig_req, "Missing trust route error");
378 tr_debug("tr_tids_req_handler: found route.");
379 if (trp_route_is_local(route)) {
380 tr_debug("tr_tids_req_handler: route is local.");
381 aaa_servers = tr_idp_aaa_server_lookup(cfg_mgr->active->ctable->idp_realms,
386 tr_debug("tr_tids_req_handler: route not local.");
387 aaa_servers = tr_aaa_server_new(tmp_ctx, trp_route_get_next_hop(route));
391 /* Find the AAA server(s) for this request */
392 if (NULL == aaa_servers) {
393 tr_debug("tr_tids_req_handler: No AAA Servers for realm %s, defaulting.", orig_req->realm->buf);
394 if (NULL == (aaa_servers = tr_default_server_lookup (cfg_mgr->active->default_servers,
396 tr_notice("tr_tids_req_handler: No default AAA servers, discarded.");
397 tids_send_err_response(tids, orig_req, "No path to AAA Server(s) for realm");
403 /* if we aren't defaulting, check idp coi and apc membership */
404 if (NULL == (tr_comm_find_idp(cfg_mgr->active->ctable, cfg_comm, fwd_req->realm))) {
405 tr_notice("tr_tids_req_handler: IDP Realm (%s) not member of community (%s).", orig_req->realm->buf, orig_req->comm->buf);
406 tids_send_err_response(tids, orig_req, "IDP community membership error");
410 if ( cfg_apc && (NULL == (tr_comm_find_idp(cfg_mgr->active->ctable, cfg_apc, fwd_req->realm)))) {
411 tr_notice("tr_tids_req_handler: IDP Realm (%s) not member of APC (%s).", orig_req->realm->buf, orig_req->comm->buf);
412 tids_send_err_response(tids, orig_req, "IDP APC membership error");
418 /* send a TID request to the AAA server(s), and get the answer(s) */
420 expiration_interval = cfg_apc->expiration_interval;
421 else expiration_interval = cfg_comm->expiration_interval;
422 if (fwd_req->expiration_interval)
423 fwd_req->expiration_interval = (expiration_interval < fwd_req->expiration_interval) ? expiration_interval : fwd_req->expiration_interval;
424 else fwd_req->expiration_interval = expiration_interval;
426 /* Set up message queue for replies from req forwarding threads */
427 mq=tr_mq_new(tmp_ctx);
429 tr_notice("tr_tids_req_handler: unable to allocate message queue.");
435 aaa_iter=tr_aaa_server_iter_new(tmp_ctx);
436 if (aaa_iter==NULL) {
437 tr_notice("tr_tids_req_handler: unable to allocate AAA server iterator.");
441 for (n_aaa=0, this_aaa=tr_aaa_server_iter_first(aaa_iter, aaa_servers);
443 n_aaa++, this_aaa=tr_aaa_server_iter_next(aaa_iter)) {
444 aaa_cookie[n_aaa]=talloc(tmp_ctx, struct tr_tids_fwd_cookie);
445 if (aaa_cookie[n_aaa]==NULL) {
446 tr_notice("tr_tids_req_handler: unable to allocate cookie for AAA thread %d.", n_aaa);
450 talloc_set_destructor((void *)(aaa_cookie[n_aaa]), tr_tids_fwd_cookie_destructor);
451 /* fill in the cookie. To ensure the thread has valid data even if we exit first and
452 * abandon it, duplicate anything pointed to (except the mq). */
453 aaa_cookie[n_aaa]->thread_id=n_aaa;
454 if (0!=pthread_mutex_init(&(aaa_cookie[n_aaa]->mutex), NULL)) {
455 tr_notice("tr_tids_req_handler: unable to init mutex for AAA thread %d.", n_aaa);
459 aaa_cookie[n_aaa]->mq=mq;
460 aaa_cookie[n_aaa]->aaa_hostname=tr_dup_name(this_aaa->hostname);
461 aaa_cookie[n_aaa]->dh_params=tr_dup_dh_params(orig_req->tidc_dh);
462 aaa_cookie[n_aaa]->fwd_req=tid_dup_req(aaa_cookie, fwd_req);
464 /* Take the cookie out of tmp_ctx before starting thread. If thread starts, it becomes
465 * responsible for freeing it until it queues a response. */
466 talloc_steal(NULL, aaa_cookie[n_aaa]);
467 if (0!=pthread_create(&(aaa_thread[n_aaa]), NULL, tr_tids_req_fwd_thread, aaa_cookie[n_aaa])) {
468 talloc_steal(tmp_ctx, aaa_cookie[n_aaa]); /* thread start failed; steal this back */
469 tr_notice("tr_tids_req_handler: unable to start AAA thread %d.", n_aaa);
475 /* determine expiration time */
476 if (0!=tr_mq_pop_timeout(cfg_mgr->active->internal->tid_req_timeout, &ts_abort)) {
477 tr_notice("tr_tids_req_handler: unable to read clock for timeout.");
482 /* wait for responses */
485 while (((n_responses+n_failed)<n_aaa) &&
486 (NULL!=(msg=tr_mq_pop(mq, &ts_abort)))) {
487 /* process message */
488 if (0==strcmp(tr_mq_msg_get_message(msg), TR_TID_MQMSG_SUCCESS)) {
489 payload=talloc_get_type_abort(tr_mq_msg_get_payload(msg), TR_RESP_COOKIE);
490 if (payload->resp->result==TID_SUCCESS) {
491 tr_tids_merge_resps(resp, payload->resp);
495 tr_notice("tr_tids_req_handler: TID error received from AAA server %d: %.*s",
497 payload->resp->err_msg->len,
498 payload->resp->err_msg->buf);
500 } else if (0==strcmp(tr_mq_msg_get_message(msg), TR_TID_MQMSG_FAILURE)) {
502 payload=talloc_get_type_abort(tr_mq_msg_get_payload(msg), TR_RESP_COOKIE);
504 tr_notice("tr_tids_req_handler: TID request for AAA server %d failed.",
507 /* unexpected message */
508 tr_err("tr_tids_req_handler: Unexpected message received. Aborting!");
513 /* Now free the cookie for this thread. Null it so we know we've dealt with it. */
514 talloc_free(aaa_cookie[payload->thread_id]);
515 aaa_cookie[payload->thread_id]=NULL;
519 /* check whether we've received enough responses to exit */
520 if ((idp_shared && (n_responses>0)) ||
521 (resp_frac_denom*n_responses>=resp_frac_numer*n_aaa))
525 /* Inform any remaining threads that we will no longer handle their responses. */
526 for (ii=0; ii<n_aaa; ii++) {
527 if (aaa_cookie[ii]!=NULL) {
528 if (0!=tr_tids_fwd_get_mutex(aaa_cookie[ii]))
529 tr_notice("tr_tids_req_handler: unable to get mutex for AAA thread %d.", ii);
531 aaa_cookie[ii]->mq=NULL; /* threads will not try to respond through a null mq */
533 if (0!=tr_tids_fwd_release_mutex(aaa_cookie[ii]))
534 tr_notice("tr_tids_req_handler: unable to release mutex for AAA thread %d.", ii);
538 /* Now all threads have either replied (and aaa_cookie[ii] is null) or have been told not to
539 * reply (by setting their mq pointer to null). However, some may have responded by placing
540 * a message on the mq after we last checked but before we set their mq pointer to null. These
541 * will not know that we gave up on them, so we must free their cookies for them. We can just
542 * go through any remaining messages on the mq to identify these threads. */
543 while (NULL!=(msg=tr_mq_pop(mq, NULL))) {
544 payload=(TR_RESP_COOKIE *)tr_mq_msg_get_payload(msg);
545 if (aaa_cookie[payload->thread_id]!=NULL)
546 talloc_free(aaa_cookie[payload->thread_id]);
551 if (n_responses==0) {
552 tid_resp_set_result(resp, TID_ERROR);
553 tid_resp_set_err_msg(resp, tr_new_name("No successful response from AAA server(s)."));
554 tid_resp_set_error_path(resp, orig_req->path);
561 talloc_free(tmp_ctx);
565 static int tr_tids_gss_handler(gss_name_t client_name, TR_NAME *gss_name,
569 struct tr_tids_event_cookie *cookie=talloc_get_type_abort(data, struct tr_tids_event_cookie);
570 TIDS_INSTANCE *tids = cookie->tids;
571 TR_CFG_MGR *cfg_mgr = cookie->cfg_mgr;
573 if ((!client_name) || (!gss_name) || (!tids) || (!cfg_mgr)) {
574 tr_debug("tr_tidc_gss_handler: Bad parameters.");
578 /* look up the RP client matching the GSS name */
579 if ((NULL == (rp = tr_rp_client_lookup(cfg_mgr->active->rp_clients, gss_name)))) {
580 tr_debug("tr_tids_gss_handler: Unknown GSS name %s", gss_name->buf);
584 /* Store the rp client */
586 tr_debug("Client's GSS Name: %s", gss_name->buf);
592 /***** TIDS event handling *****/
594 /* called when a connection to the TIDS port is received */
595 static void tr_tids_event_cb(int listener, short event, void *arg)
597 TIDS_INSTANCE *tids = (TIDS_INSTANCE *)arg;
599 if (0==(event & EV_READ))
600 tr_debug("tr_tids_event_cb: unexpected event on TIDS socket (event=0x%X)", event);
602 tids_accept(tids, listener);
605 /* Configure the tids instance and set up its event handler.
606 * Returns 0 on success, nonzero on failure. Fills in
607 * *tids_event (which should be allocated by caller). */
608 int tr_tids_event_init(struct event_base *base,
612 struct tr_socket_event *tids_ev)
614 TALLOC_CTX *tmp_ctx=talloc_new(NULL);
615 struct tr_tids_event_cookie *cookie=NULL;
619 if (tids_ev == NULL) {
620 tr_debug("tr_tids_event_init: Null tids_ev.");
625 /* Create the cookie for callbacks. We'll put it in the tids context, so it will
626 * be cleaned up when tids is freed by talloc_free. */
627 cookie=talloc(tmp_ctx, struct tr_tids_event_cookie);
628 if (cookie == NULL) {
629 tr_debug("tr_tids_event_init: Unable to allocate cookie.");
634 cookie->cfg_mgr=cfg_mgr;
636 talloc_steal(tids, cookie);
638 /* get a tids listener */
639 tids_ev->n_sock_fd=tids_get_listener(tids,
642 cfg_mgr->active->internal->hostname,
643 cfg_mgr->active->internal->tids_port,
647 if (tids_ev->n_sock_fd==0) {
648 tr_crit("Error opening TID server socket.");
654 for (ii=0; ii<tids_ev->n_sock_fd; ii++) {
655 tids_ev->ev[ii]=event_new(base,
656 tids_ev->sock_fd[ii],
660 event_add(tids_ev->ev[ii], NULL);
664 talloc_free(tmp_ctx);