fixup! crypto: Expose a way to pin a user's identity

Improve comment about pin violation
matrix-org · Oct 7, 2024 · fddcbdf · fddcbdf
1 parent 562316c
commit fddcbdf
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/bindings/matrix-sdk-ffi/src/encryption.rs b/bindings/matrix-sdk-ffi/src/encryption.rs
@@ -446,8 +446,8 @@ impl UserIdentity {
     /// method explicitly accepts the new identity, allowing it to replace
     /// the previously pinned one and bringing it out of pin violation.
     ///
-    /// An identity which is not verified and is in pin violation will require
-    /// user approval before it can be used.
+    /// UIs should display a warning to the user when encountering an identity
+    /// which is not verified and is in pin violation.
     pub(crate) async fn pin(&self) -> Result<(), ClientError> {
         Ok(self.inner.pin().await?)
     }

diff --git a/crates/matrix-sdk-crypto/src/identities/user.rs b/crates/matrix-sdk-crypto/src/identities/user.rs
@@ -137,8 +137,8 @@ impl UserIdentity {
     /// method explicitly accepts the new identity, allowing it to replace
     /// the previously pinned one and bringing it out of pin violation.
     ///
-    /// An identity which is not verified and is in pin violation will require
-    /// user approval before it can be used. See
+    /// UIs should display a warning to the user when encountering an identity
+    /// which is not verified and is in pin violation. See
     /// [`OtherUserIdentity::identity_needs_user_approval`].
     pub async fn pin(&self) -> Result<(), CryptoStoreError> {
         match self {
@@ -775,8 +775,8 @@ impl OtherUserIdentityData {
     /// method explicitly accepts the new identity, allowing it to replace
     /// the previously pinned one and bringing it out of pin violation.
     ///
-    /// An identity which is not verified and is in pin violation will require
-    /// user approval before it can be used. See
+    /// UIs should display a warning to the user when encountering an identity
+    /// which is not verified and is in pin violation. See
     /// [`OtherUserIdentity::identity_needs_user_approval`].
     pub(crate) fn pin(&self) {
         let mut m = self.pinned_master_key.write().unwrap();

diff --git a/crates/matrix-sdk/src/encryption/identities/users.rs b/crates/matrix-sdk/src/encryption/identities/users.rs
@@ -434,8 +434,8 @@ impl UserIdentity {
     /// method explicitly accepts the new identity, allowing it to replace
     /// the previously pinned one and bringing it out of pin violation.
     ///
-    /// An identity which is not verified and is in pin violation will require
-    /// user approval before it can be used.
+    /// UIs should display a warning to the user when encountering an identity
+    /// which is not verified and is in pin violation.
     pub async fn pin(&self) -> Result<(), CryptoStoreError> {
         self.inner.pin().await
     }