Struct mixnet::core::Config

pub struct Config {

    pub log_target: &'static str,
    pub num_gateway_mixnodes: u32,
    pub session_0_kx_secret: Option<KxSecret>,
    pub mixnode_session: SessionConfig,
    pub non_mixnode_session: Option<SessionConfig>,
    pub forward_packet_queue_capacity: usize,
    pub mean_forwarding_delay: Duration,
    pub per_hop_net_delay: Duration,
    pub loop_cover_proportion: f64,
    pub gen_cover_packets: bool,
    pub num_hops: usize,
    pub surb_keystore_capacity: usize,
    pub max_incomplete_messages: usize,
    pub max_incomplete_fragments: usize,
    pub max_fragments_per_message: usize,
}

Mixnet configuration.

Fields

log_target: &'static str

The target for log messages.

num_gateway_mixnodes: u32

The number of mixnodes to connect to when we are not a mixnode ourselves. When we are a mixnode, we connect to all other mixnodes.

session_0_kx_secret: Option<KxSecret>

The key-exchange secret key to use in session 0. This option is intended for testing purposes only.

mixnode_session: SessionConfig

Used by sessions in which the local node is a mixnode. If this is not the same for all nodes, delay estimates may be off.

non_mixnode_session: Option<SessionConfig>

Used by sessions in which the local node is not a mixnode. If None, we will only participate in the mixnet during sessions in which we are a mixnode.

forward_packet_queue_capacity: usize

Maximum number of packets waiting for their forwarding delay to elapse. When at the limit, any packets arriving that need forwarding will simply be dropped.

mean_forwarding_delay: Duration

Mean forwarding delay at each mixnode. This should really be the same for all nodes!

per_hop_net_delay: Duration

Conservative estimate of the network (and processing) delay per hop.

loop_cover_proportion: f64

Proportion of authored packets which should be loop cover packets (as opposed to drop cover packets or real packets). If this is not the same for all nodes, delay estimates may be off.

gen_cover_packets: bool

Generate cover packets? This option is intended for testing purposes only. It essentially just drops all cover packets instead of sending them.

num_hops: usize

Number of hops for packets to traverse. Some packets may traverse more hops if necessary. Note this only affects packets whose headers are generated by this node. Must be <= MAX_HOPS.

surb_keystore_capacity: usize

Maximum number of outstanding SURBs to keep keys for. Must be greater than 0.

max_incomplete_messages: usize

Maximum number of incomplete messages to keep.

max_incomplete_fragments: usize

Maximum number of fragments to keep across all incomplete messages.

max_fragments_per_message: usize

Maximum number of fragments per message. This should really be the same for all nodes!

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.