Debian Codegraph @

third_party/rust/mls-rs-provider-sqlite/src/key_package.rs

raw
1 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2 // Copyright by contributors to this project.
3 // SPDX-License-Identifier: (Apache-2.0 OR MIT)
4
5 use mls_rs_core::{
6 key_package::{KeyPackageData, KeyPackageStorage},
7 mls_rs_codec::{MlsDecode, MlsEncode},
8 time::MlsTime,
9 };
10 use rusqlite::{params, Connection, OptionalExtension};
11 use std::sync::{Arc, Mutex};
12
13 use crate::SqLiteDataStorageError;
14
15 #[derive(Debug, Clone)]
16 /// SQLite storage for MLS Key Packages.
17 pub struct SqLiteKeyPackageStorage {
18 connection: Arc<Mutex<Connection>>,
19 }
20
21 impl SqLiteKeyPackageStorage {
22 pub(crate) fn new(connection: Connection) -> SqLiteKeyPackageStorage {
23 SqLiteKeyPackageStorage {
24 connection: Arc::new(Mutex::new(connection)),
25 }
26 }
27
28 fn insert(
29 &mut self,
30 id: &[u8],
31 key_package: KeyPackageData,
32 ) -> Result<(), SqLiteDataStorageError> {
33 let connection = self.connection.lock().unwrap();
34
35 connection
36 .execute(
37 "INSERT INTO key_package (id, expiration, data) VALUES (?,?,?)",
38 params![
39 id,
40 key_package.expiration,
41 key_package
42 .mls_encode_to_vec()
43 .map_err(|e| SqLiteDataStorageError::DataConversionError(e.into()))?
44 ],
45 )
46 .map(|_| ())
47 .map_err(|e| SqLiteDataStorageError::SqlEngineError(e.into()))
48 }
49
50 fn get(&self, id: &[u8]) -> Result<Option<KeyPackageData>, SqLiteDataStorageError> {
51 let connection = self.connection.lock().unwrap();
52
53 connection
54 .query_row(
55 "SELECT data FROM key_package WHERE id = ?",
56 params![id],
57 |row| {
58 Ok(
59 KeyPackageData::mls_decode(&mut row.get::<_, Vec<u8>>(0)?.as_slice())
60 .unwrap(),
61 )
62 },
63 )
64 .optional()
65 .map_err(|e| SqLiteDataStorageError::SqlEngineError(e.into()))
66 }
67
68 /// Delete a specific key package from storage based on it's id.
69 pub fn delete(&self, id: &[u8]) -> Result<(), SqLiteDataStorageError> {
70 let connection = self.connection.lock().unwrap();
71
72 connection
73 .execute("DELETE FROM key_package where id = ?", params![id])
74 .map(|_| ())
75 .map_err(|e| SqLiteDataStorageError::SqlEngineError(e.into()))
76 }
77
78 /// Delete key packages that are expired based on the current system clock time.
79 pub fn delete_expired(&self) -> Result<(), SqLiteDataStorageError> {
80 self.delete_expired_by_time(MlsTime::now().seconds_since_epoch())
81 }
82
83 /// Delete key packages that are expired based on an application provided time in seconds since
84 /// unix epoch.
85 pub fn delete_expired_by_time(&self, time: u64) -> Result<(), SqLiteDataStorageError> {
86 let connection = self.connection.lock().unwrap();
87
88 connection
89 .execute(
90 "DELETE FROM key_package where expiration < ?",
91 params![time],
92 )
93 .map(|_| ())
94 .map_err(|e| SqLiteDataStorageError::SqlEngineError(e.into()))
95 }
96
97 /// Total number of key packages held in storage.
98 pub fn count(&self) -> Result<usize, SqLiteDataStorageError> {
99 let connection = self.connection.lock().unwrap();
100
101 connection
102 .query_row("SELECT count(*) FROM key_package", params![], |row| {
103 row.get(0)
104 })
105 .map_err(|e| SqLiteDataStorageError::SqlEngineError(e.into()))
106 }
107
108 /// Total number of key packages that will still remain in storage at a specific application provided
109 /// time in seconds since unix epoch. This assumes that the application would also be calling
110 /// [SqLiteKeyPackageStorage::delete_expired] at a reasonable cadence to be accurate.
111 pub fn count_at_time(&self, time: u64) -> Result<usize, SqLiteDataStorageError> {
112 let connection = self.connection.lock().unwrap();
113
114 connection
115 .query_row(
116 "SELECT count(*) FROM key_package where expiration >= ?",
117 params![time],
118 |row| row.get(0),
119 )
120 .map_err(|e| SqLiteDataStorageError::SqlEngineError(e.into()))
121 }
122 }
123
124 #[cfg_attr(not(mls_build_async), maybe_async::must_be_sync)]
125 #[cfg_attr(mls_build_async, maybe_async::must_be_async)]
126 impl KeyPackageStorage for SqLiteKeyPackageStorage {
127 type Error = SqLiteDataStorageError;
128
129 async fn insert(&mut self, id: Vec<u8>, pkg: KeyPackageData) -> Result<(), Self::Error> {
130 self.insert(id.as_slice(), pkg)
131 }
132
133 async fn get(&self, id: &[u8]) -> Result<Option<KeyPackageData>, Self::Error> {
134 self.get(id)
135 }
136
137 async fn delete(&mut self, id: &[u8]) -> Result<(), Self::Error> {
138 (*self).delete(id)
139 }
140 }
141
142 #[cfg(test)]
143 mod tests {
144 use super::SqLiteKeyPackageStorage;
145 use crate::{
146 SqLiteDataStorageEngine, SqLiteDataStorageError,
147 {connection_strategy::MemoryStrategy, test_utils::gen_rand_bytes},
148 };
149 use assert_matches::assert_matches;
150 use mls_rs_core::{crypto::HpkeSecretKey, key_package::KeyPackageData};
151
152 fn test_storage() -> SqLiteKeyPackageStorage {
153 SqLiteDataStorageEngine::new(MemoryStrategy)
154 .unwrap()
155 .key_package_storage()
156 .unwrap()
157 }
158
159 fn test_key_package() -> (Vec<u8>, KeyPackageData) {
160 let key_id = gen_rand_bytes(32);
161 let key_package = KeyPackageData::new(
162 gen_rand_bytes(256),
163 HpkeSecretKey::from(gen_rand_bytes(256)),
164 HpkeSecretKey::from(gen_rand_bytes(256)),
165 123,
166 );
167
168 (key_id, key_package)
169 }
170
171 #[test]
172 fn key_package_insert() {
173 let mut storage = test_storage();
174 let (key_package_id, key_package) = test_key_package();
175
176 storage
177 .insert(&key_package_id, key_package.clone())
178 .unwrap();
179
180 let from_storage = storage.get(&key_package_id).unwrap().unwrap();
181 assert_eq!(from_storage, key_package);
182 }
183
184 #[test]
185 fn duplicate_insert_should_fail() {
186 let mut storage = test_storage();
187 let (key_package_id, key_package) = test_key_package();
188
189 storage
190 .insert(&key_package_id, key_package.clone())
191 .unwrap();
192
193 let dupe_res = storage.insert(&key_package_id, key_package);
194
195 assert_matches!(dupe_res, Err(SqLiteDataStorageError::SqlEngineError(_)));
196 }
197
198 #[test]
199 fn key_package_not_found() {
200 let mut storage = test_storage();
201 let (key_package_id, key_package) = test_key_package();
202
203 storage.insert(&key_package_id, key_package).unwrap();
204
205 let (another_package_id, _) = test_key_package();
206
207 assert!(storage.get(&another_package_id).unwrap().is_none());
208 }
209
210 #[test]
211 fn key_package_delete() {
212 let mut storage = test_storage();
213 let (key_package_id, key_package) = test_key_package();
214
215 storage.insert(&key_package_id, key_package).unwrap();
216
217 storage.delete(&key_package_id).unwrap();
218 assert!(storage.get(&key_package_id).unwrap().is_none());
219 }
220
221 #[test]
222 fn expired_key_package_gelete() {
223 let mut storage = test_storage();
224
225 let data = [1, 15, 30, 1698652376].map(|exp| {
226 let mut kp = test_key_package();
227 kp.1.expiration = exp;
228 kp
229 });
230
231 for (id, data) in &data {
232 storage.insert(id, data.clone()).unwrap();
233 }
234
235 storage.delete_expired_by_time(30).unwrap();
236
237 assert!(storage.get(&data[0].0).unwrap().is_none());
238 assert!(storage.get(&data[1].0).unwrap().is_none());
239 storage.get(&data[2].0).unwrap().unwrap();
240 storage.get(&data[3].0).unwrap().unwrap();
241
242 storage.delete_expired().unwrap();
243
244 assert!(storage.get(&data[2].0).unwrap().is_none());
245 assert!(storage.get(&data[3].0).unwrap().is_none());
246 }
247
248 #[test]
249 fn key_count() {
250 let mut storage = test_storage();
251
252 let test_packages = (0..10).map(|_| test_key_package()).collect::<Vec<_>>();
253
254 test_packages
255 .into_iter()
256 .for_each(|(key_package_id, key_package)| {
257 storage.insert(&key_package_id, key_package).unwrap();
258 });
259
260 assert_eq!(storage.count().unwrap(), 10);
261 }
262
263 #[test]
264 fn key_count_at_time() {
265 let mut storage = test_storage();
266
267 let mut kp_1 = test_key_package();
268 kp_1.1.expiration = 1;
269 storage.insert(&kp_1.0, kp_1.1).unwrap();
270
271 let mut kp_2 = test_key_package();
272 kp_2.1.expiration = 2;
273 storage.insert(&kp_2.0, kp_2.1).unwrap();
274
275 assert_eq!(storage.count_at_time(3).unwrap(), 0);
276 assert_eq!(storage.count_at_time(2).unwrap(), 1);
277 assert_eq!(storage.count_at_time(1).unwrap(), 2);
278 assert_eq!(storage.count_at_time(0).unwrap(), 2);
279 }
280 }