2 * Copyright (c) 2016, 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.
38 #include <trust_router/tr_name.h>
39 #include <trp_internal.h>
45 /* static prototypes */
46 static TRP_INFOREC_DATA *trp_inforec_route_new(TALLOC_CTX *mem_ctx);
47 static void trp_inforec_route_print(TRP_INFOREC_DATA *);
48 static TRP_INFOREC_DATA *trp_inforec_comm_new(TALLOC_CTX *mem_ctx);
49 static void trp_inforec_comm_print(TRP_INFOREC_DATA *);
52 struct trp_inforec_type_entry {
54 TRP_INFOREC_TYPE type;
55 TRP_INFOREC_DATA *(*allocate)(TALLOC_CTX *);
56 void (*print)(TRP_INFOREC_DATA *);
58 static struct trp_inforec_type_entry trp_inforec_type_table[] = {
59 { "route", TRP_INFOREC_TYPE_ROUTE, trp_inforec_route_new, trp_inforec_route_print },
60 { "comm", TRP_INFOREC_TYPE_COMMUNITY, trp_inforec_comm_new, trp_inforec_comm_print },
61 { NULL, TRP_INFOREC_TYPE_UNKNOWN, NULL, NULL } /* must be the last entry */
65 /* look up an entry in the trp_inforec_type_table */
66 static struct trp_inforec_type_entry *get_trp_inforec_type_entry(TRP_INFOREC_TYPE msgtype)
68 struct trp_inforec_type_entry *entry=trp_inforec_type_table;
70 while ((entry->type != TRP_INFOREC_TYPE_UNKNOWN)
71 && (entry->type != msgtype)) {
77 /* translate strings to codes */
78 TRP_INFOREC_TYPE trp_inforec_type_from_string(const char *s)
80 struct trp_inforec_type_entry *entry=trp_inforec_type_table;
82 while ((entry->type != TRP_INFOREC_TYPE_UNKNOWN)
83 && (strcmp(s, entry->name)!=0)) {
88 /* translate codes to strings (do not need to be freed)
89 * Returns NULL on an unknown code */
90 const char *trp_inforec_type_to_string(TRP_INFOREC_TYPE msgtype)
92 struct trp_inforec_type_entry *entry=get_trp_inforec_type_entry(msgtype);
96 /* called by talloc when destroying an update message body */
97 static int trp_inforec_route_destructor(void *object)
99 TRP_INFOREC_ROUTE *body=talloc_get_type_abort(object, TRP_INFOREC_ROUTE);
101 /* clean up TR_NAME data, which are not managed by talloc */
102 if (body->trust_router != NULL)
103 tr_free_name(body->trust_router);
104 if (body->next_hop != NULL)
105 tr_free_name(body->next_hop);
109 static TRP_INFOREC_DATA *trp_inforec_route_new(TALLOC_CTX *mem_ctx)
111 TRP_INFOREC_DATA *new_data=talloc(mem_ctx, TRP_INFOREC_DATA);
112 TRP_INFOREC_ROUTE *new_rec=NULL;
117 new_rec=talloc(new_data, TRP_INFOREC_ROUTE);
118 if (new_rec == NULL) {
119 talloc_free(new_data);
122 new_rec->trust_router=NULL;
123 new_rec->next_hop=NULL;
124 new_rec->next_hop_port=0;
125 new_rec->metric=TRP_METRIC_INFINITY;
127 talloc_set_destructor((void *)new_rec, trp_inforec_route_destructor);
128 new_data->route=new_rec;
135 static int trp_inforec_comm_destructor(void *obj)
137 TRP_INFOREC_COMM *rec=talloc_get_type_abort(obj, TRP_INFOREC_COMM);
138 if (rec->owner_realm!=NULL)
139 tr_free_name(rec->owner_realm);
140 if (rec->owner_contact!=NULL)
141 tr_free_name(rec->owner_contact);
142 if (rec->provenance!=NULL)
143 json_decref(rec->provenance);
147 static TRP_INFOREC_DATA *trp_inforec_comm_new(TALLOC_CTX *mem_ctx)
149 TRP_INFOREC_DATA *new_data=talloc(mem_ctx, TRP_INFOREC_DATA);
150 TRP_INFOREC_COMM *new_rec=NULL;
155 new_rec=talloc(new_data, TRP_INFOREC_COMM);
157 talloc_free(new_data);
160 new_rec->comm_type=TR_COMM_UNKNOWN;
161 new_rec->role=TR_ROLE_UNKNOWN;
163 new_rec->owner_realm=NULL;
164 new_rec->owner_contact=NULL;
165 new_rec->provenance=NULL;
167 talloc_set_destructor((void *)new_rec, trp_inforec_comm_destructor);
168 new_data->comm=new_rec;
174 TRP_INFOREC *trp_inforec_get_next(TRP_INFOREC *rec)
182 static TRP_INFOREC *trp_inforec_get_tail(TRP_INFOREC *rec)
184 while ((rec->next)!=NULL)
185 rec=trp_inforec_get_next(rec);
189 void trp_inforec_set_next(TRP_INFOREC *rec, TRP_INFOREC *next_rec)
195 TRP_INFOREC_TYPE trp_inforec_get_type(TRP_INFOREC *rec)
200 return TRP_INFOREC_TYPE_UNKNOWN;
203 void trp_inforec_set_type(TRP_INFOREC *rec, TRP_INFOREC_TYPE type)
209 TR_NAME *trp_inforec_get_trust_router(TRP_INFOREC *rec)
212 case TRP_INFOREC_TYPE_ROUTE:
213 if (rec->data->route!=NULL)
214 return rec->data->route->trust_router;
222 TR_NAME *trp_inforec_dup_trust_router(TRP_INFOREC *rec)
224 return tr_dup_name(trp_inforec_get_trust_router(rec));
227 TRP_RC trp_inforec_set_trust_router(TRP_INFOREC *rec, TR_NAME *trust_router)
230 case TRP_INFOREC_TYPE_ROUTE:
231 if (rec->data->route!=NULL) {
232 rec->data->route->trust_router=trust_router;
242 /* TODO: need to return hostname/port --jlr */
243 TR_NAME *trp_inforec_get_next_hop(TRP_INFOREC *rec)
246 case TRP_INFOREC_TYPE_ROUTE:
247 if (rec->data->route!=NULL)
248 return rec->data->route->next_hop;
256 TR_NAME *trp_inforec_dup_next_hop(TRP_INFOREC *rec)
258 return tr_dup_name(trp_inforec_get_next_hop(rec));
261 TRP_RC trp_inforec_set_next_hop(TRP_INFOREC *rec, TR_NAME *next_hop)
264 case TRP_INFOREC_TYPE_ROUTE:
265 if (rec->data->route==NULL)
267 rec->data->route->next_hop=next_hop;
269 case TRP_INFOREC_TYPE_COMMUNITY:
270 /* next hop not used for community records */
278 unsigned int trp_inforec_get_metric(TRP_INFOREC *rec)
281 case TRP_INFOREC_TYPE_ROUTE:
282 if (rec->data->route!=NULL)
283 return rec->data->route->metric;
288 return TRP_METRIC_INVALID;
291 TRP_RC trp_inforec_set_metric(TRP_INFOREC *rec, unsigned int metric)
294 case TRP_INFOREC_TYPE_ROUTE:
295 if (rec->data->route!=NULL) {
296 rec->data->route->metric=metric;
306 unsigned int trp_inforec_get_interval(TRP_INFOREC *rec)
309 case TRP_INFOREC_TYPE_ROUTE:
310 if (rec->data->route!=NULL)
311 return rec->data->route->interval;
313 case TRP_INFOREC_TYPE_COMMUNITY:
314 if (rec->data->comm!=NULL)
315 return rec->data->comm->interval;
320 return TRP_INTERVAL_INVALID;
323 TRP_RC trp_inforec_set_interval(TRP_INFOREC *rec, unsigned int interval)
326 case TRP_INFOREC_TYPE_ROUTE:
327 if (rec->data->route!=NULL) {
328 rec->data->route->interval=interval;
332 case TRP_INFOREC_TYPE_COMMUNITY:
333 if (rec->data->comm!=NULL) {
334 rec->data->comm->interval=interval;
343 TR_COMM_TYPE trp_inforec_get_comm_type(TRP_INFOREC *rec)
346 case TRP_INFOREC_TYPE_COMMUNITY:
347 if (rec->data->comm!=NULL)
348 return rec->data->comm->comm_type;
353 return TR_COMM_UNKNOWN;
356 TRP_RC trp_inforec_set_comm_type(TRP_INFOREC *rec, TR_COMM_TYPE type)
359 case TRP_INFOREC_TYPE_COMMUNITY:
360 if (rec->data->comm!=NULL) {
361 rec->data->comm->comm_type=type;
371 TR_REALM_ROLE trp_inforec_get_role(TRP_INFOREC *rec)
374 case TRP_INFOREC_TYPE_COMMUNITY:
375 if (rec->data->comm!=NULL)
376 return rec->data->comm->role;
381 return TR_ROLE_UNKNOWN;
384 TRP_RC trp_inforec_set_role(TRP_INFOREC *rec, TR_REALM_ROLE role)
387 case TRP_INFOREC_TYPE_COMMUNITY:
388 if (rec->data->comm!=NULL) {
389 rec->data->comm->role=role;
399 TR_APC *trp_inforec_get_apcs(TRP_INFOREC *rec)
402 case TRP_INFOREC_TYPE_COMMUNITY:
403 if (rec->data->comm!=NULL)
404 return rec->data->comm->apcs;
412 TRP_RC trp_inforec_set_apcs(TRP_INFOREC *rec, TR_APC *apcs)
415 case TRP_INFOREC_TYPE_COMMUNITY:
416 if (rec->data->comm!=NULL) {
417 rec->data->comm->apcs=apcs;
418 talloc_steal(rec, apcs);
429 TR_NAME *trp_inforec_get_owner_realm(TRP_INFOREC *rec)
432 case TRP_INFOREC_TYPE_COMMUNITY:
433 if (rec->data->comm!=NULL)
434 return rec->data->comm->owner_realm;
442 TRP_RC trp_inforec_set_owner_realm(TRP_INFOREC *rec, TR_NAME *name)
445 case TRP_INFOREC_TYPE_COMMUNITY:
446 if (rec->data->comm!=NULL) {
447 rec->data->comm->owner_realm=name;
457 TR_NAME *trp_inforec_get_owner_contact(TRP_INFOREC *rec)
460 case TRP_INFOREC_TYPE_COMMUNITY:
461 if (rec->data->comm!=NULL)
462 return rec->data->comm->owner_contact;
470 TRP_RC trp_inforec_set_owner_contact(TRP_INFOREC *rec, TR_NAME *name)
473 case TRP_INFOREC_TYPE_COMMUNITY:
474 if (rec->data->comm!=NULL) {
475 rec->data->comm->owner_contact=name;
485 /* caller needs to incref the output if they're going to hang on to it */
486 json_t *trp_inforec_get_provenance(TRP_INFOREC *rec)
489 case TRP_INFOREC_TYPE_COMMUNITY:
490 if (rec->data->comm!=NULL)
491 return rec->data->comm->provenance;
499 /* increments the reference count */
500 TRP_RC trp_inforec_set_provenance(TRP_INFOREC *rec, json_t *prov)
503 case TRP_INFOREC_TYPE_COMMUNITY:
504 if (rec->data->comm!=NULL) {
505 if (rec->data->comm->provenance!=NULL)
506 json_decref(rec->data->comm->provenance);
507 rec->data->comm->provenance=prov;
518 static TRP_RC trp_inforec_add_to_provenance(TRP_INFOREC *rec, TR_NAME *peer)
523 case TRP_INFOREC_TYPE_ROUTE:
524 /* no provenance list */
526 case TRP_INFOREC_TYPE_COMMUNITY:
527 jpeer=tr_name_to_json_string(peer);
530 if (rec->data->comm->provenance==NULL) {
531 rec->data->comm->provenance=json_array();
532 if (rec->data->comm->provenance==NULL) {
537 if (0!=json_array_append_new(rec->data->comm->provenance, jpeer)) {
548 /* generic record type */
549 TRP_INFOREC *trp_inforec_new(TALLOC_CTX *mem_ctx, TRP_INFOREC_TYPE type)
551 TRP_INFOREC *new_rec=talloc(mem_ctx, TRP_INFOREC);
552 TRP_INFOREC_DATA *data=NULL;
553 struct trp_inforec_type_entry *dtype=get_trp_inforec_type_entry(type);
555 if ((new_rec != NULL) && (dtype->type != TRP_INFOREC_TYPE_UNKNOWN)) {
556 trp_inforec_set_type(new_rec, type);
557 trp_inforec_set_next(new_rec, NULL);
558 if (dtype->allocate!=NULL) {
559 data=dtype->allocate(new_rec);
563 talloc_free(new_rec);
571 void trp_inforec_free(TRP_INFOREC *rec)
577 static int trp_upd_destructor(void *object)
579 TRP_UPD *upd=talloc_get_type_abort(object, TRP_UPD);
580 if (upd->realm!=NULL)
581 tr_free_name(upd->realm);
583 tr_free_name(upd->comm);
585 tr_free_name(upd->peer);
589 TRP_UPD *trp_upd_new(TALLOC_CTX *mem_ctx)
591 TRP_UPD *new_body=talloc(mem_ctx, TRP_UPD);
593 if (new_body!=NULL) {
594 new_body->realm=NULL;
596 new_body->records=NULL;
598 talloc_set_destructor((void *)new_body, trp_upd_destructor);
603 void trp_upd_free(TRP_UPD *update)
609 TRP_INFOREC *trp_upd_get_inforec(TRP_UPD *upd)
617 void trp_upd_set_inforec(TRP_UPD *upd, TRP_INFOREC *rec)
623 void trp_upd_add_inforec(TRP_UPD *upd, TRP_INFOREC *rec)
625 tr_debug("trp_upd_add_inforec: adding record.");
626 if (upd->records==NULL)
629 trp_inforec_set_next(trp_inforec_get_tail(upd->records), rec);
630 talloc_steal(upd, rec);
633 TR_NAME *trp_upd_get_realm(TRP_UPD *upd)
638 TR_NAME *trp_upd_dup_realm(TRP_UPD *upd)
640 return tr_dup_name(upd->realm);
643 void trp_upd_set_realm(TRP_UPD *upd, TR_NAME *realm)
645 if (upd->realm!=NULL)
646 tr_free_name(upd->realm);
650 TR_NAME *trp_upd_get_comm(TRP_UPD *upd)
655 TR_NAME *trp_upd_dup_comm(TRP_UPD *upd)
657 return tr_dup_name(upd->comm);
660 void trp_upd_set_comm(TRP_UPD *upd, TR_NAME *comm)
663 tr_free_name(upd->comm);
667 TR_NAME *trp_upd_get_peer(TRP_UPD *upd)
672 TR_NAME *trp_upd_dup_peer(TRP_UPD *upd)
674 return tr_dup_name(upd->peer);
677 void trp_upd_set_peer(TRP_UPD *upd, TR_NAME *peer)
679 TRP_INFOREC *rec=NULL;
684 /* add to provenance list of any records that need it */
685 for (rec=trp_upd_get_inforec(upd); rec!=NULL; rec=trp_inforec_get_next(rec)) {
686 if (trp_inforec_add_to_provenance(rec, cpy=tr_dup_name(peer)) != TRP_SUCCESS) {
687 tr_err("trp_upd_set_peer: error adding peer to provenance list.");
693 void trp_upd_set_next_hop(TRP_UPD *upd, const char *hostname, unsigned int port)
695 TRP_INFOREC *rec=NULL;
698 for (rec=trp_upd_get_inforec(upd); rec!=NULL; rec=trp_inforec_get_next(rec)) {
699 if (trp_inforec_set_next_hop(rec, cpy=tr_new_name(hostname)) != TRP_SUCCESS) {
700 tr_err("trp_upd_set_next_hop: error setting next hop.");
707 static void trp_inforec_route_print(TRP_INFOREC_DATA *data)
709 if (data->route!=NULL) {
710 printf(" trust_router=%.*s\n metric=%d\n interval=%d]\n",
711 data->route->trust_router->len, data->route->trust_router->buf,
712 data->route->metric, data->route->interval);
716 static void trp_inforec_comm_print(TRP_INFOREC_DATA *data)
718 if (data->comm!=NULL) {
719 printf(" type=%s\n role=%s\n owner=%.*s\n contact=%.*s]\n",
720 tr_comm_type_to_str(data->comm->comm_type),
721 tr_realm_role_to_str(data->comm->role),
722 data->comm->owner_realm->len, data->comm->owner_realm->buf,
723 data->comm->owner_contact->len, data->comm->owner_contact->buf);
724 /* TODO: print apcs */