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.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->filters=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_filters(TR_RP_CLIENT *client, TR_FILTER_SET *filts)
 100 {
 101   if (client->filters!=NULL)
 102     tr_filter_set_free(client->filters);
 103   client->filters=filts;
 104   talloc_steal(client, filts);
 105   return 0; /* success */
 106 }
 107
 108 TR_RP_CLIENT_ITER *tr_rp_client_iter_new(TALLOC_CTX *memctx)
 109 {
 110   return talloc(memctx, TR_RP_CLIENT_ITER);
 111 }
 112
 113 void tr_rp_client_iter_free(TR_RP_CLIENT_ITER *iter)
 114 {
 115   talloc_free(iter);
 116 }
 117
 118 TR_RP_CLIENT *tr_rp_client_iter_first(TR_RP_CLIENT_ITER *iter, TR_RP_CLIENT *rp_clients)
 119 {
 120   if (!iter) {
 121     tr_err("tr_rp_client_iter_first: Iterator is null, failing.");
 122     return NULL;
 123   }
 124   *iter=rp_clients;
 125   return *iter;
 126 }
 127
 128 TR_RP_CLIENT *tr_rp_client_iter_next(TR_RP_CLIENT_ITER *iter)
 129 {
 130   if (*iter)
 131     *iter=(*iter)->next;
 132   return *iter;
 133 }
 134
 135 /**
 136  * Find a client associated with a GSS name. It's possible there are other clients that match as well.
 137  *
 138  * @param rp_clients List of RP clients to search
 139  * @param gss_name GSS name to search for
 140  * @return Borrowed reference to an RP client linked to the GSS name
 141  */
 142 TR_RP_CLIENT *tr_rp_client_lookup(TR_RP_CLIENT *rp_clients, TR_NAME *gss_name)
 143 {
 144   TR_RP_CLIENT_ITER *iter=tr_rp_client_iter_new(NULL);
 145   TR_RP_CLIENT *client=NULL;
 146
 147   if (iter==NULL) {
 148     tr_err("tr_rp_client_lookup: Unable to allocate iterator");
 149     return NULL;
 150   }
 151   for (client=tr_rp_client_iter_first(iter, rp_clients); client != NULL; client=tr_rp_client_iter_next(iter)) {
 152     if (tr_gss_names_matches(client->gss_names, gss_name))
 153       break;
 154   }
 155   tr_rp_client_iter_free(iter);
 156   return client;
 157 }
 158
 159 TR_RP_REALM *tr_rp_realm_lookup(TR_RP_REALM *rp_realms, TR_NAME *rp_name)
 160 {
 161   TR_RP_REALM *rp = NULL;
 162
 163   if (!rp_name) {
 164     tr_debug("tr_rp_realm_lookup: Bad parameters.");
 165     return NULL;
 166   }
 167
 168   for (rp=rp_realms; NULL!=rp; rp=rp->next) {
 169     if (0==tr_name_cmp(tr_rp_realm_get_id(rp), rp_name))
 170       return rp;
 171   }
 172   return NULL;
 173 }
 174
 175 static int tr_rp_realm_destructor(void *obj)
 176 {
 177   TR_RP_REALM *rp=talloc_get_type_abort(obj, TR_RP_REALM);
 178   if (rp->realm_id!=NULL)
 179     tr_free_name(rp->realm_id);
 180   return 0;
 181 }
 182
 183 TR_RP_REALM *tr_rp_realm_new(TALLOC_CTX *mem_ctx)
 184 {
 185   TR_RP_REALM *rp=talloc(mem_ctx, TR_RP_REALM);
 186   if (rp!=NULL) {
 187     rp->next=NULL;
 188     rp->realm_id=NULL;
 189     rp->refcount=0;
 190     talloc_set_destructor((void *)rp, tr_rp_realm_destructor);
 191   }
 192   return rp;
 193 }
 194
 195 void tr_rp_realm_free(TR_RP_REALM *rp)
 196 {
 197   talloc_free(rp);
 198 }
 199
 200 /* talloc note: lists of idp realms should be assembled using
 201  * tr_idp_realm_add(). This will put all of the elements in the
 202  * list, other than the head, as children of the head context.
 203  * The head can then be placed in whatever context is desired. */
 204
 205 static TR_RP_REALM *tr_rp_realm_tail(TR_RP_REALM *realm)
 206 {
 207   if (realm==NULL)
 208     return NULL;
 209
 210   while (realm->next!=NULL)
 211     realm=realm->next;
 212   return realm;
 213 }
 214
 215 /* for correct behavior, call like: rp_realms=tr_rp_realm_add_func(rp_realms, new_realm);
 216  * or better yet, use the macro */
 217 TR_RP_REALM *tr_rp_realm_add_func(TR_RP_REALM *head, TR_RP_REALM *new)
 218 {
 219   if (head==NULL)
 220     head=new;
 221   else {
 222     tr_rp_realm_tail(head)->next=new;
 223     while (new!=NULL) {
 224       talloc_steal(head, new); /* put it in the right context */
 225       new=new->next;
 226     }
 227   }
 228   return head;
 229 }
 230
 231 /* use the macro */
 232 TR_RP_REALM *tr_rp_realm_remove_func(TR_RP_REALM *head, TR_RP_REALM *remove)
 233 {
 234   TALLOC_CTX *list_ctx=talloc_parent(head);
 235   TR_RP_REALM *this=NULL;
 236
 237   if (head==NULL)
 238     return NULL;
 239
 240   if (head==remove) {
 241     /* if we're removing the head, put the next element (if present) into the context
 242      * the list head was in. */
 243     head=head->next;
 244     if (head!=NULL) {
 245       talloc_steal(list_ctx, head);
 246       /* now put all the other elements in the context of the list head */
 247       for (this=head->next; this!=NULL; this=this->next)
 248         talloc_steal(head, this);
 249     }
 250   } else {
 251     /* not removing the head; no need to play with contexts */
 252     for (this=head; this->next!=NULL; this=this->next) {
 253       if (this->next==remove) {
 254         this->next=remove->next;
 255         break;
 256       }
 257     }
 258   }
 259   return head;
 260 }
 261
 262 void tr_rp_realm_incref(TR_RP_REALM *realm)
 263 {
 264   realm->refcount++;
 265 }
 266
 267 void tr_rp_realm_decref(TR_RP_REALM *realm)
 268 {
 269   if (realm->refcount>0)
 270     realm->refcount--;
 271 }
 272
 273 /* remove any with zero refcount
 274  * Call via macro. */
 275 TR_RP_REALM *tr_rp_realm_sweep_func(TR_RP_REALM *head)
 276 {
 277   TR_RP_REALM *rp=NULL;
 278   TR_RP_REALM *old_next=NULL;
 279
 280   if (head==NULL)
 281     return NULL;
 282
 283   while ((head!=NULL) && (head->refcount==0)) {
 284     rp=head; /* keep a pointer so we can remove it */
 285     tr_rp_realm_remove(head, rp); /* use this to get talloc contexts right */
 286     tr_rp_realm_free(rp);
 287   }
 288
 289   if (head==NULL)
 290     return NULL;
 291
 292   /* will not remove the head here, that has already been done */
 293   for (rp=head; (rp!=NULL) && (rp->next!=NULL); rp=rp->next) {
 294     if (rp->next->refcount==0) {
 295       old_next=rp->next;
 296       tr_rp_realm_remove(head, rp->next); /* changes rp->next, may make it null */
 297       tr_rp_realm_free(old_next);
 298     }
 299   }
 300
 301   return head;
 302 }
 303
 304 TR_NAME *tr_rp_realm_get_id(TR_RP_REALM *rp)
 305 {
 306   if (rp==NULL)
 307     return NULL;
 308
 309   return rp->realm_id;
 310 }
 311
 312 TR_NAME *tr_rp_realm_dup_id(TR_RP_REALM *rp)
 313 {
 314   if (rp==NULL)
 315     return NULL;
 316
 317   return tr_dup_name(tr_rp_realm_get_id(rp));
 318 }
 319
 320 void tr_rp_realm_set_id(TR_RP_REALM *rp, TR_NAME *id)
 321 {
 322   if (rp->realm_id!=NULL)
 323     tr_free_name(rp->realm_id);
 324   rp->realm_id=id;
 325 }
 326
 327 char *tr_rp_realm_to_str(TALLOC_CTX *mem_ctx, TR_RP_REALM *rp)
 328 {
 329   return talloc_asprintf(mem_ctx,
 330                          "RP realm: \"%.*s\"\n",
 331                          rp->realm_id->len, rp->realm_id->buf);
 332 }