include/tr_idp.h

   1 /*
   2  * Copyright (c) 2012, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  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.
  15  *
  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.
  19  *
  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.
  32  *
  33  */
  34
  35 #ifndef TR_IDP_H
  36 #define TR_IDP_H
  37
  38 #include <talloc.h>
  39 #include <time.h>
  40
  41 #include <tr_name_internal.h>
  42 #include <tr_aaa_server.h>
  43 #include <tr_apc.h>
  44
  45 /* may also want to use in tr_rp.h */
  46 typedef enum tr_realm_origin {
  47   TR_REALM_LOCAL=0, /* realm we were configured to contact */
  48   TR_REALM_REMOTE_INCOMPLETE, /* realm we were configured to know about, without contact info yet */
  49   TR_REALM_REMOTE, /* realm we were configured to know about, with discovered contact info */
  50   TR_REALM_DISCOVERED /* realm we learned about from a peer */
  51 } TR_REALM_ORIGIN;
  52
  53 typedef struct tr_idp_realm {
  54   struct tr_idp_realm *next;
  55   struct tr_idp_realm *comm_next; /* for linked list in comm config */
  56   TR_NAME *realm_id;
  57   int shared_config;
  58   TR_AAA_SERVER *aaa_servers;
  59   TR_APC *apcs;
  60   TR_REALM_ORIGIN origin; /* how did we learn about this realm? */
  61   unsigned int refcount; /* how many TR_COMM_MEMBs refer to this realm */
  62 } TR_IDP_REALM;
  63
  64 TR_IDP_REALM *tr_idp_realm_new(TALLOC_CTX *mem_ctx);
  65 void tr_idp_realm_free(TR_IDP_REALM *idp);
  66 TR_NAME *tr_idp_realm_get_id(TR_IDP_REALM *idp);
  67 TR_NAME *tr_idp_realm_dup_id(TR_IDP_REALM *idp);
  68 void tr_idp_realm_set_id(TR_IDP_REALM *idp, TR_NAME *id);
  69 void tr_idp_realm_set_apcs(TR_IDP_REALM *idp, TR_APC *apc);
  70 TR_APC *tr_idp_realm_get_apcs(TR_IDP_REALM *idp);
  71 TR_IDP_REALM *tr_idp_realm_lookup(TR_IDP_REALM *idp_realms, TR_NAME *idp_name);
  72 TR_IDP_REALM *tr_idp_realm_add_func(TR_IDP_REALM *head, TR_IDP_REALM *new);
  73 #define tr_idp_realm_add(head,new) ((head)=tr_idp_realm_add_func((head),(new)))
  74 TR_IDP_REALM *tr_idp_realm_remove_func(TR_IDP_REALM *head, TR_IDP_REALM *remove);
  75 #define tr_idp_realm_remove(head,remove) ((head)=tr_idp_realm_remove_func((head),(remove)))
  76 TR_IDP_REALM *tr_idp_realm_sweep_func(TR_IDP_REALM *head);
  77 #define tr_idp_realm_sweep(head) ((head)=tr_idp_realm_sweep_func((head)))
  78 int tr_idp_realm_aaa_server_count(TR_IDP_REALM *idp);
  79 int tr_idp_realm_apc_count(TR_IDP_REALM *idp);
  80 void tr_idp_realm_incref(TR_IDP_REALM *realm);
  81
  82 void tr_idp_realm_decref(TR_IDP_REALM *realm);
  83 TR_AAA_SERVER *tr_idp_aaa_server_lookup(TR_IDP_REALM *idp_realms, TR_NAME *idp_realm_name, TR_NAME *comm, int *shared_out);
  84 TR_AAA_SERVER *tr_default_server_lookup(TR_AAA_SERVER *default_servers, TR_NAME *comm);
  85
  86 /* tr_idp_encoders.c */
  87 char *tr_idp_realm_to_str(TALLOC_CTX *mem_ctx, TR_IDP_REALM *idp);
  88 json_t *tr_idp_realms_to_json(TR_IDP_REALM *idp);
  89
  90 #endif