Skip to main content

TimeLockTime

Struct TimeLockTime 

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

An explicit time value supplied by the caller for encryption-time key derivation.

hour is always expressed in 24-hour notation (0–23) regardless of the TimeFormat chosen for the KDF string — the format flag only controls how the string is rendered, not how you supply the input.

§Example

use toolkit_zero::encryption::timelock::TimeLockTime;

let t = TimeLockTime::new(14, 37).unwrap(); // 14:37 local (2:37 PM)

Implementations§

Source§

impl TimeLockTime

Source

pub fn new(hour: u32, minute: u32) -> Option<Self>

Construct a TimeLockTime from a 24-hour hour (0–23) and minute (0–59).

Returns None if either value is out of range.

Examples found in repository?
examples/timelock_round_trip.rs (line 36)
24fn main() {
25    // ── Encryption side ───────────────────────────────────────────────────────
26    // Generate fresh salts.  Salts are NOT secret — store them in plaintext
27    // alongside the ciphertext so the decryption side can reproduce the key.
28    let salts = TimeLockSalts::generate();
29
30    // Use a deliberately fast preset so the example finishes quickly.
31    // In production use KdfPreset::Balanced or stronger.
32    let kdf = KdfPreset::Balanced.params();
33
34    // Lock to any Tuesday at 18:00 (hour-precision window = the full 18:00–18:59 block).
35    let cadence   = TimeLockCadence::DayOfWeek(Weekday::Tuesday);
36    let lock_time = TimeLockTime::new(18, 0).unwrap();
37
38    println!("Deriving encryption key (this may take a few seconds)…");
39    let enc_key = TimelockBuilder::encrypt()
40        .cadence(cadence.clone())
41        .time(lock_time)
42        .precision(TimePrecision::Hour)
43        .format(TimeFormat::Hour24)
44        .salts(salts.clone())
45        .kdf(kdf)
46        .derive()
47        .expect("encryption-side key derivation failed");
48
49    println!("enc_key[:8] = {:02x?}", &enc_key.as_bytes()[..8]);
50
51    // Pack every setting — including salts and KDF params — into a compact header.
52    // This header goes into the ciphertext in plaintext; nothing here is secret.
53    let header = pack(
54        TimePrecision::Hour,
55        TimeFormat::Hour24,
56        &cadence,
57        salts,
58        kdf,
59    );
60
61    // ── Decryption side ───────────────────────────────────────────────────────
62    // Load `header` from the ciphertext and call TimelockBuilder::decrypt at the
63    // matching time slot.  All settings are read from the header automatically.
64    println!("Deriving decryption key from system clock…");
65    let dec_key = TimelockBuilder::decrypt(header)
66        .derive()
67        .expect("decryption-side key derivation failed");
68
69    println!("dec_key[:8] = {:02x?}", &dec_key.as_bytes()[..8]);
70
71    // ── Verdict ───────────────────────────────────────────────────────────────
72    if enc_key.as_bytes() == dec_key.as_bytes() {
73        println!("\nKeys match ✓  — running on a Tuesday at 18:xx");
74    } else {
75        println!("\nKeys differ — not running on a Tuesday at 18:xx (expected outside that window)");
76    }
77}
Source

pub fn hour(self) -> u32

The hour component (0–23).

Source

pub fn minute(self) -> u32

The minute component (0–59).

Trait Implementations§

Source§

impl Clone for TimeLockTime

Source§

fn clone(&self) -> TimeLockTime

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 TimeLockTime

Source§

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

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

impl PartialEq for TimeLockTime

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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.
Source§

impl Copy for TimeLockTime

Source§

impl Eq for TimeLockTime

Source§

impl StructuralPartialEq for TimeLockTime

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

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

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

Source§

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

Compare self to key and return true if they are equal.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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
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, 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