typelock 0.5.1

Enforce security boundaries at the Type level
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

use diesel::{
    backend::Backend,
    deserialize::FromSql,
    serialize::{Output, ToSql},
    sql_types::Binary,
};

use crate::{Digested, Encrypted, Secret, Signed, Tagged};

// =============================================================================
// DIESEL IMPLEMENTATIONS — LOCKED TYPES ONLY
// =============================================================================
// Only locked wrapper types (Encrypted, Hashed, Digested, Signed, Tagged)
// implement diesel's FromSql/ToSql traits.
//
// Unlocked types (Decrypted, Verified) are INTENTIONALLY excluded.
//
// Rationale: unlocked types represent sensitive data in its usable form —
// plaintext, verified payloads, decrypted secrets. They should never be
// written to a database directly. If you find yourself needing to store
// an unlocked type, you almost certainly want to call `.lock()` first.
//
// If diesel impls on unlocked types are ever added, it should be treated
// as a security regression and reverted.
// =============================================================================

/// implemenations for Encrypted
impl<T, DB> FromSql<Binary, DB> for Encrypted<T>
where
    DB: Backend,
    Vec<u8>: FromSql<Binary, DB>,
{
    fn from_sql(bytes: DB::RawValue<'_>) -> diesel::deserialize::Result<Self> {
        Ok(Self::new(Vec::<u8>::from_sql(bytes)?))
    }
}

impl<T, DB> ToSql<Binary, DB> for Encrypted<T>
where
    T: std::fmt::Debug,
    DB: Backend,
    Vec<u8>: ToSql<Binary, DB>,
{
    fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, DB>) -> diesel::serialize::Result {
        self.bytes.to_sql(out)
    }
}

/// implemenations for Secret
impl<T, DB> FromSql<Binary, DB> for Secret<T>
where
    DB: Backend,
    Vec<u8>: FromSql<Binary, DB>,
{
    fn from_sql(bytes: DB::RawValue<'_>) -> diesel::deserialize::Result<Self> {
        Ok(Self::new(Vec::<u8>::from_sql(bytes)?))
    }
}

impl<T, DB> ToSql<Binary, DB> for Secret<T>
where
    T: std::fmt::Debug,
    DB: Backend,
    Vec<u8>: ToSql<Binary, DB>,
{
    fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, DB>) -> diesel::serialize::Result {
        self.bytes.to_sql(out)
    }
}

/// implemenations for Digested
impl<T, DB> FromSql<Binary, DB> for Digested<T>
where
    DB: Backend,
    Vec<u8>: FromSql<Binary, DB>,
{
    fn from_sql(bytes: DB::RawValue<'_>) -> diesel::deserialize::Result<Self> {
        Ok(Self::new(Vec::<u8>::from_sql(bytes)?))
    }
}

impl<T, DB> ToSql<Binary, DB> for Digested<T>
where
    T: std::fmt::Debug,
    DB: Backend,
    Vec<u8>: ToSql<Binary, DB>,
{
    fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, DB>) -> diesel::serialize::Result {
        self.bytes.to_sql(out)
    }
}

/// implemenations for Signed
impl<T, DB> FromSql<Binary, DB> for Signed<T>
where
    DB: Backend,
    Vec<u8>: FromSql<Binary, DB>,
{
    fn from_sql(bytes: DB::RawValue<'_>) -> diesel::deserialize::Result<Self> {
        Ok(Self::new(Vec::<u8>::from_sql(bytes)?))
    }
}

impl<T, DB> ToSql<Binary, DB> for Signed<T>
where
    T: std::fmt::Debug,
    DB: Backend,
    Vec<u8>: ToSql<Binary, DB>,
{
    fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, DB>) -> diesel::serialize::Result {
        self.bytes.to_sql(out)
    }
}

/// implemenations for Tagged
impl<T, DB> FromSql<Binary, DB> for Tagged<T>
where
    DB: Backend,
    Vec<u8>: FromSql<Binary, DB>,
{
    fn from_sql(bytes: DB::RawValue<'_>) -> diesel::deserialize::Result<Self> {
        Ok(Self::new(Vec::<u8>::from_sql(bytes)?))
    }
}

impl<T, DB> ToSql<Binary, DB> for Tagged<T>
where
    T: std::fmt::Debug,
    DB: Backend,
    Vec<u8>: ToSql<Binary, DB>,
{
    fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, DB>) -> diesel::serialize::Result {
        self.bytes.to_sql(out)
    }
}