Struct splinter::rest_api::auth::authorization::allow_keys::AllowKeysAuthorizationHandler

pub struct AllowKeysAuthorizationHandler { /* private fields */ }

A file-backed authorization handler that permits admin keys

The authorization handler only accepts Identity::Key identities; if a different type of identity is provided, the handler will return AuthorizationHandlerResult::Continue. If a key is provided, the handler will check if the key is present in the backing file. If the key is in the backing file, the handler will return AuthorizationHandlerResult::Allow; if not, it will return AuthorizationHandlerResult::Continue. The permission_id argument for AuthorizationHandler::has_permission is ignored because this authorization handler provides admin privileges (all permissions).

The authorization handler’s backing file must be a list of keys separated by newlines.

The list of keys in the file are cached in-memory by the authorization handler; this means that the handler will not have to read from the file every time permissions are checked. Instead, each time the handler checks for permissions, it will check the backing file for any changes since the last read, refreshing the internal cache if necessary. If the backing file does not exist, is removed, or becomes unavailable, the authorization handler will treat the list of keys as empty (all permission checks will receive a AuthorizationHandlerResult::Continue result).

Implementations

impl AllowKeysAuthorizationHandler

pub fn new(file_path: &str) -> Result<Self, InternalError>

Constructs a new AllowKeysAuthorizationHandler.

Arguments

• file_path - The path of the backing allow keys file.

Trait Implementations

impl AuthorizationHandler for AllowKeysAuthorizationHandler

fn has_permission(
    &self,
    identity: &Identity,
    _permission_id: &str
) -> Result<AuthorizationHandlerResult, InternalError>

Determines if the given identity has the requested permission

fn clone_box(&self) -> Box<dyn AuthorizationHandler>

Clone implementation for AuthorizationHandler. The implementation of the Clone trait for Box<dyn AuthorizationHandler> calls this method.

impl Clone for AllowKeysAuthorizationHandler

fn clone(&self) -> AllowKeysAuthorizationHandler

Returns a copy of the value.

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

Performs copy-assignment from source.