Struct CatGenerateOptions

pub struct CatGenerateOptions {
    pub validation_type: CatValidationType,
    pub alg: String,
    pub kid: String,
    pub generate_cwt_id: bool,
}

Options for generating a CAT token.

This struct contains parameters that control how a token is generated, including which cryptographic algorithm and key to use.

Examples

use common_access_token::{CatGenerateOptions, CatValidationType};

// Basic token generation options
let options = CatGenerateOptions {
    validation_type: CatValidationType::Mac,
    alg: "HS256".to_string(),
    kid: "key-1".to_string(),
    generate_cwt_id: true,
};

// Using the default options
let default_options = CatGenerateOptions::default();

Fields

validation_type: CatValidationType

Type of validation mechanism to use for the token. Currently, only CatValidationType::Mac is fully implemented.

alg: String

Algorithm to use for token generation. For CatValidationType::Mac, this should be “HS256”.

kid: String

Key ID to use for token generation. This must match a key ID in the keys map provided to the Cat instance.

generate_cwt_id: bool

Whether to generate a CWT ID for the token. A CWT ID is a unique identifier for the token that can be used for tracking or revocation purposes.

Trait Implementations

impl Clone for CatGenerateOptions

fn clone(&self) -> CatGenerateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CatGenerateOptions

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

Formats the value using the given formatter.

impl Default for CatGenerateOptions

fn default() -> Self

Creates a default set of options for token generation.

The default configuration:

• Uses HMAC-based authentication (CatValidationType::Mac)
• Uses the HS256 algorithm (HMAC with SHA-256)
• Has an empty key ID (must be set before use)
• Does not generate a CWT ID