2019-05-21 19:54:53 +00:00
|
|
|
libsecret
|
|
|
|
|
=========
|
|
|
|
|
|
2024-07-23 12:37:27 +00:00
|
|
|
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].
|
2019-05-21 19:54:53 +00:00
|
|
|
|
2022-02-02 12:19:14 +00:00
|
|
|
Documentation
|
|
|
|
|
--------
|
|
|
|
|
|
2022-02-06 19:43:03 +00:00
|
|
|
You can find the nightly documentation at https://gnome.pages.gitlab.gnome.org/libsecret/.
|
2022-02-02 12:19:14 +00:00
|
|
|
|
2019-05-21 19:54:53 +00:00
|
|
|
Building
|
|
|
|
|
--------
|
|
|
|
|
|
2023-07-09 18:23:02 +00:00
|
|
|
To build, test and install libsecret, you can use the following commands:
|
2019-05-21 19:54:53 +00:00
|
|
|
|
|
|
|
|
```
|
2023-07-09 18:23:02 +00:00
|
|
|
$ meson setup _build
|
|
|
|
|
$ meson compile -C _build
|
|
|
|
|
$ meson test -C _build
|
|
|
|
|
$ meson install -C _build
|
2019-05-21 19:54:53 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
You can browse the code, issues and more at libsecret's [GitLab repository].
|
|
|
|
|
|
|
|
|
|
If you find a bug in libsecret, please file an issue on the [issue tracker].
|
|
|
|
|
Please try to add reproducible steps and the relevant version of libsecret.
|
|
|
|
|
|
|
|
|
|
If you want to contribute functionality or bug fixes, please open a Merge
|
|
|
|
|
Request (MR). For more info on how to do this, see GitLab's [help pages on
|
|
|
|
|
MR's].
|
|
|
|
|
|
|
|
|
|
If libsecret is not translated in your language or you believe that the
|
|
|
|
|
current translation has errors, you can join one of the various translation
|
|
|
|
|
teams in GNOME. Translators do not commit directly to Git, but are advised to
|
|
|
|
|
use our separate translation infrastructure instead. More info can be found at
|
|
|
|
|
the [translation project wiki page].
|
|
|
|
|
|
2019-09-26 14:52:13 +00:00
|
|
|
Releases
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
The release tarballs use [semantic versioning] since 0.19.0, which
|
|
|
|
|
basically means:
|
|
|
|
|
|
|
|
|
|
- The major version will be incremented if backward incompatible changes are added
|
|
|
|
|
- The minor version will be incremented if new functionality is added in a backward compatible manner
|
|
|
|
|
- The patch version will be incremented if only backward compatible bug fixes are added
|
|
|
|
|
|
|
|
|
|
Note that there is no stable/unstable indication in whether the minor
|
|
|
|
|
version number is even or odd.
|
2019-05-21 19:54:53 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
[GObject]: https://developer.gnome.org/gobject/stable/
|
2024-09-25 22:26:48 +00:00
|
|
|
[secret service]: https://specifications.freedesktop.org/secret-service-spec/
|
2024-07-23 12:37:27 +00:00
|
|
|
[secret portal]: https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Secret.html
|
2019-05-21 19:54:53 +00:00
|
|
|
[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
|
|
|
|
|
[translation project wiki page]: https://wiki.gnome.org/TranslationProject/
|
2019-09-26 14:52:13 +00:00
|
|
|
[semantic versioning]: https://semver.org
|
