gpgme.git
12 months agocore: New gpgme_set_ctx_flag "request-origin".
Werner Koch [Fri, 23 Mar 2018 14:27:32 +0000 (15:27 +0100)]
core: New gpgme_set_ctx_flag "request-origin".

* src/context.h (gpgme_context): Add 'request_origin'.
* src/gpgme.c (gpgme_release): Free that field.
(gpgme_set_ctx_flag, gpgme_get_ctx_flag): Add "request-origin".
* src/engine-backend.h (engine_ops): Add 'set_engine_ops' func ptr and
adjust all users.
* src/engine.c (_gpgme_engine_set_engine_flags): New.
* src/op-support.c (_gpgme_op_reset): Call that func.
* src/engine-gpg.c (struct engine_gpg): Add 'request_origin'.
(gpg_set_engine_flags): New.
(_gpgme_engine_ops_gpg): Hook it.
(build_argv): Use command line option --request-origin.
* src/engine-gpgsm.c (struct engine_gpgsm): Add 'request_origin'.
(gpgsm_set_engine_flags): New.
(_gpgme_engine_ops_gpgsm): Hook it.
(start): Send OPTION "request-origin".
* src/engine-assuan.c (struct engine_llass): Add 'request_origin'.
(gpgsm_set_engine_flags): New.
(_gpgme_engine_ops_assuan): Hook it.
(start): Send OPTION "pretend-request-origin".

Signed-off-by: Werner Koch <wk@gnupg.org>
12 months agobuild: Allow building with released libgpg-error.
Werner Koch [Fri, 23 Mar 2018 11:36:19 +0000 (12:36 +0100)]
build: Allow building with released libgpg-error.

* src/gpgme-json.c (add_base64_to_object): Return an error if building
with an older libgpg-error.

Signed-off-by: Werner Koch <wk@gnupg.org>
12 months agoMerge branch 'json-tool'
Werner Koch [Fri, 23 Mar 2018 10:31:20 +0000 (11:31 +0100)]
Merge branch 'json-tool'

12 months agojson: Finish op:encrypt.
Werner Koch [Fri, 23 Mar 2018 10:27:59 +0000 (11:27 +0100)]
json: Finish op:encrypt.

* src/gpgme-json.c (add_base64_to_object): New.
(data_from_base64_string): New.
(op_encrypt): Employ them.
(process_request): Print unformated json.
--

Signed-off-by: Werner Koch <wk@gnupg.org>
12 months agojson: Add a new function to cJSON.
Werner Koch [Fri, 23 Mar 2018 10:26:36 +0000 (11:26 +0100)]
json: Add a new function to cJSON.

* src/cJSON.c (cJSON_CreateStringConvey): New.

12 months agodoc: python bindings howto
Ben McGinnes [Wed, 21 Mar 2018 23:06:53 +0000 (10:06 +1100)]
doc: python bindings howto

* Fixed table.

12 months agodoc and examples: python bindings HOWTO
Ben McGinnes [Wed, 21 Mar 2018 19:37:02 +0000 (06:37 +1100)]
doc and examples: python bindings HOWTO

* Added GPGME Python bindings HOWTO in Australian/British English.
** en-US "translation" still to be done.
* Added several example scripts comprised of the "Basic Functions"
  section of the HOWTO (plus the work-around at the end).
** As these scripts are very basic examples they are released under
   both the GPLv2+ and the LGPLv2.1+ (just like GPGME itself).

Signed-off-by: Ben McGinnes <ben@adversary.org>
12 months agoMerge branch 'ben/docs/2018-03' of ssh+git://playfair.gnupg.org/git/gpgme into ben...
Ben McGinnes [Wed, 21 Mar 2018 19:33:16 +0000 (06:33 +1100)]
Merge branch 'ben/docs/2018-03' of ssh+git://playfair.gnupg.org/git/gpgme into ben/docs/2018-03

12 months agoexamples: multi-key selection operations ben/docs/2018-03
Ben McGinnes [Wed, 21 Mar 2018 19:19:36 +0000 (06:19 +1100)]
examples: multi-key selection operations

* Temporarily removing multi-key selection based examples.
* There are a few issues with getting the key selections to play
  nicely with gpg.Context().keylist object types.
* Will troubleshoot them separately and restore them when that's
  worked out, but I don't want these more complicated examples to
  delay merging the HOWTO with master.

12 months agoexample: group encryption
Ben McGinnes [Wed, 21 Mar 2018 19:18:13 +0000 (06:18 +1100)]
example: group encryption

* Troubleshooting.

12 months agoexamples: encryption
Ben McGinnes [Wed, 21 Mar 2018 19:05:10 +0000 (06:05 +1100)]
examples: encryption

* Fixed two incorrect Context() objects.

12 months agoexample: key selection
Ben McGinnes [Wed, 21 Mar 2018 18:55:53 +0000 (05:55 +1100)]
example: key selection

* Removed extraneous blank line.

12 months agoexample: key selection
Ben McGinnes [Wed, 21 Mar 2018 18:52:55 +0000 (05:52 +1100)]
example: key selection

* Similar to group-key-selection.py, but does not use an existing
  group from gpg.conf; instead takes multiple key IDs, fingerprints or
  patterns on the command line and adds them to a keylist object.

12 months agoexample: sign and encrypt to group
Ben McGinnes [Wed, 21 Mar 2018 18:40:02 +0000 (05:40 +1100)]
example: sign and encrypt to group

* Begins to string together some of the simpler examples to do more
  useful things.
* Signs and encrypts a file while encrypting to every key in a group
  specified in the gpg.conf file.

12 months agojson: Use gpgrt_argparse instead of argsparse.c
Werner Koch [Wed, 21 Mar 2018 18:26:03 +0000 (19:26 +0100)]
json: Use gpgrt_argparse instead of argsparse.c

* src/gpgme-json.c: Remove header argparse.h.  Define
GPGRT_ENABLE_ARGPARSE_MACROS.
(interactive_repl): Replace strusage by gpgrt_strusage.
(my_strusage): Add SPDX level.
(main): Switch to gpgrt_argparse stuff but keep very limited
functionality when building with an older libgpg-error.

Signed-off-by: Werner Koch <wk@gnupg.org>
12 months agoexample: group key selection
Ben McGinnes [Wed, 21 Mar 2018 18:20:51 +0000 (05:20 +1100)]
example: group key selection

* Example of preparing a keylist object using an existing group line
  from the gpg.conf file.

12 months agoexample groups work around
Ben McGinnes [Wed, 21 Mar 2018 18:07:56 +0000 (05:07 +1100)]
example groups work around

* Updated usage so it only references importing the final list of
  lists produced.  Trying to use some of the mid-points can have
  unpredictable results (this is part of the problem with work
  arounds).

12 months agoexample: groups
Ben McGinnes [Wed, 21 Mar 2018 17:04:05 +0000 (04:04 +1100)]
example: groups

* Added a docstring.

12 months agoexample: verify signatures
Ben McGinnes [Wed, 21 Mar 2018 16:58:58 +0000 (03:58 +1100)]
example: verify signatures

* Added example for verifying detached signatures against the files
  they're the signatures for.

12 months agoexample: verify signed file
Ben McGinnes [Wed, 21 Mar 2018 14:50:08 +0000 (01:50 +1100)]
example: verify signed file

* Added example to verify normal and clearsigned files.

12 months agodoc: python bindings howto
Ben McGinnes [Wed, 21 Mar 2018 14:48:41 +0000 (01:48 +1100)]
doc: python bindings howto

* Fixed minor error in one of the verification examples.

12 months agoexample: detach sign file
Ben McGinnes [Wed, 21 Mar 2018 14:30:32 +0000 (01:30 +1100)]
example: detach sign file

* Added example to make detached signatures of a file with key selection.

12 months agoexample: encrypt-sign-file.py
Ben McGinnes [Wed, 21 Mar 2018 14:26:43 +0000 (01:26 +1100)]
example: encrypt-sign-file.py

* Adjusted the doc string.

12 months agoexamples: doc strings
Ben McGinnes [Wed, 21 Mar 2018 14:24:52 +0000 (01:24 +1100)]
examples: doc strings

* Fixed minor errors in two doc strings.

12 months agoexample: clear signing
Ben McGinnes [Wed, 21 Mar 2018 14:18:37 +0000 (01:18 +1100)]
example: clear signing

* Added example to clear sign a file with signing key selection.

12 months agodoc: python bindings howto
Ben McGinnes [Wed, 21 Mar 2018 14:12:36 +0000 (01:12 +1100)]
doc: python bindings howto

* deconstructed and fixed all three signing methods.

13 months agoexample: sign file
Ben McGinnes [Wed, 21 Mar 2018 01:28:03 +0000 (12:28 +1100)]
example: sign file

* Similar to encrypt file except for signing a file in normal mode.
* Noticed additional changes to be made to the howto to match this,
  but they will have to wait due to a power outage (currently running
  on battery and a mobile connection, but that won't last).

13 months agojson: Implement op:encrypt
Werner Koch [Tue, 20 Mar 2018 10:14:26 +0000 (11:14 +0100)]
json: Implement op:encrypt

Signed-off-by: Werner Koch <wk@gnupg.org>
13 months agoMerge branch 'master' into json-tool
Werner Koch [Tue, 20 Mar 2018 10:13:14 +0000 (11:13 +0100)]
Merge branch 'master' into json-tool

13 months agocore: Do not clobber R_KEY in gpgme_get_key on error.
Werner Koch [Tue, 20 Mar 2018 09:41:18 +0000 (10:41 +0100)]
core: Do not clobber R_KEY in gpgme_get_key on error.

* src/keylist.c (gpgme_get_key): Assign a value to the return
parameter only on success.
--

This problem could be triggered by an ambiguous key.  The problem is
that the key returned in that case is for one not expected and worse
it has not been ref-ed.

Signed-off-by: Werner Koch <wk@gnupg.org>
13 months agocore: Fix ABI regression in recent commit.
Werner Koch [Tue, 20 Mar 2018 09:34:56 +0000 (10:34 +0100)]
core: Fix ABI regression in recent commit.

* src/gpgme.h.in (_gpgme_op_import_result): Move new field
'skipped_v3_keys' to the end.
--

The ABI break has not made it into a release.

Also document the new field.

Fixes-commit: a630a1e3e74c926163864b013cb164b4cd1866fc
Signed-off-by: Werner Koch <wk@gnupg.org>
13 months agodoc: python bindings howto
Ben McGinnes [Tue, 20 Mar 2018 03:57:26 +0000 (14:57 +1100)]
doc: python bindings howto

* Fixed typos in examples.

13 months agoexample: keycount
Ben McGinnes [Tue, 20 Mar 2018 03:55:05 +0000 (14:55 +1100)]
example: keycount

* Fixed missing parenthesis.

13 months agoexample: decrypt file
Ben McGinnes [Tue, 20 Mar 2018 03:32:53 +0000 (14:32 +1100)]
example: decrypt file

* Decrypts a file taking file names as command line parameters.

13 months agoexample: groups work-around
Ben McGinnes [Tue, 20 Mar 2018 03:19:16 +0000 (14:19 +1100)]
example: groups work-around

* Added groups selection work around code.
* Intended for use as a module to be imported by other scripts,
  usually with "from groups import group_lists" or "from groups import
  group_lines" or similar.

13 months agoexample: encrypt file
Ben McGinnes [Mon, 19 Mar 2018 22:53:27 +0000 (09:53 +1100)]
example: encrypt file

* Nested encryption in try/except statement in case recipient key is
  untrusted or invalid.

13 months agoexample: sign and encrypt file
Ben McGinnes [Mon, 19 Mar 2018 22:47:39 +0000 (09:47 +1100)]
example: sign and encrypt file

* Example to sign and encrypt a file.
* Similar to encrypt-file.py except all keys are considered trusted
  and signs with the default key.
* Also encrypts to the default key.

13 months agoexample: encrypt file
Ben McGinnes [Mon, 19 Mar 2018 22:39:48 +0000 (09:39 +1100)]
example: encrypt file

* Fixed typo in second encryption call.

13 months agoexample: encrypt file
Ben McGinnes [Mon, 19 Mar 2018 22:25:34 +0000 (09:25 +1100)]
example: encrypt file

* Example to encrypt a file to a single key.
* Takes key ID and/or fpr as a CLI parameter.
* Takes path and filename as a CLI parameter.
* Encrypts to specified key only, no signing and writes the output in
  both ASCII armoured and GPG binary formats with output filenames
  based on input filename.

13 months agoexample: python bindings key count
Ben McGinnes [Mon, 19 Mar 2018 21:55:01 +0000 (08:55 +1100)]
example: python bindings key count

* Added script wo count the number of keys in both the public and
  secret key stores.

13 months agodoc: python bindings examples
Ben McGinnes [Mon, 19 Mar 2018 21:39:49 +0000 (08:39 +1100)]
doc: python bindings examples

* Explicitly stated that all this code is released under the GPLv2+
  and the LGPLv2.1+.

13 months agodoc: python bindings example README
Ben McGinnes [Mon, 19 Mar 2018 21:31:53 +0000 (08:31 +1100)]
doc: python bindings example README

* Added the same license as used with the HOWTO.
* Since these examples are so basic, they'll be dual licensed the same
  as GPGME itself (otherwise it would slip too dangerously against the
  need for permissive licensing of crypto libraries).

13 months agodocs: python bindings examples
Ben McGinnes [Mon, 19 Mar 2018 21:26:57 +0000 (08:26 +1100)]
docs: python bindings examples

* Added reference to location where all the examples included in the
  HOWTO will be available as executable scripts.
* Included a short README file in that location.

13 months agoexample: python bindings encryption
Ben McGinnes [Mon, 19 Mar 2018 21:07:22 +0000 (08:07 +1100)]
example: python bindings encryption

* Since we don't want to encourage accessing the low level functions
  (e.g. op_encrypt), but since this example can still be useful to
  understand, renaming it and will add new encryption examples to
  match the instructions in the HOWTO.

13 months agodoc: python bindings howto
Ben McGinnes [Mon, 19 Mar 2018 04:03:00 +0000 (15:03 +1100)]
doc: python bindings howto

* Slight python-gnupg clarification.  See also this thread:
  https://lists.gnupg.org/pipermail/gnupg-devel/2018-March/033528.html

13 months agodoc: python bindings howto
Ben McGinnes [Mon, 19 Mar 2018 02:09:46 +0000 (13:09 +1100)]
doc: python bindings howto

* Adjusted the python-gnupg so the comments regarding insecure
  invocation of commands via subprocess (shell=True) were a major
  historical issue and not a a current issue.
* Not including Vinay Sajip's requested change to say it is now secure
  since no audit of the current code base has been performed and my
  last major inspection of that code was around the time I first
  ported PyME to Python 3 in 2015.

13 months agodoc: python bindings todo list
Ben McGinnes [Mon, 19 Mar 2018 01:46:41 +0000 (12:46 +1100)]
doc: python bindings todo list

* Checked off several points of howto coverage as completed.
* Reorganised to move S/MIME coverage to its own separate group of tasks.
* Noted only revocation remains for howto completion.

13 months agodoc: python bindings howto
Ben McGinnes [Sun, 18 Mar 2018 23:39:53 +0000 (10:39 +1100)]
doc: python bindings howto

* deconstructing multi-recipient encryption.

13 months agodoc: python bindings howto
Ben McGinnes [Sun, 18 Mar 2018 23:00:44 +0000 (10:00 +1100)]
doc: python bindings howto

* Replaced the single encryption methods with one main way (i.e. cut
  the low level stuff involving SEEK_SET instructions).

13 months agodoc: python bindings howto
Ben McGinnes [Sun, 18 Mar 2018 21:49:17 +0000 (08:49 +1100)]
doc: python bindings howto

* moved single encrytion examples up to the first ones, pending merge
  and major cut.
* This is basically just to make future checks of revisions a little easier.

13 months agodoc: python bindings howto
Ben McGinnes [Sun, 18 Mar 2018 21:43:36 +0000 (08:43 +1100)]
doc: python bindings howto

* Stripped decryption example to the bare bones as suggested by Justus.

13 months agodoc: python bindings howto
Ben McGinnes [Fri, 16 Mar 2018 16:46:02 +0000 (03:46 +1100)]
doc: python bindings howto

* Made the changes suggested by Jakub Wilk on gnupg-devel.
* Still need to make the far more comprehensive changes suggested by Justus.

13 months agojson: Add framework for the gpgme-json tool
Werner Koch [Fri, 16 Mar 2018 12:55:48 +0000 (13:55 +0100)]
json: Add framework for the gpgme-json tool

* src/gpgme-json.c: New.
* src/Makefile.am (bin_PROGRAMS): Add gpgme-json.
(gpgme_json_SOURCES, gpgme_json_LDADD): New.

Signed-off-by: Werner Koch <wk@gnupg.org>
13 months agocore: Adjust cJSON code for use in GPGME.
Werner Koch [Wed, 14 Mar 2018 10:24:38 +0000 (11:24 +0100)]
core: Adjust cJSON code for use in GPGME.

* src/cJSON.c: Remove util.h.  Use gpgrt alloc functions.
(cJSON_Delete): Do not clobber ERRNO.
(cJSON_AddItemToObject): Return OBJECT or NULL.
(cJSON_AddNullToObject): New.
(cJSON_AddTrueToObject): New.
(cJSON_AddFalseToObject): New.
(cJSON_AddBoolToObject): New.
(cJSON_AddNumberToObject): New.
(cJSON_AddStringToObject): New.
* src/cJSON.h (cJSON__h): Replace macro by cJSON_h for C compliance.
(cJSON_AddNullToObject): Remove macro.
(cJSON_AddTrueToObject): Remove macro.
(cJSON_AddFalseToObject): Remove macro.
(cJSON_AddBoolToObject): Remove macro.
(cJSON_AddNumberToObject): Remove macro.
(cJSON_AddStringToObject): Remove macro.
--

The gpgrt malloc functions are used so that we can easily mix memory
returned by gpgrt (e.g. es_read_line) with memory returned from the
JSON function.  In general that is not needed but on Windows it makes
a difference if the gpgme DLL is linked to a different C runtime
than the application.

The macros have been replaced to allow error checking (i.e out of
core) for these functions.  More error checking should be implemented
instead of silently creating objects which are not as requested.

Signed-off-by: Werner Koch <wk@gnupg.org>
13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 16:52:58 +0000 (03:52 +1100)]
doc: python bindings howto

* Added clarification on why it's not on PyPI.

13 months agocpp: Expose skipped_v3_keys
Andre Heinecke [Thu, 15 Mar 2018 15:21:00 +0000 (16:21 +0100)]
cpp: Expose skipped_v3_keys

* lang/cpp/src/importresult.cpp,
 lang/cpp/src/importresult.h (ImportResult::numV3KeysSkipped): New.

--
GnuPG-Bug-Id: T3776

13 months agocore: Parse skipped_v3_keys
Andre Heinecke [Thu, 15 Mar 2018 14:58:32 +0000 (15:58 +0100)]
core: Parse skipped_v3_keys

* src/gpgme.h.in (gpgme_import_result_t): Extend with skipped_v3_keys.
* src/import.c (gpgme_op_import_result): Extend debug with new field.
(parse_import_res): Parse skipped_v3_keys.
* tests/gpg/t-support.h, tests/run-support.h (print_import_result):
Print skipped_v3_keys.

--
This makes it possible to handle this in a GUI in a future
version.

GnuPG-Bug-Id: T3776

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 14:48:56 +0000 (01:48 +1100)]
doc: python bindings howto

* fixed custom_id for decryption so the XHTML validates.

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 14:34:22 +0000 (01:34 +1100)]
doc: python bindings howto

* Promoted final encryption example so that it will appear as heading
  6.1.3 when exported to HTML or PDF.

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 05:13:34 +0000 (16:13 +1100)]
doc: python bindings howto

* Fixed a minor typographic error.
* Bumped version number in preparation for merge with master.
* While there are probably a few more things worthy of being added
  (mainly how to revoke things), this document is essentially ready
  for publication now.

Signed-off-by: Ben McGinnes <ben@adversary.org>
13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 04:51:01 +0000 (15:51 +1100)]
doc: python bindings howto

* Added key signing.

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 04:16:23 +0000 (15:16 +1100)]
doc: python bindings howto

* Added a new user ID for Danger Mouse.
* Removed the empty entry for key preferences since that is handled
  through gpg.conf and/or editing the key directly.

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 03:59:36 +0000 (14:59 +1100)]
doc: python bindings howto

* Spell checking and fixing the few errors.

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 03:43:44 +0000 (14:43 +1100)]
doc: python bindings howto

* Added an encryption subkey to Danger Mouse's primary key.

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 03:01:30 +0000 (14:01 +1100)]
doc: python bindings howto

* generated a new primary key for Danger Mouse in an alternative homedir.

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 01:27:45 +0000 (12:27 +1100)]
doc: python bindings howto

* Added sections for key generation and key editing.

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 01:14:29 +0000 (12:14 +1100)]
doc: python bindings howto

* Added c.get_key instructions and examples.

13 months agodoc: python bindings howto
Ben McGinnes [Thu, 15 Mar 2018 00:18:02 +0000 (11:18 +1100)]
doc: python bindings howto

* Added text for verifying signatures.

13 months agodoc: python bindings howto
Ben McGinnes [Wed, 14 Mar 2018 20:20:31 +0000 (07:20 +1100)]
doc: python bindings howto

* Added 4 signature verification methods and partial text for them.

13 months agodoc: python bindings howto
Ben McGinnes [Wed, 14 Mar 2018 17:07:57 +0000 (04:07 +1100)]
doc: python bindings howto

* Added description for detached signatures.

13 months agodoc: python bindings howto
Ben McGinnes [Wed, 14 Mar 2018 16:51:51 +0000 (03:51 +1100)]
doc: python bindings howto

* Fixed multiple sample code examples of writing output to a file.
* Added the description of detached signatures.

13 months agocore: Import cJSON code from the payproc project.
Werner Koch [Wed, 14 Mar 2018 09:55:52 +0000 (10:55 +0100)]
core: Import cJSON code from the payproc project.

* src/cJSON.c: New.
* src/cJSON.h: New.
* src/cJSON.readme: New.
--

This is a copy of the code from the payproc commit
af5d6b4f820ee19e246a2cab6f56465fe91f1233.  The code was originally
added to payproc with the commit below.

Signed-off-by: Werner Koch <wk@gnupg.org>
===============================================
commit 7ae7ef29bc5ec19e005e6a5a739233d655f3f05f
Author:     Werner Koch <wk@gnupg.org>
AuthorDate: Wed Apr 2 09:01:42 2014 +0200
Commit:     Werner Koch <wk@gnupg.org>
CommitDate: Wed Apr 2 09:12:02 2014 +0200

Simplify cJSON and add new macros.

* src/cJSON.h: Re-indented.
(cjson_t): New.
(cjson_is_): New macros.
* src/cJSON.c: Re-indented.  Include errno.h and our util.h.
(ep): Remove global var.
(cJSON_GetErrorPtr): Remove.
(cJSON_strcasecmp): Cast args for use with tolower.
(cJSON_malloc, cJSON_free): Remove.  Change callers to use xtrymalloc
and xfree.
(cJSON_InitHooks): Remove.
(cJSON_strdup): Remove.  Change callers to use xtrystrdup.
(cJSON_New_Item): Simplify.
(cJSON_ParseWithOpts, cJSON_Parse): Add arg R_ERROFF.
(parse_string, parse_value, parse_array, parse_object): Add arg EP.
--

cJSON has been taken from cjson-code-58.zip.  The README file has been
renamed to cJSON.readme and the files have been changed to GNU coding
standards.  Because that parser is small enough to be source copied it
does not make sense to treat it as a library and I changed the memory
allocation functions to the usual xmalloc ones. The only external
dependency now is out util.h which declares those functions.

The lowercase cjson_t better fits into our coding style as well as the
new macros.  Thanks to Dave Gamble for this nice parser.
===============================================

13 months agodoc: python bindings todo
Ben McGinnes [Wed, 14 Mar 2018 09:40:50 +0000 (20:40 +1100)]
doc: python bindings todo

* minor phrasing fix.

13 months agodoc: python bindings howto
Ben McGinnes [Wed, 14 Mar 2018 09:36:30 +0000 (20:36 +1100)]
doc: python bindings howto

* Added recommended method of single encryption with description.

13 months agodoc: python binding howto
Ben McGinnes [Tue, 13 Mar 2018 15:40:41 +0000 (02:40 +1100)]
doc: python binding howto

* Clarified which English dialects this is written in.
* Translating to American can happen *after* it's done.
** The Yank version would probably want to change some of the examples
   anyway.
* Began the description for normal/default signing.

13 months agodoc: python bindings howto
Ben McGinnes [Tue, 13 Mar 2018 15:21:44 +0000 (02:21 +1100)]
doc: python bindings howto

* Added a section on key selection.
* Included recommendation for using fingerprint when selecting one
  specific key.
* Also included the most ironically amusing example of multiple key
  selection in a GPG guide.  Hey, it's public data ... (heh).

13 months agodoc: python bindings howto
Ben McGinnes [Tue, 13 Mar 2018 14:41:21 +0000 (01:41 +1100)]
doc: python bindings howto

* Added explanation of the ascendance of Python 3 over Python 2 in the
  guide to the intro.
* Expanded key selection description so people know what not to
  include regarding key IDs with this key selection method.

13 months agodoc: python bindings howto
Ben McGinnes [Tue, 13 Mar 2018 08:20:44 +0000 (19:20 +1100)]
doc: python bindings howto

* Added key selection for specifying signing key or keys.

13 months agodoc: python bindings howto
Ben McGinnes [Tue, 13 Mar 2018 07:32:30 +0000 (18:32 +1100)]
doc: python bindings howto

* During the course of working out the updated signature methods,
  determined that key selection (including counting) will beed to be
  presented before the basic functions.
* Moved "working with keys" up.

13 months agodoc: python bindings howto
Ben McGinnes [Tue, 13 Mar 2018 04:03:11 +0000 (15:03 +1100)]
doc: python bindings howto

* Signatures have changed as a result of the recent update from Justus.
* Sample code updated.
* Text to follow later.

13 months agodoc: python bindings howto
Ben McGinnes [Tue, 13 Mar 2018 00:50:38 +0000 (11:50 +1100)]
doc: python bindings howto

* Added text description for the decryption example.

13 months agodoc: python bindings howto
Ben McGinnes [Mon, 12 Mar 2018 21:26:22 +0000 (08:26 +1100)]
doc: python bindings howto

* Added a miscellaneous work-arounds section at the end.
* Included code in said miscellaneous section for accessing the groups
  specified in a gpg.conf file.
* It's a bit ugly since it does require subprocess (but not call,
  Popen or shell access and only accesses one command).

13 months agodoc: python bindings howto
Ben McGinnes [Mon, 12 Mar 2018 20:49:42 +0000 (07:49 +1100)]
doc: python bindings howto

* Fixed a spelling error in the key counting text.

13 months agodoc: python bindings howto
Ben McGinnes [Mon, 12 Mar 2018 20:42:04 +0000 (07:42 +1100)]
doc: python bindings howto

* updated multi-encryption final example to be complete.
* second example shows most likely method of reading plaintext.
* updated example filenames to stick with running gag
  (i.e. secret_plans.txt).

13 months agodoc: python bindings howto
Ben McGinnes [Mon, 12 Mar 2018 19:09:53 +0000 (06:09 +1100)]
doc: python bindings howto

* error corrections.
* multiple typesetting fixes only required due to certain archaic
  eccentricities of LaTeX.
* a couple of minor python PEP8 compliance corrections.

13 months agodoc: python bindings howto
Ben McGinnes [Mon, 12 Mar 2018 18:42:50 +0000 (05:42 +1100)]
doc: python bindings howto

* Fixed an error in the encryption try/except statement.

13 months agodoc: python bindings howto
Ben McGinnes [Mon, 12 Mar 2018 17:55:44 +0000 (04:55 +1100)]
doc: python bindings howto

* Added a more complicated encryption example with a few variations on
  the encryption method to account for untrusted recipient keys,
  signing or not signing, including or excluding default keys and so
  on.

13 months agodoc: python bindings howto
Ben McGinnes [Mon, 12 Mar 2018 13:33:11 +0000 (00:33 +1100)]
doc: python bindings howto

* Switched from links to some external docs to using footnotes where
  necessary.
* Ideally the howto should be as stand alone as possible.
* Also it makes it difficult to convert to another format for
  proof-reading if there are links that the conversion can't find.

13 months agodoc: python bindings HOWTO
Ben McGinnes [Fri, 9 Mar 2018 09:45:14 +0000 (20:45 +1100)]
doc: python bindings HOWTO

* Added instructions and code to count the number of public and secret
  keys available since it was quick and easy.

13 months agodoc: python TODO list
Ben McGinnes [Fri, 9 Mar 2018 09:44:02 +0000 (20:44 +1100)]
doc: python TODO list

* Slightly tweaked one heading to make it clear it wasn't a duplicate.

13 months agodoc: python bindings howto
Ben McGinnes [Fri, 9 Mar 2018 05:49:05 +0000 (16:49 +1100)]
doc: python bindings howto

* Wrote the text description explaining each step in the most basic
  encryption operation.
* Will need to include additional examples for encrypting to multiple
  recipients using Context().encrypt instead of Context().op_encrypt.

13 months agodoc: python bindings TODO list
Ben McGinnes [Fri, 9 Mar 2018 04:27:40 +0000 (15:27 +1100)]
doc: python bindings TODO list

* Updated to reflect the most recent work on the HOWTO for the Python
  bindings.

13 months agodoc: python bindings howto
Ben McGinnes [Fri, 9 Mar 2018 04:22:24 +0000 (15:22 +1100)]
doc: python bindings howto

* Added example for verifying both detached and "in-line" signatures.

13 months agoMerge branch 'master' of ssh+git://playfair.gnupg.org/git/gpgme into ben/docs/2018-03
Ben McGinnes [Thu, 8 Mar 2018 22:31:44 +0000 (09:31 +1100)]
Merge branch 'master' of ssh+git://playfair.gnupg.org/git/gpgme into ben/docs/2018-03

* Fixed conflicts with TODO.

13 months agodocs: TODO
Ben McGinnes [Thu, 8 Mar 2018 22:01:53 +0000 (09:01 +1100)]
docs: TODO

* Removed WS.

13 months agodoc: TODO list update
Ben McGinnes [Thu, 8 Mar 2018 21:36:12 +0000 (08:36 +1100)]
doc: TODO list update

* Closed off a few ancient items and added recommendation to others to
  use the dev.gnupg.org site for real bugs/features updates.
* See also this statement on the gnupg-devel list regarding this file:
  https://lists.gnupg.org/pipermail/gnupg-devel/2018-March/033499.html

13 months agodocs: python bindings howto update.
Ben McGinnes [Thu, 8 Mar 2018 20:53:57 +0000 (07:53 +1100)]
docs: python bindings howto update.

* Added all four signing code examples that are most likely to be
  used: armoured, clearsigned, detached armoured and detached binary.
* May remove some examples and just discuss the differences, but it
  depends on the way the text is filled out.

13 months agodoc: python bindings howto update
Ben McGinnes [Thu, 8 Mar 2018 18:25:49 +0000 (05:25 +1100)]
doc: python bindings howto update

* Added example of decryption.
* included some quick notes for myself regarding aspects to explain
  when I flesh out the explanatory text.

13 months agodoc: Basic operation of the python bindings
Ben McGinnes [Thu, 8 Mar 2018 17:42:41 +0000 (04:42 +1100)]
doc: Basic operation of the python bindings

* Added sample code for encrypting some text to a single key.
* Basically I'm just lifting existing production code and changing the
  key IDs from mine to "0x12345678DEADBEEF" for these first few
  examples.
* I'll fill in the text description after.
* Note: due to my regional location, I might split some tasks into
  more commits in order to be sure no work gets lost in case of
  emergency (or to put it another way: I know Telstra too well to
  trust them).

13 months agodoc-howto: fundamental aspects of GPGME vs Python
Ben McGinnes [Thu, 8 Mar 2018 04:23:05 +0000 (15:23 +1100)]
doc-howto: fundamental aspects of GPGME vs Python

* Added a section for those pythonistas who are too used to web
  programming.  Stressed that it's not simply not RESTful, it's not
  even REST-like.
* Letting me move on to drawing a very loose parallel between a
  session and a context.  The differences should become obvious in the
  subsequent sections.