Struct routinator::config::Config

pub struct Config {

    pub cache_dir: PathBuf,
    pub tal_dir: PathBuf,
    pub exceptions: Vec<PathBuf>,
    pub strict: bool,
    pub stale: FilterPolicy,
    pub unsafe_vrps: FilterPolicy,
    pub unknown_objects: FilterPolicy,
    pub allow_dubious_hosts: bool,
    pub fresh: bool,
    pub disable_rsync: bool,
    pub rsync_command: String,
    pub rsync_args: Option<Vec<String>>,
    pub rsync_timeout: Duration,
    pub disable_rrdp: bool,
    pub rrdp_fallback_time: Duration,
    pub rrdp_max_delta_count: usize,
    pub rrdp_timeout: Option<Duration>,
    pub rrdp_connect_timeout: Option<Duration>,
    pub rrdp_local_addr: Option<IpAddr>,
    pub rrdp_root_certs: Vec<PathBuf>,
    pub rrdp_proxies: Vec<String>,
    pub rrdp_user_agent: String,
    pub rrdp_keep_responses: Option<PathBuf>,
    pub rrdp_disable_gzip: bool,
    pub max_object_size: Option<u64>,
    pub dirty_repository: bool,
    pub validation_threads: usize,
    pub refresh: Duration,
    pub retry: Duration,
    pub expire: Duration,
    pub history_size: usize,
    pub rtr_listen: Vec<SocketAddr>,
    pub http_listen: Vec<SocketAddr>,
    pub systemd_listen: bool,
    pub rtr_tcp_keepalive: Option<Duration>,
    pub rtr_client_metrics: bool,
    pub log_level: LevelFilter,
    pub log_target: LogTarget,
    pub pid_file: Option<PathBuf>,
    pub working_dir: Option<PathBuf>,
    pub chroot: Option<PathBuf>,
    pub user: Option<String>,
    pub group: Option<String>,
    pub tal_labels: HashMap<String, String>,
}

Routinator configuration.

This type contains both the basic configuration of Routinator, such as where to keep the repository and how to update it, as well as the configuration for server mode.

All values are public and can be accessed directly.

The two functions config_args and server_args can be used to create the clap application. Its matches can then be used to create the basic config via from_arg_matches. If the RTR server configuration is necessary, it can be added via apply_server_arg_matches from the server subcommand matches.

The methods init_logging and switch_logging can be used to configure logging according to the strategy provided by the configuration. On Unix systems only, the method daemonize creates a correctly configured Daemonizer. Finally, to_toml can be used to produce a TOML value that contains a configuration file content representing the current configuration.

Fields

cache_dir: PathBuf

Path to the directory that contains the repository cache.

tal_dir: PathBuf

Path to the directory that contains the trust anchor locators.

exceptions: Vec<PathBuf>

Paths to the local exceptions files.

strict: bool

Should we do strict validation?

See the relevant RPKI crate documentation for more information.

stale: FilterPolicy

How should we deal with stale objects?

Stale objects are manifests and CRLs that have a next_update field in the past. The current version of the protocol leaves the decision how to interpret stale objects to local policy. This configuration value configures this policy.

Since the upcoming version of the protocol clarifies that these objects should be rejected, this is the default policy.

unsafe_vrps: FilterPolicy

How should we deal with unsafe VRPs?

Unsafe VRPs have their prefix intersect with a prefix held by a rejected CA. Allowing such VRPs may lead to legitimate routes being flagged as RPKI invalid. To avoid this, these can VRPs can be filtered.

The default for now is to warn about them.

unknown_objects: FilterPolicy

How to deal with unknown RPKI object types.

allow_dubious_hosts: bool

Allow dubious host names.

fresh: bool

Should we wipe the cache before starting?

(This option is only available on command line.)

disable_rsync: bool

Whether to disable rsync.

rsync_command: String

The command to run for rsync.

rsync_args: Option<Vec<String>>

Optional arguments passed to rsync.

If these are present, they overide the arguments automatically determined otherwise. Thus, Some<Vec::new()> will supress all arguments.

rsync_timeout: Duration

Timeout for rsync commands.

disable_rrdp: bool

Whether to disable RRDP.

rrdp_fallback_time: Duration

Time since last update of an RRDP repository before fallback to rsync.

rrdp_max_delta_count: usize

The maxmimm number of deltas we allow before using snapshot.

rrdp_timeout: Option<Duration>

RRDP timeout in seconds.

If this is None, no timeout is set.

rrdp_connect_timeout: Option<Duration>

Optional RRDP connect timeout in seconds.

rrdp_local_addr: Option<IpAddr>

Optional RRDP local address to bind to when doing requests.

rrdp_root_certs: Vec<PathBuf>

RRDP additional root certificates for HTTPS.

These do not overide the default system root certififcates.

rrdp_proxies: Vec<String>

RRDP HTTP proxies.

rrdp_user_agent: String

RRDP HTTP User Agent.

rrdp_keep_responses: Option<PathBuf>

Should we keep RRDP responses and if so where?

rrdp_disable_gzip: bool

Disable the use if the gzip transfer encoding in the RRDP client.

max_object_size: Option<u64>

Optional size limit for objects.

dirty_repository: bool

Wether to not cleanup the repository directory after a validation run.

If this is false and update has not been disabled otherwise, all data for rsync modules (if rsync is enabled) and RRDP servers (if RRDP is enabled) that have not been used during validation will be deleted.

validation_threads: usize

Number of threads used during validation.

refresh: Duration

The refresh interval for repository validation.

retry: Duration

The RTR retry inverval to be announced to a client.

expire: Duration

The RTR expire time to be announced to a client.

history_size: usize

How many diffs to keep in the history.

rtr_listen: Vec<SocketAddr>

Addresses to listen on for RTR TCP transport connections.

http_listen: Vec<SocketAddr>

Addresses to listen on for HTTP monitoring connectsion.

systemd_listen: bool

Whether to get the listening sockets from systemd.

rtr_tcp_keepalive: Option<Duration>

The length of the TCP keep-alive timeout for RTR TCP sockets.

If this is None, TCP keep-alive will not be enabled.

rtr_client_metrics: bool

Should we publish detailed RTR client statistics?

log_level: LevelFilter

The log levels to be logged.

log_target: LogTarget

The target to log to.

pid_file: Option<PathBuf>

The optional PID file for server mode.

working_dir: Option<PathBuf>

The optional working directory for server mode.

chroot: Option<PathBuf>

The optional directory to chroot to in server mode.

user: Option<String>

The name of the user to change to in server mode.

group: Option<String>

The name of the group to change to in server mode.

tal_labels: HashMap<String, String>

A mapping of TAL file names to TAL labels.

Implementations

impl Config

pub fn config_args<'a: 'b, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

Adds the basic arguments to a clapp app.

The function follows clap’s builder pattern: it takes an app, adds a bunch of arguments to it and returns it at the end.

pub fn server_args<'a: 'b, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

Adds the relevant config args to the server subcommand.

Some of the options in the config only make sense for the RTR server. Having them in the global part of the clap command line is confusing, so we stick to defaults unless we actually run the server. This function adds the relevant arguments to the subcommand provided via app.

It follows clap’s builder pattern and returns the app with all arguments added.

pub fn from_arg_matches(
    matches: &ArgMatches<'_>,
    cur_dir: &Path
) -> Result<Self, Failed>

Creates a configuration from command line matches.

The function attempts to create configuration from the command line arguments provided via matches. It will try to read a config file if provided via the config file option (-c or --config) or a file in $HOME/.routinator.conf otherwise. If the latter doesn’t exist either, starts with a default configuration.

All relative paths given in command line arguments will be interpreted relative to cur_dir. Conversely, paths in the config file are treated as relative to the config file’s directory.

If you are runming in server mode, you need to also apply the server arguments via apply_server_arg_matches.

pub fn apply_server_arg_matches(
    &mut self,
    matches: &ArgMatches<'_>,
    cur_dir: &Path
) -> Result<(), Failed>

Applies the RTR server command line arguments to an existing config.

All paths used in arguments are interpreted relative to cur_dir.

pub fn adjust_chroot_paths(&mut self) -> Result<(), Failed>

Alters paths so that they are relative to a possible chroot.

pub fn to_toml(&self) -> Value

Returns a TOML representation of the config.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl Display for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Config) -> bool

This method tests for !=.

impl Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config