rtr_mgr.h

Go to the documentation of this file.

/*
 * This file is part of RTRlib.
 *
 * This file is subject to the terms and conditions of the MIT license.
 * See the file LICENSE in the top level directory for more details.
 *
 * Website: http://rtrlib.realmv6.org/
 */
 
#ifndef RTR_MGR
#define RTR_MGR
 
#include "config.h"
 
#include "rtrlib/aspa/aspa.h"
#include "rtrlib/pfx/pfx.h"
#include "rtrlib/spki/spkitable.h"
#ifdef RTRLIB_BGPSEC_ENABLED
#include "rtrlib/bgpsec/bgpsec.h"
#endif
 
#include <pthread.h>
#include <stdint.h>
 
enum rtr_mgr_status {
        RTR_MGR_CLOSED,
        RTR_MGR_CONNECTING,
        RTR_MGR_ESTABLISHED,
        RTR_MGR_ERROR,
};
 
struct rtr_mgr_group {
        struct rtr_socket **sockets;
        unsigned int sockets_len;
        uint8_t preference;
        enum rtr_mgr_status status;
};
 
typedef void (*rtr_mgr_status_fp)(const struct rtr_mgr_group *, enum rtr_mgr_status, const struct rtr_socket *, void *);
 
struct tommy_list_wrapper;
 
// TODO Add refresh, expire, and retry intervals to config for easier access.
struct rtr_mgr_config {
        struct tommy_list_wrapper *groups;
        unsigned int len;
        pthread_rwlock_t mutex;
        rtr_mgr_status_fp status_fp;
        void *status_fp_data;
        struct pfx_table *pfx_table;
        struct spki_table *spki_table;
        struct aspa_table *aspa_table;
};
 
int rtr_mgr_init(struct rtr_mgr_config **config_out, struct rtr_mgr_group groups[], const unsigned int groups_len,
                 const rtr_mgr_status_fp status_fp, void *status_fp_data);
 
int rtr_mgr_setup_sockets(struct rtr_mgr_config *config, struct rtr_mgr_group groups[], const unsigned int groups_len,
                          const unsigned int refresh_interval, const unsigned int expire_interval,
                          const unsigned int retry_interval);
 
int rtr_mgr_add_roa_support(struct rtr_mgr_config *config, const pfx_update_fp pfx_update_fp);
 
int rtr_mgr_add_group(struct rtr_mgr_config *config, const struct rtr_mgr_group *group);
int rtr_mgr_remove_group(struct rtr_mgr_config *config, unsigned int preference);
void rtr_mgr_free(struct rtr_mgr_config *config);
 
int rtr_mgr_start(struct rtr_mgr_config *config);
 
void rtr_mgr_stop(struct rtr_mgr_config *config);
 
bool rtr_mgr_conf_in_sync(struct rtr_mgr_config *config);
 
int rtr_mgr_validate(struct rtr_mgr_config *config, const uint32_t asn, const struct lrtr_ip_addr *prefix,
                     const uint8_t mask_len, enum pfxv_state *result);
 
int rtr_mgr_get_spki(struct rtr_mgr_config *config, const uint32_t asn, uint8_t *ski, struct spki_record **result,
                     unsigned int *result_count);
 
const char *rtr_mgr_status_to_str(enum rtr_mgr_status status);
 
void rtr_mgr_for_each_ipv4_record(struct rtr_mgr_config *config, pfx_for_each_fp fp, void *data);
 
void rtr_mgr_for_each_ipv6_record(struct rtr_mgr_config *config, pfx_for_each_fp fp, void *data);
 
struct rtr_mgr_group *rtr_mgr_get_first_group(struct rtr_mgr_config *config);
 
int rtr_mgr_for_each_group(struct rtr_mgr_config *config, void (*fp)(const struct rtr_mgr_group *group, void *data),
                           void *data);
 
int rtr_mgr_add_aspa_support(struct rtr_mgr_config *config, const aspa_update_fp aspa_update_fp);
 
int rtr_mgr_add_spki_support(struct rtr_mgr_config *config, const spki_update_fp spki_update_fp);
 
/* @} */
 
#ifdef RTRLIB_BGPSEC_ENABLED
 
int rtr_mgr_bgpsec_validate_as_path(const struct rtr_bgpsec *data, struct rtr_mgr_config *config);
 
int rtr_mgr_bgpsec_generate_signature(const struct rtr_bgpsec *data, uint8_t *private_key,
                                      struct rtr_signature_seg **new_signature);
 
int rtr_mgr_bgpsec_get_version(void);
 
int rtr_mgr_bgpsec_has_algorithm_suite(uint8_t alg_suite);
 
int rtr_mgr_bgpsec_get_algorithm_suites(const uint8_t **algs_arr);
 
void rtr_mgr_bgpsec_free_signatures(struct rtr_signature_seg *seg);
 
struct rtr_secure_path_seg *rtr_mgr_bgpsec_new_secure_path_seg(uint8_t pcount, uint8_t flags, uint32_t asn);
 
void rtr_mgr_bgpsec_prepend_sec_path_seg(struct rtr_bgpsec *bgpsec, struct rtr_secure_path_seg *new_seg);
 
struct rtr_signature_seg *rtr_mgr_bgpsec_new_signature_seg(uint8_t *ski, uint16_t sig_len, uint8_t *signature);
 
int rtr_mgr_bgpsec_prepend_sig_seg(struct rtr_bgpsec *bgpsec, struct rtr_signature_seg *new_seg);
 
struct rtr_bgpsec *rtr_mgr_bgpsec_new(uint8_t alg, uint8_t safi, uint16_t afi, uint32_t my_as, uint32_t target_as,
                                      struct rtr_bgpsec_nlri *nlri);
 
void rtr_mgr_bgpsec_free(struct rtr_bgpsec *bgpsec);
 
void rtr_mgr_free_secure_path(struct rtr_secure_path_seg *seg);
 
struct rtr_secure_path_seg *rtr_mgr_bgpsec_pop_secure_path_seg(struct rtr_bgpsec *bgpsec);
 
struct rtr_signature_seg *rtr_mgr_bgpsec_pop_signature_seg(struct rtr_bgpsec *bgpsec);
 
void rtr_mgr_bgpsec_append_sec_path_seg(struct rtr_bgpsec *bgpsec, struct rtr_secure_path_seg *new_seg);
 
int rtr_mgr_bgpsec_append_sig_seg(struct rtr_bgpsec *bgpsec, struct rtr_signature_seg *new_seg);
 
struct rtr_bgpsec_nlri *rtr_mgr_bgpsec_nlri_new(int nlri_len);
 
void rtr_mgr_bgpsec_nlri_free(struct rtr_bgpsec_nlri *nlri);
 
void rtr_mgr_bgpsec_add_spki_record(struct rtr_mgr_config *config, struct spki_record *record);
#endif
 
#endif