LicenseKey

Struct LicenseKey 

Source
pub struct LicenseKey { /* private fields */ }
Expand description

Secure license key with automatic memory protection

This type provides secure storage and handling of Truthlinked license keys with the following security guarantees:

§Security Features

  • Memory Protection: Key data is automatically zeroized when dropped
  • No Credential Leakage: Debug and Display implementations show only redacted versions
  • Safe Serialization: Serialization outputs redacted version, never full key
  • Constant-Time Operations: Where applicable, operations are constant-time

§Thread Safety

This type is Send + Sync and can be safely shared across threads.

§Example

use truthlinked_sdk::LicenseKey;
 
let key = LicenseKey::new("tl_free_secret123".to_string());
 
// Safe to log - shows redacted version
println!("Using key: {}", key);  // "tl_...123"
 
// Key is automatically zeroized when dropped
drop(key);

Implementations§

Source§

impl LicenseKey

Source

pub fn new(key: String) -> Self

Creates a new license key with memory protection

The provided key string will be stored securely and automatically zeroized from memory when this instance is dropped.

§Arguments
  • key - The license key string (e.g., “tl_free_…”)
§Security

The key is immediately moved into secure storage and will be zeroized when this instance goes out of scope.

Source

pub fn redacted(&self) -> String

Returns a redacted version of the license key safe for logging

The redacted version shows only the first 3 and last 3 characters of the license key, with the middle portion replaced by “…”.

§Example
let key = LicenseKey::new("tl_free_secret123456789".to_string());
assert_eq!(key.redacted(), "tl_...789");
§Security

This method is safe to use in logs, error messages, and debug output as it does not reveal the full license key.

Trait Implementations§

Source§

impl Clone for LicenseKey

Source§

fn clone(&self) -> LicenseKey

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LicenseKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for LicenseKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for LicenseKey

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Serialize for LicenseKey

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Zeroize for LicenseKey

Source§

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

Auto Trait Implementations§

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> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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