Commit Graph

68 Commits

Author SHA1 Message Date
Daniel Kahn Gillmor
f7e2b7884a Python examples: use gi.require_version("Secret", "1")
This is the standard mechanism to initialize a GObject introspectable
interface.  If you don't do this, you get this PyGIWarning:

  Secret was imported without specifying a version first. Use
  gi.require_version('Secret', '1') before import to ensure that the
  right version gets loaded.
2024-06-19 18:58:48 -04:00
Daniel Kahn Gillmor
7f01cc6786 Python: Correct Importing example
Without this fix, we get a TypeError:

TypeError: Must be mapping, not set
2024-06-19 09:36:38 -04:00
Jonathan Wakely
abad8802ae Fix example in usage docs 2023-02-03 15:59:53 +00:00
Maximiliano Sandoval R
b4b701cc8f
docs: Fix source link
Needs a trailing backslash to work.
2022-02-07 13:02:11 +01:00
Maximiliano Sandoval R
868a88ffe8
secret-schema: Add missind docs 2022-02-07 13:02:09 +01:00
Maximiliano
2c3a34cca4 Port documentation to gi-docgen 2022-02-02 12:19:14 +00:00
Dhanuka Warusadura
431bd637bc Add TPM2 file backend support build/test documentation
These changes add TPM2 file backend support build and test
instructions to default documentation.
2021-09-03 19:39:50 +05:30
Evangelos Ribeiro Tzaras
436200b0cb docs: Fix typos 2021-07-09 17:08:29 +02:00
Niels De Graef
2147b96c9d Drop autotools-based build
Our official instructions only tell how to build with Meson, our CI is
only done with Meson and I wouldn't be surprised if most developers only
used Meson as well.

In other words, the autotools build is outdated. Let's say our goodbye
and drop it in the next stable release.
2020-11-15 20:37:48 +01:00
Niels De Graef
f256f5ada6 docs: Make sure to set install: true 2020-03-10 14:17:59 +00:00
Daiki Ueno
a0d10597ee secret-backend: New interface to represent password storage backend
This interface provides a separation between the
frontend (secret_password*) and the backend (SecretService).  That
makes it easier to replace SecretService with a custom backend
implementation.
2019-10-08 07:55:55 +00:00
Daiki Ueno
c06c9d2e26 build: Simplify file substitution
Since meson 0.50, configuration_data() can take a dictionary.
2019-07-25 19:59:05 +02:00
Daiki Ueno
a5db34dcd5 secret-value: Add secret_value_unref_to_password
This adds the secret_value_unref_to_password function that
unreferences and returns the stored secret in non-pageable memory.
This is supposed to be used with secret_password_lookup_binary*
functions.
2019-07-18 13:54:12 +00:00
Daiki Ueno
29c1460fd7 secret-password: Add store_binary functions
This adds a set of functions that takes a SecretValue instead of a
text password when storing a secret.  This is useful if the stored
password is not null-terminated.
2019-07-18 13:54:12 +00:00
Daiki Ueno
bac85c00fc secret-password: Add lookup_binary functions
This adds a set of functions that return a SecretValue instead of a
text password when looking up a secret.  This is useful if the stored
password is not null-terminated.
2019-07-18 13:54:12 +00:00
Daiki Ueno
5fedca8ffc secret-password: Add search functions
This adds a set of functions that expose secret_service_search* from
the simple API.
2019-07-18 13:54:12 +00:00
Daiki Ueno
938640ae52 secret-retrievable: New interface to represent read-only item
This is a ground work for adding a local storage backend.  As
SecretItem is derived from GDBusProxy, it cannot be simply exposed to
the application through the secret_password_search() if the item is
not backed by the DBus API.  This adds an abstract interface
representing a read-only view of a secret item for that purpose.
2019-07-18 13:54:12 +00:00
Sutou Kouhei
c00283ebd0 Add version macros
Added macros:

  * SECRET_VERSION_MAJOR
  * SECRET_VERSION_MINOR
  * SECRET_VERSION_MICRO
  * SECRET_CHECK_VERSION

These macros are widely defined in GLib based library. For example,
GLib, GTK, poppler GLib and so on define them.

These macros are useful to detect libsecret version on build type and
from GObject Introspection based bindings.
2019-06-09 16:38:39 +02:00
Niels De Graef
b19c309096 Add build support for Meson
To build with meson, use the following commands:

```
$ meson build
$ ninja -C build
 # in case you want to install
$ ninja -C build install
```
2019-01-19 21:03:56 +00:00
Philip Withnall
b738c9f787 lib/schemas: Add secret_get_schema() accessor for SECRET_SCHEMA_*s
The SECRET_SCHEMA_* extern structs are not introspectable; add a new
accessor function which takes an enum and returns a struct, which is
introspectable.

Mark the old extern structs as (skip), but don’t deprecate them because
they’re still useful from C (if unconventional).

Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://bugzilla.gnome.org/show_bug.cgi?id=697681
2018-03-22 17:46:22 +00:00
Antonio Murdaca
43cac02864 Fix typos
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
Signed-off-by: Stef Walter <stefw@redhat.com>
 * Fix one spelling of 'succeeded'

https://bugzilla.gnome.org/show_bug.cgi?id=763143
2016-03-08 13:32:07 +01:00
Stef Walter
4c08fe2933 docs: Don't overcomplicate things with the major version in docs
Just hard code '1' instead of using variable substitution.

https://bugzilla.gnome.org/show_bug.cgi?id=751400
2015-06-29 14:41:49 +02:00
Frédéric Péters
d2a87b5148 Update doc online location to unstable url
developer.gnome.org doesn't create /stable/ links for libraries that have not
reached 1.0 yet.
2015-04-15 11:49:59 +02:00
Roy Zhang
70d1bc3307 Fix typo in documentation
Since "equivalent" is not a function, it should not follow with
parenthese.

https://bugzilla.gnome.org/show_bug.cgi?id=747654
2015-04-11 07:29:05 +02:00
Stef Walter
6b7d643929 libsecret: Add secret_service_encode_dbus_secret() and opposite
Add secret_service_encode_dbus_secret() and
secret_service_decode_dbus_secret() functions for encoding
and decoding the Secret Service API DBus structs that carry
secrets on the wire.

These are not added to the stable or scripting APIs.
2014-03-04 14:15:27 +01:00
Stef Walter
b72048c920 Makefile.am: Use a single Makefile.am and parallel tests
Allow parallel building and testing by using a single Makefile.am

Implement parallel testing using TAP, with various drivers and
compilers living in the build/ directory.

Fix all sorts of issues that this caused, including builddir != srcdir,
leaks in tests and so on.

It would have been nice to break out all the above into separate
commits ... blush.
2014-03-04 12:57:19 +01:00
Stef Walter
179ba93a83 Update doc online location to stable url. 2014-01-13 09:27:20 +01:00
Stef Walter
66e8949b7b Remove unstable vapi
Just use the main vapi, and expect people to define the relevant
SECRET_WITH_UNSTABLE preprocessor macro.

https://bugzilla.gnome.org/show_bug.cgi?id=721429
2014-01-04 11:17:18 +01:00
Stef Walter
dd6fcf87bb Mark most of unstable API as stable
This is with the exception of the 'path' functions.
2013-12-11 10:57:22 +01:00
Stef Walter
482dc34d74 Fix documentation warnings 2013-12-11 08:26:58 +01:00
Stef Walter
1758194f26 service: Rename secret_service_new() and friends to open()
The _new() suffix confuses vala and gobject introspection thinking
that it's a constructor, and there's no way to tell it otherwise. And
things really get messy because they're async functions.

So while we're still unstable, rename these functions to
secret_service_open() secret_service_open_sync() and
secret_service_open_finish().

This is an API/API break, but its to the portion of the library
marked as unstable. Only used by seahorse (in jhbuild) and updated
usage there.
2013-06-21 15:11:14 +02:00
Stef Walter
cec740fea9 Add secret_value_get_text() function to return NULL terminated secret 2013-06-21 15:11:14 +02:00
Stef Walter
24cc1e118f Fix for glib deprecations
* g_type_init() was deprecated in glib 2.35.0
2012-10-22 20:50:48 +02:00
Stef Walter
49cdaf5df8 Release version 0.6 2012-07-14 09:07:20 +02:00
Stef Walter
e0ba10ee09 Rename secret_password_remove() to secret_password_clear()
* It's clearer what happens here: we try to remove as many matching
   passwords as possible.
 * Also rename secret_service_remove() to secret_service_clear()
 * Rename secret_password_clear() which used to wipe password memory
   to secret_password_wipe().
2012-07-14 08:20:32 +02:00
Stef Walter
83c8674a03 Update documentation for to have correct headers
* Add add more warnings to unstable API documentation
2012-07-13 13:04:26 +02:00
Stef Walter
7816417167 Release version 0.5 2012-07-13 12:48:41 +02:00
Stef Walter
db95ff86b3 Add missing documentation for secret_item_get_schema_name() 2012-07-13 12:26:23 +02:00
Stef Walter
a1c3e9bb09 Document how to build with or use libsecret 2012-07-13 12:01:06 +02:00
Stef Walter
5cc30b2b68 Rename the library subdirectory to libsecret
* Death by a thousand paper cuts from gir and vapi not liking
   the fact that the secret.h file was not usable uninstalled
   and installed in the same way.
2012-07-13 10:40:25 +02:00
Stef Walter
80df2e6484 Add flags for secret_item_create and secret_collection_create
* For future extensibility
2012-07-12 13:59:35 +02:00
Stef Walter
c22bc528df Rename secret_service_read_alias() to secret_collection_for_alias()
* Much more logical, especially in the future when arbitrary aliases
   are implemented in gnome-keyring-daemon
2012-07-12 12:38:50 +02:00
Stef Walter
35022289da Add documentation for how to migrate from libgnome-keyring 2012-07-12 11:40:50 +02:00
Stef Walter
9c2eca05ff Implement per collection search
* Use the SearchItems dbus method on the Collection interface
 * Tweak some issues with the service search code as well
2012-07-09 11:23:36 +02:00
Stef Walter
c1f860d45f Fix up documentation 2012-07-06 10:21:04 +02:00
Stef Walter
175ae08984 Disconnect the cached default SecretService if service goes away
* Because the session would no longer be valid if the service
   was autostarted for the same SecretService proxy
2012-07-06 10:08:27 +02:00
Stef Walter
7098b856b7 Rename the functions that operate on a dbus item path
* They all contain '_dbus_path' in their name
 * Move secret_service_get_session_path() to the paths functionality
 * Move the secret_collection_new() and secret_item_new() functionality
   to the path based section.
2012-07-06 09:27:05 +02:00
Stef Walter
153dfcec5f Add secret_collection_load_items()
* And flags to prevent loading of items when creating a
   SecretCollection object
 * Rename secret_service_ensure_collections() to
   secret_service_load_collections()
2012-07-05 23:33:07 +02:00
Stef Walter
889f6d66b7 Make secret_service_search() able to unlock, load secrets
* Turn secret_service_search() and friends into a more convenient
   API, so that callers can get attributes, unlocking, and secrets
   if so desired.
 * Also support retrieving either one secret, or all of them.
2012-07-05 23:33:07 +02:00
Stef Walter
012ed7d620 Move secret_service_get_secrets() to secret_item_load_secrets()
* And cache the secrets on the items instead of returning
   them in a GHashtable
2012-07-05 23:33:07 +02:00