Enum valence_network::ConnectionMode

#[non_exhaustive]
pub enum ConnectionMode {
    Online {
        prevent_proxy_connections: bool,
    },
    Offline,
    BungeeCord,
    Velocity {
        secret: Arc<str>,
    },
}

Describes how new connections to the server are handled.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Online

The “online mode” fetches all player data (username, UUID, and properties) from the configured session server and enables encryption.

This mode should be used by all publicly exposed servers which are not behind a proxy.

Fields

prevent_proxy_connections: bool

Determines if client IP validation should take place during authentication.

When prevent_proxy_connections is enabled, clients can no longer log-in if they connected to the Yggdrasil server using a different IP than the one used to connect to this server.

This is used by the default implementation of NetworkCallbacks::session_server. A different implementation may choose to ignore this value.

Offline

Disables client authentication with the configured session server. Clients can join with any username and UUID they choose, potentially gaining privileges they would not otherwise have. Additionally, encryption is disabled and Minecraft’s default skins will be used.

This mode should be used for development purposes only and not for publicly exposed servers.

BungeeCord

This mode should be used under one of the following situations:

• The server is behind a BungeeCord/Waterfall proxy with IP forwarding enabled.
• The server is behind a Velocity proxy configured to use the legacy forwarding mode.

All player data (username, UUID, and properties) is fetched from the proxy, but no attempt is made to stop connections originating from elsewhere. As a result, you must ensure clients connect through the proxy and are unable to connect to the server directly. Otherwise, clients can use any username or UUID they choose similar to ConnectionMode::Offline.

To protect against this, a firewall can be used. However, ConnectionMode::Velocity is recommended as a secure alternative.

Velocity

This mode is used when the server is behind a Velocity proxy configured with the forwarding mode modern.

All player data (username, UUID, and properties) is fetched from the proxy and all connections originating from outside Velocity are blocked.

Fields

secret: Arc<str>

The secret key used to prevent connections from outside Velocity. The proxy and Valence must be configured to use the same secret key.

Trait Implementations

impl Clone for ConnectionMode

fn clone(&self) -> ConnectionMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for ConnectionMode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConnectionMode