diff options
author | Ingo Klöcker <[email protected]> | 2022-01-31 14:59:55 +0000 |
---|---|---|
committer | Ingo Klöcker <[email protected]> | 2022-02-03 14:56:30 +0000 |
commit | 3c2cff74b535422532e1256ee8177fa9c03eaf18 (patch) | |
tree | e4d10ecb036e2ce0d15ba845e77be08b2b954970 /doc | |
parent | doc: Fixed type of an object member (diff) | |
download | gpgme-3c2cff74b535422532e1256ee8177fa9c03eaf18.tar.gz gpgme-3c2cff74b535422532e1256ee8177fa9c03eaf18.zip |
core: New function gpgme_op_receive_keys
* src/gpgme.h.in (gpgme_op_receive_keys_start, gpgme_op_receive_keys):
New.
* src/gpgme.def, src/libgpgme.vers: Add them.
* src/engine-backend.h (struct engine_ops): Add arg keyids to field
'import'.
* src/engine.h, src/engine.c (_gpgme_engine_op_import): Add arg keyids.
* src/engine.c (_gpgme_engine_op_import): Forward new arg keyids.
* src/import.c: (_gpgme_op_import_start, _gpgme_op_import_keys_start):
Pass NULL to new arg of _gpgme_op_import_start.
(_gpgme_op_receive_keys_start, gpgme_op_receive_keys_start,
gpgme_op_receive_keys): New.
* src/engine-gpg.c (gpg_import): Add arg keyids. Extend check for
valid arguments. Build command line if keyids are given.
* src/engine-gpgsm.c (gpgsm_import): Add arg keyids. Return error if
keyids is not NULL.
tests/run-receive-keys.c: New.
tests/Makefile.am (noinst_PROGRAMS): Add new test runner.
--
The new function allows importing keys given by their key ids or
fingerprints from a keyserver (like gpg's --recv-keys command).
GnuPG-bug-id: 5808
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gpgme.texi | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi index 012afac1..9590ce88 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -5108,6 +5108,36 @@ listing mode does not match, and @code{GPG_ERR_NO_DATA} if no keys were considered for import. @end deftypefun +@deftypefun gpgme_error_t gpgme_op_receive_keys (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{keyids}[]}) +@since{1.17.0} + +The function @code{gpgme_op_receive_keys} adds the keys described by +the @code{NULL} terminated array @var{keyids} to the key ring of the +crypto engine used by @var{ctx}. It is used to retrieve and import keys +from an external source. This function currently works only for OpenPGP. + +After the operation completed successfully, the result can be +retrieved with @code{gpgme_op_import_result}. + +The function returns the error code @code{GPG_ERR_NO_ERROR} if the +import was completed successfully, @code{GPG_ERR_INV_VALUE} if +@var{ctx} is not a valid pointer, and @code{GPG_ERR_NO_DATA} if no keys +were considered for import. +@end deftypefun + +@deftypefun gpgme_error_t gpgme_op_receive_keys_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{keyids}[]}) +@since{1.17.0} + +The function @code{gpgme_op_receive_keys_start} initiates a +@code{gpgme_op_receive_keys} operation. It can be completed by calling +@code{gpgme_wait} on the context. @xref{Waiting For Completion}. + +The function returns the error code @code{GPG_ERR_NO_ERROR} if the +import was started successfully, @code{GPG_ERR_INV_VALUE} if +@var{ctx} is not a valid pointer, and @code{GPG_ERR_NO_DATA} if no keys +were considered for import. +@end deftypefun + @deftp {Data type} {gpgme_import_status_t} This is a pointer to a structure used to store a part of the result of a @code{gpgme_op_import} operation. For each considered key one |