gateway: swap order of parent_window and options

Author: iinuwa

credentialsd-common/src/model.rs

@@ -1,6 +1,6 @@
 use std::{fmt::Display, path::PathBuf};
 
-use serde::{Deserialize, Serialize, de::Visitor};
+use serde::{Deserialize, Serialize};
 use zvariant::{SerializeDict, Type};
 
 pub use libwebauthn::ops::webauthn::{

credentialsd/src/dbus/gateway.rs

@@ -217,8 +217,8 @@ impl<C: CredentialRequestController + Send + Sync + 'static> CredentialGateway<C
         &self,
         #[zbus(header)] header: Header<'_>,
         #[zbus(connection)] connection: &Connection,
+        parent_window: Optional<WindowHandle>,
         request: CreateCredentialRequest,
-        window_handle: Optional<WindowHandle>,
     ) -> Result<CreateCredentialResponse, Error> {
         let (_origin, is_same_origin, _top_origin) =
             check_origin(request.origin.as_deref(), request.is_same_origin)
@@ -253,7 +253,7 @@ impl<C: CredentialRequestController + Send + Sync + 'static> CredentialGateway<C
                 .controller
                 .lock()
                 .await
-                .request_credential(requesting_app, cred_request, window_handle.into())
+                .request_credential(requesting_app, cred_request, parent_window.into())
                 .await?;
 
             if let CredentialResponse::CreatePublicKeyCredentialResponse(cred_response) = response {
@@ -284,8 +284,8 @@ impl<C: CredentialRequestController + Send + Sync + 'static> CredentialGateway<C
         &self,
         #[zbus(header)] header: Header<'_>,
         #[zbus(connection)] connection: &Connection,
+        parent_window: Optional<WindowHandle>,
         request: GetCredentialRequest,
-        window_handle: Optional<WindowHandle>,
     ) -> Result<GetCredentialResponse, Error> {
         let (_origin, is_same_origin, _top_origin) =
             check_origin(request.origin.as_deref(), request.is_same_origin)
@@ -318,7 +318,7 @@ impl<C: CredentialRequestController + Send + Sync + 'static> CredentialGateway<C
                 .controller
                 .lock()
                 .await
-                .request_credential(requesting_app, cred_request, window_handle.into())
+                .request_credential(requesting_app, cred_request, parent_window.into())
                 .await?;
 
             if let CredentialResponse::GetPublicKeyCredentialResponse(cred_response) = response {

demo_client/gui.py

@@ -319,7 +319,7 @@ def create_passkey(
         "publicKey": Variant("a{sv}", {"request_json": Variant("s", req_json)}),
     }
 
-    rsp = interface.call_create_credential_sync([req, window_handle])
+    rsp = interface.call_create_credential_sync([window_handle, req])
 
     # print("Received response")
     # pprint(rsp)
@@ -358,7 +358,7 @@ def get_passkey(interface, window_handle, origin, top_origin, rp_id, cred_ids, c
         "publicKey": Variant("a{sv}", {"request_json": Variant("s", req_json)}),
     }
 
-    rsp = interface.call_get_credential_sync([req, window_handle])
+    rsp = interface.call_get_credential_sync([window_handle, req])
     # print("Received response")
     # pprint(rsp)
     if rsp["type"].value != "public-key":

demo_client/main.py

@@ -114,7 +114,7 @@ async def create_password(interface):
             },
         ),
     }
-    rsp = await interface.call_create_credential([password_req, ""])
+    rsp = await interface.call_create_credential(["", password_req])
     return rsp
 
 
@@ -131,7 +131,7 @@ async def get_password(interface):
             ],
         ),
     }
-    rsp = await interface.call_get_credential(password_req)
+    rsp = await interface.call_get_credential(["", password_req])
     if rsp["type"].value == "password":
         cred = rsp["password"].value
         id = cred["id"].value
@@ -174,7 +174,7 @@ async def create_passkey(interface, origin, top_origin, rp_id, user_handle, user
         "publicKey": Variant("a{sv}", {"request_json": Variant("s", req_json)}),
     }
 
-    rsp = await interface.call_create_credential(req)
+    rsp = await interface.call_create_credential(["", req])
 
     print("Received response")
     pprint(rsp)
@@ -215,7 +215,7 @@ async def get_passkey(
         "publicKey": Variant("a{sv}", {"request_json": Variant("s", req_json)}),
     }
 
-    rsp = await interface.call_get_credential([req, ""])
+    rsp = await interface.call_get_credential(["", req])
     print("Received response")
     pprint(rsp)
     if rsp["type"].value != "public-key":

doc/api.md

@@ -153,6 +153,21 @@ it would pass this request to this API:
 }
 ```
 
+## Window Identifiers
+
+For window identifiers, we follow the same format as the
+[XDG Desktop Portal conventions for window identifiers][xdg-window-identifiers].
+
+Where a `parent_window` is specified, the value should be a string in the format:
+
+`<window_system>:<handle>`
+
+The supported window systems are `wayland` and `x11`.
+
+If the client does not have a window or cannot access it, pass an empty string.
+
+[xdg-window-identifiers]: https://flatpak.github.io/xdg-desktop-portal/docs/window-identifiers.html
+
 # Gateway API
 
 The Gateway is the entrypoint for public clients to retrieve and store
@@ -174,14 +189,19 @@ for what kind of credential the client would like to create.
 ### Request
 
 ```
-CreateCredentialRequest[a{sv}] {
-    origin: string
-    is_same_origin: string
-    type: CredentialType
-    <extra_fields>
-}
+CreateCredentialRequest(
+    IN parent_window s,
+    IN options a{sv} {
+        origin: string
+        is_same_origin: string
+        type: CredentialType
+        <extra_fields>
+    }
+)
 ```
 
+For information on `parent_window`, see [Window Identifiers](#window-identifiers).
+
 > TODO: We should make this a tagged enum
 
 ```
@@ -287,13 +307,18 @@ credentials the client will accept.
 ### Request
 
 ```
-GetCredentialRequest[a{sv}] {
-    origin: string
-    is_same_origin: string
-    publicKey: GetPublicKeyCredentialOptions?
-}
+GetCredentialRequest (
+    IN parent_window s
+    IN options a{sv} {
+        origin: string
+        is_same_origin: string
+        publicKey: GetPublicKeyCredentialOptions?
+    }
+)
 ```
 
+For information on `parent_window`, see [Window Identifiers](#window-identifiers).
+
 Note that while only one credential type can be specified in
 `CreateCredential()`, credential types in this `GetCredential()` are not mutually
 exclusive: as new credential types are added to the specification, a client may

doc/xyz.iinuwa.credentialsd.Credentials.xml

@@ -9,11 +9,11 @@
   </interface>
   <interface name="xyz.iinuwa.credentialsd.Credentials1">
     <method name="CreateCredential">
-      <arg name="request" type="(a{sv}s)" direction="in"/>
+      <arg name="request" type="(sa{sv})" direction="in"/>
       <arg type="a{sv}" direction="out"/>
     </method>
     <method name="GetCredential">
-      <arg name="request" type="(a{sv}s)" direction="in"/>
+      <arg name="request" type="(sa{sv})" direction="in"/>
       <arg type="a{sv}" direction="out"/>
     </method>
     <method name="GetClientCapabilities">