RTRlib
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Structures | Typedefs | Enumerations | Functions
RTR connection manager

Data Structures

struct  rtr_mgr_group
 

Typedefs

typedef void(* rtr_mgr_status_fp )(const struct rtr_mgr_group *, enum rtr_mgr_status, const struct rtr_socket *, void *)
 

Enumerations

enum  rtr_mgr_status { RTR_MGR_CLOSED, RTR_MGR_CONNECTING, RTR_MGR_ESTABLISHED, RTR_MGR_ERROR }
 

Functions

bool rtr_mgr_conf_in_sync (struct rtr_mgr_config *config)
 
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)
 
void rtr_mgr_free (struct rtr_mgr_config *config)
 
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)
 
int rtr_mgr_init (struct rtr_mgr_config **config_out, 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, const pfx_update_fp update_fp, const spki_update_fp spki_update_fp, const rtr_mgr_status_fp status_fp, void *status_fp_data)
 
int rtr_mgr_start (struct rtr_mgr_config *config)
 
const char * rtr_mgr_status_to_str (enum rtr_mgr_status status)
 
void rtr_mgr_stop (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)
 

Detailed Description

The RTR connection manager is initialized with one or multiple groups of rtr_sockets. Each group is configured with a preference value and contains a set of rtr_socket RTR sockets. It connects to all sockets of the group with the lowest preference value.
In case of failures, the connection manager establishes connections to RTR servers of another group with the next lowest preference value (see IETF RFC 6810 for details about error handling).
RTRlib also supports a Retry Interval (see draft-ietf-sidr-rpki-rtr-rfc6810-bis). If a more preferred group is online again, the RTR connection manager will switch back and close connections to the caches of the less preferred group.

Enumeration Type Documentation

Status of a rtr_mgr_group.

Enumerator
RTR_MGR_CLOSED 

RTR sockets are disconnected

RTR_MGR_CONNECTING 

RTR sockets trying to establish a connection.

RTR_MGR_ESTABLISHED 

All RTR sockets of the group are synchronized with rtr servers.

RTR_MGR_ERROR 

Error occurred on at least one RTR socket.

Function Documentation

bool rtr_mgr_conf_in_sync ( struct rtr_mgr_config *  config)

Check if rtr_mgr_group is fully synchronized with at least one group.

Parameters
[in]configThe rtr_mgr_config.
Returns
true If pfx_table stores non-outdated pfx_records
false If pfx_table isn't fully synchronized with at least one group.
void rtr_mgr_for_each_ipv4_record ( struct rtr_mgr_config *  config,
pfx_for_each_fp  fp,
void *  data 
)

Iterates over all IPv4 records in the pfx_table.

For every pfx_record the function fp is called. The pfx_record and the data pointer is passed to the fp.

Parameters
[in]configrtr_mgr_config
[in]fpPointer to callback function with signature pfx_for_each_fp.
[in]dataThis parameter is forwarded to the callback function.
void rtr_mgr_for_each_ipv6_record ( struct rtr_mgr_config *  config,
pfx_for_each_fp  fp,
void *  data 
)

Iterates over all IPv6 records in the pfx_table.

For every pfx_record the function fp is called. The pfx_record and the data pointer is passed to the fp.

Parameters
[in]configrtr_mgr_config
[in]fpPointer to callback function with signature pfx_for_each_fp.
[in]dataThis parameter is forwarded to the callback function.
void rtr_mgr_free ( struct rtr_mgr_config *  config)

Frees all resources that were allocated from the rtr_mgr.

rtr_mgr_stop must be called before, to shutdown all rtr_sockets.

Parameters
[in]configrtr_mgr_config.

References pfx_table_free(), and spki_table_free().

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 
)
inline

Returns all SPKI records which match the given ASN and SKI.

Parameters
[in]config
[in]asnAutonomous system number of the Origin-AS
[in]skithe SKI to search for
[out]resulta array of all matching spki_records
[out]result_countnumber of returned spki_records
Returns
SPKI_SUCCESS On success
SPKI_ERROR If an error occurred

References spki_table_get_all().

int rtr_mgr_init ( struct rtr_mgr_config **  config_out,
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,
const pfx_update_fp  update_fp,
const spki_update_fp  spki_update_fp,
const rtr_mgr_status_fp  status_fp,
void *  status_fp_data 
)

Initializes a rtr_mgr_config.

Parameters
[out]config_outThe rtr_mgr_config that will be initialized by this function. On error, *config_out will be NULL!
[in]groupsArray of rtr_mgr_group. Every RTR socket in an rtr_mgr_group must be assoziated with an initialized transport socket. A Transport socket is only allowed to be associated with one rtr socket. The preference values must be unique in the group array. More than one rtr_mgr_group with the same preference value isn't allowed.
[in]groups_lenNumber of elements in the groups array. Must be >= 1.
[in]refresh_intervalInterval in seconds between serial queries that are sent to the server. Must be >= 1 and <= 86400s (1d), recommended default is 3600s (1h).
[in]expire_intervalStored validation records will be deleted if cache was unable to refresh data for this period. The value should be twice the refresh_interval and must be >= 600s (10min) and <= 172800s (2d). The recommended default is 7200s (2h).
[in]retry_intervalThis parameter tells the router how long to wait (in seconds) before retrying a failed Serial Query or Reset Query. The value must be >= 1s and <= 7200s (2h). The recommended default is 600s (10min).
[in]update_fpPointer to pfx_update_fp callback, that is executed for every added and removed pfx_record.
[in]spki_update_fpPointer to spki_update_fp callback, that is executed for every added and removed spki_record.
[in]status_fpPointer to a function that is called if the connection status from one of the socket groups is changed.
[in]status_fp_dataPointer to a memory area that is passed to the status_fp function. Memory area can be freely used to pass user-defined data to the status_fp callback.
Returns
RTR_ERROR If an error occurred
RTR_INVALID_PARAM If refresh_interval or expire_interval is invalid.
RTR_SUCCESS On success.

References pfx_table_free(), pfx_table_init(), rtr_init(), RTR_MGR_CLOSED, spki_table_free(), and spki_table_init().

int rtr_mgr_start ( struct rtr_mgr_config *  config)

Establishes rtr_socket connections.

Establishes the connection with the rtr_sockets of the group with the lowest preference value and handles errors as defined in the RPKI-RTR protocol.

Parameters
[in]configPointer to an initialized rtr_mgr_config.
Returns
RTR_SUCCESS On success
RTR_ERROR On error
const char* rtr_mgr_status_to_str ( enum rtr_mgr_status  status)

Converts a rtr_mgr_status to a String.

Parameters
[in]statusstate to convert to a string.
Returns
NULL If status isn't a valid rtr_mgr_status.
!=NULL The rtr_rtr_mgr_status as String.
void rtr_mgr_stop ( struct rtr_mgr_config *  config)

Terminates rtr_socket connections.

Terminates all rtr_socket connections defined in the config. All pfx_records received from these sockets will be purged.

Parameters
[in]configThe rtr_mgr_config struct

References rtr_stop().

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 
)
inline

Validates the origin of a BGP-Route.

Parameters
[in]configThe rtr_mgr_config
[in]asnAutonomous system number of the Origin-AS of the prefix
[in]prefixAnnounced network prefix
[in]mask_lenLength of the network mask of the announced prefix
[out]resultOutcome of the validation
Returns
PFX_SUCCESS On success.
PFX_ERROR If an error occurred.

References pfx_table_validate().