diff options
author | Ingo Klöcker <[email protected]> | 2020-10-27 14:33:51 +0000 |
---|---|---|
committer | Ingo Klöcker <[email protected]> | 2020-10-29 11:57:10 +0000 |
commit | f3407d0ee4e34ed33be18de5f886a4da2affbf9f (patch) | |
tree | ffdd4777a07af84a034e58b0c9459e37013a61d7 /doc | |
parent | python: Handle the when case __doc__ is None. (diff) | |
download | gpgme-f3407d0ee4e34ed33be18de5f886a4da2affbf9f.tar.gz gpgme-f3407d0ee4e34ed33be18de5f886a4da2affbf9f.zip |
core: New function gpgme_op_revsig.
* src/gpgme.h.in (gpgme_op_revsig_start, gpgme_op_revsig): New.
(GPGME_REVSIG_LFSEP): New.
* src/context.h (ctx_op_data_id_t): Add OPDATA_REVSIG.
* src/revsig.c: New.
* src/Makefile.am (main_sources): Add revsig.
* src/libgpgme.vers, src/gpgme.def: Add gpgme_op_revsig and
gpgme_op_revsig_start.
* src/engine.h, src/engine.c: (_gpgme_engine_op_revsig): New.
* src/engine-backend.h (engine_ops): Add 'revsig' and adjust all
engine initializers.
* src/engine-gpg.c (gpg_revsig): New.
(_gpgme_engine_ops_gpg): Set revsig to gpg_revsig.
* doc/gpgme.texi: Document new functions.
* tests/run-keysign.c: Add option --revoke.
--
This extends GPGME to support the --quick-revoke-sig command
added by GnuPG 2.2.24. This allows revoking key signatures.
GnuPG-bug-id: 5094
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gpgme.texi | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi index d3c64ee7..99a228b3 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -4726,6 +4726,71 @@ be completed by calling @code{gpgme_wait} on the context. @c +@c gpgme_op_revsig +@c +@deftypefun gpgme_error_t gpgme_op_revsig @ + (@w{gpgme_ctx_t @var{ctx}}, @ + @w{gpgme_key_t @var{key}}, @ + @w{gpgme_key_t @var{signing_key}}, @ + @w{const char *@var{userid}}, @ + @w{unsigned int @var{flags}}); + +@since{1.14.1} + +The function @code{gpgme_op_revsig} revokes key signatures of the +public key @var{key} made with the key @var{signing_key}. This +function requires at least version 2.2.24 of GnuPG. + +@var{key} specifies the key to operate on. + +@var{signing_key} specifies the key whose signatures shall be revoked. + +@var{userid} selects the user ID or user IDs whose signatures shall +be revoked. If @var{userid} is set to @code{NULL} the signatures +on all user IDs are revoked. The user ID must be given verbatim +because the engine does an exact and case sensitive match. Thus the +@code{uid} field from the user ID object (@code{gpgme_user_id_t}) is to +be used. To select more than one user ID put them all into one string +separated by linefeeds characters (@code{\n}) and set the flag +@code{GPGME_REVSIG_LFSEP}. + +@var{flags} can be set to the bit-wise OR of the following flags: + +@table @code +@item GPGME_REVSIG_LFSEP +@since{1.14.1} + +Although linefeeds are uncommon in user IDs this flag is required to +explicitly declare that @var{userid} may contain several linefeed +separated user IDs. + +@end table + +The function returns zero on success, @code{GPG_ERR_NOT_SUPPORTED} if +the engine does not support the command, or a bunch of other error +codes. + +@end deftypefun + + +@deftypefun gpgme_error_t gpgme_op_revsig_start @ + (@w{gpgme_ctx_t @var{ctx}}, @ + @w{gpgme_key_t @var{key}}, @ + @w{gpgme_key_t @var{signing_key}}, @ + @w{const char *@var{userid}}, @ + @w{unsigned int @var{flags}}); + +@since{1.14.1} + +The function @code{gpgme_op_revsig_start} initiates a +@code{gpgme_op_revsig} operation; see there for details. It must +be completed by calling @code{gpgme_wait} on the context. +@xref{Waiting For Completion}. + +@end deftypefun + + +@c @c EXPORTING KEYS @c @node Exporting Keys |