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
136
137
138
139
140
141
142
143
144
145
146

use typelock::{FromBytes, LockSchema, ToBytes};
use common::PolicyProvider;

mod common;

#[derive(LockSchema, Clone)]
#[typelock(
    unlocked(name = UserUnlocked, derives(Debug)), 
    locked(name = UserLocked, attributes(allow(dead_code)))
)]
struct User {
    pub id: i64,

    #[secure(policy(encrypt))]
    pub email: String,

    #[secure(policy(secret), rename = "password_hash")]
    pub password: String,

    #[secure(policy(encrypt))]
    pub user_data: UserData,
}

#[derive(Debug, Clone)]
struct UserData {
    first_name: String,
}

impl ToBytes for UserData {
    fn to_bytes(&self) -> Result<Vec<u8>, typelock::Error> {
        Ok(self.first_name.as_bytes().to_vec())
    }
}

impl FromBytes for UserData {
    fn from_bytes(bytes: &[u8]) -> Result<Self, typelock::Error> {
        Ok(Self {
            first_name: String::from_utf8(bytes.to_vec())?,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use typelock::{Lockable, Unlockable};

    #[test]
    fn test_conversion_between_models() {
        let provider = PolicyProvider;
        let user = User {
            id: 1,
            email: "user@email".to_string(),
            password: "user-password".to_string(),
            user_data: UserData {
                first_name: "user".to_string(),
            },
        };

        // We need to clone the user since both lock and unlock move the
        // original user model. Cloning sensitive data is generally discouraged
        // as it creates ghost copies in memory, that potentially compromise the
        // security of your data. I'm using clone here just for test purposes to
        // allow calling assert_eq!() to validate my crates implementation. Also
        // consider using the crate `zeroize` to remove sensitive data from memory.
        let locked_user = user.clone().lock(&provider).unwrap();
        let unlocked_user = user
            .clone()
            .lock(&provider)
            .unwrap()
            .unlock(&provider)
            .unwrap();

        assert_eq!(user.id, unlocked_user.id);
        assert_eq!(user.email, *unlocked_user.email);

        // Hashing is irreversable, hence both the locked and unlocked
        // user just store the hashed bytes which should be equal.
        assert_eq!(locked_user.password_hash, unlocked_user.password);

        assert_eq!(
            user.user_data.first_name,
            unlocked_user.user_data.first_name
        );
    }

    #[test]
    fn test_conversion_between_vec_models() {
        let provider = PolicyProvider;
        let user1 = User {
            id: 1,
            email: "user1@email".to_string(),
            password: "user1-password".to_string(),
            user_data: UserData {
                first_name: "user1".to_string(),
            },
        };

        let user2 = User {
            id: 2,
            email: "user2@email".to_string(),
            password: "user2-password".to_string(),
            user_data: UserData {
                first_name: "user2".to_string(),
            },
        };

        let users = vec![user1, user2];
        let locked_users = users.clone().lock(&provider).unwrap();
        let unlocked_users = locked_users.unlock(&provider).unwrap();

        assert_eq!(users.len(), unlocked_users.len());

        for (original, unlocked) in users.iter().zip(unlocked_users.iter()) {
            assert_eq!(original.id, unlocked.id);
            assert_eq!(original.email, *unlocked.email);
            assert_eq!(original.user_data.first_name, unlocked.user_data.first_name);
        }
    }

    #[test]
    fn test_derive_pass_through() {
        #[derive(LockSchema, Clone)]
        #[typelock(locked(name = LockedTest, derives(Debug)), unlocked(name = UnlockedTest, derives(Debug)))]
        #[allow(dead_code)]
        struct Test {
            id: i64,

            #[secure(policy(secret), rename = "password_hash")]
            password: String,
        }
    }

    #[test]
    fn test_attribute_pass_through() {
        #[derive(LockSchema, Clone)]
        #[typelock(locked(name = LockedTest, attributes(allow(dead_code))), unlocked(name = UnlockedTest, attributes(allow(dead_code))))]
        #[allow(dead_code)]
        struct Test {
            id: i64,

            #[secure(policy(secret), rename = "password_hash")]
            password: String,
        }
    }
}