Refactoring to enable community flooding. Partially tested.

[trust_router.git] / include / tr_comm.h

diff --git a/include/tr_comm.h b/include/tr_comm.h
index 85c7b03..a660435 100644 (file)
--- a/include/tr_comm.h
+++ b/include/tr_comm.h
@@ -35,10 +35,15 @@
 #ifndef TR_COMM_H
 #define TR_COMM_H
 
+#include <talloc.h>
+#include <time.h>
+
 #include <tr_idp.h>
 #include <tr_rp.h>
 #include <tr_apc.h>
 
+typedef struct tr_comm_table TR_COMM_TABLE;
+
 typedef enum tr_comm_type {
   TR_COMM_UNKNOWN,
   TR_COMM_APC,
@@ -50,16 +55,78 @@ typedef struct tr_comm {
   TR_NAME *id;
   TR_COMM_TYPE type;
   TR_APC *apcs;
-  TR_IDP_REALM *idp_realms;
-  TR_RP_REALM *rp_realms;
   TR_NAME *owner_realm; /* what realm owns this community? */
   TR_NAME *owner_contact; /* contact email */
   time_t expiration_interval; /*Minutes to key expiration; only valid for an APC*/
+  unsigned int refcount; /* how many TR_COMM_MEMBs refer to this community? */
 } TR_COMM;
 
+/* community membership - link realms to their communities */
+typedef struct tr_comm_memb {
+  struct tr_comm_memb *next;
+  TR_IDP_REALM *idp; /* only set one of idp and rp, other null */
+  TR_RP_REALM *rp; /* only set one of idp and rp, other null */
+  TR_COMM *comm;
+  TR_NAME *origin;
+  json_t *provenance; /* array of names of systems traversed */
+  struct timespec *expiry;
+} TR_COMM_MEMB;
+
+/* table of communities/memberships */
+struct tr_comm_table {
+  TR_COMM *comms; /* all communities */
+  TR_COMM_MEMB *memberships; /* head of the linked list of membership records */
+}; 
+
+typedef struct tr_comm_iter {
+  TR_COMM_MEMB *cur_memb;
+  TR_NAME *match; /* realm or comm to match */
+} TR_COMM_ITER;
+
+typedef enum tr_realm_role {
+  TR_ROLE_UNKNOWN=0,
+  TR_ROLE_IDP,
+  TR_ROLE_RP
+} TR_REALM_ROLE;
+
+
+
+TR_COMM_TABLE *tr_comm_table_new(TALLOC_CTX *mem_ctx);
+void tr_comm_table_free(TR_COMM_TABLE *ctab);
+
+TR_COMM_TABLE *tr_comm_table_new(TALLOC_CTX *mem_ctx);
+void tr_comm_table_free(TR_COMM_TABLE *ctab);
+void tr_comm_table_add_comm(TR_COMM_TABLE *ctab, TR_COMM *new);
+void tr_comm_table_remove_comm(TR_COMM_TABLE *ctab, TR_COMM *comm);
+void tr_comm_table_add_memb(TR_COMM_TABLE *ctab, TR_COMM_MEMB *new);
+void tr_comm_table_remove_memb(TR_COMM_TABLE *ctab, TR_COMM_MEMB *memb);
+TR_COMM_MEMB *tr_comm_table_find_memb(TR_COMM_TABLE *ctab, TR_NAME *realm, TR_NAME *comm, TR_NAME *origin);
+TR_COMM_MEMB *tr_comm_table_find_rp_memb(TR_COMM_TABLE *ctab, TR_NAME *rp_realm, TR_NAME *comm, TR_NAME *origin); /* TODO ?? */
+TR_COMM_MEMB *tr_comm_table_find_idp_memb(TR_COMM_TABLE *ctab, TR_NAME *idp_realm, TR_NAME *comm, TR_NAME *origin); /* TODO ?? */
+TR_COMM *tr_comm_table_find_comm(TR_COMM_TABLE *ctab, TR_NAME *comm_id);
+size_t tr_comm_table_size(TR_COMM_TABLE *ctab);
+
+TR_COMM_MEMB *tr_comm_memb_new(TALLOC_CTX *mem_ctx);
+void tr_comm_memb_free(TR_COMM_MEMB *memb);
+void tr_comm_memb_set_rp_realm(TR_COMM_MEMB *memb, TR_RP_REALM *realm);
+TR_RP_REALM *tr_comm_memb_get_rp_realm(TR_COMM_MEMB *memb);
+void tr_comm_memb_set_idp_realm(TR_COMM_MEMB *memb, TR_IDP_REALM *realm);
+TR_IDP_REALM *tr_comm_memb_get_idp_realm(TR_COMM_MEMB *memb);
+void tr_comm_memb_set_comm(TR_COMM_MEMB *memb, TR_COMM *comm);
+TR_COMM *tr_comm_memb_get_comm(TR_COMM_MEMB *memb);
+TR_NAME *tr_comm_memb_get_origin(TR_COMM_MEMB *memb);
+TR_NAME *tr_comm_memb_dup_origin(TR_COMM_MEMB *memb);
+void tr_comm_memb_set_provenance(TR_COMM_MEMB *memb, json_t *prov);
+void tr_comm_memb_add_to_provenance(TR_COMM_MEMB *memb, TR_NAME *hop);
+size_t tr_comm_memb_provenance_len(TR_COMM_MEMB *memb);
+void tr_comm_memb_set_expiry(TR_COMM_MEMB *memb, struct timespec *time);
+struct timespec *tr_comm_memb_get_expiry(TR_COMM_MEMB *memb);
+int tr_comm_memb_is_expired(TR_COMM_MEMB *memb, struct timespec *curtime);
+
 TR_COMM *tr_comm_new(TALLOC_CTX *mem_ctx);
 void tr_comm_free(TR_COMM *comm);
 void tr_comm_set_id(TR_COMM *comm, TR_NAME *id);
+TR_APC *tr_comm_get_apcs(TR_COMM *comm);
 TR_NAME *tr_comm_get_id(TR_COMM *comm);
 TR_NAME *tr_comm_dup_id(TR_COMM *comm);
 void tr_comm_set_type(TR_COMM *comm, TR_COMM_TYPE type);
@@ -70,13 +137,35 @@ TR_NAME *tr_comm_dup_owner_realm(TR_COMM *comm);
 void tr_comm_set_owner_contact(TR_COMM *comm, TR_NAME *contact);
 TR_NAME *tr_comm_get_owner_contact(TR_COMM *comm);
 TR_NAME *tr_comm_dup_owner_contact(TR_COMM *comm);
-TR_COMM *tr_comm_add_func(TR_COMM *comms, TR_COMM *new); /* use the macro instead */
-#define tr_comm_add(comms, new) ((comms)=tr_comm_add_func((comms), (new)))
-void tr_comm_add_idp_realm(TR_COMM *comm, TR_IDP_REALM *realm);
-void tr_comm_add_rp_realm(TR_COMM *comm, TR_RP_REALM *realm);
-TR_COMM *tr_comm_lookup(TR_COMM *comms, TR_NAME *comm_name);
-TR_RP_REALM *tr_find_comm_rp (TR_COMM *comm, TR_NAME *rp_realm);
-TR_IDP_REALM *tr_find_comm_idp (TR_COMM *comm, TR_NAME *idp_realm);
+void tr_comm_add_idp_realm(TR_COMM_TABLE *ctab, TR_COMM *comm, TR_IDP_REALM *realm, json_t *provenance, struct timespec *expiry);
+void tr_comm_add_rp_realm(TR_COMM_TABLE *ctab, TR_COMM *comm, TR_RP_REALM *realm, json_t *provenance, struct timespec *expiry);
+TR_RP_REALM *tr_comm_find_rp(TR_COMM_TABLE *ctab, TR_COMM *comm, TR_NAME *rp_realm);
+TR_IDP_REALM *tr_comm_find_idp(TR_COMM_TABLE *ctab, TR_COMM *comm, TR_NAME *idp_realm);
 const char *tr_comm_type_to_str(TR_COMM_TYPE type);
+TR_COMM_TYPE tr_comm_type_from_str(const char *s);
+void tr_comm_incref(TR_COMM *comm);
+void tr_comm_decref(TR_COMM *comm);
+unsigned int tr_comm_get_refcount(TR_COMM *comm);
+
+/* for iterating over communities within a realm or realms within a community */
+TR_COMM_ITER *tr_comm_iter_new(TALLOC_CTX *mem_ctx);
+void tr_comm_iter_free(TR_COMM_ITER *iter);
+
+/* these iterate over communities for a realm */
+TR_COMM *tr_comm_iter_first(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *realm);
+TR_COMM *tr_comm_iter_next(TR_COMM_ITER *iter);
+TR_COMM *tr_comm_iter_first_rp(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *realm);
+TR_COMM *tr_comm_iter_next_rp(TR_COMM_ITER *iter);
+TR_COMM *tr_comm_iter_first_idp(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *realm);
+TR_COMM *tr_comm_iter_next_idp(TR_COMM_ITER *iter);
+
+/* iterate over realms for a community */
+TR_RP_REALM *tr_rp_realm_iter_first(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *comm);
+TR_RP_REALM *tr_rp_realm_iter_next(TR_COMM_ITER *iter);
+TR_IDP_REALM *tr_idp_realm_iter_first(TR_COMM_ITER *iter, TR_COMM_TABLE *ctab, TR_NAME *comm);
+TR_IDP_REALM *tr_idp_realm_iter_next(TR_COMM_ITER *iter);
+
+const char *tr_realm_role_to_str(TR_REALM_ROLE role);
+TR_REALM_ROLE tr_realm_role_from_str(const char *s);
 
 #endif