Skip to content

Commit d43f2f4

Browse files
committed
naming
1 parent 8c68b37 commit d43f2f4

File tree

17 files changed

+101
-101
lines changed

17 files changed

+101
-101
lines changed

wasm/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ members = [
1111
"auth",
1212
"sessions",
1313
"main",
14-
"bordercrypt"
14+
"secure-storage"
1515
]
1616

1717
[workspace.package]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "bordercrypt"
2+
name = "secureStorage"
33
version.workspace = true
44
edition.workspace = true
55

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use rand::RngCore;
88
use zeroize::Zeroizing;
99

1010
use crate::constants::{AEAD_TAG_SIZE, BLOCK_SIZE, PLAINTEXT_SIZE};
11-
use crate::error::{BordercryptError, Result};
11+
use crate::error::{SecureStorageError, Result};
1212
use crate::pq::{PQ_MSG_SIZE, PqPublicKey, PqSecretKey, pq_decrypt, pq_encrypt, pq_rerand};
1313

1414
const BLOCK_AEAD_SUFFIX: &str = ":block_aead";
@@ -52,19 +52,19 @@ pub fn decrypt_block(
5252

5353
let nonce = crypto_aead::Nonce::from(
5454
<[u8; crypto_aead::NONCE_SIZE]>::try_from(&msg[..crypto_aead::NONCE_SIZE])
55-
.map_err(|_| BordercryptError::CorruptedBlock)?,
55+
.map_err(|_| SecureStorageError::CorruptedBlock)?,
5656
);
5757
let aead_ct = &msg[crypto_aead::NONCE_SIZE..];
5858
let key = crypto_aead::Key::from(*aead_key);
5959

6060
let plaintext_vec = Zeroizing::new(
6161
crypto_aead::decrypt(&key, &nonce, aead_ct, aad.as_bytes())
62-
.ok_or(BordercryptError::CorruptedBlock)?,
62+
.ok_or(SecureStorageError::CorruptedBlock)?,
6363
);
6464

6565
let mut plaintext = Zeroizing::new([0u8; PLAINTEXT_SIZE]);
6666
if plaintext_vec.len() != PLAINTEXT_SIZE {
67-
return Err(BordercryptError::CorruptedBlock);
67+
return Err(SecureStorageError::CorruptedBlock);
6868
}
6969
plaintext.copy_from_slice(&plaintext_vec);
7070
Ok(plaintext)
@@ -126,7 +126,7 @@ mod tests {
126126
key
127127
}
128128

129-
const AAD_ROOT: &str = "test:bordercrypt:session:v0:i0:b0";
129+
const AAD_ROOT: &str = "test:secureStorage:session:v0:i0:b0";
130130

131131
// --- encrypt / decrypt ---
132132

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ use std::fmt::Write as _;
1010

1111
use crate::types::SessionIndex;
1212

13-
/// Root domain: `{domain}:bordercrypt`
13+
/// Root domain: `{domain}:secureStorage`
1414
#[must_use]
1515
pub fn root(domain: &str) -> String {
16-
format!("{domain}:bordercrypt")
16+
format!("{domain}:secureStorage")
1717
}
1818

1919
/// Session scope: `{root}:session:v{version}:i{index}`
2020
#[must_use]
2121
pub fn session_scope(domain: &str, version: u32, index: SessionIndex) -> String {
22-
format!("{domain}:bordercrypt:session:v{version}:i{}", index.as_u8())
22+
format!("{domain}:secureStorage:session:v{version}:i{}", index.as_u8())
2323
}
2424

2525
/// Block scope: `{session_scope}:b{block_index}`
@@ -30,15 +30,15 @@ pub fn block_scope(buf: &mut String, domain: &str, version: u32, index: SessionI
3030
// String::write_fmt is infallible
3131
let _ = write!(
3232
buf,
33-
"{domain}:bordercrypt:session:v{version}:i{}:b{block}",
33+
"{domain}:secureStorage:session:v{version}:i{}:b{block}",
3434
index.as_u8()
3535
);
3636
}
3737

3838
/// Salt for password KDF: `{root}:password_kdf`
3939
#[must_use]
4040
pub fn password_kdf_salt(domain: &str) -> String {
41-
format!("{domain}:bordercrypt:password_kdf")
41+
format!("{domain}:secureStorage:password_kdf")
4242
}
4343

4444
/// Salt for root KDF: `{domain}:kdf:salt`
@@ -51,7 +51,7 @@ pub fn root_kdf_salt(domain: &str) -> String {
5151
#[must_use]
5252
pub fn sk_wrap_aad(domain: &str, version: u32, index: SessionIndex) -> String {
5353
format!(
54-
"{domain}:bordercrypt:session:v{version}:i{}:pq_sk_wrap",
54+
"{domain}:secureStorage:session:v{version}:i{}:pq_sk_wrap",
5555
index.as_u8()
5656
)
5757
}
@@ -69,7 +69,7 @@ pub fn block_kdf_salt(
6969
buf.clear();
7070
let _ = write!(
7171
buf,
72-
"{domain}:bordercrypt:session:v{version}:i{}:b{block}:kdf:salt",
72+
"{domain}:secureStorage:session:v{version}:i{}:b{block}:kdf:salt",
7373
index.as_u8()
7474
);
7575
}
@@ -87,7 +87,7 @@ pub fn block_aead_key_label(
8787
buf.clear();
8888
let _ = write!(
8989
buf,
90-
"{domain}:bordercrypt:session:v{version}:i{}:b{block}:kdf:block_aead_key",
90+
"{domain}:secureStorage:session:v{version}:i{}:b{block}:kdf:block_aead_key",
9191
index.as_u8()
9292
);
9393
}
@@ -105,21 +105,21 @@ pub fn block_aead_aad(
105105
buf.clear();
106106
let _ = write!(
107107
buf,
108-
"{domain}:bordercrypt:session:v{version}:i{}:b{block}:block_aead",
108+
"{domain}:secureStorage:session:v{version}:i{}:b{block}:block_aead",
109109
index.as_u8()
110110
);
111111
}
112112

113113
/// Label for sk_wrap_key derivation: `{root}:kdf:sk_wrap_key`
114114
#[must_use]
115115
pub fn sk_wrap_key_label(domain: &str) -> String {
116-
format!("{domain}:bordercrypt:kdf:sk_wrap_key")
116+
format!("{domain}:secureStorage:kdf:sk_wrap_key")
117117
}
118118

119119
/// Label for root_aead_key derivation: `{root}:kdf:root_aead_key`
120120
#[must_use]
121121
pub fn root_aead_key_label(domain: &str) -> String {
122-
format!("{domain}:bordercrypt:kdf:root_aead_key")
122+
format!("{domain}:secureStorage:kdf:root_aead_key")
123123
}
124124

125125
#[cfg(test)]
@@ -128,15 +128,15 @@ mod tests {
128128

129129
#[test]
130130
fn test_root_format() {
131-
assert_eq!(root("app:ns"), "app:ns:bordercrypt");
131+
assert_eq!(root("app:ns"), "app:ns:secureStorage");
132132
}
133133

134134
#[test]
135135
fn test_session_scope_format() {
136136
let idx = SessionIndex::new(2).unwrap();
137137
assert_eq!(
138138
session_scope("app:ns", 1, idx),
139-
"app:ns:bordercrypt:session:v1:i2"
139+
"app:ns:secureStorage:session:v1:i2"
140140
);
141141
}
142142

@@ -145,14 +145,14 @@ mod tests {
145145
let idx = SessionIndex::new(0).unwrap();
146146
let mut buf = String::new();
147147
block_scope(&mut buf, "app:ns", 0, idx, 42);
148-
assert_eq!(buf, "app:ns:bordercrypt:session:v0:i0:b42");
148+
assert_eq!(buf, "app:ns:secureStorage:session:v0:i0:b42");
149149
}
150150

151151
#[test]
152152
fn test_password_kdf_salt() {
153153
assert_eq!(
154154
password_kdf_salt("app:ns"),
155-
"app:ns:bordercrypt:password_kdf"
155+
"app:ns:secureStorage:password_kdf"
156156
);
157157
}
158158

@@ -166,7 +166,7 @@ mod tests {
166166
let idx = SessionIndex::new(1).unwrap();
167167
assert_eq!(
168168
sk_wrap_aad("app:ns", 0, idx),
169-
"app:ns:bordercrypt:session:v0:i1:pq_sk_wrap"
169+
"app:ns:secureStorage:session:v0:i1:pq_sk_wrap"
170170
);
171171
}
172172

@@ -175,7 +175,7 @@ mod tests {
175175
let idx = SessionIndex::new(0).unwrap();
176176
let mut buf = String::new();
177177
block_kdf_salt(&mut buf, "app:ns", 0, idx, 5);
178-
assert_eq!(buf, "app:ns:bordercrypt:session:v0:i0:b5:kdf:salt");
178+
assert_eq!(buf, "app:ns:secureStorage:session:v0:i0:b5:kdf:salt");
179179
}
180180

181181
#[test]
@@ -185,7 +185,7 @@ mod tests {
185185
block_aead_key_label(&mut buf, "app:ns", 0, idx, 5);
186186
assert_eq!(
187187
buf,
188-
"app:ns:bordercrypt:session:v0:i0:b5:kdf:block_aead_key"
188+
"app:ns:secureStorage:session:v0:i0:b5:kdf:block_aead_key"
189189
);
190190
}
191191

@@ -194,22 +194,22 @@ mod tests {
194194
let idx = SessionIndex::new(0).unwrap();
195195
let mut buf = String::new();
196196
block_aead_aad(&mut buf, "app:ns", 0, idx, 5);
197-
assert_eq!(buf, "app:ns:bordercrypt:session:v0:i0:b5:block_aead");
197+
assert_eq!(buf, "app:ns:secureStorage:session:v0:i0:b5:block_aead");
198198
}
199199

200200
#[test]
201201
fn test_sk_wrap_key_label() {
202202
assert_eq!(
203203
sk_wrap_key_label("app:ns"),
204-
"app:ns:bordercrypt:kdf:sk_wrap_key"
204+
"app:ns:secureStorage:kdf:sk_wrap_key"
205205
);
206206
}
207207

208208
#[test]
209209
fn test_root_aead_key_label() {
210210
assert_eq!(
211211
root_aead_key_label("app:ns"),
212-
"app:ns:bordercrypt:kdf:root_aead_key"
212+
"app:ns:secureStorage:kdf:root_aead_key"
213213
);
214214
}
215215

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
/// Unified error type for all bordercrypt operations.
1+
/// Unified error type for all secureStorage operations.
22
///
33
/// Error messages are deliberately generic to avoid leaking information
44
/// to an adversary (e.g. no distinction between "bad nonce" and "bad tag").
55
#[derive(Debug, thiserror::Error)]
66
#[non_exhaustive]
7-
pub enum BordercryptError {
7+
pub enum SecureStorageError {
88
#[error("invalid password")]
99
InvalidPassword,
1010

@@ -31,4 +31,4 @@ pub enum BordercryptError {
3131
}
3232

3333
/// Convenience alias used throughout the crate.
34-
pub type Result<T> = core::result::Result<T, BordercryptError>;
34+
pub type Result<T> = core::result::Result<T, SecureStorageError>;
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Key derivation for bordercrypt.
1+
//! Key derivation for secureStorage.
22
33
use zeroize::Zeroizing;
44

@@ -135,6 +135,6 @@ mod tests {
135135
#[test]
136136
fn returns_block_scope() {
137137
let (_key, scope) = derive_block_aead_key("app", 0, idx(2), &ROOT_KEY, 5);
138-
assert_eq!(scope, "app:bordercrypt:session:v0:i2:b5");
138+
assert_eq!(scope, "app:secureStorage:session:v0:i2:b5");
139139
}
140140
}
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//! [version: u32 BE] [pq_pk: PK_SIZE bytes] [sk_nonce: 16 bytes] [sk_ct: remaining]
66
//! ```
77
8-
use crate::error::{BordercryptError, Result};
8+
use crate::error::{SecureStorageError, Result};
99
use crate::pq::PqPublicKey;
1010
use crate::storage::KeypairStorage;
1111
use crate::types::SessionIndex;
@@ -61,15 +61,15 @@ impl KeypairFile {
6161
/// Deserialize from binary format.
6262
pub fn deserialize(data: &[u8]) -> Result<Self> {
6363
if data.len() < MIN_SIZE {
64-
return Err(BordercryptError::CorruptedBlock);
64+
return Err(SecureStorageError::CorruptedBlock);
6565
}
6666

6767
let mut offset = 0;
6868

6969
let version = u32::from_be_bytes(
7070
data[offset..offset + 4]
7171
.try_into()
72-
.map_err(|_| BordercryptError::CorruptedBlock)?,
72+
.map_err(|_| SecureStorageError::CorruptedBlock)?,
7373
);
7474
offset += 4;
7575

@@ -80,7 +80,7 @@ impl KeypairFile {
8080
let sk_nonce: [u8; crypto_aead::NONCE_SIZE] = data
8181
[offset..offset + crypto_aead::NONCE_SIZE]
8282
.try_into()
83-
.map_err(|_| BordercryptError::CorruptedBlock)?;
83+
.map_err(|_| SecureStorageError::CorruptedBlock)?;
8484
offset += crypto_aead::NONCE_SIZE;
8585

8686
let sk_ct = data[offset..].to_vec();
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Bordercrypt v2 on-device encrypted storage.
1+
//! SecureStorage v2 on-device encrypted storage.
22
//!
33
//! Spec: <https://github.com/massalabs/gossip/discussions/380>
44
@@ -24,7 +24,7 @@ pub use domain::{
2424
block_aead_aad, block_aead_key_label, block_kdf_salt, block_scope, password_kdf_salt, root,
2525
root_aead_key_label, root_kdf_salt, session_scope, sk_wrap_aad, sk_wrap_key_label,
2626
};
27-
pub use error::{BordercryptError, Result};
27+
pub use error::{SecureStorageError, Result};
2828
pub use kdf::{SessionKeys, derive_block_aead_key, derive_session_keys};
2929
pub use keypair::{KeypairFile, read_session_keypair, read_session_version_and_pk};
3030
pub use lifecycle::{allocate_session, cover_traffic_tick, provision_storage};
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use crate::BLOCK_SIZE;
88
use crate::block::{create_cover_block, rerandomize_block};
99
use crate::constants::{LENGTH_HDR_SIZE, PLAINTEXT_SIZE, SESSION_COUNT};
1010
use crate::domain;
11-
use crate::error::{BordercryptError, Result};
11+
use crate::error::{SecureStorageError, Result};
1212
use crate::kdf::derive_session_keys;
1313
use crate::keypair::{KeypairFile, read_session_version_and_pk};
1414
use crate::pq::{PqPublicKey, PqSecretKey, pq_keygen};
@@ -142,7 +142,7 @@ pub fn cover_traffic_tick<S: BlockStorage + KeypairStorage>(
142142
let ct_arr: &[u8; BLOCK_SIZE] = new_ct
143143
.as_slice()
144144
.try_into()
145-
.map_err(|_| BordercryptError::CorruptedBlock)?;
145+
.map_err(|_| SecureStorageError::CorruptedBlock)?;
146146
storage.write_block(cur_session, block_index, ct_arr)?;
147147
storage.fsync(cur_session)?;
148148
}

0 commit comments

Comments
 (0)