FFI: Expose `UserIdentity::is_verified` and add a new `Encryption::user_identity` method. #4142

pixlwave · 2024-10-16T16:54:22Z

Nothing exciting here, just exposing another method.

stefanceriu · 2024-10-16T17:03:43Z

bindings/matrix-sdk-ffi/src/encryption.rs

+    /// Is the user identity considered to be verified.
+    ///
+    /// If the identity belongs to another user, our own user identity needs to
+    /// be verified as well for the identity to be considered to be verified.


I wonder if we should just copy paste the underlying documentation instead of rolling a new one 🤔

I did but removing the middle section as it seems overly technical from the perspective of an SDK user to me.

Ah, I see, I was looking at the one inside the crypto crate which seemed just perfect. I'm just worried something will change on one level or another and then the documentation will be out of date.

bnjbvr

Code looks good, I'm fine with either this code comment or one copied from the SDK. Thanks.

codecov · 2024-10-17T07:25:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.83%. Comparing base (08152bd) to head (195fed7).
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4142      +/-   ##
==========================================
- Coverage   84.84%   84.83%   -0.01%     
==========================================
  Files         269      269              
  Lines       28793    28788       -5     
==========================================
- Hits        24429    24423       -6     
- Misses       4364     4365       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

bmarty · 2024-10-17T07:27:36Z

bindings/matrix-sdk-ffi/src/encryption.rs

+    ///
+    /// If the identity belongs to another user, our own user identity needs to
+    /// be verified as well for the identity to be considered to be verified.
+    pub fn is_verified(&self) -> bool {


I am wondering if this data should be live? Maybe not for now but in the future the app could be more reactive if we had a way to get a live UserIdentity.

Yeah, I'd really like this to be a property on RoomMember that would update automatically through the room members stream if I'm honest, but I don't have a clue how to do that as the members live separately to the encryption 🫤

BillCarsonFr · 2024-10-17T07:40:41Z

I am not sure of the full context here but if you expose is_verified() you probably want also to expose was_previously_verified() / has_verification_violation().

pixlwave · 2024-10-17T07:46:30Z

I am not sure of the full context here but if you expose is_verified() you probably want also to expose was_previously_verified() / has_verification_violation().

This is being added to show the green badge on the user profile screen (element-hq/element-meta#2569).

I'm unsure now, are you saying that it is possible for is_verified and has_verification_violation to both be true at the same time and we need to think about these together, or just that the other 2 might be useful?

bmarty · 2024-10-17T09:43:47Z

(I confirm that the API works as expected on a EXA WIP branch)

BillCarsonFr · 2024-10-17T15:05:01Z

I am not sure of the full context here but if you expose is_verified() you probably want also to expose was_previously_verified() / has_verification_violation().

This is being added to show the green badge on the user profile screen (element-hq/element-meta#2569).

I'm unsure now, are you saying that it is possible for is_verified and has_verification_violation to both be true at the same time and we need to think about these together, or just that the other 2 might be useful?

No has_verification_violation means that the user used to be verified, but is not anymore. (so should have a red badge, whereas a user that was never verified and is not should have no badge)

pixlwave · 2024-10-18T10:14:37Z

For now this is everything we need.

pixlwave · 2024-10-18T10:15:29Z

@bnjbvr I exposed 1 more method to allow requesting identities for unknown users from the homeserver, otherwise I'm happy to have this merged if you're ok with it 🙂

bnjbvr

API question below. Looks good otherwise :)

bnjbvr · 2024-10-21T08:17:41Z

bindings/matrix-sdk-ffi/src/encryption.rs

+    /// To get the E2EE identity of a user even if it is not available locally
+    /// use `request_user_identity()`.


How does the API work overall: there's both get_user_identity() (which may return None) and request_user_identity() (which is guaranteed to return something for rooms where the two users are present). How is the caller supposed to know which one should be called? Call get_user_identity() first, and if it returns nothing, try request_user_identity()?

If so:

can we either document it clearly here?

or provide a unique method that first fetches from the local crypto store, then does the remote query if not found?

or provide a unique method that first fetches from the local crypto store, then does the remote query if not found?

This is what we're doing in the apps, I wasn't sure if it was crossing a boundary making the SDK use it like this too, but if you'd like this, I'd much prefer to expose a single user_identity method that does a get_ and falls back to request_ if needed.

Both work for me, but if you want to keep the current version, I'd like a comment precising this on get_user_identity() at least please :)

bnjbvr · 2024-10-21T10:46:24Z

bindings/matrix-sdk-ffi/src/encryption.rs

    ///
    /// # Arguments
    ///
    /// * `user_id` - The ID of the user that the identity belongs to.
    ///
+    /// * `request_if_needed` - If true, the identity will be requested from the


nit: doesn't match the parameter name 😛

Oops, refactor didn't get the docs.

bnjbvr · 2024-10-21T10:47:21Z

bindings/matrix-sdk-ffi/src/encryption.rs

+                    return Ok(None);
+                }
+            }
+            Err(e) => {


nit: please use err or error for this variable's name, one-letter named variables are bleh :P

ahaha, I always thought this one-letter naming was a Rust preference. 100% happy to stop doing this 🙌

bmarty · 2024-10-21T12:12:08Z

bindings/matrix-sdk-ffi/src/encryption.rs

        &self,
        user_id: String,
+        request_from_homeserver_if_needed: bool,


I am wondering in which case(s) an sdk user could set the parameter request_from_homeserver_if_needed to false.

bmarty · 2024-10-21T12:14:07Z

bindings/matrix-sdk-ffi/src/encryption.rs

+    ///
+    /// * `request_from_homeserver_if_needed` - If true, the identity will be
+    ///   requested from the homeserver if it is not found in the crypto store.
+    ///   When `true` the identity returned is guaranteed to be up-to-date.


When true the identity returned is guaranteed to be up-to-date.

I would claim that if when true there is always a request sent to the server, no? I mean in case identity is known locally, and has changed without the SDK knowing (no network, etc.), this assumption will not be true.

How would the app / the SDK know whether an identity was known locally but we should trigger the request because it was updated? In that case, we might as well spawn the request all the time, since we can't really know when it's been updated, right?

If the user came from the room members I believe we should already have their identity in the crypto store as I understand it. But happy to remove this parameter.

pixlwave requested a review from a team as a code owner October 16, 2024 16:54

pixlwave requested review from bnjbvr and removed request for a team October 16, 2024 16:54

stefanceriu reviewed Oct 16, 2024

View reviewed changes

bnjbvr approved these changes Oct 17, 2024

View reviewed changes

bmarty reviewed Oct 17, 2024

View reviewed changes

pixlwave added 2 commits October 18, 2024 11:12

chore(ffi): Expose is_verified UserIdentity method.

d5d1678

chore(ffi): Expose the request_user_identity Encryption method.

afc2594

pixlwave force-pushed the doug/is-verified branch from 3b5b20b to afc2594 Compare October 18, 2024 10:12

pixlwave changed the title ~~FFI: Expose is_verified UserIdentity method.~~ FFI: Expose is_verified UserIdentity method and request_user_identity Encryption method. Oct 18, 2024

This was referenced Oct 18, 2024

Show a verification badge on the Room Member/User Profile screens. element-hq/element-x-ios#3427

Merged

[Story] EX: Show in user's profile when they have been verified element-hq/element-meta#2569

Closed

bnjbvr reviewed Oct 21, 2024

View reviewed changes

bnjbvr approved these changes Oct 21, 2024

View reviewed changes

pixlwave force-pushed the doug/is-verified branch from 6e63406 to dce7297 Compare October 21, 2024 10:55

bmarty reviewed Oct 21, 2024

View reviewed changes

chore(ffi): Combine get/request_user_identity functions.

195fed7

pixlwave force-pushed the doug/is-verified branch from dce7297 to 195fed7 Compare October 21, 2024 13:22

bnjbvr changed the title ~~FFI: Expose is_verified UserIdentity method and request_user_identity Encryption method.~~ FFI: Expose UserIdentity::is_verified and add a new Encryption::user_identity method. Oct 21, 2024

bnjbvr enabled auto-merge (squash) October 21, 2024 13:26

bnjbvr merged commit befcd06 into main Oct 21, 2024
40 checks passed

bnjbvr deleted the doug/is-verified branch October 21, 2024 13:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FFI: Expose `UserIdentity::is_verified` and add a new `Encryption::user_identity` method. #4142

FFI: Expose `UserIdentity::is_verified` and add a new `Encryption::user_identity` method. #4142

pixlwave commented Oct 16, 2024

stefanceriu Oct 16, 2024

pixlwave Oct 16, 2024

stefanceriu Oct 17, 2024

bnjbvr left a comment

codecov bot commented Oct 17, 2024 •

edited

Loading

bmarty Oct 17, 2024

pixlwave Oct 17, 2024 •

edited

Loading

BillCarsonFr commented Oct 17, 2024

pixlwave commented Oct 17, 2024 •

edited

Loading

bmarty commented Oct 17, 2024

BillCarsonFr commented Oct 17, 2024

pixlwave commented Oct 18, 2024

pixlwave commented Oct 18, 2024

bnjbvr left a comment

bnjbvr Oct 21, 2024

pixlwave Oct 21, 2024

bnjbvr Oct 21, 2024

bnjbvr Oct 21, 2024

pixlwave Oct 21, 2024

bnjbvr Oct 21, 2024

pixlwave Oct 21, 2024

pixlwave Oct 21, 2024

bmarty Oct 21, 2024

bmarty Oct 21, 2024 •

edited

Loading

bnjbvr Oct 21, 2024

pixlwave Oct 21, 2024

pixlwave Oct 21, 2024

		/// To get the E2EE identity of a user even if it is not available locally
		/// use `request_user_identity()`.

FFI: Expose UserIdentity::is_verified and add a new Encryption::user_identity method. #4142

FFI: Expose UserIdentity::is_verified and add a new Encryption::user_identity method. #4142

Conversation

pixlwave commented Oct 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bnjbvr left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 17, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

pixlwave Oct 17, 2024 • edited Loading

Choose a reason for hiding this comment

BillCarsonFr commented Oct 17, 2024

pixlwave commented Oct 17, 2024 • edited Loading

bmarty commented Oct 17, 2024

BillCarsonFr commented Oct 17, 2024

pixlwave commented Oct 18, 2024

pixlwave commented Oct 18, 2024

bnjbvr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bmarty Oct 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FFI: Expose `UserIdentity::is_verified` and add a new `Encryption::user_identity` method. #4142

FFI: Expose `UserIdentity::is_verified` and add a new `Encryption::user_identity` method. #4142

codecov bot commented Oct 17, 2024 •

edited

Loading

pixlwave Oct 17, 2024 •

edited

Loading

pixlwave commented Oct 17, 2024 •

edited

Loading

bmarty Oct 21, 2024 •

edited

Loading