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>
54 * Create a response with minimal fields filled in
56 * @param mem_ctx talloc context for the return value
57 * @param req request to respond to
58 * @return new response structure allocated in the mem_ctx context
60 static TID_RESP *tids_create_response(TALLOC_CTX *mem_ctx, TID_REQ *req)
65 if (NULL == (resp = tid_resp_new(mem_ctx))) {
66 tr_crit("tids_create_response: Error allocating response structure.");
70 resp->result = TID_SUCCESS; /* presume success */
71 if ((NULL == (resp->rp_realm = tr_dup_name(req->rp_realm))) ||
72 (NULL == (resp->realm = tr_dup_name(req->realm))) ||
73 (NULL == (resp->comm = tr_dup_name(req->comm)))) {
74 tr_crit("tids_create_response: Error allocating fields in response.");
78 if (NULL == (resp->orig_coi = tr_dup_name(req->orig_coi))) {
79 tr_crit("tids_create_response: Error allocating fields in response.");
83 if (req->request_id) {
84 if (NULL == (resp->request_id = tr_dup_name(req->request_id))) {
85 tr_crit("tids_create_response: Error allocating fields in response.");
93 if ((!success) && (resp!=NULL)) {
100 static int tids_handle_request(TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp)
104 /* Check that this is a valid TID Request. If not, send an error return. */
106 (!(req->rp_realm)) ||
109 tr_notice("tids_handle_request(): Not a valid TID Request.");
110 tid_resp_set_result(resp, TID_ERROR);
111 tid_resp_set_err_msg(resp, tr_new_name("Bad request format"));
115 tr_debug("tids_handle_request: adding self to req path.");
116 tid_req_add_path(req, tids->hostname, tids->tids_port);
118 /* Call the caller's request handler */
119 /* TBD -- Handle different error returns/msgs */
120 if (0 > (rc = (*tids->req_handler)(tids, req, resp, tids->cookie))) {
121 /* set-up an error response */
122 tr_debug("tids_handle_request: req_handler returned error.");
123 tid_resp_set_result(resp, TID_ERROR);
124 if (!tid_resp_get_err_msg(resp)) /* Use msg set by handler, if any */
125 tid_resp_set_err_msg(resp, tr_new_name("Internal processing error"));
127 /* set-up a success response */
128 tr_debug("tids_handle_request: req_handler returned success.");
129 tid_resp_set_result(resp, TID_SUCCESS);
130 resp->err_msg = NULL; /* No error msg on successful return */
137 * Produces a JSON-encoded msg containing the TID response
139 * @param mem_ctx talloc context for the return value
140 * @param resp outgoing response
141 * @return JSON-encoded message containing the TID response
143 static char *tids_encode_response(TALLOC_CTX *mem_ctx, TID_RESP *resp)
146 char *resp_buf = NULL;
148 /* Construct the response message */
149 mresp.msg_type = TID_RESPONSE;
150 tr_msg_set_resp(&mresp, resp);
152 /* Encode the message to JSON */
153 resp_buf = tr_msg_encode(mem_ctx, &mresp);
154 if (resp_buf == NULL) {
155 tr_err("tids_encode_response: Error encoding json response.");
158 tr_debug("tids_encode_response: Encoded response: %s", resp_buf);
165 * Encode/send an error response
167 * Part of the public interface
174 int tids_send_err_response (TIDS_INSTANCE *tids, TID_REQ *req, const char *err_msg) {
175 TID_RESP *resp = NULL;
178 if ((!tids) || (!req) || (!err_msg)) {
179 tr_debug("tids_send_err_response: Invalid parameters.");
183 /* If we already sent a response, don't send another no matter what. */
187 if (NULL == (resp = tids_create_response(req, req))) {
188 tr_crit("tids_send_err_response: Can't create response.");
192 /* mark this as an error response, and include the error message */
193 resp->result = TID_ERROR;
194 resp->err_msg = tr_new_name((char *)err_msg);
195 resp->error_path = req->path;
197 rc = tids_send_response(tids, req, resp);
204 * Encode/send a response
206 * Part of the public interface
208 * @param tids not actually used, but kept for ABI compatibility
213 int tids_send_response (TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp)
218 if ((!tids) || (!req) || (!resp)) {
219 tr_debug("tids_send_response: Invalid parameters.");
223 /* Never send a second response if we already sent one. */
227 resp_buf = tids_encode_response(NULL, NULL);
228 if (resp_buf == NULL) {
229 tr_err("tids_send_response: Error encoding json response.");
234 tr_debug("tids_send_response: Encoded response: %s", resp_buf);
236 /* If external logging is enabled, fire off a message */
237 /* TODO Can be moved to end once segfault in gsscon_write_encrypted_token fixed */
240 /* Send the response over the connection */
241 err = gsscon_write_encrypted_token (req->conn, req->gssctx, resp_buf,
242 strlen(resp_buf) + 1);
244 tr_notice("tids_send_response: Error sending response over connection.");
249 /* indicate that a response has been sent for this request */
258 * Callback to process a request and produce a response
260 * @param req_str JSON-encoded request
261 * @param data pointer to a TIDS_INSTANCE
262 * @return pointer to the response string or null to send no response
264 static TR_MSG *tids_req_cb(TALLOC_CTX *mem_ctx, TR_MSG *mreq, void *data)
266 TALLOC_CTX *tmp_ctx = talloc_new(NULL);
267 TIDS_INSTANCE *tids = talloc_get_type_abort(data, TIDS_INSTANCE);
269 TID_RESP *resp = NULL;
270 TR_MSG *resp_msg = NULL; /* this is the return value */
273 /* If this isn't a TID Request, just drop it. */
274 if (mreq->msg_type != TID_REQUEST) {
275 tr_debug("tids_req_cb: Not a TID request, dropped.");
279 /* Get a handle on the request itself. Don't free req - it belongs to mreq */
280 req = tr_msg_get_req(mreq);
282 /* Allocate a response message */
283 resp_msg = talloc(tmp_ctx, TR_MSG);
284 if (resp_msg == NULL) {
285 /* We cannot create a response message, so all we can really do is emit
286 * an error message and return. */
287 tr_crit("tids_req_cb: Error allocating response message.");
291 /* Allocate a response structure and populate common fields. Put it in the
292 * response message's talloc context. */
293 resp = tids_create_response(resp_msg, req);
295 /* If we were unable to create a response, we cannot reply. Log an
296 * error if we can, then drop the request. */
297 tr_crit("tids_req_cb: Error creating response structure.");
298 resp_msg = NULL; /* the contents are in tmp_ctx, so they will still be cleaned up */
301 /* Now officially assign the response to the message. */
302 tr_msg_set_resp(resp_msg, resp);
304 /* Handle the request and fill in resp */
305 rc = tids_handle_request(tids, req, resp);
307 tr_debug("tids_req_cb: Error from tids_handle_request(), rc = %d.", rc);
308 /* Fall through, to send the response, either way */
311 /* put the response message in the caller's context */
312 talloc_steal(mem_ctx, resp_msg);
315 talloc_free(tmp_ctx);
319 static int tids_destructor(void *object)
321 TIDS_INSTANCE *tids = talloc_get_type_abort(object, TIDS_INSTANCE);
323 g_array_unref(tids->pids);
327 TIDS_INSTANCE *tids_new(TALLOC_CTX *mem_ctx)
329 TIDS_INSTANCE *tids = talloc_zero(mem_ctx, TIDS_INSTANCE);
331 tids->pids = g_array_new(FALSE, FALSE, sizeof(struct tid_process));
332 if (tids->pids == NULL) {
336 talloc_set_destructor((void *)tids, tids_destructor);
342 * Create a new TIDS instance
344 * Deprecated: exists for ABI compatibility, but tids_new() should be used instead
347 TIDS_INSTANCE *tids_create(void)
349 return tids_new(NULL);
352 /* Get a listener for tids requests, returns its socket fd. Accept
353 * connections with tids_accept() */
354 nfds_t tids_get_listener(TIDS_INSTANCE *tids,
355 TIDS_REQ_FUNC *req_handler,
356 tids_auth_func *auth_handler,
357 const char *hostname,
366 tids->tids_port = port;
367 n_fd = tr_sock_listen_all(port, fd_out, max_fd);
370 tr_err("tids_get_listener: Error opening port %d");
372 /* opening port succeeded */
373 tr_info("tids_get_listener: Opened port %d.", port);
375 /* make this socket non-blocking */
376 for (ii=0; ii<n_fd; ii++) {
377 if (0 != fcntl(fd_out[ii], F_SETFL, O_NONBLOCK)) {
378 tr_err("tids_get_listener: Error setting O_NONBLOCK.");
379 for (ii=0; ii<n_fd; ii++) {
390 /* store the caller's request handler & cookie */
391 tids->req_handler = req_handler;
392 tids->auth_handler = auth_handler;
393 tids->hostname = hostname;
394 tids->cookie = cookie;
400 /* Accept and process a connection on a port opened with tids_get_listener() */
401 int tids_accept(TIDS_INSTANCE *tids, int listen)
406 struct tid_process tp = {0};
408 if (0 > (conn = tr_sock_accept(listen))) {
409 tr_err("tids_accept: Error accepting connection");
413 if (0 > pipe(pipe_fd)) {
414 perror("Error on pipe()");
417 /* pipe_fd[0] is for reading, pipe_fd[1] is for writing */
419 if (0 > (pid = fork())) {
420 perror("Error on fork()");
425 close(pipe_fd[0]); /* child only writes */
427 tr_gss_handle_connection(conn,
428 "trustidentity", tids->hostname, /* acceptor name */
429 tids->auth_handler, tids->cookie, /* auth callback and cookie */
430 tids_req_cb, tids /* req callback and cookie */
432 if (write(pipe_fd[1], "OK\0", 3) < 0)
433 tr_crit("tids_accept: child process unable to write to pipe");
436 exit(0); /* exit to kill forked child process */
439 /* Only the parent process gets here */
440 close(pipe_fd[1]); /* parent only listens */
441 close(conn); /* connection belongs to the child */
443 tp.read_fd = pipe_fd[0];
444 g_array_append_val(tids->pids, tp); /* remember the PID of our child process */
446 /* clean up any processes that have completed */
447 tids_sweep_procs(tids);
452 * Clean up any finished TID request processes
454 * This is called by the main process after forking each TID request. If you want to be
455 * sure finished processes are cleaned up promptly even during a lull in TID requests,
456 * this can be called from the main thread of the main process. It is not thread-safe,
457 * so should not be used from sub-threads. It should not be called by child processes -
458 * this would probably be harmless but ineffective.
462 void tids_sweep_procs(TIDS_INSTANCE *tids)
465 struct tid_process tp = {0};
466 char result[10] = {0};
471 /* loop backwards over the array so we can remove elements as we go */
472 for (ii=tids->pids->len; ii > 0; ii--) {
473 /* ii-1 is the current index - get our own copy, we may destroy the list's copy */
474 tp = g_array_index(tids->pids, struct tid_process, ii-1);
476 wait_rc = waitpid(tp.pid, &status, WNOHANG);
478 continue; /* process still running */
481 /* invalid options will probably keep being invalid, report that condition */
483 tr_crit("tids_sweep_procs: waitpid called with invalid options");
485 /* If we got ECHILD, that means the PID was invalid; we'll assume the process was
486 * terminated and we missed it. For all other errors, move on
487 * to the next PID to check. */
491 tr_warning("tid_sweep_procs: TID process %d disappeared", tp.pid);
494 /* remove the item (we still have a copy of the data) */
495 g_array_remove_index_fast(tids->pids, ii-1); /* disturbs only indices >= ii-1 which we've already handled */
497 /* Report exit status unless we got ECHILD above or somehow waitpid returned the wrong pid */
498 if (wait_rc == tp.pid) {
499 if (WIFEXITED(status)) {
500 tr_debug("tids_sweep_procs: TID process %d exited with status %d.", tp.pid, WTERMSIG(status));
501 } else if (WIFSIGNALED(status)) {
502 tr_debug("tids_sweep_procs: TID process %d terminated by signal %d.", tp.pid, WTERMSIG(status));
504 } else if (wait_rc > 0) {
505 tr_err("tids_sweep_procs: waitpid returned pid %d, expected %d", wait_rc, tp.pid);
508 /* read the pipe - if the TID request worked, it will have written status before terminating */
509 result_len = read(tp.read_fd, result, sizeof(result)/sizeof(result[0]));
512 if ((result_len > 0) && (strcmp(result, "OK") == 0)) {
514 tr_debug("tids_sweep_procs: TID process %d succeeded", tp.pid);
517 tr_debug("tids_sweep_procs: TID process %d failed", tp.pid);
522 /* Process tids requests forever. Should not return except on error. */
523 int tids_start (TIDS_INSTANCE *tids,
524 TIDS_REQ_FUNC *req_handler,
525 tids_auth_func *auth_handler,
526 const char *hostname,
530 int fd[TR_MAX_SOCKETS]={0};
532 struct pollfd poll_fd[TR_MAX_SOCKETS]={{0}};
535 n_fd = tids_get_listener(tids, req_handler, auth_handler, hostname, port, cookie, fd, TR_MAX_SOCKETS);
537 perror ("Error from tids_listen()");
541 tr_info("Trust Path Query Server starting on host %s:%d.", hostname, port);
543 /* set up the poll structs */
544 for (ii=0; ii<n_fd; ii++) {
545 poll_fd[ii].fd=fd[ii];
546 poll_fd[ii].events=POLLIN;
549 while(1) { /* accept incoming conns until we are stopped */
550 /* clear out events from previous iteration */
551 for (ii=0; ii<n_fd; ii++)
552 poll_fd[ii].revents=0;
554 /* wait indefinitely for a connection */
555 if (poll(poll_fd, n_fd, -1) < 0) {
556 perror("Error from poll()");
560 /* fork handlers for any sockets that have data */
561 for (ii=0; ii<n_fd; ii++) {
562 if (poll_fd[ii].revents == 0)
565 if ((poll_fd[ii].revents & POLLERR) || (poll_fd[ii].revents & POLLNVAL)) {
566 perror("Error polling fd");
570 if (poll_fd[ii].revents & POLLIN) {
571 if (tids_accept(tids, poll_fd[ii].fd))
572 tr_err("tids_start: error in tids_accept().");
577 return 1; /* should never get here, loops "forever" */
580 void tids_destroy (TIDS_INSTANCE *tids)
582 /* clean up logfiles */