security-context-v1: Document out of band metadata for flatpak

and specify when the invalid_metadata error will be sent.

Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
This commit is contained in:
Sebastian Wick 2023-07-06 20:10:38 +02:00
parent 681c33c854
commit b19ee1a7e3
2 changed files with 10 additions and 1 deletions

View file

@ -1,7 +1,8 @@
# security-context-v1 engines # security-context-v1 engines
This document describes how some specific engine implementations populate the This document describes how some specific engine implementations populate the
metadata in security-context-v1. metadata in security-context-v1 and provide further metadata with out of band
mechanisms.
## [Flatpak] ## [Flatpak]
@ -11,4 +12,7 @@ metadata in security-context-v1.
* `instance_id` is the Flatpak instance ID of the running sandbox. It is always * `instance_id` is the Flatpak instance ID of the running sandbox. It is always
set. set.
More metadata is stored in `$XDG_RUNTIME_DIR/.flatpak/$instance_id/info`. This
file will be readable when `wp_security_context_v1.commit` is called.
[Flatpak]: https://flatpak.org/ [Flatpak]: https://flatpak.org/

View file

@ -163,6 +163,11 @@
Atomically register the new client and attach the security context Atomically register the new client and attach the security context
metadata. metadata.
If the provided metadata is inconsistent or does not match with out of
band metadata (see
https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/staging/security-context/engines.md),
the invalid_metadata error may be sent eventually.
It's a protocol error to send any request other than "destroy" after It's a protocol error to send any request other than "destroy" after
this request. In this case, the already_used error is sent. this request. In this case, the already_used error is sent.
</description> </description>