Struct Credentials 

pub struct Credentials<Id> {
    pub id: Id,
    pub secret: String,
}

Authentication credentials containing a user identifier and plaintext secret.

This type represents raw login input at the authentication boundary. It stores the caller-provided identifier together with a plaintext secret so a verifier can compare it against stored authentication material.

Type Parameter

• Id: Identifier type used by the calling application, commonly String or uuid::Uuid

Security

• The secret field contains plaintext sensitive data.
• Keep instances short-lived and avoid cloning them unnecessarily.
• Never log, persist, or expose the raw secret.
• Use secure transport when credentials cross process or network boundaries.

Examples

Create credentials from application input:

use webgates_core::credentials::Credentials;

let credentials = Credentials::new(&"user@example.com".to_string(), "user_password");

assert_eq!(credentials.id, "user@example.com");
assert_eq!(credentials.secret, "user_password");

Deserialize credentials from JSON:

use webgates_core::credentials::Credentials;

let json = r#"{"id":"user@example.com","secret":"password123"}"#;
let credentials: Credentials<String> = serde_json::from_str(json)?;

assert_eq!(credentials.id, "user@example.com");

Use a UUID identifier:

use uuid::Uuid;
use webgates_core::credentials::Credentials;

let user_id = Uuid::now_v7();
let credentials = Credentials::new(&user_id, "user_password");

assert_eq!(credentials.id, user_id);

Fields

id: Id

User identifier, such as a username, email address, or UUID.

secret: String

Plaintext secret supplied by the caller, such as a password.

Implementations

impl<Id> Credentials<Id>

pub fn new(id: &Id, secret: &str) -> Self

where Id: ToOwned<Owned = Id>,

Creates credentials from an identifier and a plaintext secret.

The identifier is cloned into the returned value and the secret is stored as an owned String.

Parameters

• id: User identifier to copy into the credentials
• secret: Plaintext secret supplied by the caller

Security

The returned value contains plaintext sensitive data. Callers should keep it short-lived and avoid logging or persisting it.

Examples

use webgates_core::credentials::Credentials;

let credentials = Credentials::new(&"admin@company.com".to_string(), "admin_password");

assert_eq!(credentials.id, "admin@company.com");
assert_eq!(credentials.secret, "admin_password");

use uuid::Uuid;
use webgates_core::credentials::Credentials;

let user_id = Uuid::now_v7();
let credentials = Credentials::new(&user_id, "user_secret");

assert_eq!(credentials.id, user_id);

Trait Implementations

impl<Id: Clone> Clone for Credentials<Id>

fn clone(&self) -> Credentials<Id>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id: Debug> Debug for Credentials<Id>

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

Formats the value using the given formatter.

impl<'de, Id> Deserialize<'de> for Credentials<Id>

where Id: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Id> Serialize for Credentials<Id>

where Id: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.