2 * Copyright (c) 2012, 2015, 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.
40 #include <sys/socket.h>
45 #include <tid_internal.h>
49 #include <tr_socket.h>
52 #include <sys/resource.h>
55 * Create a response with minimal fields filled in
57 * @param mem_ctx talloc context for the return value
58 * @param req request to respond to
59 * @return new response structure allocated in the mem_ctx context
61 static TID_RESP *tids_create_response(TALLOC_CTX *mem_ctx, TID_REQ *req)
66 if (NULL == (resp = tid_resp_new(mem_ctx))) {
67 tr_crit("tids_create_response: Error allocating response structure.");
71 resp->result = TID_SUCCESS; /* presume success */
72 if ((NULL == (resp->rp_realm = tr_dup_name(req->rp_realm))) ||
73 (NULL == (resp->realm = tr_dup_name(req->realm))) ||
74 (NULL == (resp->comm = tr_dup_name(req->comm)))) {
75 tr_crit("tids_create_response: Error allocating fields in response.");
79 if (NULL == (resp->orig_coi = tr_dup_name(req->orig_coi))) {
80 tr_crit("tids_create_response: Error allocating fields in response.");
84 if (req->request_id) {
85 if (NULL == (resp->request_id = tr_dup_name(req->request_id))) {
86 tr_crit("tids_create_response: Error allocating fields in response.");
94 if ((!success) && (resp!=NULL)) {
101 static int tids_handle_request(TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp)
105 /* Check that this is a valid TID Request. If not, send an error return. */
107 (!(req->rp_realm)) ||
110 tr_notice("tids_handle_request(): Not a valid TID Request.");
111 tid_resp_set_result(resp, TID_ERROR);
112 tid_resp_set_err_msg(resp, tr_new_name("Bad request format"));
116 tr_debug("tids_handle_request: adding self to req path.");
117 tid_req_add_path(req, tids->hostname, tids->tids_port);
119 /* Call the caller's request handler */
120 /* TBD -- Handle different error returns/msgs */
121 if (0 > (rc = (*tids->req_handler)(tids, req, resp, tids->cookie))) {
122 /* set-up an error response */
123 tr_debug("tids_handle_request: req_handler returned error.");
124 tid_resp_set_result(resp, TID_ERROR);
125 if (!tid_resp_get_err_msg(resp)) /* Use msg set by handler, if any */
126 tid_resp_set_err_msg(resp, tr_new_name("Internal processing error"));
128 /* set-up a success response */
129 tr_debug("tids_handle_request: req_handler returned success.");
130 tid_resp_set_result(resp, TID_SUCCESS);
131 resp->err_msg = NULL; /* No error msg on successful return */
138 * Produces a JSON-encoded msg containing the TID response
140 * @param mem_ctx talloc context for the return value
141 * @param resp outgoing response
142 * @return JSON-encoded message containing the TID response
144 static char *tids_encode_response(TALLOC_CTX *mem_ctx, TID_RESP *resp)
147 char *resp_buf = NULL;
149 /* Construct the response message */
150 mresp.msg_type = TID_RESPONSE;
151 tr_msg_set_resp(&mresp, resp);
153 /* Encode the message to JSON */
154 resp_buf = tr_msg_encode(mem_ctx, &mresp);
155 if (resp_buf == NULL) {
156 tr_err("tids_encode_response: Error encoding json response.");
159 tr_debug("tids_encode_response: Encoded response: %s", resp_buf);
166 * Encode/send an error response
168 * Part of the public interface
175 int tids_send_err_response (TIDS_INSTANCE *tids, TID_REQ *req, const char *err_msg) {
176 TID_RESP *resp = NULL;
179 if ((!tids) || (!req) || (!err_msg)) {
180 tr_debug("tids_send_err_response: Invalid parameters.");
184 /* If we already sent a response, don't send another no matter what. */
188 if (NULL == (resp = tids_create_response(req, req))) {
189 tr_crit("tids_send_err_response: Can't create response.");
193 /* mark this as an error response, and include the error message */
194 resp->result = TID_ERROR;
195 resp->err_msg = tr_new_name((char *)err_msg);
196 resp->error_path = req->path;
198 rc = tids_send_response(tids, req, resp);
205 * Encode/send a response
207 * Part of the public interface
209 * @param tids not actually used, but kept for ABI compatibility
214 int tids_send_response (TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp)
219 if ((!tids) || (!req) || (!resp)) {
220 tr_debug("tids_send_response: Invalid parameters.");
224 /* Never send a second response if we already sent one. */
228 resp_buf = tids_encode_response(NULL, NULL);
229 if (resp_buf == NULL) {
230 tr_err("tids_send_response: Error encoding json response.");
235 tr_debug("tids_send_response: Encoded response: %s", resp_buf);
237 /* If external logging is enabled, fire off a message */
238 /* TODO Can be moved to end once segfault in gsscon_write_encrypted_token fixed */
241 /* Send the response over the connection */
242 err = gsscon_write_encrypted_token (req->conn, req->gssctx, resp_buf,
243 strlen(resp_buf) + 1);
245 tr_notice("tids_send_response: Error sending response over connection.");
250 /* indicate that a response has been sent for this request */
259 * Callback to process a request and produce a response
261 * @param req_str JSON-encoded request
262 * @param data pointer to a TIDS_INSTANCE
263 * @return pointer to the response string or null to send no response
265 static TR_MSG *tids_req_cb(TALLOC_CTX *mem_ctx, TR_MSG *mreq, void *data)
267 TALLOC_CTX *tmp_ctx = talloc_new(NULL);
268 TIDS_INSTANCE *tids = talloc_get_type_abort(data, TIDS_INSTANCE);
270 TID_RESP *resp = NULL;
271 TR_MSG *resp_msg = NULL; /* this is the return value */
274 /* If this isn't a TID Request, just drop it. */
275 if (mreq->msg_type != TID_REQUEST) {
276 tr_debug("tids_req_cb: Not a TID request, dropped.");
280 /* Get a handle on the request itself. Don't free req - it belongs to mreq */
281 req = tr_msg_get_req(mreq);
283 /* Allocate a response message */
284 resp_msg = talloc(tmp_ctx, TR_MSG);
285 if (resp_msg == NULL) {
286 /* We cannot create a response message, so all we can really do is emit
287 * an error message and return. */
288 tr_crit("tids_req_cb: Error allocating response message.");
292 /* Allocate a response structure and populate common fields. Put it in the
293 * response message's talloc context. */
294 resp = tids_create_response(resp_msg, req);
296 /* If we were unable to create a response, we cannot reply. Log an
297 * error if we can, then drop the request. */
298 tr_crit("tids_req_cb: Error creating response structure.");
299 resp_msg = NULL; /* the contents are in tmp_ctx, so they will still be cleaned up */
302 /* Now officially assign the response to the message. */
303 tr_msg_set_resp(resp_msg, resp);
305 /* Handle the request and fill in resp */
306 rc = tids_handle_request(tids, req, resp);
308 tr_debug("tids_req_cb: Error from tids_handle_request(), rc = %d.", rc);
309 /* Fall through, to send the response, either way */
312 /* put the response message in the caller's context */
313 talloc_steal(mem_ctx, resp_msg);
316 talloc_free(tmp_ctx);
320 static int tids_destructor(void *object)
322 TIDS_INSTANCE *tids = talloc_get_type_abort(object, TIDS_INSTANCE);
324 g_array_unref(tids->pids);
328 TIDS_INSTANCE *tids_new(TALLOC_CTX *mem_ctx)
330 TIDS_INSTANCE *tids = talloc_zero(mem_ctx, TIDS_INSTANCE);
332 tids->pids = g_array_new(FALSE, FALSE, sizeof(struct tid_process));
333 if (tids->pids == NULL) {
337 talloc_set_destructor((void *)tids, tids_destructor);
343 * Create a new TIDS instance
345 * Deprecated: exists for ABI compatibility, but tids_new() should be used instead
348 TIDS_INSTANCE *tids_create(void)
350 return tids_new(NULL);
353 /* Get a listener for tids requests, returns its socket fd. Accept
354 * connections with tids_accept() */
355 nfds_t tids_get_listener(TIDS_INSTANCE *tids,
356 TIDS_REQ_FUNC *req_handler,
357 tids_auth_func *auth_handler,
358 const char *hostname,
367 tids->tids_port = port;
368 n_fd = tr_sock_listen_all(port, fd_out, max_fd);
371 tr_err("tids_get_listener: Error opening port %d", port);
373 /* opening port succeeded */
374 tr_info("tids_get_listener: Opened port %d.", port);
376 /* make this socket non-blocking */
377 for (ii=0; ii<n_fd; ii++) {
378 if (0 != fcntl(fd_out[ii], F_SETFL, O_NONBLOCK)) {
379 tr_err("tids_get_listener: Error setting O_NONBLOCK.");
380 for (ii=0; ii<n_fd; ii++) {
391 /* store the caller's request handler & cookie */
392 tids->req_handler = req_handler;
393 tids->auth_handler = auth_handler;
394 tids->hostname = hostname;
395 tids->cookie = cookie;
401 /* Strings used to report results from the handler process. The
402 * TIDS_MAX_MESSAGE_LEN must be longer than the longest message, including
403 * null termination (i.e., strlen() + 1) */
404 #define TIDS_MAX_MESSAGE_LEN (10)
405 #define TIDS_SUCCESS_MESSAGE "OK"
406 #define TIDS_ERROR_MESSAGE "ERR"
409 * Process to handle an incoming TIDS request
411 * This should be run in the child process after a fork(). Handles
412 * the request, writes the result to result_fd, and terminates.
413 * Never returns to the caller.
415 * @param tids TID server instance
416 * @param conn_fd file descriptor for the incoming connection
417 * @param result_fd writable file descriptor for the result, or 0 to disable reporting
419 static void tids_handle_proc(TIDS_INSTANCE *tids, int conn_fd, int result_fd)
421 const char *response_message = NULL;
422 struct rlimit rlim; /* for disabling core dump */
424 switch(tr_gss_handle_connection(conn_fd,
425 "trustidentity", tids->hostname, /* acceptor name */
426 tids->auth_handler, tids->cookie, /* auth callback and cookie */
427 tids_req_cb, tids /* req callback and cookie */
430 response_message = TIDS_SUCCESS_MESSAGE;
435 response_message = TIDS_ERROR_MESSAGE;
439 if (0 != result_fd) {
440 /* write strlen + 1 to include the null termination */
441 if (write(result_fd, response_message, strlen(response_message) + 1) < 0)
442 tr_err("tids_accept: child process unable to write to pipe");
448 /* This ought to be an exit(0), but log4shib does not play well with fork() due to
449 * threading issues. To ensure we do not get stuck in the exit handler, we will
450 * abort. First disable core dump for this subprocess (the main process will still
451 * dump core if the environment allows). */
452 rlim.rlim_cur = 0; /* max core size of 0 */
453 rlim.rlim_max = 0; /* prevent the core size limit from being raised later */
454 setrlimit(RLIMIT_CORE, &rlim);
455 abort(); /* exit hard */
458 /* Accept and process a connection on a port opened with tids_get_listener() */
459 int tids_accept(TIDS_INSTANCE *tids, int listen)
464 struct tid_process tp = {0};
466 if (0 > (conn = tr_sock_accept(listen))) {
467 tr_err("tids_accept: Error accepting connection");
471 if (0 > pipe(pipe_fd)) {
472 perror("Error on pipe()");
475 /* pipe_fd[0] is for reading, pipe_fd[1] is for writing */
477 if (0 > (pid = fork())) {
478 perror("Error on fork()");
483 /* Only the child process gets here */
484 close(pipe_fd[0]); /* close the read end of the pipe, the child only writes */
485 close(listen); /* close the child process's handle on the listen port */
487 tids_handle_proc(tids, conn, pipe_fd[1]); /* never returns */
490 /* Only the parent process gets here */
491 close(pipe_fd[1]); /* close the write end of the pipe, the parent only listens */
492 close(conn); /* connection belongs to the child, so close parent's handle */
494 /* remember the PID of our child process */
495 tr_info("tids_accept: Spawned TID process %d to handle incoming connection.", pid);
497 tp.read_fd = pipe_fd[0];
498 g_array_append_val(tids->pids, tp);
500 /* clean up any processes that have completed */
501 tids_sweep_procs(tids);
506 * Clean up any finished TID request processes
508 * This is called by the main process after forking each TID request. If you want to be
509 * sure finished processes are cleaned up promptly even during a lull in TID requests,
510 * this can be called from the main thread of the main process. It is not thread-safe,
511 * so should not be used from sub-threads. It should not be called by child processes -
512 * this would probably be harmless but ineffective.
516 void tids_sweep_procs(TIDS_INSTANCE *tids)
519 struct tid_process tp = {0};
520 char result[TIDS_MAX_MESSAGE_LEN] = {0};
525 /* loop backwards over the array so we can remove elements as we go */
526 for (ii=tids->pids->len; ii > 0; ii--) {
527 /* ii-1 is the current index - get our own copy, we may destroy the list's copy */
528 tp = g_array_index(tids->pids, struct tid_process, ii-1);
530 wait_rc = waitpid(tp.pid, &status, WNOHANG);
532 continue; /* process still running */
535 /* invalid options will probably keep being invalid, report that condition */
537 tr_crit("tids_sweep_procs: waitpid called with invalid options");
539 /* If we got ECHILD, that means the PID was invalid; we'll assume the process was
540 * terminated and we missed it. For all other errors, move on
541 * to the next PID to check. */
545 tr_warning("tid_sweep_procs: TID process %d disappeared", tp.pid);
548 /* remove the item (we still have a copy of the data) */
549 g_array_remove_index_fast(tids->pids, ii-1); /* disturbs only indices >= ii-1 which we've already handled */
551 /* Report exit status unless we got ECHILD above or somehow waitpid returned the wrong pid */
552 if (wait_rc == tp.pid) {
553 if (WIFEXITED(status)) {
554 tr_debug("tids_sweep_procs: TID process %d exited with status %d.", tp.pid, WTERMSIG(status));
555 } else if (WIFSIGNALED(status)) {
556 tr_debug("tids_sweep_procs: TID process %d terminated by signal %d.", tp.pid, WTERMSIG(status));
558 } else if (wait_rc > 0) {
559 tr_err("tids_sweep_procs: waitpid returned pid %d, expected %d", wait_rc, tp.pid);
562 /* read the pipe - if the TID request worked, it will have written status before terminating */
563 result_len = read(tp.read_fd, result, TIDS_MAX_MESSAGE_LEN);
566 if ((result_len > 0) && (strcmp(result, TIDS_SUCCESS_MESSAGE) == 0)) {
568 tr_info("tids_sweep_procs: TID process %d exited successfully.", tp.pid);
571 tr_info("tids_sweep_procs: TID process %d exited with an error.", tp.pid);
576 /* Process tids requests forever. Should not return except on error. */
577 int tids_start(TIDS_INSTANCE *tids,
578 TIDS_REQ_FUNC *req_handler,
579 tids_auth_func *auth_handler,
580 const char *hostname,
584 int fd[TR_MAX_SOCKETS]={0};
586 struct pollfd poll_fd[TR_MAX_SOCKETS]={{0}};
589 n_fd = tids_get_listener(tids, req_handler, auth_handler, hostname, port, cookie, fd, TR_MAX_SOCKETS);
591 perror ("Error from tids_listen()");
595 tr_info("Trust Path Query Server starting on host %s:%d.", hostname, port);
597 /* set up the poll structs */
598 for (ii=0; ii<n_fd; ii++) {
599 poll_fd[ii].fd=fd[ii];
600 poll_fd[ii].events=POLLIN;
603 while(1) { /* accept incoming conns until we are stopped */
604 /* clear out events from previous iteration */
605 for (ii=0; ii<n_fd; ii++)
606 poll_fd[ii].revents=0;
608 /* wait indefinitely for a connection */
609 if (poll(poll_fd, n_fd, -1) < 0) {
610 perror("Error from poll()");
614 /* fork handlers for any sockets that have data */
615 for (ii=0; ii<n_fd; ii++) {
616 if (poll_fd[ii].revents == 0)
619 if ((poll_fd[ii].revents & POLLERR) || (poll_fd[ii].revents & POLLNVAL)) {
620 perror("Error polling fd");
624 if (poll_fd[ii].revents & POLLIN) {
625 if (tids_accept(tids, poll_fd[ii].fd))
626 tr_err("tids_start: error in tids_accept().");
631 return 1; /* should never get here, loops "forever" */
634 void tids_destroy (TIDS_INSTANCE *tids)
636 /* clean up logfiles */