6 hours agocore: Clear all flags for a new data property. master
Werner Koch [Thu, 19 Jul 2018 18:38:21 +0000 (20:38 +0200)]
core: Clear all flags for a new data property.

(insert_into_property_table): Use it here.  Clear all flags.

Fixes-commit: 085cdeddef637cc057362fcbde13b0261b8699ec
Signed-off-by: Werner Koch <>
9 hours agocore: Blank out the plaintext after decryption failure.
Werner Koch [Thu, 19 Jul 2018 15:38:50 +0000 (17:38 +0200)]
core: Blank out the plaintext after decryption failure.

* src/data.h (data_prop_t): New enum.
(struct gpgme_data): Add field propidx.
* src/data.c (property_t): New.
(property_table, property_table_size, property_table_lock): New.
(insert_into_property_table): New.
(remove_from_property_table): New.
(_gpgme_data_get_dserial): New.
(_gpgme_data_set_prop): New.
(_gpgme_data_get_prop): New.
(_gpgme_data_new): Connect new object to property_table.
(_gpgme_data_release): Remove from property_table.
(gpgme_data_read): With DATA_PROP_BLANKOUT set don't fill the buffer.
* src/data-mem.c (gpgme_data_release_and_get_mem): Likewise.
* src/decrypt.c (struct op_data): Add field plaintext_dserial.
(_gpgme_op_decrypt_init_result): Add arg plaintext and init new field.
(_gpgme_decrypt_status_handler): Set DATA_PROP_BLANKOUT on decryption
(_gpgme_decrypt_start): Pass PLAIN to the init function.
* src/decrypt-verify.c (decrypt_verify_start): Ditto.
* Check for stdint.h and bail out if uint64_t is not

This is a best effort feature to not output plaintext after a
decryption failure (e.g. due to no or broken authenticated
encryption).  It always work when using a memory object and reading it
after the decryption but it can't work reliable when the user is
reading from the data object while the decryption process is still

This is quite a large change because the data objects and the context
objects are allowed to be owned by different threads.  Thus a
synchronization is needed and we do this with a global table of all
data objects to which the context objects can do soft-linking via a
unique data object serial number.

Signed-off-by: Werner Koch <>
13 hours agocpp: Print origin and last update for key/uid
Andre Heinecke [Thu, 19 Jul 2018 10:58:49 +0000 (12:58 +0200)]
cpp: Print origin and last update for key/uid

* lang/cpp/src/key.cpp: Print origin and last update in
iostream operators.

17 hours agojson: Don't use strdup but the xtrystrdup wrapper.
Werner Koch [Thu, 19 Jul 2018 07:46:57 +0000 (09:46 +0200)]
json: Don't use strdup but the xtrystrdup wrapper.

* src/gpgme-json.c (create_keylist_patterns): Use CNT as first arg for
(process_request): s/strdup/xtrystrdup/.

calloc takes two arguments so to be able to detect integer overflow.
Thus if we switch from malloc to calloc we should utilize that.

Signed-off-by: Werner Koch <>
17 hours agocore: New interface gpgme_data_new_from_estream.
Werner Koch [Thu, 19 Jul 2018 07:50:30 +0000 (09:50 +0200)]
core: New interface gpgme_data_new_from_estream.

* src/ (gpgme_data_new_from_estream): New.
* src/data-estream.c: New.
* src/data.h (gpgme_data): New union member e_stream.

The estream functions (gpgrt_fopen et al.) are any waypart of the
required libgpg-error library and thus it makes sense to provide this
convenience interface.

Signed-off-by: Werner Koch <>
37 hours agojson: Fix memleak in native msging repl
Andre Heinecke [Wed, 18 Jul 2018 11:15:02 +0000 (13:15 +0200)]
json: Fix memleak in native msging repl

* src/gpgme-json.c (native_messaging_repl): Free request and
response after each loop.

If we only accept once request we should not loop. If we loop
we should do it properly.

37 hours agojson: Ensure that native msging request is string
Andre Heinecke [Wed, 18 Jul 2018 11:06:08 +0000 (13:06 +0200)]
json: Ensure that native msging request is string

* src/gpgme-json.c (native_messaging_repl): Ensure that the
request is NULL terminated.

This avoids potential memory leaks and access to unmapped memory
in case the request was not terminated.
Other request functions use es_read_line which gurantees NULL

37 hours agojson: Fix crash by ensuring response is never NULL
Andre Heinecke [Wed, 18 Jul 2018 11:02:32 +0000 (13:02 +0200)]
json: Fix crash by ensuring response is never NULL

* src/gpgme-json.c (encode_and_chunk): Try to always
return at least an error.
(process_request): Double check that it does not return NULL.

If process_request returns NULL the following strlen on it
would crash.

38 hours agojson: Fix memory errors in create_keylist_patterns
Andre Heinecke [Wed, 18 Jul 2018 10:57:51 +0000 (12:57 +0200)]
json: Fix memory errors in create_keylist_patterns

* src/gpgme-json.c (create_keylist_patterns): Reserve two
pointers more then linefeeds.
(create_keylist_patterns): Fix loop to count linebreaks.
(create_keylist_patterns): Use calloc for good measure.

This fixes crashes and memory corruption as cnt did not
match i.

39 hours agoqt: Handle encoding for diagnostics
Andre Heinecke [Wed, 18 Jul 2018 09:27:46 +0000 (11:27 +0200)]
qt: Handle encoding for diagnostics

* lang/qt/src/threadedjobmixin.cpp (fromEncoding)
(stringFromGpgOutput): New helpers.
(markupDiagnostics): Use it.

The Problem is that on my western windows system GnuPG
gets CP 437 as GetConsoleOutputCP and prints in that codepage.
In a W32 GUI Application we get 0 as GetConsoleOutputCP and 1252
with GetACP.

The only thing that seemed to somehow match was GetOEMCP but
that might just be luck and it might still be broken in
other windows languages.

This code is also used in Kleopatra so it might make sense
to make it public once it is demonstrated that it works on
most systems.

3 days agojson: Fix crash on invalid json
Andre Heinecke [Mon, 16 Jul 2018 17:47:11 +0000 (19:47 +0200)]
json: Fix crash on invalid json

* src/gpgme-json.c (process_request): Init res. Check for
json object before encode and chunk.

If json is invalid we can't read chunksize and would crash
in encode and chunk.

3 days agojson: Fix uninitialized key unref in op_delete
Andre Heinecke [Mon, 16 Jul 2018 17:46:04 +0000 (19:46 +0200)]
json: Fix uninitialized key unref in op_delete

* src/gpgme-json.c (op_delete): Init key.

3 days agojson: Minor cleanups in cJSON.c
Werner Koch [Mon, 16 Jul 2018 12:42:30 +0000 (14:42 +0200)]
json: Minor cleanups in cJSON.c

* src/cJSON.c: Add comments on the origin of the code.
(parse_string): Allocate an extra byte for safeness.
(cJSON_AddItemToArray): Allo ARRAY to be NULL.

Signed-off-by: Werner Koch <>
3 days agojson: Fix buffer overflow in cJSON.c
Werner Koch [Mon, 16 Jul 2018 10:34:52 +0000 (12:34 +0200)]
json: Fix buffer overflow in cJSON.c

* src/cJSON.c (parse_string): Correctly detect bad hex.

The call to parse_hex4 checks that only hex digits follow and in the
error case returns 0.  However, by the time of the combined check for
an invalid value and the error PTR has already been set to the last
hex character and thus if the end-of-string or a quote character was
one of the bad hex digits the loop will miss the end of the string
which does not match with the simple buffer length allocation test at
the begin of the function.

Signed-off-by: Werner Koch <>
6 days agopython bindings: example scripts
Ben McGinnes [Fri, 13 Jul 2018 10:36:27 +0000 (20:36 +1000)]
python bindings: example scripts

* Fixed incorrect mention of output prompt referencing secret keys
  when the scripts are only for exporting public keys in whole or
  minimised forms.

8 days agojson: Add with-sec-fprs param to export
Andre Heinecke [Wed, 11 Jul 2018 14:18:24 +0000 (16:18 +0200)]
json: Add with-sec-fprs param to export

* src/gpgme-json.c (add_secret_fprs): New helper.
(op_export, hlp_export): Extend for with-sec fprs.

This is a request from Mailvelope, to import an export
they need the information for which keys from the export
a secret key is also available. For simplicity it is
much preferred to get this information in a single call
without the need to do and parse a keylisting additionally
in a second native-messaging call.

So we make it optional to include that info in the export.

9 days agoexample scripts: python work-arounds
Ben McGinnes [Tue, 10 Jul 2018 03:40:18 +0000 (13:40 +1000)]
example scripts: python work-arounds

* fixed three typos which were guaranteed to break said script.

10 days agodocs: python bindings howto
Ben McGinnes [Mon, 9 Jul 2018 11:30:20 +0000 (21:30 +1000)]
docs: python bindings howto

* Complete typographic overhaul.
* Removed all section level indentation since it does not affect
  output formatting, but might affect source code examples.
* In text-mode stripped out all tabs which had crept in and replaced
  them with four spaces.
* Updated all code examples (again) to conform with Python-mode.
* Bumped version number in preparation for next release of GPG 2.2.9
  and corresponding GPGME release.

10 days agojson: Add with-secret without secret only
Andre Heinecke [Mon, 9 Jul 2018 09:36:28 +0000 (11:36 +0200)]
json: Add with-secret without secret only

* src/gpgme-json.c (op_keylist, hlp_keylist): Add "with-secret"
as a flag to do a public keylist with secret information.

10 days agotests: Add --with-secret to run-keylist.c
Andre Heinecke [Mon, 9 Jul 2018 09:17:27 +0000 (11:17 +0200)]
tests: Add --with-secret to run-keylist.c

* run-keylist.c (show_usage, main): Add --with-secret.

10 days agodoc: More explicit doc for EXTERN and LOCAL modes.
Andre Heinecke [Mon, 9 Jul 2018 09:10:19 +0000 (11:10 +0200)]
doc: More explicit doc for EXTERN and LOCAL modes.

* doc/gpgme.texi (GPGME_KEYLIST_MODE_EXTERN),
command line flags for CMS and OpenPGP Protocol.

This might help new users coming to gnupg to understand what
the flags do.

10 days agoAdd ctx flag for auto-key-locate
Andre Heinecke [Tue, 3 Jul 2018 15:50:23 +0000 (17:50 +0200)]
Add ctx flag for auto-key-locate

* src/context.h (gpgme_context): Add auto_key_locate.
* src/engine-gpg.c (engine_gpg): Add auto_key_locate.
(gpg_set_engine_flags, build_argv): Handle auto_key_locate.
(gpg_release): Free auto_key_locate.
* src/gpgme.c (gpgme_release): Free auto_key_locate.
(gpgme_get_ctx_flag, gpgme_set_ctx_flag): Handle auto-key-locate.
* doc/gpgme.texi: Document auto-key-locate flag.
* tests/run-keylist.c (show_usage, main): Add --from-wkd option.

This enables users of GPGME to control more fine grained what
auto-key-locate does.  Especially for WKD lookups / refreshes
can this be useful.

GnuPG-Bug-Id: T2917
Differential Revision:

12 days agopython bindings: howto examples
Ben McGinnes [Sat, 7 Jul 2018 17:40:35 +0000 (03:40 +1000)]
python bindings: howto examples

* Made sure all example scripts meet PEP8 compliance.
* Required fixing approx. a dozen of them in minor ways.

2 weeks agoqt: Handle OpenPGP Diagnostic log
Andre Heinecke [Thu, 5 Jul 2018 09:28:08 +0000 (11:28 +0200)]
qt: Handle OpenPGP Diagnostic log

* lang/qt/src/threadedjobmixin.cpp (_detail::audit_log_as_html):
Handle OpenPGP audit log differently.

2 weeks agocpp: Add enum mapping for GPGME_AUDIT_LOG_DIAG
Andre Heinecke [Thu, 5 Jul 2018 08:22:13 +0000 (10:22 +0200)]
cpp: Add enum mapping for GPGME_AUDIT_LOG_DIAG

* src/context.cpp (to_auditlog_flags): Map DIAG value.
* src/context.h (AuditLogFlags): Add it.

2 weeks agocore: Add gpg auditlog to get diagnostics
Andre Heinecke [Wed, 4 Jul 2018 13:39:01 +0000 (15:39 +0200)]
core: Add gpg auditlog to get diagnostics

* src/engine-gpg.c (engine_gpg): Add diagnostics member.
(gpg_release): Release diagnostics data.
(gpg_new): Set up logger-fd and diagnostics.
(gpg_getauditlog): New. Copy diagnostics to a user data.
(engine_ops): Add getauditlog.
* src/engine-gpgsm.c (gpgsm_getauditlog): Return not implemented
* src/getauditlog.c (getauditlog_start): Don't reset engine
for diagnostics.
* tests/run-decrypt.c (show_usage, main): Add --diagnostics.
* doc/gpgme.texi(Additional Logs): Document getauditlog.

This enables users of GPGME to get more verbose information
from gpg which can assist users in figuring out a problem
that was before hidden behind a generalized error like
"Decryption Failed".

For GPGSM it is not yet available as it is problematic to
get it properly in server mode and GPGSM already had the
original audit log mechanism in place.

GPGME_AUDITLOG_DEFAULT was added for a more explicit

2 weeks agocpp: Fix memory of DecryptionResult::symkeyAlgo
Andre Heinecke [Wed, 4 Jul 2018 10:15:05 +0000 (12:15 +0200)]
cpp: Fix memory of DecryptionResult::symkeyAlgo

* lang/cpp/src/decryptionresult.cpp (Private, ~Private): strdup
the symkey algo.

2 weeks agojson: Add keylist mode locate
Andre Heinecke [Wed, 4 Jul 2018 09:13:26 +0000 (11:13 +0200)]
json: Add keylist mode locate

* src/gpgme-json.c (op_keylist, hlp_keylist): Add locate.

The same rationale for the KEYLIST_MODE_LOCATE in GPGME
also applies here. It makes the API a little less magic.

2 weeks agopython bindings: scheming serpents
Ben McGinnes [Sun, 1 Jul 2018 19:05:09 +0000 (05:05 +1000)]
python bindings: scheming serpents

* Apparently I am wrong and Scheme is the new Python after all.
* Non-import related PEP8 compliance must wait for another day, though
  the other PEP8 fixes remain.

2 weeks agopython bindings: gpg.core
Ben McGinnes [Sun, 1 Jul 2018 17:55:19 +0000 (03:55 +1000)]
python bindings: gpg.core

* Changed id/else statements to a more pythonic form from scheme
  masquerading as python - sorry Justus, it had to go ;).
* With the added bonus of enabling PEP8 compliance in those sections.
* Fixed remaining PEP8 compliance issues with the exception of the
  imports at the beginning of the file (changing those will break the
  entire module, so we'll cope with it as it is).

2 weeks agom4 update: python 3.7
Ben McGinnes [Fri, 29 Jun 2018 04:52:37 +0000 (14:52 +1000)]
m4 update: python 3.7

* Fixed an error in arcane m4 syntax.

2 weeks agopython bindings: python 3.7
Ben McGinnes [Fri, 29 Jun 2018 04:26:30 +0000 (14:26 +1000)]
python bindings: python 3.7

* Bindings confirmed to work with the newly released 3.7.0.
* Updated M4 file to reflect this change and correct the Python binary
  search order (3.7 is not yet given priority, but will still be found
  first via the more generic python3 executable).
* Updated, bindings documentation and README to reflect this.

3 weeks agowhitespace police:
Ben McGinnes [Thu, 28 Jun 2018 08:46:31 +0000 (18:46 +1000)]
whitespace police:

* There's always one or, in this case, two.

3 weeks agodocs: python bindings howto
Ben McGinnes [Thu, 28 Jun 2018 08:33:51 +0000 (18:33 +1000)]
docs: python bindings howto

* Updated official doc (the org-mode file) with the instructions on
  importing and exporting both public and secret keys.

3 weeks agopython bindings examples
Ben McGinnes [Thu, 28 Jun 2018 08:14:13 +0000 (18:14 +1000)]
python bindings examples

* Added a secret key export variant which saves output as both GPG
  binary and ASCII armoured, plus saves in $GNUPGHOME and uses
  multiple methods of determining what that location is.

3 weeks agopython bindings examples
Ben McGinnes [Wed, 27 Jun 2018 17:28:07 +0000 (03:28 +1000)]
python bindings examples

* Added a key import variant which accesses the SKS keyservers in a
  RESTful fashion and then imports or attempts to import the response.

3 weeks agopython bindings examples: three export scripts
Ben McGinnes [Wed, 27 Jun 2018 10:12:27 +0000 (20:12 +1000)]
python bindings examples: three export scripts

* Example of default exporting keys.
* Example of exporting minimised keys.
* Example of exporting secret keys to a file with correct permissions.

Signed-off-by: Ben McGinnes <>
3 weeks agopython bindings: import example
Ben McGinnes [Wed, 27 Jun 2018 15:50:56 +0000 (01:50 +1000)]
python bindings: import example

* Added an example script for importing a key from a file (either
  ASCII armoured or not).

3 weeks agopython bindings: export secret keys
Ben McGinnes [Wed, 27 Jun 2018 09:16:29 +0000 (19:16 +1000)]
python bindings: export secret keys

* The holy grail: a function to export secret keys.
* GPGME will still invoke pinentry and gpg-agent as usual to authorise
  the export.
* Mostly similar to the two previous export functions for public keys
  except that it will return None if the result had a length of zero
  bytes.  Meaning that the difference between the specified pattern
  (if any) not matching available keys and an incorrect passphrase is
  not able to be determined from this function (or the underlying one
  for that matter).

Signed-off-by: Ben McGinnes <>
3 weeks agopython bindings: export public keys
Ben McGinnes [Wed, 27 Jun 2018 14:57:37 +0000 (00:57 +1000)]
python bindings: export public keys

* Updated key_export and key_export_minimal to return None where a
  pattern matched no keys in a manner simnilar to the possible result
  of key_export_secret.

3 weeks agopython bindings: export public keys
Ben McGinnes [Wed, 27 Jun 2018 08:51:09 +0000 (18:51 +1000)]
python bindings: export public keys

* Added functions for exporting public keys to gpg.core in both
  complete form and in minimised form.
* Rather than letting people need to worry about the export modes we
  are simply separating the functions as people would be more familiar
  with from the command line usage anyway.
* Functions added for Context are: ctx.key_export_minimal and
  ctx.key_export as the default or full export.

Signed-off-by: Ben McGinnes <>
4 weeks agojson: Add file handling for debug output
Andre Heinecke [Wed, 20 Jun 2018 07:43:19 +0000 (09:43 +0200)]
json: Add file handling for debug output

* src/gpgme-json.c (main): Add possibilty to set log file.

This is similar to how GPGME_DEBUG works. It takes ; on
Windows as seperator and : on linux. Followed by a file name.

For Linux it might make sense to use a different seperator
to allow setting a socket explicitly. But this is better
in line with the current GPGME_DEBUG behavior.

The change helps on Windows where we don't have a
log socket.

4 weeks agopython bindings: core import statements
Ben McGinnes [Sun, 17 Jun 2018 12:42:43 +0000 (22:42 +1000)]
python bindings: core import statements

* Fixed the bit I broke while fixing the PEP8 compliance issues.

4 weeks agopython bindings: core — PEP8 compliance
Ben McGinnes [Sun, 17 Jun 2018 05:58:44 +0000 (15:58 +1000)]
python bindings: core — PEP8 compliance

* Fixed most of the PEP8 errors in
* Those remaining may need more than little edits and are a bit
  strange (too clearly the result of a programmer who has spent far
  too much time dealing with Lisp so that for Python it looks
  ... strange).

4 weeks agopython bindings: core - key import gsoc/jacob-key-import
Ben McGinnes [Sun, 17 Jun 2018 04:35:20 +0000 (14:35 +1000)]
python bindings: core - key import

* Wrapped the key import function in the try/exception statements
  needed to catch at least the most likely unsuccessful import attempt
* Mostly draws on the file error and no data import statuses for
  errors, with a couple of exceptions.

Signed-off-by: Ben McGinnes <>
4 weeks agopython bindings: core key import
Ben McGinnes [Sat, 16 Jun 2018 23:28:30 +0000 (09:28 +1000)]
python bindings: core key import

* The foundation of a pythonic key import function authored by Jacob
* A unit testing script for the same function originally authored by
  Tobias Mueller
* Added DCO reference for Jacob Adams to the GPGME AUTHORS file.
* Additional details regarding this patch are available here:

Signed-off-by: Ben McGinnes <>
5 weeks agoscript:
Ben McGinnes [Sun, 10 Jun 2018 15:03:58 +0000 (01:03 +1000)]

* Added check for if it is run on a Windows system so that the correct
  binary filename is invoked.

5 weeks agocpp: Add proper gpgme_op_createkey
Andre Heinecke [Fri, 8 Jun 2018 14:19:47 +0000 (16:19 +0200)]
cpp: Add proper gpgme_op_createkey

* lang/cpp/src/context.cpp, lang/cpp/src/context.h
(Context::createKeyEx): New.

The createKeyEx function follows the usual pattern that the
synchronous call returns a result directly while for the
async an extra call is neccessary.

5 weeks agojson: Return fingerprint as createkey result
Andre Heinecke [Fri, 8 Jun 2018 12:52:41 +0000 (14:52 +0200)]
json: Return fingerprint as createkey result

* src/gpgme-json.c (op_createkey): Return fingerprint of new key.

5 weeks agojson: Add op_createkey
Andre Heinecke [Fri, 8 Jun 2018 11:55:21 +0000 (13:55 +0200)]
json: Add op_createkey

* src/gpgme-json.c (hlp_createkey, op_createkey): New.
(process_request, hlp_help): Add it.

This uses an unrestricted context for now until

GnuPG-Bug-Id: T4010
is implemented in GnuPG.

5 weeks agojson: Generalize chunking and getmore
Andre Heinecke [Thu, 7 Jun 2018 15:48:55 +0000 (17:48 +0200)]
json: Generalize chunking and getmore

* src/gpgme-json.c (MIN_REPLY_CHUNK_SIZE): Lower value to
new real minimum.
(DEF_REPLY_CHUNK_SIZE): Don't chunk by default.
(pending_data): Remove type and base64.
(make_data_object): Remove chunksize handling as this is now
(encode_and_chunk): Setup the pending_data buffer for chunking
if required.
(op_getmore): Changed to generically work on a response.
(hlp_getmore): Update accordingly.
(hlp_help): Document chunksize as generic parameter for all commands.
(process_request): Use encode_and_chunk on the response.
(hlp_encrypt, op_encrypt, hlp_decrypt, op_decrypt),
(hlp_verify, op_verify, hlp_sign, op_sign),
(op_keylist, hlp_keylist, hlp_export, op_export): Update accordingly.

To include handling for json properties e.g. in a keylist in
the chunk mechanism the mechanism is now more general.

If the chunksize property is provided the response will
always look exactly like a "getmore" response. E.g.

    "op": "keylist",
    "chunksize": 64
Results in:
   "more": true,
   "base64": true,
   "response": "ewoJImtleXMiOglbewoJCQkicmV2b2tlZCI6"

For simplicity this is even true if the chunksize is larger
then the response.

The client has to combine all "response" chunks and base64
decode them to get valid json.

The complete response (including json) is never larger then
the chunksize but might be smaller. Except for interactive
use due to additional format characters.

6 weeks agojson: Rework verify_result_to_json
Andre Heinecke [Thu, 7 Jun 2018 14:05:15 +0000 (16:05 +0200)]
json: Rework verify_result_to_json

* src/gpgme-json.c (sigsum_to_json): Add bool repr.
(signature_to_json, verify_result_to_json): Extend and follow better
(hlp_decrypt, hlp_verify): Expand doc.

This should make it more clear which values are mapped as
the naming is more direct and clear and help to use
the gpgme documentation to understand the verify_result values.

6 weeks agojson: Add direct way to query a config option
Andre Heinecke [Thu, 7 Jun 2018 09:42:47 +0000 (11:42 +0200)]
json: Add direct way to query a config option

* src/gpgme-json.c (op_config_opt, hlp_config_opt): New operation.
(process_request, hlp_help): Add it.

This is more conveniant API for most query operations where
a single option is required.

An example would be:
    "op": "config_opt",
    "component": "gpg",
    "option": "default-key"

Which results in:
   "option":       {
           "name": "default-key",
           "description":  "use NAME as default secret key",
           "argname":      "NAME",
           "flags":        0,
           "level":        0,
           "type": 1,
           "alt_type":     1,
           "value":        [{
                           "string":       "F462B6B1",
                           "is_none":      false

6 weeks agojson: Add op_config to query gpgconf
Andre Heinecke [Thu, 7 Jun 2018 09:23:14 +0000 (11:23 +0200)]
json: Add op_config to query gpgconf

* src/gpgme-json.c (op_config, hlp_config): New.
(hlp_help, process_request): Add config.
(conf_arg_to_json, conf_opt_to_json, conf_comp_to_json): New

6 weeks agoexamples: python howto
Ben McGinnes [Thu, 7 Jun 2018 05:06:20 +0000 (15:06 +1000)]
examples: python howto

* Uses the groups module to prepare a list of recipients and encrypt
  to those.
* The main version ( tries to check for invalid
  recipients, but still falls back to always trust for the second
  encryption attempt.
* The gullible version doesn't try pruning the recipient list at all,
  it just tries to encrypt and if it fails, switches straight to
  always trust.
* The trustno1 version doesn't use the always trust model at all and
  only attempts pruning the list of invalid recipients.

6 weeks agocore: Return a better error code on certain decryption failures.
Werner Koch [Wed, 6 Jun 2018 14:20:27 +0000 (16:20 +0200)]
core: Return a better error code on certain decryption failures.

* src/decrypt.c (op_data_t): Add field first_status_error.
(parse_status_error): Set it.
(_gpgme_decrypt_status_handler): Prefer an ERROR code over a

GnuPG-bug-id: 3983
Signed-off-by: Werner Koch <>
6 weeks agojson: Allow to compile with libgpg-error < 1.28
Werner Koch [Tue, 5 Jun 2018 07:40:17 +0000 (09:40 +0200)]
json: Allow to compile with libgpg-error < 1.28

* src/cJSON.c: Use gpgrt fucntion only if available.

We have a hack in gpgme-json to allow building with older libgpg-error
versions.  That whole thing will not work but the instead the binary
will print an error at runtime that it needs to be build with a newer
libgcrypt.  There was a little bug here for the Debian packages
libgpg-error versions which failed to build cJSON.  cJSON is only
needed be the full gpgme-json but nevertheless the Makefile wants to
build it.  The fix is straightforward.

GnuPG-bug-id: 3971
Signed-off-by: Werner Koch <>
6 weeks agodocs: python bindings howto
Ben McGinnes [Sat, 2 Jun 2018 14:46:46 +0000 (00:46 +1000)]
docs: python bindings howto

* Another attempt at fixing the org-mode version.
* A proof reader ascertained there were tabs in it instead of whitespace.
* Stripped the lot out and replaced with standard 4 spaces, fixed
  every incorrect example ... and it still breaks upon save and/or export.
* Added the reference to the script to demonstrate the module/code.

6 weeks agoAuthors: DCO
Ben McGinnes [Sat, 2 Jun 2018 07:15:40 +0000 (17:15 +1000)]
Authors: DCO

* Added mine to the GPGME AUTHORS file.  Mainly so I'm doing what I
  say myself when about to request another from someone ...  ;)

6 weeks agocpp: Add gpgme_(get)set_ctx_flag
Andre Heinecke [Fri, 1 Jun 2018 09:08:12 +0000 (11:08 +0200)]
cpp: Add gpgme_(get)set_ctx_flag

* NEWS: Mention API extensions.
* lang/cpp/src/context.cpp, lang/cpp/src/context.h
(Context::setFlag, Context::getFlag): New.

6 weeks agocpp: Add legacy_cipher_nomdc
Andre Heinecke [Fri, 1 Jun 2018 08:58:24 +0000 (10:58 +0200)]
cpp: Add legacy_cipher_nomdc

* lang/cpp/src/decryptionresult.cpp, lang/cpp/src/decryptionresult.h
(DecryptionResult::isLegacyCipherNoMDC): New.


7 weeks agocore: New context flag "ignore-mdc-error".
Werner Koch [Thu, 31 May 2018 23:29:20 +0000 (01:29 +0200)]
core: New context flag "ignore-mdc-error".

* src/context.h (gpgme_context): Add field ignore_mdc_error.
* src/gpgme.c (gpgme_set_ctx_flag, gpgme_get_ctx_flag): Set/get it.
* src/engine-gpg.c (engine_gpg): Add flags.ignore_mdc_error.
(gpg_set_engine_flags): Set it.
(build_argv): Pass option to gpg.
* src/decrypt.c (_gpgme_decrypt_status_handler): Take care of flag.
(gpgme_op_decrypt_result): Clear flag.
(gpgme_op_decrypt): Clear flag.
* src/decrypt-verify.c (gpgme_op_decrypt_verify): Clear flag
(gpgme_op_decrypt_ext): Clear flag.

* tests/run-decrypt.c (show_usage): Add option --ignore-mdc-error.

Signed-off-by: Werner Koch <>
7 weeks agocore: New decryption result flag 'legacy_cipher_nomdc'.
Werner Koch [Thu, 31 May 2018 23:01:08 +0000 (01:01 +0200)]
core: New decryption result flag 'legacy_cipher_nomdc'.

* src/ (_gpgme_op_decrypt_result): Add flag
* src/decrypt.c (parse_status_error): Set this flag.
* tests/run-decrypt.c (print_result): print it.
(main): Print the result even on error.

Signed-off-by: Werner Koch <>
7 weeks agocore: Remove cruft from the engine-gpg code.
Werner Koch [Thu, 31 May 2018 22:13:18 +0000 (00:13 +0200)]
core: Remove cruft from the engine-gpg code.

* src/engine-gpg.c (read_status): Remove the handling of
GPGME_STATUS_END_STREAM; this was used only by the former experimental
--pipemode of gpg but that is not even anymore invoked here.
(struct engine_gpg): Remove cmd.linked_data and .linked_idx.
(build_argv): Remove code for linked_data.
(gpg_new): Ditto.
(gpg_set_command_handler): Remove arr linked_data.
* src/engine-backend.h (engine_ops): Remove arg data from
* src/engine.c (_gpgme_engine_set_command_handler): Remove arg
linked_data and adjust all callers.

Signed-off-by: Werner Koch <>
7 weeks agocore: Minor cleanup in engine-gpg and -gpgsm.
Werner Koch [Thu, 31 May 2018 21:56:06 +0000 (23:56 +0200)]
core: Minor cleanup in engine-gpg and -gpgsm.

* src/engine-gpg.c: Remove errno.h.
(build_argv): Use gpg_error_from_syserror instead of ERRNO.
* src/engine-gpgsm.c: Remove errno.h.
(status_handler): Remove check for EINTR; gpgme_data_write already
handles EINTR.

Signed-off-by: Werner Koch <>
7 weeks agocpp: Add gpgme_data_rewind to cpp API
Andre Heinecke [Tue, 29 May 2018 07:16:22 +0000 (09:16 +0200)]
cpp: Add gpgme_data_rewind to cpp API

* lang/cpp/src/data.h, lang/cpp/src/data.cpp (Data::rewind): New.
* lang/qt/tests/t-various.cpp (testDataRewind): Test it.

The advantage of this convieniance function in GPGME is that
it avoids the messiness that are declarations with off_t.

GnuPG-Bug-Id: T3996

7 weeks agojson: Fix compiler warning.
Werner Koch [Mon, 28 May 2018 07:58:02 +0000 (09:58 +0200)]
json: Fix compiler warning.

* src/gpgme-json.c (op_version): Mark request as unused.

Signed-off-by: Werner Koch <>
7 weeks agojson: Do not allow to export or delete secret keys.
Werner Koch [Mon, 28 May 2018 07:56:49 +0000 (09:56 +0200)]
json: Do not allow to export or delete secret keys.

* src/gpgme-json.c (op_export, op_delete): Return GPG_ERR_FORBIDDEN if
"secret" is used.

This should not be possible from a browser and we need to make this
fully clear.  Actually gpg-agent won't allow that anyway but having
this explicitly is better.

If that is ever needed a dedicated command line option may enable
this, for example when used by regular programs and not by the browser.
But that requires other changes as well.

Signed-off-by: Werner Koch <>
7 weeks agojson: Fix use of get_context.
Werner Koch [Mon, 28 May 2018 07:53:32 +0000 (09:53 +0200)]
json: Fix use of get_context.

* src/gpgme-json.c (create_onetime_context): New.
(release_onetime_context): New.
(op_sign): Use the new fucntions to create a separate context.
(op_encrypt): Use a separate context for key listings.
(create_keylist_patterns): Remove unneeded cast.

get_context retruns a static per-process context and can thus not be
used as a separate context.  Use dedicated fucntions for this.

Signed-off-by: Werner Koch <>
7 weeks agojson: Implement encrypt-sign
Andre Heinecke [Fri, 25 May 2018 13:48:39 +0000 (15:48 +0200)]
json: Implement encrypt-sign

* src/gpgme-json.c (op_encrypt): Add optional signing_keys param.
(get_keys, create_keylist_patterns): Add param for json object name.

If the optional parameter signing_keys is provided to encrypt
it becomes an encrypt-sign operation.

7 weeks agojson: Implement delete command
Andre Heinecke [Fri, 25 May 2018 13:24:03 +0000 (15:24 +0200)]
json: Implement delete command

* src/gpgme-json.c (op_delete): New.
(hlp_help, process_request): Add it.

As with import / export delete also does not work for
the browser origin.

7 weeks agojson: Implement op_export
Andre Heinecke [Fri, 25 May 2018 12:52:51 +0000 (14:52 +0200)]
json: Implement op_export

* src/gpgme-json.c (op_export): New.
(hlp_getmore, process_request): Add it.

Secret key export does not work with request-origin browser.

7 weeks agojson: Fix double ctx alloc
Andre Heinecke [Fri, 25 May 2018 12:50:59 +0000 (14:50 +0200)]
json: Fix double ctx alloc

* src/gpgme-json.c (op_keylist): Only get one ctx.

7 weeks agojson: Add guard in create_keylist_patterns
Andre Heinecke [Fri, 25 May 2018 12:50:20 +0000 (14:50 +0200)]
json: Add guard in create_keylist_patterns

* src/gpgme-json.c (create_keylist_patterns): Guard against
a string ending with a linbreak.

7 weeks agojson: Implement import operation
Andre Heinecke [Fri, 25 May 2018 12:19:41 +0000 (14:19 +0200)]
json: Implement import operation

* src/gpgme-json.c (op_import): New.
(import_status_to_json, import_result_to_json): New.
(hlp_help, process_request): Add import.

7 weeks agojson: Improve keylist help
Andre Heinecke [Fri, 25 May 2018 11:09:34 +0000 (13:09 +0200)]
json: Improve keylist help

* src/gpgme-json.c (hlp_keylist): Clarify doc about keys parameter.

7 weeks agojson: Fix keylist pattern handling
Andre Heinecke [Fri, 25 May 2018 11:06:44 +0000 (13:06 +0200)]
json: Fix keylist pattern handling

* src/gpgme-json.c (xfree_array): New helper.
(create_keylist_patterns): Convert keystring to gpgme patterns.
(op_sign, op_keylist): Use it.

7 weeks agojson: Add additional commands to help
Andre Heinecke [Fri, 25 May 2018 10:22:37 +0000 (12:22 +0200)]
json: Add additional commands to help

* src/gpgme-json.c (hlp_help): Add additional commands.

7 weeks agojson: Refactor signature and ei code
Andre Heinecke [Fri, 25 May 2018 10:17:46 +0000 (12:17 +0200)]
json: Refactor signature and ei code

* src/gpgme-json.c (add_summary_to_object): Changed to:
(add_signature_to_object): Changed to signature_to_json.
(add_signatures_to_object): Changed to verify_result_to_json.
(add_ei_to_object): Changed to engine_info_to_json.
(op_decrypt, op_verify, op_version): Use new functions.

This pattern of gpgme_type to json object conversion
is much cleaner then the error returning "add to object"

7 weeks agojson: Implement keylist
Andre Heinecke [Fri, 25 May 2018 09:34:33 +0000 (11:34 +0200)]
json: Implement keylist

* src/gpgme-json.c (xjson_AddStringToObject0)
(xjson_AddItemToObject): New helpers.
(sig_notation_to_json, key_sig_to_json, tofu_to_json)
(uid_to_json, subkey_to_json, key_to_json): New
GPGME to JSON functions.
(op_keylist): New.
(process_request): Add op_keylist.

The conversion from GPGME data structures to
JSON follow the same pattern for the keylist
functions using the xjson wrappers instead
of error checking every cJSON call.

For large keylists the keylist command also
needs a data / getmore handling somehow.

7 weeks agojson: Deduplicate input handling code
Andre Heinecke [Fri, 25 May 2018 07:46:30 +0000 (09:46 +0200)]
json: Deduplicate input handling code

* gpgme-json.c (get_string_data): New.
(op_verify, op_sign, op_decrypt, op_encrypt): Use it.

This handles the common base64 decoding and creation of the
gpgme_data object.

8 weeks agoexamples: mutt crypt-hooks generator
Ben McGinnes [Thu, 24 May 2018 21:12:52 +0000 (07:12 +1000)]
examples: mutt crypt-hooks generator

* Added a script which demonstrates how the groups module works.
* Script generates Mutt/Neomutt crypt-hooks for every group entry in
  gpg.conf, including those entries for multiple keys (Mutt handles
  that differently).

8 weeks agodocs: python bindings howto
Ben McGinnes [Thu, 24 May 2018 19:22:16 +0000 (05:22 +1000)]
docs: python bindings howto

* Fixed the script so it really does what is described (the
  old code had the same result for groups, group_lines and
* Updated the corresponding example in the doc to match.

8 weeks agodoc: python bindings howto
Ben McGinnes [Sun, 13 May 2018 18:14:45 +0000 (04:14 +1000)]
doc: python bindings howto

* Fixed org-mode python source indenting.
** Note: nested indented blocks do not indent correctly when exported
   to [X]HTML.

8 weeks agojson: Add code to gpg_error based messages
Andre Heinecke [Thu, 24 May 2018 14:35:42 +0000 (16:35 +0200)]
json: Add code to gpg_error based messages

* src/gpgme-json.c (gpg_error_object): New.
(error_object_v): Extend to take error.

Having the error code is helpful, especially as
the strerrors are localized. E.g. to detect

8 weeks agojson: Implement op_version
Andre Heinecke [Thu, 24 May 2018 14:15:14 +0000 (16:15 +0200)]
json: Implement op_version

* src/gpgme-json.c (op_version): New.
(process_request): Extend for version.
(protocol_to_string, add_ei_to_object): New helpers.

8 weeks agojson: Implement op_verify
Andre Heinecke [Thu, 24 May 2018 11:56:16 +0000 (13:56 +0200)]
json: Implement op_verify

* src/gpgme-json.c (op_verify): New.
(hlp_help): Add verify.
(process_request): Add verify.

Mostly works, except for detached, base64 encoded signatures,
they are somehow not yet written to gpgme.

8 weeks agojson: Put signature info before data output
Andre Heinecke [Thu, 24 May 2018 11:36:31 +0000 (13:36 +0200)]
json: Put signature info before data output

* src/gpgme-json.c (op_decrypt): Move info before data.

This should enable it to first parse signatures before
handling very large chunks of data.

8 weeks agojson: Add sign to help
Andre Heinecke [Thu, 24 May 2018 11:31:15 +0000 (13:31 +0200)]
json: Add sign to help

* src/gpgme-json.c (hlp_help): Add sign.

8 weeks agojson: Add op_sign
Andre Heinecke [Thu, 24 May 2018 11:24:02 +0000 (13:24 +0200)]
json: Add op_sign

* src/gpgme-json.c (op_sign): New.

8 weeks agojson: Fix invalid function call
Andre Heinecke [Thu, 24 May 2018 11:16:55 +0000 (13:16 +0200)]
json: Fix invalid function call

* src/gpgme-json.c (add_signatures_to_object): Fix call to

That is what happens if you edit code while reviewing changes,
without testing it again,..

8 weeks agojson: Print signatures for decrypt/verify
Andre Heinecke [Thu, 24 May 2018 10:34:31 +0000 (12:34 +0200)]
json: Print signatures for decrypt/verify

* gpgme-json.c (xJSON_CreateArray),
(add_summary_to_object, validity_to_string): New helpers.
(add_signature_to_object, add_signatures_to_object)
(add_signatures_object): New.
(op_decrypt): Handle verify_result.
(hlp_help): Mention decrypt.

8 weeks agojson: Minor typo fixes
Andre Heinecke [Thu, 24 May 2018 08:26:41 +0000 (10:26 +0200)]
json: Minor typo fixes

* src/gpgme-json.c: Minor typo fixes.

8 weeks agodocs and examples: python howto
Ben McGinnes [Wed, 23 May 2018 04:43:06 +0000 (14:43 +1000)]
docs and examples: python howto

* Updated the decryption example code in the HOWTO and the
  corresponding script to gracefully handle a
  decryption failure.  This error will always be triggered when GPGME
  is used to try to decrypt an old, MDC-less encrypted message or

8 weeks agocpp: Expose sessionKey and symkeyAlgo
Andre Heinecke [Tue, 22 May 2018 10:08:01 +0000 (12:08 +0200)]
cpp: Expose sessionKey and symkeyAlgo

* lang/cpp/decryptionresult.cpp, lang/cpp/decryptionresult.h
(DecryptionResult::symkeyAlgo, DecryptionResult::sessionKey): New.

2 months agocore, w32: Add w64 handling for regkeys
Andre Heinecke [Thu, 17 May 2018 15:41:53 +0000 (17:41 +0200)]
core, w32: Add w64 handling for regkeys

* src/w32-util.c (_gpgme_get_gpg_path): Use new defines.
(GNUPG_REGKEY_2): x64 aware regkey as used by GnuPG in Gpg4win 2.x
(GNUPG_REGKEY_3): x64 aware regkey as used by GnuPG in Gpg4win 3.x
(_gpgme_get_gpgconf_path): Use new regkeys. Add another fallback.

This should fix more "unsupported protocol" issues if Gpg4win /
GnuPG is installed in a non standard path on 64bit systems.

The regkey handling is similar to that of gpgex and gpgol.

GnuPG-Bug-Id: T3988

2 months agocore: Always fail if an OpenPG message is not integrity protected.
Werner Koch [Thu, 17 May 2018 07:14:40 +0000 (09:14 +0200)]
core: Always fail if an OpenPG message is not integrity protected.

* src/decrypt.c (struct op_data_t): Add field not_integrity_protected.
(parse_decryption_info): Set this.  Also rename mode to aead_algo for
(_gpgme_decrypt_status_handler): Force failure in case of a missing

This extra check makes sure that a missing or stripped MDC in
 - gpg < 2.1
 - or gpg 2.2 with an old cipher algorithm
will lead to a decryption failure.  gpg 2.3 will always fail in this
case.  Implementing this check here and not backporting the 2.3 change
to 2.2 has the benefit that all GPGME using applications are protected
but scripts relying on rfc2440 (i.e. without MDC) will only break when
migrating to 2.3.

Note that S/MIME has no integrity protection mechanism but gpgsm
neither emits a DECRYPTION_INFO status line, so an error will not be
triggered.  If in the future gpgsm supports authenticated encryption
it may issue a DECRYPTION_INFO line to force a failure here but it
will in that case also emit a DECRYPTION_FAILED anyway.

GnuPG-bug-id: 3981
Signed-off-by: Werner Koch <>
2 months agojson: Improve auto-base64 encoding to not split UTF-8 chars.
Werner Koch [Wed, 9 May 2018 14:41:05 +0000 (16:41 +0200)]
json: Improve auto-base64 encoding to not split UTF-8 chars.

* src/gpgme-json.c (make_data_object): Switch to Base64 also for UTF-8

Signed-off-by: Werner Koch <>
2 months agocore: Make the status-fd monitor work for all gpgsm commands.
Werner Koch [Wed, 9 May 2018 14:39:30 +0000 (16:39 +0200)]
core: Make the status-fd monitor work for all gpgsm commands.

* src/engine-gpgsm.c (status_handler): Call the status monitor also

Signed-off-by: Werner Koch <>
2 months agopython: key expiration datetime stamp tests
Ben McGinnes [Sat, 5 May 2018 02:27:17 +0000 (12:27 +1000)]
python: key expiration datetime stamp tests

* Changed the expiration date for the generated test key to NYE this
  century, rather than the NYE this millennium as originally suggested
  in job #3815.
* This covers the lifetimes of current users (except, maybe, some very
  healthy millennials) as well as the 32-bit clock end date in 2038;
  without falling foul of OpenPGP's 2106 expiration.