Skip to main content

Token

Struct Token 

Source
pub struct Token(/* private fields */);
Expand description

A bearer token shared between an agent and the control plane.

Implementations§

Source§

impl Token

Source

pub fn new(token: impl Into<String>) -> Self

Wrap a raw token. Surrounding whitespace is trimmed.

Prefer Token::from_env / Token::from_file in production so the secret is not baked into the binary or argv.

Source

pub fn generate() -> Self

Generate a fresh random token (256 bits of OS entropy, base64url-encoded, prefixed solti_agt_).

This is a pure value: it performs no persistence. The SDK is a library and does not decide where the secret lives: the agent binary owns that (file, vault, k8s secret, …).

Source

pub fn from_env(var: &str) -> ModelResult<Self>

Read the token from an environment variable.

Returns ModelError::Invalid if the variable is unset or empty.

Source

pub fn from_file(path: impl AsRef<Path>) -> ModelResult<Self>

Read the token from a file (trailing newline / whitespace trimmed).

Returns ModelError::Invalid if the file cannot be read or is empty.

Source

pub fn expose(&self) -> &str

Borrow the raw token for outbound header construction (the sending side, e.g. solti-discover). Inbound verification should use Token::verify.

Source

pub fn is_empty(&self) -> bool

Whether the token is empty (after trimming) — used by config validation.

Source

pub fn verify(&self, candidate: &str) -> bool

Constant-time comparison against a candidate presented by a caller.

Used by the inbound verification path (solti-api), a timing side-channel cannot be used to recover the secret byte-by-byte. A length mismatch returns false (token length is not secret); equal-length content comparison stays constant-time.

Trait Implementations§

Source§

impl Clone for Token

Source§

fn clone(&self) -> Token

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Token

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Token

§

impl RefUnwindSafe for Token

§

impl Send for Token

§

impl Sync for Token

§

impl Unpin for Token

§

impl UnsafeUnpin for Token

§

impl UnwindSafe for Token

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.