diff options
| author | Werner Koch <[email protected]> | 2018-04-17 06:33:44 +0000 | 
|---|---|---|
| committer | Werner Koch <[email protected]> | 2018-04-17 06:45:00 +0000 | 
| commit | a1f76b3b54b75a150fe272b804d85ffd40a507a6 (patch) | |
| tree | 3f0dd57d543391fc300206bcfebb5e9eb9bb10fd /doc/gpgme.texi | |
| parent | core: Tweak STATUS_FAILURE handling. (diff) | |
| download | gpgme-a1f76b3b54b75a150fe272b804d85ffd40a507a6.tar.gz gpgme-a1f76b3b54b75a150fe272b804d85ffd40a507a6.zip | |
core: Add extended versions of the encrypt functions.
* src/gpgme.h.in (gpgme_op_encrypt_ext_start) New.
(gpgme_op_encrypt_ext): New.
(gpgme_op_encrypt_sign_ext_start): New.
(gpgme_op_encrypt_sign_ext): New.
* src/libgpgme.vers, tests/run-encrypt.c: Add them.
* src/encrypt.c (encrypt_start): Add arg recpstring.
(gpgme_op_encrypt): Factor code out to ...
(gpgme_op_encrypt_ext): new function with new arg recpstring.
(gpgme_op_encrypt_start): Factor code out to ...
(gpgme_op_encrypt_ext_start): new function with new arg recpstring.
* src/encrypt-sign.c (encrypt_sign_start): Add arg recpstring.
(gpgme_op_encrypt_sign): Factor code out to ...
(gpgme_op_encrypt_sign_ext): new function with new arg recpstring.
(gpgme_op_encrypt_sign_start): Factor code out to ...
(gpgme_op_encrypt_sign_ext_start): new function with new arg
recpstring.
* src/engine-backend.h (struct engine_ops): Change fields encrypt and
encrypt_sign.
* src/engine.c (_gpgme_engine_op_encrypt): Add arg recpstring and pass
to engine.
(_gpgme_engine_op_encrypt_sign): Ditto.
* src/engine-gpg.c (append_args_from_recipients_string): New.
(gpg_encrypt): Add arg recpstring and call new function as needed.
(gpg_encrypt_sign): Ditto.
* src/engine-gpgsm.c (set_recipients_from_string): New.
(gpgsm_encrypt): Add arg recpstring and call new function as needed.
* src/engine-uiserver.c (set_recipients_from_string): New.
(uiserver_encrypt): Add arg recpstring and call new function as
needed.
* tests/run-encrypt.c (xstrdup): New.
(main): Add option --keystring.
* src/gpgme-json.c (get_keys): Simplify.
(op_encrypt): Modify to make use of the extended encrypt function.
--
This new feature can be used to avoid the need for a key lookup and
thus several extra calls to the backend.
Note that run-test uses a semicolon as delimiter because that make
testing the feature on the command line much easier.
Signed-off-by: Werner Koch <[email protected]>
Diffstat (limited to 'doc/gpgme.texi')
| -rw-r--r-- | doc/gpgme.texi | 77 | 
1 files changed, 77 insertions, 0 deletions
| diff --git a/doc/gpgme.texi b/doc/gpgme.texi index cbb0e649..1df9c46e 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -6154,6 +6154,45 @@ pointer, and @code{GPG_ERR_UNUSABLE_PUBKEY} if @var{rset} does not  contain any valid recipients.  @end deftypefun +@deftypefun gpgme_error_t gpgme_op_encrypt_ext @ +            (@w{gpgme_ctx_t @var{ctx}}, @ +             @w{gpgme_key_t @var{recp}[]}, @ +             @w{const char *@var{recpstring}}, @ +             @w{gpgme_encrypt_flags_t @var{flags}}, @ +             @w{gpgme_data_t @var{plain}}, @w{gpgme_data_t @var{cipher}}) + +@since{1.11.0} + +This is an extended version of @code{gpgme_op_encrypt} with +@var{recpstring} as additional parameter.  If @var{recp} is NULL and +@var{recpstring} is not NULL, the latter is expected to be a linefeed +delimited string with the set of key specifications.  In contrast to +@var{recp} the keys are given directly as strings and there is no need +to first create key objects.  The keys are passed verbatim to the +backend engine. + +@end deftypefun + + +@deftypefun gpgme_error_t gpgme_op_encrypt_ext_start @ +            (@w{gpgme_ctx_t @var{ctx}}, @ +             @w{gpgme_key_t @var{recp}[]}, @ +             @w{const char *@var{recpstring}}, @ +             @w{gpgme_encrypt_flags_t @var{flags}}, @ +             @w{gpgme_data_t @var{plain}}, @w{gpgme_data_t @var{cipher}}) + +@since{1.11.0} + +This is an extended version of @code{gpgme_op_encrypt_start} with +@var{recpstring} as additional parameter.  If @var{recp} is NULL and +@var{recpstring} is not NULL, the latter is expected to be a linefeed +delimited string with the set of key specifications.  In contrast to +@var{recp} the keys are given directly as strings and there is no need +to first create key objects.  The keys are passed verbatim to the +backend engine. + +@end deftypefun +  @deftp {Data type} {gpgme_encrypt_result_t}  This is a pointer to a structure used to store the result of a  @code{gpgme_op_encrypt} operation.  After successfully encrypting @@ -6203,6 +6242,44 @@ if @var{ctx}, @var{rset}, @var{plain} or @var{cipher} is not a valid  pointer.  @end deftypefun +@deftypefun gpgme_error_t gpgme_op_encrypt_sign_ext @ +            (@w{gpgme_ctx_t @var{ctx}}, @ +             @w{gpgme_key_t @var{recp}[]}, @ +             @w{const char *@var{recpstring}}, @ +             @w{gpgme_encrypt_flags_t @var{flags}}, @ +             @w{gpgme_data_t @var{plain}}, @w{gpgme_data_t @var{cipher}}) + +@since{1.11.0} + +This is an extended version of @code{gpgme_op_encrypt_sign} with +@var{recpstring} as additional parameter.  If @var{recp} is NULL and +@var{recpstring} is not NULL, the latter is expected to be a linefeed +delimited string with the set of key specifications.  In contrast to +@var{recp} the keys are given directly as strings and there is no need +to first create the key objects.  The keys are passed verbatim to the +backend engine. + +@end deftypefun + +@deftypefun gpgme_error_t gpgme_op_encrypt_sign_ext_start @ +            (@w{gpgme_ctx_t @var{ctx}}, @ +             @w{gpgme_key_t @var{recp}[]}, @ +             @w{const char *@var{recpstring}}, @ +             @w{gpgme_encrypt_flags_t @var{flags}}, @ +             @w{gpgme_data_t @var{plain}}, @w{gpgme_data_t @var{cipher}}) + +@since{1.11.0} + +This is an extended version of @code{gpgme_op_encrypt_sign_start} with +@var{recpstring} as additional parameter.  If @var{recp} is NULL and +@var{recpstring} is not NULL, the latter is expected to be a linefeed +delimited string with the set of key specifications.  In contrast to +@var{recp} the keys are given directly as strings and there is no need +to first create the key objects.  The keys are passed verbatim to the +backend engine. + +@end deftypefun +  @node Miscellaneous  @section Miscellaneous operations | 
