Enum openvpn_plugin::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

pub fn clone(&self) -> EventResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EventResult

impl Debug for EventResult

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

Formats the value using the given formatter.

impl Eq for EventResult

impl Hash for EventResult

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<EventResult> for EventResult

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for EventResult

impl StructuralPartialEq for EventResult