mod pk_signing;
use std::sync::{
atomic::{AtomicBool, Ordering},
Arc,
};
pub use pk_signing::{MasterSigning, PickledSignings, SelfSigning, SigningError, UserSigning};
use ruma::{
api::client::keys::upload_signatures::v3::{Request as SignatureUploadRequest, SignedKeys},
events::secret::request::SecretName,
DeviceKeyAlgorithm, DeviceKeyId, OwnedDeviceId, OwnedDeviceKeyId, OwnedUserId, UserId,
};
use serde::{Deserialize, Serialize};
use tokio::sync::Mutex;
use vodozemac::Ed25519Signature;
use super::StaticAccountData;
use crate::{
error::SignatureError,
requests::UploadSigningKeysRequest,
store::SecretImportError,
types::{DeviceKeys, MasterPubkey, SelfSigningPubkey, UserSigningPubkey},
Account, DeviceData, OtherUserIdentityData, OwnUserIdentity, OwnUserIdentityData,
};
#[derive(Clone, Debug)]
pub struct PrivateCrossSigningIdentity {
user_id: OwnedUserId,
shared: Arc<AtomicBool>,
pub(crate) master_key: Arc<Mutex<Option<MasterSigning>>>,
pub(crate) user_signing_key: Arc<Mutex<Option<UserSigning>>>,
pub(crate) self_signing_key: Arc<Mutex<Option<SelfSigning>>>,
}
#[derive(Debug, Clone)]
pub struct DiffResult {
master_differs: bool,
self_signing_differs: bool,
user_signing_differs: bool,
}
impl DiffResult {
pub fn any_differ(&self) -> bool {
self.master_differs || self.self_signing_differs || self.user_signing_differs
}
pub fn none_differ(&self) -> bool {
!self.master_differs && !self.self_signing_differs && !self.user_signing_differs
}
}
#[derive(Serialize, Deserialize)]
#[allow(missing_debug_implementations)]
pub struct PickledCrossSigningIdentity {
pub user_id: OwnedUserId,
pub shared: bool,
pub keys: PickledSignings,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CrossSigningStatus {
pub has_master: bool,
pub has_self_signing: bool,
pub has_user_signing: bool,
}
impl CrossSigningStatus {
pub fn is_complete(&self) -> bool {
self.has_master && self.has_user_signing && self.has_self_signing
}
}
impl PrivateCrossSigningIdentity {
pub fn user_id(&self) -> &UserId {
&self.user_id
}
pub async fn is_empty(&self) -> bool {
let has_master = self.master_key.lock().await.is_some();
let has_user = self.user_signing_key.lock().await.is_some();
let has_self = self.self_signing_key.lock().await.is_some();
!(has_master && has_user && has_self)
}
pub async fn master_key_id(&self) -> Option<OwnedDeviceKeyId> {
let master_key = self.master_public_key().await?.get_first_key()?.to_base64();
let master_key = OwnedDeviceId::from(master_key);
Some(DeviceKeyId::from_parts(DeviceKeyAlgorithm::Ed25519, &master_key))
}
pub async fn can_sign_devices(&self) -> bool {
self.self_signing_key.lock().await.is_some()
}
pub async fn can_sign_users(&self) -> bool {
self.user_signing_key.lock().await.is_some()
}
pub async fn has_master_key(&self) -> bool {
self.master_key.lock().await.is_some()
}
pub async fn status(&self) -> CrossSigningStatus {
CrossSigningStatus {
has_master: self.has_master_key().await,
has_self_signing: self.can_sign_devices().await,
has_user_signing: self.can_sign_users().await,
}
}
pub async fn master_public_key(&self) -> Option<MasterPubkey> {
self.master_key.lock().await.as_ref().map(|m| m.public_key().to_owned())
}
pub async fn self_signing_public_key(&self) -> Option<SelfSigningPubkey> {
self.self_signing_key.lock().await.as_ref().map(|k| k.public_key().to_owned())
}
pub async fn user_signing_public_key(&self) -> Option<UserSigningPubkey> {
self.user_signing_key.lock().await.as_ref().map(|k| k.public_key().to_owned())
}
pub async fn export_secret(&self, secret_name: &SecretName) -> Option<String> {
match secret_name {
SecretName::CrossSigningMasterKey => {
self.master_key.lock().await.as_ref().map(|m| m.export_seed())
}
SecretName::CrossSigningUserSigningKey => {
self.user_signing_key.lock().await.as_ref().map(|m| m.export_seed())
}
SecretName::CrossSigningSelfSigningKey => {
self.self_signing_key.lock().await.as_ref().map(|m| m.export_seed())
}
_ => None,
}
}
pub(crate) async fn import_secret(
&self,
public_identity: OwnUserIdentity,
secret_name: &SecretName,
seed: &str,
) -> Result<(), SecretImportError> {
let (master, self_signing, user_signing) = match secret_name {
SecretName::CrossSigningMasterKey => (Some(seed), None, None),
SecretName::CrossSigningSelfSigningKey => (None, Some(seed), None),
SecretName::CrossSigningUserSigningKey => (None, None, Some(seed)),
_ => return Ok(()),
};
self.import_secrets(public_identity, master, self_signing, user_signing).await
}
pub(crate) async fn import_secrets(
&self,
public_identity: OwnUserIdentity,
master_key: Option<&str>,
self_signing_key: Option<&str>,
user_signing_key: Option<&str>,
) -> Result<(), SecretImportError> {
let master = if let Some(master_key) = master_key {
let master = MasterSigning::from_base64(self.user_id().to_owned(), master_key)?;
if public_identity.master_key() == master.public_key() {
Some(master)
} else {
return Err(SecretImportError::MismatchedPublicKeys);
}
} else {
None
};
let user_signing = if let Some(user_signing_key) = user_signing_key {
let subkey = UserSigning::from_base64(self.user_id().to_owned(), user_signing_key)?;
if public_identity.user_signing_key() == subkey.public_key() {
Ok(Some(subkey))
} else {
Err(SecretImportError::MismatchedPublicKeys)
}
} else {
Ok(None)
}?;
let self_signing = if let Some(self_signing_key) = self_signing_key {
let subkey = SelfSigning::from_base64(self.user_id().to_owned(), self_signing_key)?;
if public_identity.self_signing_key() == subkey.public_key() {
Ok(Some(subkey))
} else {
Err(SecretImportError::MismatchedPublicKeys)
}
} else {
Ok(None)
}?;
if let Some(master) = master {
*self.master_key.lock().await = Some(master);
}
if let Some(self_signing) = self_signing {
*self.self_signing_key.lock().await = Some(self_signing);
}
if let Some(user_signing) = user_signing {
*self.user_signing_key.lock().await = Some(user_signing);
}
Ok(())
}
pub async fn import_secrets_unchecked(
&self,
master_key: Option<&str>,
self_signing_key: Option<&str>,
user_signing_key: Option<&str>,
) -> Result<(), SecretImportError> {
if let Some(master_key) = master_key {
let master = MasterSigning::from_base64(self.user_id().to_owned(), master_key)?;
*self.master_key.lock().await = Some(master);
}
if let Some(user_signing_key) = user_signing_key {
let subkey = UserSigning::from_base64(self.user_id().to_owned(), user_signing_key)?;
*self.user_signing_key.lock().await = Some(subkey);
};
if let Some(self_signing_key) = self_signing_key {
let subkey = SelfSigning::from_base64(self.user_id().to_owned(), self_signing_key)?;
*self.self_signing_key.lock().await = Some(subkey);
}
Ok(())
}
pub(crate) async fn clear_if_differs(
&self,
public_identity: &OwnUserIdentityData,
) -> DiffResult {
let result = self.get_public_identity_diff(public_identity).await;
if result.master_differs {
*self.master_key.lock().await = None;
}
if result.user_signing_differs {
*self.user_signing_key.lock().await = None;
}
if result.self_signing_differs {
*self.self_signing_key.lock().await = None;
}
result
}
pub(crate) async fn get_public_identity_diff(
&self,
public_identity: &OwnUserIdentityData,
) -> DiffResult {
let master_differs = self
.master_public_key()
.await
.is_some_and(|master| &master != public_identity.master_key());
let user_signing_differs = self
.user_signing_public_key()
.await
.is_some_and(|subkey| &subkey != public_identity.user_signing_key());
let self_signing_differs = self
.self_signing_public_key()
.await
.is_some_and(|subkey| &subkey != public_identity.self_signing_key());
DiffResult { master_differs, user_signing_differs, self_signing_differs }
}
pub(crate) async fn get_missing_secrets(&self) -> Vec<SecretName> {
let mut missing = Vec::new();
if !self.has_master_key().await {
missing.push(SecretName::CrossSigningMasterKey);
}
if !self.can_sign_devices().await {
missing.push(SecretName::CrossSigningSelfSigningKey);
}
if !self.can_sign_users().await {
missing.push(SecretName::CrossSigningUserSigningKey);
}
missing
}
pub fn empty(user_id: &UserId) -> Self {
Self {
user_id: user_id.into(),
shared: Arc::new(AtomicBool::new(false)),
master_key: Arc::new(Mutex::new(None)),
self_signing_key: Arc::new(Mutex::new(None)),
user_signing_key: Arc::new(Mutex::new(None)),
}
}
async fn public_keys(
&self,
) -> Result<(MasterPubkey, SelfSigningPubkey, UserSigningPubkey), SignatureError> {
let master_private_key = self.master_key.lock().await;
let master_private_key =
master_private_key.as_ref().ok_or(SignatureError::MissingSigningKey)?;
let self_signing_private_key = self.self_signing_key.lock().await;
let self_signing_private_key =
self_signing_private_key.as_ref().ok_or(SignatureError::MissingSigningKey)?;
let user_signing_private_key = self.user_signing_key.lock().await;
let user_signing_private_key =
user_signing_private_key.as_ref().ok_or(SignatureError::MissingSigningKey)?;
let mut master = master_private_key.public_key().to_owned();
let mut self_signing = self_signing_private_key.public_key().to_owned();
let mut user_signing = user_signing_private_key.public_key().to_owned();
master_private_key.sign_subkey(master.as_mut());
master_private_key.sign_subkey(self_signing.as_mut());
master_private_key.sign_subkey(user_signing.as_mut());
Ok((master, self_signing, user_signing))
}
pub(crate) async fn to_public_identity(&self) -> Result<OwnUserIdentityData, SignatureError> {
let (master, self_signing, user_signing) = self.public_keys().await?;
let identity = OwnUserIdentityData::new(master, self_signing, user_signing)?;
identity.mark_as_verified();
Ok(identity)
}
pub(crate) async fn sign_user(
&self,
user_identity: &OtherUserIdentityData,
) -> Result<SignatureUploadRequest, SignatureError> {
let master_key = self
.user_signing_key
.lock()
.await
.as_ref()
.ok_or(SignatureError::MissingSigningKey)?
.sign_user(user_identity)?;
let mut user_signed_keys = SignedKeys::new();
user_signed_keys.add_cross_signing_keys(
user_identity
.master_key()
.get_first_key()
.ok_or(SignatureError::MissingSigningKey)?
.to_base64()
.into(),
master_key.to_raw(),
);
let signed_keys = [(user_identity.user_id().to_owned(), user_signed_keys)].into();
Ok(SignatureUploadRequest::new(signed_keys))
}
pub(crate) async fn sign_device(
&self,
device: &DeviceData,
) -> Result<SignatureUploadRequest, SignatureError> {
let mut device_keys = device.as_device_keys().to_owned();
device_keys.signatures.clear();
self.sign_device_keys(&mut device_keys).await
}
pub(crate) async fn sign_account(
&self,
account: &StaticAccountData,
) -> Result<SignatureUploadRequest, SignatureError> {
let mut device_keys = account.unsigned_device_keys();
self.sign_device_keys(&mut device_keys).await
}
pub(crate) async fn sign_device_keys(
&self,
device_keys: &mut DeviceKeys,
) -> Result<SignatureUploadRequest, SignatureError> {
self.self_signing_key
.lock()
.await
.as_ref()
.ok_or(SignatureError::MissingSigningKey)?
.sign_device(device_keys)?;
let mut user_signed_keys = SignedKeys::new();
user_signed_keys.add_device_keys(device_keys.device_id.clone(), device_keys.to_raw());
let signed_keys = [((*self.user_id).to_owned(), user_signed_keys)].into();
Ok(SignatureUploadRequest::new(signed_keys))
}
pub(crate) async fn sign(&self, message: &str) -> Result<Ed25519Signature, SignatureError> {
Ok(self
.master_key
.lock()
.await
.as_ref()
.ok_or(SignatureError::MissingSigningKey)?
.sign(message))
}
pub(crate) async fn with_account(
account: &Account,
) -> (Self, UploadSigningKeysRequest, SignatureUploadRequest) {
let mut master = MasterSigning::new(account.user_id().into());
account
.sign_cross_signing_key(master.public_key_mut().as_mut())
.expect("Can't sign our freshly created master key with our account");
let identity = Self::new_helper(account.user_id(), master);
let signature_request = identity
.sign_account(account.static_data())
.await
.expect("Can't sign own device with new cross signing keys");
let request = identity.as_upload_request().await;
(identity, request, signature_request)
}
fn new_helper(user_id: &UserId, master: MasterSigning) -> Self {
let (user, self_signing) = master.new_subkeys();
Self {
user_id: user_id.into(),
shared: Arc::new(AtomicBool::new(false)),
master_key: Arc::new(Mutex::new(Some(master))),
self_signing_key: Arc::new(Mutex::new(Some(self_signing))),
user_signing_key: Arc::new(Mutex::new(Some(user))),
}
}
#[cfg(any(test, feature = "testing"))]
#[allow(dead_code)]
pub fn new(user_id: OwnedUserId) -> Self {
let master = MasterSigning::new(user_id.to_owned());
Self::new_helper(&user_id, master)
}
#[cfg(any(test, feature = "testing"))]
#[allow(dead_code)]
pub fn reset(&mut self) {
let new = Self::new(self.user_id().to_owned());
*self = new
}
pub fn mark_as_shared(&self) {
self.shared.store(true, Ordering::SeqCst)
}
pub fn shared(&self) -> bool {
self.shared.load(Ordering::SeqCst)
}
pub async fn pickle(&self) -> PickledCrossSigningIdentity {
let master_key = self.master_key.lock().await.as_ref().map(|m| m.pickle());
let self_signing_key = self.self_signing_key.lock().await.as_ref().map(|m| m.pickle());
let user_signing_key = self.user_signing_key.lock().await.as_ref().map(|m| m.pickle());
let keys = PickledSignings { master_key, user_signing_key, self_signing_key };
PickledCrossSigningIdentity { user_id: self.user_id.clone(), shared: self.shared(), keys }
}
pub fn from_pickle(pickle: PickledCrossSigningIdentity) -> Result<Self, SigningError> {
let keys = pickle.keys;
let master = keys.master_key.map(MasterSigning::from_pickle).transpose()?;
let self_signing = keys.self_signing_key.map(SelfSigning::from_pickle).transpose()?;
let user_signing = keys.user_signing_key.map(UserSigning::from_pickle).transpose()?;
Ok(Self {
user_id: (*pickle.user_id).into(),
shared: Arc::new(AtomicBool::from(pickle.shared)),
master_key: Arc::new(Mutex::new(master)),
self_signing_key: Arc::new(Mutex::new(self_signing)),
user_signing_key: Arc::new(Mutex::new(user_signing)),
})
}
pub(crate) async fn as_upload_request(&self) -> UploadSigningKeysRequest {
let master_key =
self.master_key.lock().await.as_ref().map(|k| k.public_key().as_ref().clone());
let user_signing_key =
self.user_signing_key.lock().await.as_ref().map(|k| k.public_key().as_ref().clone());
let self_signing_key =
self.self_signing_key.lock().await.as_ref().map(|k| k.public_key().as_ref().clone());
UploadSigningKeysRequest { master_key, self_signing_key, user_signing_key }
}
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use matrix_sdk_test::async_test;
use ruma::{device_id, user_id, CanonicalJsonValue, DeviceKeyAlgorithm, DeviceKeyId, UserId};
use serde_json::json;
use super::{pk_signing::Signing, PrivateCrossSigningIdentity};
use crate::{
identities::{DeviceData, OtherUserIdentityData},
olm::{Account, SignedJsonObject, VerifyJson},
types::Signatures,
};
fn user_id() -> &'static UserId {
user_id!("@example:localhost")
}
#[test]
fn test_signature_verification() {
let signing = Signing::new();
let user_id = user_id();
let key_id = DeviceKeyId::from_parts(DeviceKeyAlgorithm::Ed25519, "DEVICEID".into());
let json = json!({
"hello": "world"
});
let canonicalized: CanonicalJsonValue = json.try_into().unwrap();
let canonicalized = canonicalized.to_string();
let signature = signing.sign(&canonicalized);
let mut signatures = Signatures::new();
signatures.add_signature(user_id.to_owned(), key_id.clone(), signature);
let public_key = signing.public_key();
public_key
.verify_canonicalized_json(user_id, &key_id, &signatures, &canonicalized)
.expect("The signature can be verified");
}
#[test]
fn test_pickling_signing() {
let signing = Signing::new();
let pickled = signing.pickle();
let unpickled = Signing::from_pickle(pickled).unwrap();
assert_eq!(signing.public_key(), unpickled.public_key());
}
#[async_test]
async fn test_private_identity_creation() {
let identity = PrivateCrossSigningIdentity::new(user_id().to_owned());
let master_key = identity.master_key.lock().await;
let master_key = master_key.as_ref().unwrap();
master_key
.public_key()
.verify_subkey(identity.self_signing_key.lock().await.as_ref().unwrap().public_key())
.unwrap();
master_key
.public_key()
.verify_subkey(identity.user_signing_key.lock().await.as_ref().unwrap().public_key())
.unwrap();
}
#[async_test]
async fn test_identity_pickling() {
let identity = PrivateCrossSigningIdentity::new(user_id().to_owned());
let pickled = identity.pickle().await;
let unpickled = PrivateCrossSigningIdentity::from_pickle(pickled).unwrap();
assert_eq!(identity.user_id, unpickled.user_id);
assert_eq!(&*identity.master_key.lock().await, &*unpickled.master_key.lock().await);
assert_eq!(
&*identity.user_signing_key.lock().await,
&*unpickled.user_signing_key.lock().await
);
assert_eq!(
&*identity.self_signing_key.lock().await,
&*unpickled.self_signing_key.lock().await
);
}
#[async_test]
async fn test_private_identity_signed_by_account() {
let account = Account::with_device_id(user_id(), device_id!("DEVICEID"));
let (identity, _, _) = PrivateCrossSigningIdentity::with_account(&account).await;
let master = identity.master_key.lock().await;
let master = master.as_ref().unwrap();
let public_key = master.public_key().as_ref();
let signatures = &public_key.signatures;
let canonical_json = public_key.to_canonical_json().unwrap();
account
.has_signed_raw(signatures, &canonical_json)
.expect("The account should have signed the master key");
master
.public_key()
.has_signed_raw(signatures, &canonical_json)
.expect("The master key should have self-signed");
assert!(!master.public_key().signatures().is_empty());
}
#[async_test]
async fn test_sign_device() {
let account = Account::with_device_id(user_id(), device_id!("DEVICEID"));
let (identity, _, _) = PrivateCrossSigningIdentity::with_account(&account).await;
let mut device = DeviceData::from_account(&account);
let self_signing = identity.self_signing_key.lock().await;
let self_signing = self_signing.as_ref().unwrap();
let mut device_keys = device.as_device_keys().to_owned();
self_signing.sign_device(&mut device_keys).unwrap();
device.update_device(&device_keys).unwrap();
let public_key = &self_signing.public_key();
public_key.verify_device(&device).unwrap()
}
#[async_test]
async fn test_sign_user_identity() {
let account = Account::with_device_id(user_id(), device_id!("DEVICEID"));
let (identity, _, _) = PrivateCrossSigningIdentity::with_account(&account).await;
let bob_account =
Account::with_device_id(user_id!("@bob:localhost"), device_id!("DEVICEID"));
let (bob_private, _, _) = PrivateCrossSigningIdentity::with_account(&bob_account).await;
let mut bob_public = OtherUserIdentityData::from_private(&bob_private).await;
let user_signing = identity.user_signing_key.lock().await;
let user_signing = user_signing.as_ref().unwrap();
let master = user_signing.sign_user(&bob_public).unwrap();
assert_eq!(
master.signatures.signature_count(),
1,
"We're only uploading our own signature"
);
bob_public.master_key = Arc::new(master.try_into().unwrap());
user_signing.public_key().verify_master_key(bob_public.master_key()).unwrap();
}
}