Skip to main content

JwtAlgorithm

zlayer_types::api::cluster

Enum JwtAlgorithm

pub enum JwtAlgorithm {
    Hs256,
    Both,
    Eddsa,
}

Expand description

The JWT algorithm policy a cluster enforces for join tokens.

Phases of the HS256 → EdDSA migration:

Hs256: accept HS256-JWT and Ed25519-signed-envelope tokens. EdDSA-JWT is rejected (fresh tokens have nowhere to come from in this phase).
Both: accept all three modern formats. Operators run their cluster here for a migration grace window so in-flight HS256 tokens remain valid while clients re-issue under EdDSA.
Eddsa: accept EdDSA-JWT and Ed25519-signed-envelope. HS256-JWT is rejected with an actionable error. The symmetric {data_dir}/join_secret may be wiped via WipeJoinSecret at this point — it’s no longer load-bearing.

Variants§

Hs256

HS256-only (legacy default for clusters created before Wave 11).

Both

Both algorithms accepted (migration window).

Eddsa

EdDSA-only. The cluster has decommissioned its symmetric secret.

Implementations§

impl JwtAlgorithm

pub fn as_str(self) -> &'static str

Return the canonical lowercase identifier.

Trait Implementations§

impl Clone for JwtAlgorithm

fn clone(&self) -> JwtAlgorithm

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

impl ComposeSchema for JwtAlgorithm

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Copy for JwtAlgorithm

impl Debug for JwtAlgorithm

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

Formats the value using the given formatter. Read more

impl Default for JwtAlgorithm

fn default() -> JwtAlgorithm

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for JwtAlgorithm

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for JwtAlgorithm

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

Formats the value using the given formatter. Read more

impl Eq for JwtAlgorithm

impl PartialEq for JwtAlgorithm

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

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

1.0.0 (const: unstable) · Source§

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 Serialize for JwtAlgorithm

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for JwtAlgorithm

impl ToSchema for JwtAlgorithm

fn name() -> Cow<'static, str>

Return name of the schema. Read more

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type. Read more

Auto Trait Implementations§

impl Freeze for JwtAlgorithm

impl RefUnwindSafe for JwtAlgorithm

impl Send for JwtAlgorithm

impl Sync for JwtAlgorithm

impl Unpin for JwtAlgorithm

impl UnsafeUnpin for JwtAlgorithm

impl UnwindSafe for JwtAlgorithm

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromBase64 for T
where T: for<'de> Deserialize<'de>,

fn from_base64<Input>(raw: &Input) -> Result<T, Error>
where Input: AsRef<[u8]> + ?Sized,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> PartialSchema for T
where T: ComposeSchema + ?Sized,

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<C> SignWithKey<String> for C
where C: ToBase64,

fn sign_with_key(self, key: &impl SigningAlgorithm) -> Result<String, Error>

impl<T> ToBase64 for T
where T: Serialize,

fn to_base64(&self) -> Result<Cow<'_, str>, Error>

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> ToStringFallible for T
where T: Display,

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

impl<T, U> TryFrom<U> for T
where 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>

Performs the conversion.

impl<T, U> TryInto<U> for T
where 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>

Performs the conversion.

impl<T> ValidateIp for T
where T: ToString,

fn validate_ipv4(&self) -> bool

Validates whether the given string is an IP V4

fn validate_ipv6(&self) -> bool

Validates whether the given string is an IP V6

fn validate_ip(&self) -> bool

Validates whether the given string is an IP

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more