Checkpoint commit: refactoring the request code in TIDS for better reuse
[trust_router.git] / include / tr_rp.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_RP_H
36 #define TR_RP_H
37
38 #include <talloc.h>
39
40 #include <tr_gss_names.h>
41 #include <tr_filter.h>
42
43 typedef struct tr_rp_client {
44   struct tr_rp_client *next;
45   struct tr_rp_client *comm_next;
46   TR_GSS_NAMES *gss_names;
47   TR_FILTER_SET *filters;
48 } TR_RP_CLIENT;
49
50 typedef struct tr_rp_client *TR_RP_CLIENT_ITER;
51
52 /* Structure to make a linked list of RP realms by name for community config */
53 typedef struct tr_rp_realm {
54   struct tr_rp_realm *next;
55   TR_NAME *realm_id;
56   unsigned int refcount; /* how many TR_COMM_MEMBs refer to this realm */
57 } TR_RP_REALM;
58
59 /* prototypes */
60 TR_RP_CLIENT *tr_rp_client_new(TALLOC_CTX *mem_ctx);
61 void tr_rp_client_free(TR_RP_CLIENT *client);
62 TR_RP_CLIENT *tr_rp_client_add_func(TR_RP_CLIENT *clients, TR_RP_CLIENT *new);
63 #define tr_rp_client_add(clients,new) ((clients)=tr_rp_client_add_func((clients),(new)))
64 int tr_rp_client_add_gss_name(TR_RP_CLIENT *client, TR_NAME *name);
65 int tr_rp_client_set_filters(TR_RP_CLIENT *client, TR_FILTER_SET *filts);
66 TR_RP_CLIENT_ITER *tr_rp_client_iter_new(TALLOC_CTX *memctx);
67 void tr_rp_client_iter_free(TR_RP_CLIENT_ITER *iter);
68 TR_RP_CLIENT *tr_rp_client_iter_first(TR_RP_CLIENT_ITER *iter, TR_RP_CLIENT *rp_clients);
69 TR_RP_CLIENT *tr_rp_client_iter_next(TR_RP_CLIENT_ITER *iter);
70 TR_RP_CLIENT *tr_rp_client_lookup(TR_RP_CLIENT *rp_clients, TR_NAME *gss_name);
71
72 TR_RP_REALM *tr_rp_realm_new(TALLOC_CTX *mem_ctx);
73 void tr_rp_realm_free(TR_RP_REALM *rp);
74 TR_NAME *tr_rp_realm_get_id(TR_RP_REALM *rp);
75 TR_NAME *tr_rp_realm_dup_id(TR_RP_REALM *rp);
76 void tr_rp_realm_set_id(TR_RP_REALM *rp, TR_NAME *id);
77 TR_RP_REALM *tr_rp_realm_lookup(TR_RP_REALM *rp_realms, TR_NAME *rp_name);
78 TR_RP_REALM *tr_rp_realm_add_func(TR_RP_REALM *head, TR_RP_REALM *new);
79 #define tr_rp_realm_add(head,new) ((head)=tr_rp_realm_add_func((head),(new)))
80 TR_RP_REALM *tr_rp_realm_remove_func(TR_RP_REALM *head, TR_RP_REALM *remove);
81 #define tr_rp_realm_remove(head,remove) ((head)=tr_rp_realm_remove_func((head),(remove)))
82 TR_RP_REALM *tr_rp_realm_sweep_func(TR_RP_REALM *head);
83 #define tr_rp_realm_sweep(head) ((head)=tr_rp_realm_sweep_func((head)))
84 void tr_rp_realm_incref(TR_RP_REALM *realm);
85 void tr_rp_realm_decref(TR_RP_REALM *realm);
86
87 char *tr_rp_realm_to_str(TALLOC_CTX *mem_ctx, TR_RP_REALM *rp);
88
89 #endif