From 54ee246e450e27d95a92658b9dcaf64ae6df9c33 Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Tue, 23 Jul 2024 14:37:27 +0200 Subject: [PATCH] doc: mention file backend see https://gitlab.gnome.org/GNOME/libsecret/-/merge_requests/6 --- README.md | 15 +++++++-------- libsecret/secret-service.c | 7 +++++-- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8d4a1bb..3f57df8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ libsecret ========= -A [GObject]-based library for accessing the Secret Service API of the -[freedesktop.org project], a cross-desktop effort to access passwords, tokens -and other types of secrets. libsecret provides a convenient wrapper for these -methods so consumers do not have to call the low-level DBus methods. - -The actual Secret Service API spec can be found at -https://specifications.freedesktop.org/secret-service/. +A [GObject]-based library for storing and receiving secrets. libsecret provides +a convenient wrapper around two different mechanisms: If available, secrets are +stored in the freedesktop [secret service]. Otherwise, secrets are stored in a +file that is encrypted using a master secret that was provided by the [secret +portal]. Documentation -------- @@ -59,7 +57,8 @@ version number is even or odd. [GObject]: https://developer.gnome.org/gobject/stable/ -[freedesktop.org project]: https://www.freedesktop.org/ +[secret service]: https://specifications.freedesktop.org/secret-service/ +[secret portal]: https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Secret.html [GitLab repository]: https://gitlab.gnome.org/GNOME/libsecret [help pages on MR's]: https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html [issue tracker]: https://gitlab.gnome.org/GNOME/libsecret/issues diff --git a/libsecret/secret-service.c b/libsecret/secret-service.c index 6575d9c..68d4ad7 100644 --- a/libsecret/secret-service.c +++ b/libsecret/secret-service.c @@ -34,8 +34,11 @@ * * A proxy object representing the Secret Service. * - * A #SecretService object represents the Secret Service implementation which - * runs as a D-Bus service. + * A #SecretService object either represents an implementation of the + * [`org.freedesktop.Secret`](https://specifications.freedesktop.org/secret-service/latest/) + * D-Bus service or a file that is encrypted using a master secret that was + * provided by the + * [secret portal](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Secret.html). * * Normally a single #SecretService object can be shared between multiple * callers. The [func@Service.get] method is used to access this #SecretService