Enum EventResult

pub enum EventResult {
    Success,
    Deferred,
    Failure,
}

Enum representing the results an OpenVPN plugin can return from an event callback.

Variants

Success

Will return OPENVPN_PLUGIN_FUNC_SUCCESS to OpenVPN. Indicates that the plugin marks the event as a success. This means an auth is approved or similar, depending on which type of event.

Deferred

Will return OPENVPN_PLUGIN_FUNC_DEFERRED to OpenVPN. WARNING: Can only be returned from the EventType::AuthUserPassVerify (OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY) event. No other events may return this variant. Returning this tells OpenVPN to continue its normal work and that the decision on if the authentication is accepted or not will be delivered later, via writing to the path under the auth_control_file environment variable.

Failure

Will return OPENVPN_PLUGIN_FUNC_ERROR to OpenVPN. Both returning Ok(EventResult::Failure) and Err(e) from a callback will result in OPENVPN_PLUGIN_FUNC_ERROR being returned to OpenVPN. The difference being that an Err(e) will also log the error e. This variant is intended for when the plugin did not encounter an error, but the event is a failure or is to be declined. Intended to be used to decline an authentication request and similar.

Trait Implementations

impl Clone for EventResult

fn clone(&self) -> EventResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventResult

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

Formats the value using the given formatter.

impl Hash for EventResult

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EventResult

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

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

const 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 Copy for EventResult

impl Eq for EventResult

impl StructuralPartialEq for EventResult