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 <trust_router/tr_name.h>
  39 #include <tr_gss.h>
  40 #include <tr_config.h>
  41 #include <tr_rp.h>
  42 #include <tr_debug.h>
  43
  44 static int tr_rp_client_destructor(void *obj)
  45 {
  46   return 0;
  47 }
  48
  49 TR_RP_CLIENT *tr_rp_client_new(TALLOC_CTX *mem_ctx)
  50 {
  51   TR_RP_CLIENT *client=talloc(mem_ctx, TR_RP_CLIENT);
  52
  53   if (client!=NULL) {
  54     client->next=NULL;
  55     client->comm_next=NULL;
  56     client->gss_names=NULL;
  57     client->filter=NULL;
  58     talloc_set_destructor((void *)client, tr_rp_client_destructor);
  59   }
  60   return client;
  61 }
  62
  63 void tr_rp_client_free(TR_RP_CLIENT *client)
  64 {
  65   talloc_free(client);
  66 }
  67
  68 static TR_RP_CLIENT *tr_rp_client_tail(TR_RP_CLIENT *client)
  69 {
  70   if (client==NULL)
  71     return NULL;
  72
  73   while (client->next!=NULL)
  74     client=client->next;
  75   return client;
  76 }
  77
  78 /* do not call directly, use the tr_rp_client_add() macro */
  79 TR_RP_CLIENT *tr_rp_client_add_func(TR_RP_CLIENT *clients, TR_RP_CLIENT *new)
  80 {
  81   if (clients==NULL)
  82     clients=new;
  83   else {
  84     tr_rp_client_tail(clients)->next=new;
  85     while (new!=NULL) {
  86       talloc_steal(clients, new); /* put it in the right context */
  87       new=new->next;
  88     }
  89   }
  90   return clients;
  91 }
  92
  93
  94 int tr_rp_client_add_gss_name(TR_RP_CLIENT *rp_client, TR_NAME *gss_name)
  95 {
  96   return tr_gss_names_add(rp_client->gss_names, gss_name);
  97 }
  98
  99 int tr_rp_client_set_filter(TR_RP_CLIENT *client, TR_FILTER *filt)
 100 {
 101   if (client->filter!=NULL)
 102     tr_filter_free(client->filter);
 103   client->filter=filt;
 104   talloc_steal(client, filt);
 105   return 0; /* success */
 106 }
 107
 108 TR_RP_CLIENT *tr_rp_client_lookup(TR_RP_CLIENT *rp_clients, TR_NAME *gss_name)
 109 {
 110   TR_RP_CLIENT *rp = NULL;
 111
 112   if ((!rp_clients) || (!gss_name)) {
 113     tr_debug("tr_rp_client_lookup: Bad parameters.");
 114     return NULL;
 115   }
 116
 117   for (rp = rp_clients; NULL != rp; rp = rp->next) {
 118     if (tr_gss_names_matches(rp->gss_names, gss_name))
 119       return rp;
 120   }
 121   return NULL;
 122 }
 123
 124 TR_RP_REALM *tr_rp_realm_lookup(TR_RP_REALM *rp_realms, TR_NAME *rp_name)
 125 {
 126   TR_RP_REALM *rp = NULL;
 127
 128   if (!rp_name) {
 129     tr_debug("tr_rp_realm_lookup: Bad parameters.");
 130     return NULL;
 131   }
 132
 133   for (rp=rp_realms; NULL!=rp; rp=rp->next) {
 134     if (0==tr_name_cmp(tr_rp_realm_get_id(rp), rp_name))
 135       return rp;
 136   }
 137   return NULL;
 138 }
 139
 140 static int tr_rp_realm_destructor(void *obj)
 141 {
 142   TR_RP_REALM *rp=talloc_get_type_abort(obj, TR_RP_REALM);
 143   if (rp->realm_id!=NULL)
 144     tr_free_name(rp->realm_id);
 145   return 0;
 146 }
 147
 148 TR_RP_REALM *tr_rp_realm_new(TALLOC_CTX *mem_ctx)
 149 {
 150   TR_RP_REALM *rp=talloc(mem_ctx, TR_RP_REALM);
 151   if (rp!=NULL) {
 152     rp->next=NULL;
 153     rp->realm_id=NULL;
 154     rp->refcount=0;
 155     talloc_set_destructor((void *)rp, tr_rp_realm_destructor);
 156   }
 157   return rp;
 158 }
 159
 160 void tr_rp_realm_free(TR_RP_REALM *rp)
 161 {
 162   talloc_free(rp);
 163 }
 164
 165 /* talloc note: lists of idp realms should be assembled using
 166  * tr_idp_realm_add(). This will put all of the elements in the
 167  * list, other than the head, as children of the head context.
 168  * The head can then be placed in whatever context is desired. */
 169
 170 static TR_RP_REALM *tr_rp_realm_tail(TR_RP_REALM *realm)
 171 {
 172   if (realm==NULL)
 173     return NULL;
 174
 175   while (realm->next!=NULL)
 176     realm=realm->next;
 177   return realm;
 178 }
 179
 180 /* for correct behavior, call like: rp_realms=tr_rp_realm_add_func(rp_realms, new_realm);
 181  * or better yet, use the macro */
 182 TR_RP_REALM *tr_rp_realm_add_func(TR_RP_REALM *head, TR_RP_REALM *new)
 183 {
 184   if (head==NULL)
 185     head=new;
 186   else {
 187     tr_rp_realm_tail(head)->next=new;
 188     while (new!=NULL) {
 189       talloc_steal(head, new); /* put it in the right context */
 190       new=new->next;
 191     }
 192   }
 193   return head;
 194 }
 195
 196 /* use the macro */
 197 TR_RP_REALM *tr_rp_realm_remove_func(TR_RP_REALM *head, TR_RP_REALM *remove)
 198 {
 199   TALLOC_CTX *list_ctx=talloc_parent(head);
 200   TR_RP_REALM *this=NULL;
 201
 202   if (head==NULL)
 203     return NULL;
 204
 205   if (head==remove) {
 206     /* if we're removing the head, put the next element (if present) into the context
 207      * the list head was in. */
 208     head=head->next;
 209     if (head!=NULL) {
 210       talloc_steal(list_ctx, head);
 211       /* now put all the other elements in the context of the list head */
 212       for (this=head->next; this!=NULL; this=this->next)
 213         talloc_steal(head, this);
 214     }
 215   } else {
 216     /* not removing the head; no need to play with contexts */
 217     for (this=head; this->next!=NULL; this=this->next) {
 218       if (this->next==remove) {
 219         this->next=remove->next;
 220         break;
 221       }
 222     }
 223   }
 224   return head;
 225 }
 226
 227 void tr_rp_realm_incref(TR_RP_REALM *realm)
 228 {
 229   realm->refcount++;
 230 }
 231
 232 void tr_rp_realm_decref(TR_RP_REALM *realm)
 233 {
 234   if (realm->refcount>0)
 235     realm->refcount--;
 236 }
 237
 238 /* remove any with zero refcount
 239  * Call via macro. */
 240 TR_RP_REALM *tr_rp_realm_sweep_func(TR_RP_REALM *head)
 241 {
 242   TR_RP_REALM *rp=NULL;
 243   TR_RP_REALM *old_next=NULL;
 244
 245   if (head==NULL)
 246     return NULL;
 247
 248   while ((head!=NULL) && (head->refcount==0)) {
 249     rp=head; /* keep a pointer so we can remove it */
 250     tr_rp_realm_remove(head, rp); /* use this to get talloc contexts right */
 251     tr_rp_realm_free(rp);
 252   }
 253
 254   if (head==NULL)
 255     return NULL;
 256
 257   /* will not remove the head here, that has already been done */
 258   for (rp=head; rp->next!=NULL; rp=rp->next) {
 259     if (rp->next->refcount==0) {
 260       old_next=rp->next;
 261       tr_rp_realm_remove(head, rp->next); /* changes rp->next */
 262       tr_rp_realm_free(old_next);
 263     }
 264   }
 265
 266   return head;
 267 }
 268
 269 TR_NAME *tr_rp_realm_get_id(TR_RP_REALM *rp)
 270 {
 271   if (rp==NULL)
 272     return NULL;
 273
 274   return rp->realm_id;
 275 }
 276
 277 TR_NAME *tr_rp_realm_dup_id(TR_RP_REALM *rp)
 278 {
 279   if (rp==NULL)
 280     return NULL;
 281
 282   return tr_dup_name(tr_rp_realm_get_id(rp));
 283 }
 284
 285 void tr_rp_realm_set_id(TR_RP_REALM *rp, TR_NAME *id)
 286 {
 287   if (rp->realm_id!=NULL)
 288     tr_free_name(rp->realm_id);
 289   rp->realm_id=id;
 290 }
 291
 292 char *tr_rp_realm_to_str(TALLOC_CTX *mem_ctx, TR_RP_REALM *rp)
 293 {
 294   return talloc_asprintf(mem_ctx,
 295                          "RP realm: \"%.*s\"\n",
 296                          rp->realm_id->len, rp->realm_id->buf);
 297 }