common/tr_rp.c

   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 #include <talloc.h>
  36
  37 #include <tr.h>
  38 #include <tr_name_internal.h>
  39 #include <tr_gss_names.h>
  40 #include <tr_config.h>
  41 #include <tr_rp.h>
  42 #include <tr_debug.h>
  43
  44 TR_RP_REALM *tr_rp_realm_lookup(TR_RP_REALM *rp_realms, TR_NAME *rp_name)
  45 {
  46   TR_RP_REALM *rp = NULL;
  47
  48   if (!rp_name) {
  49     tr_debug("tr_rp_realm_lookup: Bad parameters.");
  50     return NULL;
  51   }
  52
  53   for (rp=rp_realms; NULL!=rp; rp=rp->next) {
  54     if (0==tr_name_cmp(tr_rp_realm_get_id(rp), rp_name))
  55       return rp;
  56   }
  57   return NULL;
  58 }
  59
  60 static int tr_rp_realm_destructor(void *obj)
  61 {
  62   TR_RP_REALM *rp=talloc_get_type_abort(obj, TR_RP_REALM);
  63   if (rp->realm_id!=NULL)
  64     tr_free_name(rp->realm_id);
  65   return 0;
  66 }
  67
  68 TR_RP_REALM *tr_rp_realm_new(TALLOC_CTX *mem_ctx)
  69 {
  70   TR_RP_REALM *rp=talloc(mem_ctx, TR_RP_REALM);
  71   if (rp!=NULL) {
  72     rp->next=NULL;
  73     rp->realm_id=NULL;
  74     rp->refcount=0;
  75     talloc_set_destructor((void *)rp, tr_rp_realm_destructor);
  76   }
  77   return rp;
  78 }
  79
  80 void tr_rp_realm_free(TR_RP_REALM *rp)
  81 {
  82   talloc_free(rp);
  83 }
  84
  85 /* talloc note: lists of idp realms should be assembled using
  86  * tr_idp_realm_add(). This will put all of the elements in the
  87  * list, other than the head, as children of the head context.
  88  * The head can then be placed in whatever context is desired. */
  89
  90 static TR_RP_REALM *tr_rp_realm_tail(TR_RP_REALM *realm)
  91 {
  92   if (realm==NULL)
  93     return NULL;
  94
  95   while (realm->next!=NULL)
  96     realm=realm->next;
  97   return realm;
  98 }
  99
 100 /* for correct behavior, call like: rp_realms=tr_rp_realm_add_func(rp_realms, new_realm);
 101  * or better yet, use the macro */
 102 TR_RP_REALM *tr_rp_realm_add_func(TR_RP_REALM *head, TR_RP_REALM *new)
 103 {
 104   if (head==NULL)
 105     head=new;
 106   else {
 107     tr_rp_realm_tail(head)->next=new;
 108     while (new!=NULL) {
 109       talloc_steal(head, new); /* put it in the right context */
 110       new=new->next;
 111     }
 112   }
 113   return head;
 114 }
 115
 116 /* use the macro */
 117 TR_RP_REALM *tr_rp_realm_remove_func(TR_RP_REALM *head, TR_RP_REALM *remove)
 118 {
 119   TALLOC_CTX *list_ctx=talloc_parent(head);
 120   TR_RP_REALM *this=NULL;
 121
 122   if (head==NULL)
 123     return NULL;
 124
 125   if (head==remove) {
 126     /* if we're removing the head, put the next element (if present) into the context
 127      * the list head was in. */
 128     head=head->next;
 129     if (head!=NULL) {
 130       talloc_steal(list_ctx, head);
 131       /* now put all the other elements in the context of the list head */
 132       for (this=head->next; this!=NULL; this=this->next)
 133         talloc_steal(head, this);
 134     }
 135   } else {
 136     /* not removing the head; no need to play with contexts */
 137     for (this=head; this->next!=NULL; this=this->next) {
 138       if (this->next==remove) {
 139         this->next=remove->next;
 140         break;
 141       }
 142     }
 143   }
 144   return head;
 145 }
 146
 147 void tr_rp_realm_incref(TR_RP_REALM *realm)
 148 {
 149   realm->refcount++;
 150 }
 151
 152 void tr_rp_realm_decref(TR_RP_REALM *realm)
 153 {
 154   if (realm->refcount>0)
 155     realm->refcount--;
 156 }
 157
 158 /* remove any with zero refcount
 159  * Call via macro. */
 160 TR_RP_REALM *tr_rp_realm_sweep_func(TR_RP_REALM *head)
 161 {
 162   TR_RP_REALM *rp=NULL;
 163   TR_RP_REALM *old_next=NULL;
 164
 165   if (head==NULL)
 166     return NULL;
 167
 168   while ((head!=NULL) && (head->refcount==0)) {
 169     rp=head; /* keep a pointer so we can remove it */
 170     tr_rp_realm_remove(head, rp); /* use this to get talloc contexts right */
 171     tr_rp_realm_free(rp);
 172   }
 173
 174   if (head==NULL)
 175     return NULL;
 176
 177   /* will not remove the head here, that has already been done */
 178   for (rp=head; (rp!=NULL) && (rp->next!=NULL); rp=rp->next) {
 179     if (rp->next->refcount==0) {
 180       old_next=rp->next;
 181       tr_rp_realm_remove(head, rp->next); /* changes rp->next, may make it null */
 182       tr_rp_realm_free(old_next);
 183     }
 184   }
 185
 186   return head;
 187 }
 188
 189 TR_NAME *tr_rp_realm_get_id(TR_RP_REALM *rp)
 190 {
 191   if (rp==NULL)
 192     return NULL;
 193
 194   return rp->realm_id;
 195 }
 196
 197 TR_NAME *tr_rp_realm_dup_id(TR_RP_REALM *rp)
 198 {
 199   if (rp==NULL)
 200     return NULL;
 201
 202   return tr_dup_name(tr_rp_realm_get_id(rp));
 203 }
 204
 205 void tr_rp_realm_set_id(TR_RP_REALM *rp, TR_NAME *id)
 206 {
 207   if (rp->realm_id!=NULL)
 208     tr_free_name(rp->realm_id);
 209   rp->realm_id=id;
 210 }
 211
 212 char *tr_rp_realm_to_str(TALLOC_CTX *mem_ctx, TR_RP_REALM *rp)
 213 {
 214   return talloc_asprintf(mem_ctx,
 215                          "RP realm: \"%.*s\"\n",
 216                          rp->realm_id->len, rp->realm_id->buf);
 217 }
 218