securedrop_protocol_minimal/
traits.rs

1use crate::VerifyingKey;
2use crate::message::{MessagePrivateKey, MessagePublicKey};
3use crate::metadata::MetadataPublicKey;
4use crate::primitives::x25519::DHPrivateKey;
5use crate::primitives::x25519::DHPublicKey;
6use crate::sign::{JournalistEphemeralKey, JournalistLongTermKey, Signature};
7use alloc::vec::Vec;
8
9use crate::ciphertext::Plaintext;
10use crate::keys::{
11    Enrollment, KeyBundlePublic, MessageKeyBundle, SignedKeyBundlePublic, SignedLongtermPubKeyBytes,
12};
13
14// Sealed traits that downstream crates should not implement.
15// Do not re-export!
16use crate::sealed;
17
18////////////////////////
19///
20/// Users have the following (public traits) in common:
21/// They expose a fetch pubkey, a message auth pubkey
22/// (implicit authentication),
23/// and a collection of KeyBundles (tuples of keys - a keybundle contains
24/// all the key material required to send a message to a given user).
25/// A Source has a KeyBundle collection of size 1.
26/// A Journalist has KeyBundle collection of size > 1.
27/// Some users (Sources) use a key from their message bundle as
28/// their message auth key.
29pub trait UserPublic {
30    fn fetch_pk(&self) -> &DHPublicKey;
31    /// The long-term SD-APKE public key `pk^APKE`.
32    fn message_auth_pk(&self) -> &MessagePublicKey;
33    fn message_metadata_pk(&self) -> &MetadataPublicKey;
34    /// The ephemeral SD-APKE public key `pk^{APKE_E}` from a key bundle.
35    fn message_enc_pk(&self) -> &MessagePublicKey;
36}
37
38pub trait JournalistPublic: UserPublic {
39    fn verifying_key(&self) -> &VerifyingKey;
40    fn self_signature(&self) -> &Signature<JournalistLongTermKey>;
41    fn signed_keybytes(&self) -> &SignedLongtermPubKeyBytes;
42    fn ephemeral_bundle(&self) -> &KeyBundlePublic;
43    fn ephemeral_signature(&self) -> &Signature<JournalistEphemeralKey>;
44}
45
46#[cfg(not(hax))]
47pub trait Enrollable: sealed::Sealed {
48    // sealed traits don't play nice with hax right now, so this is a workaround
49    fn signing_key(&self) -> &VerifyingKey;
50    fn enroll(&self) -> Enrollment;
51    /// Each item is a [`SignedKeyBundlePublic`]: the public keys together with the
52    /// journalist's self-signature over them.
53    fn signed_keybundles(&self) -> Vec<SignedKeyBundlePublic>;
54}
55
56#[cfg(hax)]
57pub trait Enrollable {
58    fn signing_key(&self) -> &VerifyingKey;
59    fn enroll(&self) -> Enrollment;
60    /// Each item is a [`SignedKeyBundlePublic`]: the public keys together with the
61    /// journalist's self-signature over them.
62    fn signed_keybundles(&self) -> Vec<SignedKeyBundlePublic>;
63}
64
65/// Users have the following (secret traits) in common:
66/// They have a fetching keypair used to retrieve messages;
67/// They have a message authentication keypair used to implicitly
68/// authenticate their messages (via DH-AKEM);
69/// They can index a KeyBundle (tuple) and use it to attempt to
70/// decrypt a message.
71#[cfg(not(hax))]
72pub trait UserSecret: sealed::Sealed {
73    fn num_bundles(&self) -> usize;
74    fn fetch_keypair(&self) -> (&DHPrivateKey, &DHPublicKey);
75    /// The long-term SD-APKE private key `sk^APKE`.
76    fn message_auth_key(&self) -> &MessagePrivateKey;
77    /// The holder's own long-term SD-APKE public key `pk^APKE`.
78    fn own_message_auth_pk(&self) -> &MessagePublicKey;
79    fn build_message(&self, message: Vec<u8>) -> Plaintext;
80    fn keybundles(&self) -> Vec<&MessageKeyBundle>;
81}
82
83#[cfg(hax)]
84pub trait UserSecret {
85    fn num_bundles(&self) -> usize;
86    fn fetch_keypair(&self) -> (&DHPrivateKey, &DHPublicKey);
87    /// The long-term SD-APKE private key `sk^APKE`.
88    fn message_auth_key(&self) -> &MessagePrivateKey;
89    /// The holder's own long-term SD-APKE public key `pk^APKE`.
90    fn own_message_auth_pk(&self) -> &MessagePublicKey;
91    fn build_message(&self, message: Vec<u8>) -> Plaintext;
92    fn keybundles(&self) -> Vec<&MessageKeyBundle>;
93}
94
95// hax doesn't work well with sealed trait pattern right now
96#[cfg(not(hax))]
97pub trait RestrictedApi: sealed::Sealed {}
98
99#[cfg(hax)]
100pub trait RestrictedApi {}
securedrop_protocol_minimal/traits.rs

securedrop_protocol_minimal/
traits.rs
