2 * Copyright (c) 2012, 2015, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
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.
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.
46 typedef struct tr_comm_table TR_COMM_TABLE;
48 typedef enum tr_comm_type {
54 typedef struct tr_comm {
59 TR_NAME *owner_realm; /* what realm owns this community? */
60 TR_NAME *owner_contact; /* contact email */
61 time_t expiration_interval; /*Minutes to key expiration; only valid for an APC*/
62 unsigned int refcount; /* how many TR_COMM_MEMBs refer to this community? */
65 /* community membership - link realms to their communities */
66 typedef struct tr_comm_memb {
67 struct tr_comm_memb *next;
68 struct tr_comm_memb *origin_next; /* for multiple copies from different origins */
69 TR_IDP_REALM *idp; /* only set one of idp and rp, other null */
70 TR_RP_REALM *rp; /* only set one of idp and rp, other null */
73 json_t *provenance; /* array of names of systems traversed */
74 unsigned int interval;
75 struct timespec *expiry;
76 unsigned int times_expired; /* how many times has this expired? */
77 int triggered; /* do we need to send this with triggered updates? */
80 /* table of communities/memberships */
81 struct tr_comm_table {
82 TR_COMM *comms; /* all communities */
83 TR_IDP_REALM *idp_realms; /* all idp realms */
84 TR_RP_REALM *rp_realms; /* all rp realms */
85 TR_COMM_MEMB *memberships; /* head of the linked list of membership records */
88 typedef enum tr_realm_role {
94 typedef struct tr_realm {
100 /* nb, not all iterator routines use all members */
101 typedef struct tr_comm_iter {
103 TR_COMM_MEMB *cur_memb;
104 TR_COMM_MEMB *cur_orig_head; /* for iterating along orig_next list */
105 TR_NAME *match; /* realm or comm to match */
106 TR_REALM *realm; /* handle so caller does not have to manage memory, private */
110 TR_COMM_TABLE *tr_comm_table_new(TALLOC_CTX *mem_ctx);
111 void tr_comm_table_free(TR_COMM_TABLE *ctab);
113 TR_COMM_TABLE *tr_comm_table_new(TALLOC_CTX *mem_ctx);
114 void tr_comm_table_free(TR_COMM_TABLE *ctab);
115 void tr_comm_table_sweep(TR_COMM_TABLE *ctab);
116 int tr_comm_table_add_comm(TR_COMM_TABLE *ctab, TR_COMM *new);
117 void tr_comm_table_remove_comm(TR_COMM_TABLE *ctab, TR_COMM *comm);
118 TR_RP_REALM *tr_comm_table_find_rp_realm(TR_COMM_TABLE *ctab, TR_NAME *realm_id);
119 void tr_comm_table_add_rp_realm(TR_COMM_TABLE *ctab, TR_RP_REALM *new);
120 void tr_comm_table_remove_rp_realm(TR_COMM_TABLE *ctab, TR_RP_REALM *realm);
121 TR_IDP_REALM *tr_comm_table_find_idp_realm(TR_COMM_TABLE *ctab, TR_NAME *realm_id);
122 void tr_comm_table_add_idp_realm(TR_COMM_TABLE *ctab, TR_IDP_REALM *new);
123 void tr_comm_table_remove_idp_realm(TR_COMM_TABLE *ctab, TR_IDP_REALM *realm);
124 void tr_comm_table_add_memb(TR_COMM_TABLE *ctab, TR_COMM_MEMB *new);
125 void tr_comm_table_remove_memb(TR_COMM_TABLE *ctab, TR_COMM_MEMB *memb);
126 TR_COMM_MEMB *tr_comm_table_find_memb_origin(TR_COMM_TABLE *ctab, TR_NAME *realm, TR_NAME *comm, TR_NAME *origin);
127 TR_COMM_MEMB *tr_comm_table_find_memb(TR_COMM_TABLE *ctab, TR_NAME *realm, TR_NAME *comm);
128 TR_COMM_MEMB *tr_comm_table_find_rp_memb_origin(TR_COMM_TABLE *ctab, TR_NAME *rp_realm, TR_NAME *comm, TR_NAME *origin);
129 TR_COMM_MEMB *tr_comm_table_find_rp_memb(TR_COMM_TABLE *ctab, TR_NAME *rp_realm, TR_NAME *comm);
130 TR_COMM_MEMB *tr_comm_table_find_idp_memb_origin(TR_COMM_TABLE *ctab, TR_NAME *idp_realm, TR_NAME *comm, TR_NAME *origin);
131 TR_COMM_MEMB *tr_comm_table_find_idp_memb(TR_COMM_TABLE *ctab, TR_NAME *idp_realm, TR_NAME *comm);
132 TR_COMM *tr_comm_table_find_comm(TR_COMM_TABLE *ctab, TR_NAME *comm_id);
133 size_t tr_comm_table_size(TR_COMM_TABLE *ctab);
134 char *tr_comm_table_to_str(TALLOC_CTX *mem_ctx, TR_COMM_TABLE *ctab);
135 void tr_comm_table_print(FILE *f, TR_COMM_TABLE *ctab);
137 TR_COMM_MEMB *tr_comm_memb_new(TALLOC_CTX *mem_ctx);
138 void tr_comm_memb_free(TR_COMM_MEMB *memb);
139 int tr_comm_memb_cmp(TR_COMM_MEMB *m1, TR_COMM_MEMB *m2);
140 TR_REALM_ROLE tr_comm_memb_get_role(TR_COMM_MEMB *memb);
141 void tr_comm_memb_set_rp_realm(TR_COMM_MEMB *memb, TR_RP_REALM *realm);
142 TR_RP_REALM *tr_comm_memb_get_rp_realm(TR_COMM_MEMB *memb);
143 void tr_comm_memb_set_idp_realm(TR_COMM_MEMB *memb, TR_IDP_REALM *realm);
144 TR_IDP_REALM *tr_comm_memb_get_idp_realm(TR_COMM_MEMB *memb);
145 TR_NAME *tr_comm_memb_get_realm_id(TR_COMM_MEMB *memb);
146 void tr_comm_memb_set_comm(TR_COMM_MEMB *memb, TR_COMM *comm);
147 TR_COMM *tr_comm_memb_get_comm(TR_COMM_MEMB *memb);
148 TR_NAME *tr_comm_memb_get_origin(TR_COMM_MEMB *memb);
149 TR_NAME *tr_comm_memb_dup_origin(TR_COMM_MEMB *memb);
150 json_t *tr_comm_memb_get_provenance(TR_COMM_MEMB *memb);
151 void tr_comm_memb_set_provenance(TR_COMM_MEMB *memb, json_t *prov);
152 void tr_comm_memb_add_to_provenance(TR_COMM_MEMB *memb, TR_NAME *hop);
153 size_t tr_comm_memb_provenance_len(TR_COMM_MEMB *memb);
154 void tr_comm_memb_set_interval(TR_COMM_MEMB *memb, unsigned int interval);
155 unsigned int tr_comm_memb_get_interval(TR_COMM_MEMB *memb);
156 void tr_comm_memb_set_expiry(TR_COMM_MEMB *memb, struct timespec *time);
157 struct timespec *tr_comm_memb_get_expiry(TR_COMM_MEMB *memb);
158 struct timespec *tr_comm_memb_get_expiry_realtime(TR_COMM_MEMB *memb, struct timespec *result);
159 int tr_comm_memb_is_expired(TR_COMM_MEMB *memb, struct timespec *curtime);
160 void tr_comm_memb_set_triggered(TR_COMM_MEMB *memb, int trig);
161 int tr_comm_memb_is_triggered(TR_COMM_MEMB *memb);
162 void tr_comm_memb_reset_times_expired(TR_COMM_MEMB *memb);
163 void tr_comm_memb_expire(TR_COMM_MEMB *memb);
164 unsigned int tr_comm_memb_get_times_expired(TR_COMM_MEMB *memb);
166 TR_COMM *tr_comm_new(TALLOC_CTX *mem_ctx);
167 void tr_comm_free(TR_COMM *comm);
168 void tr_comm_set_id(TR_COMM *comm, TR_NAME *id);
169 TR_NAME *tr_comm_get_id(TR_COMM *comm);
170 TR_NAME *tr_comm_dup_id(TR_COMM *comm);
171 void tr_comm_set_apcs(TR_COMM *comm, TR_APC *apc);
172 TR_APC *tr_comm_get_apcs(TR_COMM *comm);
173 void tr_comm_set_type(TR_COMM *comm, TR_COMM_TYPE type);
174 TR_COMM_TYPE tr_comm_get_type(TR_COMM *comm);
175 void tr_comm_set_owner_realm(TR_COMM *comm, TR_NAME *realm);
176 TR_NAME *tr_comm_get_owner_realm(TR_COMM *comm);
177 TR_NAME *tr_comm_dup_owner_realm(TR_COMM *comm);
178 void tr_comm_set_owner_contact(TR_COMM *comm, TR_NAME *contact);
179 TR_NAME *tr_comm_get_owner_contact(TR_COMM *comm);
180 TR_NAME *tr_comm_dup_owner_contact(TR_COMM *comm);
181 void tr_comm_add_idp_realm(TR_COMM_TABLE *ctab, TR_COMM *comm, TR_IDP_REALM *realm, unsigned int interval, json_t *provenance, struct timespec *expiry);
182 void tr_comm_add_rp_realm(TR_COMM_TABLE *ctab, TR_COMM *comm, TR_RP_REALM *realm, unsigned int interval, json_t *provenance, struct timespec *expiry);
183 TR_RP_REALM *tr_comm_find_rp(TR_COMM_TABLE *ctab, TR_COMM *comm, TR_NAME *rp_realm);
184 TR_IDP_REALM *tr_comm_find_idp(TR_COMM_TABLE *ctab, TR_COMM *comm, TR_NAME *idp_realm);
185 const char *tr_comm_type_to_str(TR_COMM_TYPE type);
186 TR_COMM_TYPE tr_comm_type_from_str(const char *s);
187 void tr_comm_incref(TR_COMM *comm);
188 void tr_comm_decref(TR_COMM *comm);
189 unsigned int tr_comm_get_refcount(TR_COMM *comm);
191 /* for iterating over communities within a realm or realms within a community */
192 TR_COMM_ITER *tr_comm_iter_new(TALLOC_CTX *mem_ctx);
193 void tr_comm_iter_free(TR_COMM_ITER *iter);
195 /* iterate over all communities in a table */
196 TR_COMM *tr_comm_table_iter_first(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab);
197 TR_COMM *tr_comm_table_iter_next(TR_COMM_ITER *);
199 /* these iterate over communities for a realm */
200 TR_COMM *tr_comm_iter_first(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *realm);
201 TR_COMM *tr_comm_iter_next(TR_COMM_ITER *iter);
202 TR_COMM *tr_comm_iter_first_rp(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *realm);
203 TR_COMM *tr_comm_iter_next_rp(TR_COMM_ITER *iter);
204 TR_COMM *tr_comm_iter_first_idp(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *realm);
205 TR_COMM *tr_comm_iter_next_idp(TR_COMM_ITER *iter);
207 /* iterate over realms for a community */
208 TR_REALM *tr_realm_iter_first(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *comm);
209 TR_REALM *tr_realm_iter_next(TR_COMM_ITER *iter);
210 TR_RP_REALM *tr_rp_realm_iter_first(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *comm);
211 TR_RP_REALM *tr_rp_realm_iter_next(TR_COMM_ITER *iter);
212 TR_IDP_REALM *tr_idp_realm_iter_first(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *comm);
213 TR_IDP_REALM *tr_idp_realm_iter_next(TR_COMM_ITER *iter);
215 /* iterate over members with different origins */
216 TR_COMM_MEMB *tr_comm_memb_iter_first(TR_COMM_ITER *iter, TR_COMM_MEMB *memb);
217 TR_COMM_MEMB *tr_comm_memb_iter_next(TR_COMM_ITER *iter);
219 /* iterate over all members */
220 TR_COMM_MEMB *tr_comm_memb_iter_all_first(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab);
221 TR_COMM_MEMB *tr_comm_memb_iter_all_next(TR_COMM_ITER *iter);
223 /* general realm stuff, should probably move */
224 TR_NAME *tr_realm_get_id(TR_REALM *realm);
225 TR_NAME *tr_realm_dup_id(TR_REALM *realm);
227 const char *tr_realm_role_to_str(TR_REALM_ROLE role);
228 TR_REALM_ROLE tr_realm_role_from_str(const char *s);
230 /* tr_comm_encoders.c */
231 json_t *tr_comm_table_to_json(TR_COMM_TABLE *ctable);