[−][src]Struct schemeguardian::GenericAuthEngine
Struct structure
use redactedsecret::SecretString; use serde::{Serialize, Deserialize}; use schemeguardian::{GenericRole, Lease}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } #[derive(Debug, Serialize, Deserialize)] pub struct GenericAuthEngine<R> { identifier: SecretString, role: GenericRole<R>, target: Option<SecretString>, lease: Lease, random_key: SecretString, }
Example
use schemeguardian::{GenericAuthEngine, GenericRole, Lease}; use redactedsecret::SecretString; use std::time::{SystemTime, Duration}; use tai64::{TAI64N}; use serde::{Serialize, Deserialize}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .identifier(SecretString::new("Foo".to_owned())) .role(GenericRole::CustomRole(Custom::ExecutiveBoard)) .target(Some(SecretString::new("IT-Diploma".to_owned()))) .lease(Lease::DateExpiryTAI(TAI64N::from_system_time(&(SystemTime::now() + Duration::from_secs(2))))) .build();
Methods
impl<R> GenericAuthEngine<R> where
R: Serialize + DeserializeOwned + PartialEq + Debug,
[src]
R: Serialize + DeserializeOwned + PartialEq + Debug,
Usage
use schemeguardian::GenericAuthEngine; use serde::{Serialize, Deserialize}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new();
pub fn new() -> Self
[src]
Initialize a new GenericAuthEngine
Example
use schemeguardian::GenericAuthEngine; use serde::{Serialize, Deserialize}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new();
pub fn identifier(self, user: SecretString) -> Self
[src]
Add an identifier
Example
use schemeguardian::GenericAuthEngine; use serde::{Serialize, Deserialize}; use redactedsecret::SecretString; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .identifier(SecretString::new("Foo".to_owned()));
pub fn role(self, value: GenericRole<R>) -> Self
[src]
Add a Role
Example
use schemeguardian::{GenericAuthEngine, GenericRole}; use serde::{Serialize, Deserialize}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .role(GenericRole::CustomRole(Custom::ExecutiveBoard));
pub fn target(self, value: Option<SecretString>) -> Self
[src]
Add a Target
Example
use schemeguardian::{GenericAuthEngine, GenericRole}; use serde::{Serialize, Deserialize}; use redactedsecret::SecretString; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .target(Some(SecretString::new("Foo".to_owned())));
pub fn lease(self, lease: Lease) -> Self
[src]
Add a Lease
Example
use schemeguardian::{GenericAuthEngine, Lease}; use serde::{Serialize, Deserialize}; use std::time::{SystemTime, Duration}; use tai64::{TAI64N}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .lease(Lease::DateExpiryTAI(TAI64N::from_system_time(&(SystemTime::now() + Duration::from_secs(2)))));
pub fn build(self) -> Self
[src]
Adds a random 64bit CSRNG phrase and builds the struct
Example
use schemeguardian::GenericAuthEngine; use serde::{Serialize, Deserialize}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .build();
pub fn encodable(&self) -> SecretString
[src]
Generates a key that can be encoded as a branca token or cookie seperated by :::
as username:::rac
Example
use schemeguardian::GenericAuthEngine; use serde::{Serialize, Deserialize}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .encodable();
pub fn insert(self) -> Result<DbOps, SGError>
[src]
Inserts the secrets into the Key-Value Store
Example
use schemeguardian::AuthEngine; AuthEngine::new() .build() .insert();
pub fn rac(self) -> Result<SecretString, SGError>
[src]
Shows the random 64bit CSRNG key
Example
use schemeguardian::GenericAuthEngine; use serde::{Serialize, Deserialize}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .rac();
pub fn show_role(self) -> Result<GenericRole<R>, SGError>
[src]
Shows value for GenericRole
Example
use schemeguardian::GenericAuthEngine; use serde::{Serialize, Deserialize}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .show_role();
pub fn show_target(self) -> Result<Option<SecretString>, SGError>
[src]
Shows value for Target for GenericRole struct
Example
use schemeguardian::GenericAuthEngine; use serde::{Serialize, Deserialize}; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .show_target();
pub fn authenticate(
&self,
user_random: SecretString
) -> Result<(AccessStatus, GenericPayload<R>), SGError>
[src]
&self,
user_random: SecretString
) -> Result<(AccessStatus, GenericPayload<R>), SGError>
Authenticate an existing token
Currently returns:
custom_codes::AccessStatus::Expired
for an secret that has reached end of life
custom_codes::AccessStatus::Granted
for a secret that is live and RAC is authenticated
custom_codes::AccessStatus::RejectedRAC
for a secret that is live but the RAC is not authentic
custom_codes::AccessStatus::Rejected
for a secret that cannot be authenticated
Example
use schemeguardian::GenericAuthEngine; use serde::{Serialize, Deserialize}; use redactedsecret::SecretString; #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] enum Custom { ExecutiveBoard, } GenericAuthEngine::<Custom>::new() .authenticate(SecretString::new("Foo".to_owned()));
Trait Implementations
impl<R: Clone> Clone for GenericAuthEngine<R>
[src]
fn clone(&self) -> GenericAuthEngine<R>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<R: Eq> Eq for GenericAuthEngine<R>
[src]
impl<R: PartialEq> PartialEq<GenericAuthEngine<R>> for GenericAuthEngine<R>
[src]
fn eq(&self, other: &GenericAuthEngine<R>) -> bool
[src]
fn ne(&self, other: &GenericAuthEngine<R>) -> bool
[src]
impl<R: Debug> Debug for GenericAuthEngine<R>
[src]
impl<R> StructuralPartialEq for GenericAuthEngine<R>
[src]
impl<R> StructuralEq for GenericAuthEngine<R>
[src]
impl<R> Serialize for GenericAuthEngine<R> where
R: Serialize,
[src]
R: Serialize,
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<'de, R> Deserialize<'de> for GenericAuthEngine<R> where
R: Deserialize<'de>,
[src]
R: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl<R> Send for GenericAuthEngine<R> where
R: Send,
R: Send,
impl<R> Sync for GenericAuthEngine<R> where
R: Sync,
R: Sync,
impl<R> Unpin for GenericAuthEngine<R> where
R: Unpin,
R: Unpin,
impl<R> UnwindSafe for GenericAuthEngine<R> where
R: UnwindSafe,
R: UnwindSafe,
impl<R> RefUnwindSafe for GenericAuthEngine<R> where
R: RefUnwindSafe,
R: RefUnwindSafe,
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,