77ddba225fa869137d570e1009f9c91ffff13984
[gpgme.git] / lang / python / docs / GPGMEpythonHOWTOen.org
1 #+TITLE: GNU Privacy Guard (GnuPG) Made Easy Python Bindings HOWTO (English)
2 #+LATEX_COMPILER: xelatex
3 #+LATEX_CLASS: article
4 #+LATEX_CLASS_OPTIONS: [12pt]
5 #+LATEX_HEADER: \usepackage{xltxtra}
6 #+LATEX_HEADER: \usepackage[margin=1in]{geometry}
7 #+LATEX_HEADER: \setmainfont[Ligatures={Common}]{Times New Roman}
8 #+LATEX_HEADER: \author{Ben McGinnes <ben@gnupg.org>}
9 #+HTML_HEAD_EXTRA: <link type="application/rss+xml" href="https://git.gnupg.org/cgi-bin/gitweb.cgi?p=gpgme.git;a=rss;f=lang/python/docs/GPGMEpythonHOWTOen.org"/>
10
11
12 * Introduction
13   :PROPERTIES:
14   :CUSTOM_ID: intro
15   :END:
16
17   | Version:        | 0.1.0                                    |
18   | Author:         | Ben McGinnes <ben@gnupg.org>             |
19   | Author GPG Key: | DB4724E6FA4286C92B4E55C4321E4E2373590E5D |
20   | Language:       | Australian English, British English      |
21   | xml:lang:       | en-AU, en-GB, en                         |
22
23   This document provides basic instruction in how to use the GPGME
24   Python bindings to programmatically leverage the GPGME library.
25
26
27 ** Python 2 versus Python 3
28    :PROPERTIES:
29    :CUSTOM_ID: py2-vs-py3
30    :END:
31
32    Though the GPGME Python bindings themselves provide support for
33    both Python 2 and 3, the focus is unequivocally on Python 3 and
34    specifically from Python 3.4 and above.  As a consequence all the
35    examples and instructions in this guide use Python 3 code.
36
37    Much of it will work with Python 2, but much of it also deals with
38    Python 3 byte literals, particularly when reading and writing data.
39    Developers concentrating on Python 2.7, and possibly even 2.6, will
40    need to make the appropriate modifications to support the older
41    string and unicode types as opposed to bytes.
42
43    There are multiple reasons for concentrating on Python 3; some of
44    which relate to the immediate integration of these bindings, some
45    of which relate to longer term plans for both GPGME and the python
46    bindings and some of which relate to the impending EOL period for
47    Python 2.7.  Essentially, though, there is little value in tying
48    the bindings to a version of the language which is a dead end and
49    the advantages offered by Python 3 over Python 2 make handling the
50    data types with which GPGME deals considerably easier.
51
52
53 ** Examples
54    :PROPERTIES:
55    :CUSTOM_ID: howto-python3-examples
56    :END:
57
58    All of the examples found in this document can be found as Python 3
59    scripts in the =lang/python/examples/howto= directory.
60
61
62 * GPGME Concepts
63   :PROPERTIES:
64   :CUSTOM_ID: gpgme-concepts
65   :END:
66
67
68 ** A C API
69    :PROPERTIES:
70    :CUSTOM_ID: gpgme-c-api
71    :END:
72
73    Unlike many modern APIs with which programmers will be more
74    familiar with these days, the GPGME API is a C API.  The API is
75    intended for use by C coders who would be able to access its
76    features by including the =gpgme.h= header file with their own C
77    source code and then access its functions just as they would any
78    other C headers.
79
80    This is a very effective method of gaining complete access to the
81    API and in the most efficient manner possible.  It does, however,
82    have the drawback that it cannot be directly used by other
83    languages without some means of providing an interface to those
84    languages.  This is where the need for bindings in various
85    languages stems.
86
87
88 ** Python bindings
89    :PROPERTIES:
90    :CUSTOM_ID: gpgme-python-bindings
91    :END:
92
93    The Python bindings for GPGME provide a higher level means of
94    accessing the complete feature set of GPGME itself.  It also
95    provides a more pythonic means of calling these API functions.
96
97    The bindings are generated dynamically with SWIG and the copy of
98    =gpgme.h= generated when GPGME is compiled.
99
100    This means that a version of the Python bindings is fundamentally
101    tied to the exact same version of GPGME used to generate that copy
102    of =gpgme.h=.
103
104
105 ** Difference between the Python bindings and other GnuPG Python packages
106    :PROPERTIES:
107    :CUSTOM_ID: gpgme-python-bindings-diffs
108    :END:
109
110    There have been numerous attempts to add GnuPG support to Python
111    over the years.  Some of the most well known are listed here, along
112    with what differentiates them.
113
114
115 *** The python-gnupg package maintained by Vinay Sajip
116     :PROPERTIES:
117     :CUSTOM_ID: diffs-python-gnupg
118     :END:
119
120     This is arguably the most popular means of integrating GPG with
121     Python.  The package utilises the =subprocess= module to implement
122     wrappers for the =gpg= and =gpg2= executables normally invoked on
123     the command line (=gpg.exe= and =gpg2.exe= on Windows).
124
125     The popularity of this package stemmed from its ease of use and
126     capability in providing the most commonly required features.
127
128     Unfortunately it has been beset by a number of security issues in
129     the past; most of which stemmed from using unsafe methods of
130     accessing the command line via the =subprocess= calls.  While some
131     effort has been made over the last two to three years (as of 2018)
132     to mitigate this, particularly by no longer providing shell access
133     through those subprocess calls, the wrapper is still somewhat
134     limited in the scope of its GnuPG features coverage.
135
136     The python-gnupg package is available under the MIT license.
137
138
139 *** The gnupg package created and maintained by Isis Lovecruft
140     :PROPERTIES:
141     :CUSTOM_ID: diffs-isis-gnupg
142     :END:
143
144     In 2015 Isis Lovecruft from the Tor Project forked and then
145     re-implemented the python-gnupg package as just gnupg.  This new
146     package also relied on subprocess to call the =gpg= or =gpg2=
147     binaries, but did so somewhat more securely.
148
149     The naming and version numbering selected for this package,
150     however, resulted in conflicts with the original python-gnupg and
151     since its functions were called in a different manner to
152     python-gnupg, the release of this package also resulted in a great
153     deal of consternation when people installed what they thought was
154     an upgrade that subsequently broke the code relying on it.
155
156     The gnupg package is available under the GNU General Public
157     License version 3.0 (or any later version).
158
159
160 *** The PyME package maintained by Martin Albrecht
161     :PROPERTIES:
162     :CUSTOM_ID: diffs-pyme
163     :END:
164
165     This package is the origin of these bindings, though they are
166     somewhat different now.  For details of when and how the PyME
167     package was folded back into GPGME itself see the /Short History/
168     document[fn:1] in this Python bindings =docs= directory.[fn:2]
169
170     The PyME package was first released in 2002 and was also the first
171     attempt to implement a low level binding to GPGME.  In doing so it
172     provided access to considerably more functionality than either the
173     =python-gnupg= or =gnupg= packages.
174
175     The PyME package is only available for Python 2.6 and 2.7.
176
177     Porting the PyME package to Python 3.4 in 2015 is what resulted in
178     it being folded into the GPGME project and the current bindings
179     are the end result of that effort.
180
181     The PyME package is available under the same dual licensing as
182     GPGME itself: the GNU General Public License version 2.0 (or any
183     later version) and the GNU Lesser General Public License version
184     2.1 (or any later version).
185
186
187 * GPGME Python bindings installation
188   :PROPERTIES:
189   :CUSTOM_ID: gpgme-python-install
190   :END:
191
192
193 ** No PyPI
194    :PROPERTIES:
195    :CUSTOM_ID: do-not-use-pypi
196    :END:
197
198    Most third-party Python packages and modules are available and
199    distributed through the Python Package Installer, known as PyPI.
200
201    Due to the nature of what these bindings are and how they work, it
202    is infeasible to install the GPGME Python bindings in the same way.
203
204    This is because the bindings use SWIG to dynamically generate C
205    bindings against =gpgme.h= and =gpgme.h= is generated from
206    =gpgme.h.in= at compile time when GPGME is built from source.  Thus
207    to include a package in PyPI which actually built correctly would
208    require either statically built libraries for every architecture
209    bundled with it or a full implementation of C for each
210    architecture.
211
212
213 ** Requirements
214    :PROPERTIES:
215    :CUSTOM_ID: gpgme-python-requirements
216    :END:
217
218    The GPGME Python bindings only have three requirements:
219
220    1. A suitable version of Python 2 or Python 3.  With Python 2 that
221       means Python 2.7 and with Python 3 that means Python 3.4 or
222       higher.
223    2. SWIG.
224    3. GPGME itself.  Which also means that all of GPGME's dependencies
225       must be installed too.
226
227
228 ** Installation
229    :PROPERTIES:
230    :CUSTOM_ID: installation
231    :END:
232
233    Installing the Python bindings is effectively achieved by compiling
234    and installing GPGME itself.
235
236    Once SWIG is installed with Python and all the dependencies for
237    GPGME are installed you only need to confirm that the version(s) of
238    Python you want the bindings installed for are in your =$PATH=.
239
240    By default GPGME will attempt to install the bindings for the most
241    recent or highest version number of Python 2 and Python 3 it
242    detects in =$PATH=.  It specifically checks for the =python= and
243    =python3= executables first and then checks for specific version
244    numbers.
245
246    For Python 2 it checks for these executables in this order:
247    =python=, =python2= and =python2.7=.
248
249    For Python 3 it checks for these executables in this order:
250    =python3=, =python3.6=, =python3.5= and =python3.4=.
251
252
253 *** Installing GPGME
254     :PROPERTIES:
255     :CUSTOM_ID: install-gpgme
256     :END:
257
258     See the GPGME =README= file for details of how to install GPGME from
259     source.
260
261
262 * Fundamentals
263   :PROPERTIES:
264   :CUSTOM_ID: howto-fund-a-mental
265   :END:
266
267   Before we can get to the fun stuff, there are a few matters
268   regarding GPGME's design which hold true whether you're dealing with
269   the C code directly or these Python bindings.
270
271
272 ** No REST
273    :PROPERTIES:
274    :CUSTOM_ID: no-rest-for-the-wicked
275    :END:
276
277    The first part of which is or will be fairly blatantly obvious upon
278    viewing the first example, but it's worth reiterating anyway.  That
279    being that this API is /*not*/ a REST API.  Nor indeed could it
280    ever be one.
281
282    Most, if not all, Python programmers (and not just Python
283    programmers) know how easy it is to work with a RESTful API.  In
284    fact they've become so popular that many other APIs attempt to
285    emulate REST-like behaviour as much as they are able.  Right down
286    to the use of JSON formatted output to facilitate the use of their
287    API without having to retrain developers.
288
289    This API does not do that.  It would not be able to do that and
290    also provide access to the entire C API on which it's built.  It
291    does, however, provide a very pythonic interface on top of the
292    direct bindings and it's this pythonic layer with which this HOWTO
293    deals with.
294
295
296 ** Context
297    :PROPERTIES:
298    :CUSTOM_ID: howto-get-context
299    :END:
300
301    One of the reasons which prevents this API from being RESTful is
302    that most operations require more than one instruction to the API
303    to perform the task.  Sure, there are certain functions which can
304    be performed simultaneously, particularly if the result known or
305    strongly anticipated (e.g. selecting and encrypting to a key known
306    to be in the public keybox).
307
308    There are many more, however, which cannot be manipulated so
309    readily: they must be performed in a specific sequence and the
310    result of one operation has a direct bearing on the outcome of
311    subsequent operations.  Not merely by generating an error either.
312
313    When dealing with this type of persistent state on the web, full of
314    both the RESTful and REST-like, it's most commonly referred to as a
315    session.  In GPGME, however, it is called a context and every
316    operation type has one.
317
318
319 * Working with keys
320   :PROPERTIES:
321   :CUSTOM_ID: howto-keys
322   :END:
323
324
325 ** Key selection
326    :PROPERTIES:
327    :CUSTOM_ID: howto-keys-selection
328    :END:
329
330    Selecting keys to encrypt to or to sign with will be a common
331    occurrence when working with GPGMe and the means available for
332    doing so are quite simple.
333
334    They do depend on utilising a Context; however once the data is
335    recorded in another variable, that Context does not need to be the
336    same one which subsequent operations are performed.
337
338    The easiest way to select a specific key is by searching for that
339    key's key ID or fingerprint, preferably the full fingerprint
340    without any spaces in it.  A long key ID will probably be okay, but
341    is not advised and short key IDs are already a problem with some
342    being generated to match specific patterns.  It does not matter
343    whether the pattern is upper or lower case.
344
345    So this is the best method:
346
347    #+begin_src python
348      import gpg
349
350      k = gpg.Context().keylist(pattern="258E88DCBD3CD44D8E7AB43F6ECB6AF0DEADBEEF")
351      keys = list(k)
352    #+end_src
353
354    This is passable and very likely to be common:
355
356    #+begin_src python
357      import gpg
358
359      k = gpg.Context().keylist(pattern="0x6ECB6AF0DEADBEEF")
360      keys = list(k)
361    #+end_src
362
363    And this is a really bad idea:
364
365    #+begin_src python
366      import gpg
367
368      k = gpg.Context().keylist(pattern="0xDEADBEEF")
369      keys = list(k)
370    #+end_src
371
372    Alternatively it may be that the intention is to create a list of
373    keys which all match a particular search string.  For instance all
374    the addresses at a particular domain, like this:
375
376    #+begin_src python
377      import gpg
378
379      ncsc = gpg.Context().keylist(pattern="ncsc.mil")
380      nsa = list(ncsc)
381    #+end_src
382
383
384 *** Counting keys
385     :PROPERTIES:
386     :CUSTOM_ID: howto-keys-counting
387     :END:
388
389     Counting the number of keys in your public keybox (=pubring.kbx=),
390     the format which has superseded the old keyring format
391     (=pubring.gpg= and =secring.gpg=), or the number of secret keys is
392     a very simple task.
393
394     #+begin_src python
395       import gpg
396
397       c = gpg.Context()
398       seckeys = c.keylist(pattern=None, secret=True)
399       pubkeys = c.keylist(pattern=None, secret=False)
400
401       seclist = list(seckeys)
402       secnum = len(seclist)
403
404       publist = list(pubkeys)
405       pubnum = len(publist)
406
407       print("""
408       Number of secret keys:  {0}
409       Number of public keys:  {1}
410       """.format(secnum, pubnum))
411     #+end_src
412
413
414 ** Get key
415    :PROPERTIES:
416    :CUSTOM_ID: howto-get-key
417    :END:
418
419    An alternative method of getting a single key via its fingerprint
420    is available directly within a Context with =Context().get_key=.
421    This is the preferred method of selecting a key in order to modify
422    it, sign or certify it and for obtaining relevant data about a
423    single key as a part of other functions; when verifying a signature
424    made by that key, for instance.
425
426    By default this method will select public keys, but it can select
427    secret keys as well.
428
429    This first example demonstrates selecting the current key of Werner
430    Koch, which is due to expire at the end of 2018:
431
432    #+begin_src python
433      import gpg
434
435      fingerprint = "80615870F5BAD690333686D0F2AD85AC1E42B367"
436      key = gpg.Context().get_key(fingerprint)
437    #+end_src
438
439    Whereas this example demonstrates selecting the author's current
440    key with the =secret= key word argument set to =True=:
441
442    #+begin_src python
443      import gpg
444
445      fingerprint = "DB4724E6FA4286C92B4E55C4321E4E2373590E5D"
446      key = gpg.Context().get_key(fingerprint, secret=True)
447    #+end_src
448
449    It is, of course, quite possible to select expired, disabled and
450    revoked keys with this function, but only to effectively display
451    information about those keys.
452
453    It is also possible to use both unicode or string literals and byte
454    literals with the fingerprint when getting a key in this way.
455
456
457 * Basic Functions
458   :PROPERTIES:
459   :CUSTOM_ID: howto-the-basics
460   :END:
461
462   The most frequently called features of any cryptographic library
463   will be the most fundamental tasks for encryption software.  In this
464   section we will look at how to programmatically encrypt data,
465   decrypt it, sign it and verify signatures.
466
467
468 ** Encryption
469    :PROPERTIES:
470    :CUSTOM_ID: howto-basic-encryption
471    :END:
472
473    Encrypting is very straight forward.  In the first example below
474    the message, =text=, is encrypted to a single recipient's key.  In
475    the second example the message will be encrypted to multiple
476    recipients.
477
478
479 *** Encrypting to one key
480     :PROPERTIES:
481     :CUSTOM_ID: howto-basic-encryption-single
482     :END:
483
484     Once the the Context is set the main issues with encrypting data
485     is essentially reduced to key selection and the keyword arguments
486     specified in the =gpg.Context().encrypt()= method.
487
488     Those keyword arguments are: =recipients=, a list of keys
489     encrypted to (covered in greater detail in the following section);
490     =sign=, whether or not to sign the plaintext data, see subsequent
491     sections on signing and verifying signatures below (defaults to
492     =True=); =sink=, to write results or partial results to a secure
493     sink instead of returning it (defaults to =None=); =passphrase=,
494     only used when utilising symmetric encryption (defaults to
495     =None=); =always_trust=, used to override the trust model settings
496     for recipient keys (defaults to =False=); =add_encrypt_to=,
497     utilises any preconfigured =encrypt-to= or =default-key= settings
498     in the user's =gpg.conf= file (defaults to =False=); =prepare=,
499     prepare for encryption (defaults to =False=); =expect_sign=,
500     prepare for signing (defaults to =False=); =compress=, compresses
501     the plaintext prior to encryption (defaults to =True=).
502
503     #+begin_src python
504       import gpg
505
506       a_key = "0x12345678DEADBEEF"
507       text = b"""Some text to test with.
508
509       Since the text in this case must be bytes, it is most likely that
510       the input form will be a separate file which is opened with "rb"
511       as this is the simplest method of obtaining the correct data
512       format.
513       """
514
515       c = gpg.Context(armor=True)
516       rkey = list(c.keylist(pattern=a_key, secret=False))
517       ciphertext, result, sign_result = c.encrypt(text, recipients=rkey, sign=False)
518
519       with open("secret_plans.txt.asc", "wb") as afile:
520           afile.write(ciphertext)
521     #+end_src
522
523     Though this is even more likely to be used like this; with the
524     plaintext input read from a file, the recipient keys used for
525     encryption regardless of key trust status and the encrypted output
526     also encrypted to any preconfigured keys set in the =gpg.conf=
527     file:
528
529     #+begin_src python
530       import gpg
531
532       a_key = "0x12345678DEADBEEF"
533
534       with open("secret_plans.txt", "rb") as afile:
535           text = afile.read()
536
537       c = gpg.Context(armor=True)
538       rkey = list(c.keylist(pattern=a_key, secret=False))
539       ciphertext, result, sign_result = c.encrypt(text, recipients=rkey,
540                                                   sign=True, always_trust=True,
541                                                   add_encrypt_to=True)
542
543       with open("secret_plans.txt.asc", "wb") as afile:
544           afile.write(ciphertext)
545     #+end_src
546
547     If the =recipients= paramater is empty then the plaintext is
548     encrypted symmetrically.  If no =passphrase= is supplied as a
549     parameter or via a callback registered with the =Context()= then
550     an out-of-band prompt for the passphrase via pinentry will be
551     invoked.
552
553
554 *** Encrypting to multiple keys
555     :PROPERTIES:
556     :CUSTOM_ID: howto-basic-encryption-multiple
557     :END:
558
559     Encrypting to multiple keys essentially just expands upon the key
560     selection process and the recipients from the previous examples.
561
562     The following example encrypts a message (=text=) to everyone with
563     an email address on the =gnupg.org= domain,[fn:3] but does /not/ encrypt
564     to a default key or other key which is configured to normally
565     encrypt to.
566
567     #+begin_src python
568       import gpg
569
570       text = b"""Oh look, another test message.
571
572       The same rules apply as with the previous example and more likely
573       than not, the message will actually be drawn from reading the
574       contents of a file or, maybe, from entering data at an input()
575       prompt.
576
577       Since the text in this case must be bytes, it is most likely that
578       the input form will be a separate file which is opened with "rb"
579       as this is the simplest method of obtaining the correct data
580       format.
581       """
582
583       c = gpg.Context(armor=True)
584       rpattern = list(c.keylist(pattern="@gnupg.org", secret=False))
585       logrus = []
586
587       for i in range(len(rpattern)):
588           if rpattern[i].can_encrypt == 1:
589               logrus.append(rpattern[i])
590
591       ciphertext, result, sign_result = c.encrypt(text, recipients=logrus, sign=False,
592                                                   always_trust=True)
593
594       with open("secret_plans.txt.asc", "wb") as afile:
595           afile.write(ciphertext)
596     #+end_src
597
598     All it would take to change the above example to sign the message
599     and also encrypt the message to any configured default keys would
600     be to change the =c.encrypt= line to this:
601
602     #+begin_src python
603       ciphertext, result, sign_result = c.encrypt(text, recipients=logrus,
604                                                   always_trust=True,
605                                                   add_encrypt_to=True)
606     #+end_src
607
608     The only keyword arguments requiring modification are those for
609     which the default values are changing.  The default value of
610     =sign= is =True=, the default of =always_trust= is =False=, the
611     default of =add_encrypt_to= is =False=.
612
613     If =always_trust= is not set to =True= and any of the recipient
614     keys are not trusted (e.g. not signed or locally signed) then the
615     encryption will raise an error.  It is possible to mitigate this
616     somewhat with something more like this:
617
618     #+begin_src python
619       import gpg
620
621       with open("secret_plans.txt.asc", "rb") as afile:
622           text = afile.read()
623
624       c = gpg.Context(armor=True)
625       rpattern = list(c.keylist(pattern="@gnupg.org", secret=False))
626       logrus = []
627
628       for i in range(len(rpattern)):
629           if rpattern[i].can_encrypt == 1:
630               logrus.append(rpattern[i])
631
632       try:
633           ciphertext, result, sign_result = c.encrypt(text, recipients=logrus, add_encrypt_to=True)
634       except gpg.errors.InvalidRecipients as e:
635           for i in range(len(e.recipients)):
636               for n in range(len(logrus)):
637                   if logrus[n].fpr == e.recipients[i].fpr:
638                       logrus.remove(logrus[n])
639                   else:
640                       pass
641           try:
642               ciphertext, result, sign_result = c.encrypt(text, recipients=logrus, add_encrypt_to=True)
643           except:
644               pass
645
646       with open("secret_plans.txt.asc", "wb") as afile:
647           afile.write(ciphertext)
648     #+end_src
649
650     This will attempt to encrypt to all the keys searched for, then
651     remove invalid recipients if it fails and try again.
652
653
654 ** Decryption
655    :PROPERTIES:
656    :CUSTOM_ID: howto-basic-decryption
657    :END:
658
659    Decrypting something encrypted to a key in one's secret keyring is
660    fairly straight forward.
661
662    In this example code, however, preconfiguring either
663    =gpg.Context()= or =gpg.core.Context()= as =c= is unnecessary
664    because there is no need to modify the Context prior to conducting
665    the decryption and since the Context is only used once, setting it
666    to =c= simply adds lines for no gain.
667
668    #+begin_src python
669      import gpg
670
671      ciphertext = input("Enter path and filename of encrypted file: ")
672      newfile = input("Enter path and filename of file to save decrypted data to: ")
673      with open(ciphertext, "rb") as cfile:
674          plaintext, result, verify_result = gpg.Context().decrypt(cfile)
675      with open(newfile, "wb") as nfile:
676          nfile.write(plaintext)
677    #+end_src
678
679    The data available in =plaintext= in this example is the decrypted
680    content as a byte object, the recipient key IDs and algorithms in
681    =result= and the results of verifying any signatures of the data in
682    =verify_result=.
683
684
685 ** Signing text and files
686    :PROPERTIES:
687    :CUSTOM_ID: howto-basic-signing
688    :END:
689
690    The following sections demonstrate how to specify keys to sign with.
691
692
693 *** Signing key selection
694     :PROPERTIES:
695     :CUSTOM_ID: howto-basic-signing-signers
696     :END:
697
698     By default GPGME and the Python bindings will use the default key
699     configured for the user invoking the GPGME API.  If there is no
700     default key specified and there is more than one secret key
701     available it may be necessary to specify the key or keys with
702     which to sign messages and files.
703
704     #+begin_src python
705       import gpg
706
707       logrus = input("Enter the email address or string to match signing keys to: ")
708       hancock = gpg.Context().keylist(pattern=logrus, secret=True)
709       sig_src = list(hancock)
710     #+end_src
711
712     The signing examples in the following sections include the
713     explicitly designated =signers= parameter in two of the five
714     examples; once where the resulting signature would be ASCII
715     armoured and once where it would not be armoured.
716
717     While it would be possible to enter a key ID or fingerprint here
718     to match a specific key, it is not possible to enter two
719     fingerprints and match two keys since the patten expects a string,
720     bytes or None and not a list.  A string with two fingerprints
721     won't match any single key.
722
723
724 *** Normal or default signing messages or files
725     :PROPERTIES:
726     :CUSTOM_ID: howto-basic-signing-normal
727     :END:
728
729     The normal or default signing process is essentially the same as
730     is most often invoked when also encrypting a message or file.  So
731     when the encryption component is not utilised, the result is to
732     produce an encoded and signed output which may or may not be ASCII
733     armoured and which may or may not also be compressed.
734
735     By default compression will be used unless GnuPG detects that the
736     plaintext is already compressed.  ASCII armouring will be
737     determined according to the value of =gpg.Context().armor=.
738
739     The compression algorithm is selected in much the same way as the
740     symmetric encryption algorithm or the hash digest algorithm is
741     when multiple keys are involved; from the preferences saved into
742     the key itself or by comparison with the preferences with all
743     other keys involved.
744
745    #+begin_src python
746      import gpg
747
748      text0 = """Declaration of ... something.
749
750      """
751      text = text0.encode()
752
753      c = gpg.Context(armor=True, signers=sig_src)
754      signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.NORMAL)
755
756      with open("/path/to/statement.txt.asc", "w") as afile:
757          afile.write(signed_data.decode())
758    #+end_src
759
760    Though everything in this example is accurate, it is more likely
761    that reading the input data from another file and writing the
762    result to a new file will be performed more like the way it is done
763    in the next example.  Even if the output format is ASCII armoured.
764
765    #+begin_src python
766      import gpg
767
768      with open("/path/to/statement.txt", "rb") as tfile:
769          text = tfile.read()
770
771      c = gpg.Context()
772      signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.NORMAL)
773
774      with open("/path/to/statement.txt.sig", "wb") as afile:
775          afile.write(signed_data)
776    #+end_src
777
778
779 *** Detached signing messages and files
780     :PROPERTIES:
781     :CUSTOM_ID: howto-basic-signing-detached
782     :END:
783
784     Detached signatures will often be needed in programmatic uses of
785     GPGME, either for signing files (e.g. tarballs of code releases)
786     or as a component of message signing (e.g. PGP/MIME encoded
787     email).
788
789     #+begin_src python
790       import gpg
791
792       text0 = """Declaration of ... something.
793
794       """
795       text = text0.encode()
796
797       c = gpg.Context(armor=True)
798       signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.DETACH)
799
800       with open("/path/to/statement.txt.asc", "w") as afile:
801           afile.write(signed_data.decode())
802     #+end_src
803
804     As with normal signatures, detached signatures are best handled as
805     byte literals, even when the output is ASCII armoured.
806
807     #+begin_src python
808       import gpg
809
810       with open("/path/to/statement.txt", "rb") as tfile:
811           text = tfile.read()
812
813       c = gpg.Context(signers=sig_src)
814       signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.DETACH)
815
816       with open("/path/to/statement.txt.sig", "wb") as afile:
817           afile.write(signed_data)
818     #+end_src
819
820
821 *** Clearsigning messages or text
822     :PROPERTIES:
823     :CUSTOM_ID: howto-basic-signing-clear
824     :END:
825
826     Though PGP/in-line messages are no longer encouraged in favour of
827     PGP/MIME, there is still sometimes value in utilising in-line
828     signatures.  This is where clear-signed messages or text is of
829     value.
830
831     #+begin_src python
832       import gpg
833
834       text0 = """Declaration of ... something.
835
836       """
837       text = text0.encode()
838
839       c = gpg.Context()
840       signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.CLEAR)
841
842       with open("/path/to/statement.txt.asc", "w") as afile:
843           afile.write(signed_data.decode())
844     #+end_src
845
846     In spite of the appearance of a clear-signed message, the data
847     handled by GPGME in signing it must still be byte literals.
848
849     #+begin_src python
850       import gpg
851
852       with open("/path/to/statement.txt", "rb") as tfile:
853           text = tfile.read()
854
855       c = gpg.Context()
856       signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.CLEAR)
857
858       with open("/path/to/statement.txt.asc", "wb") as afile:
859           afile.write(signed_data)
860     #+end_src
861
862
863 ** Signature verification
864    :PROPERTIES:
865    :CUSTOM_ID: howto-basic-verification
866    :END:
867
868    Essentially there are two principal methods of verification of a
869    signature.  The first of these is for use with the normal or
870    default signing method and for clear-signed messages.  The second is
871    for use with files and data with detached signatures.
872
873    The following example is intended for use with the default signing
874    method where the file was not ASCII armoured:
875
876    #+begin_src python
877      import gpg
878      import time
879
880      filename = "statement.txt"
881      gpg_file = "statement.txt.gpg"
882
883      c = gpg.Context()
884
885      try:
886          data, result = c.verify(open(gpg_file))
887          verified = True
888      except gpg.errors.BadSignatures as e:
889          verified = False
890          print(e)
891
892      if verified is True:
893          for i in range(len(result.signatures)):
894              sign = result.signatures[i]
895              print("""Good signature from:
896      {0}
897      with key {1}
898      made at {2}
899      """.format(c.get_key(sign.fpr).uids[0].uid,
900                 sign.fpr, time.ctime(sign.timestamp)))
901      else:
902          pass
903    #+end_src
904
905    Whereas this next example, which is almost identical would work
906    with normal ASCII armoured files and with clear-signed files:
907
908    #+begin_src python
909      import gpg
910      import time
911
912      filename = "statement.txt"
913      asc_file = "statement.txt.asc"
914
915      c = gpg.Context()
916
917      try:
918          data, result = c.verify(open(asc_file))
919          verified = True
920      except gpg.errors.BadSignatures as e:
921          verified = False
922          print(e)
923
924      if verified is True:
925          for i in range(len(result.signatures)):
926              sign = result.signatures[i]
927              print("""Good signature from:
928      {0}
929      with key {1}
930      made at {2}
931      """.format(c.get_key(sign.fpr).uids[0].uid,
932                 sign.fpr, time.ctime(sign.timestamp)))
933      else:
934          pass
935    #+end_src
936
937    In both of the previous examples it is also possible to compare the
938    original data that was signed against the signed data in =data= to
939    see if it matches with something like this:
940
941    #+begin_src python
942      with open(filename, "rb") as afile:
943          text = afile.read()
944
945      if text == data:
946          print("Good signature.")
947      else:
948          pass
949    #+end_src
950
951    The following two examples, however, deal with detached signatures.
952    With his method of verification the data that was signed does not
953    get returned since it is already being explicitly referenced in the
954    first argument of =c.verify=.  So =data= is =None= and only the
955    information in =result= is available.
956
957    #+begin_src python
958      import gpg
959      import time
960
961      filename = "statement.txt"
962      sig_file = "statement.txt.sig"
963
964      c = gpg.Context()
965
966      try:
967          data, result = c.verify(open(filename), open(sig_file))
968          verified = True
969      except gpg.errors.BadSignatures as e:
970          verified = False
971          print(e)
972
973      if verified is True:
974          for i in range(len(result.signatures)):
975              sign = result.signatures[i]
976              print("""Good signature from:
977      {0}
978      with key {1}
979      made at {2}
980      """.format(c.get_key(sign.fpr).uids[0].uid,
981                 sign.fpr, time.ctime(sign.timestamp)))
982      else:
983          pass
984    #+end_src
985
986    #+begin_src python
987      import gpg
988      import time
989
990      filename = "statement.txt"
991      asc_file = "statement.txt.asc"
992
993      c = gpg.Context()
994
995      try:
996          data, result = c.verify(open(filename), open(asc_file))
997          verified = True
998      except gpg.errors.BadSignatures as e:
999          verified = False
1000          print(e)
1001
1002      if verified is not None:
1003          for i in range(len(result.signatures)):
1004              sign = result.signatures[i]
1005              print("""Good signature from:
1006      {0}
1007      with key {1}
1008      made at {2}
1009      """.format(c.get_key(sign.fpr).uids[0].uid,
1010                 sign.fpr, time.ctime(sign.timestamp)))
1011      else:
1012          pass
1013    #+end_src
1014
1015
1016 * Creating keys and subkeys
1017   :PROPERTIES:
1018   :CUSTOM_ID: key-generation
1019   :END:
1020
1021   The one thing, aside from GnuPG itself, that GPGME depends on, of
1022   course, is the keys themselves.  So it is necessary to be able to
1023   generate them and modify them by adding subkeys, revoking or
1024   disabling them, sometimes deleting them and doing the same for user
1025   IDs.
1026
1027   In the following examples a key will be created for the world's
1028   greatest secret agent, Danger Mouse.  Since Danger Mouse is a secret
1029   agent he needs to be able to protect information to =SECRET= level
1030   clearance, so his keys will be 3072-bit keys.
1031
1032   The pre-configured =gpg.conf= file which sets cipher, digest and
1033   other preferences contains the following configuration parameters:
1034
1035   #+begin_src conf
1036     expert
1037     allow-freeform-uid
1038     allow-secret-key-import
1039     trust-model tofu+pgp
1040     tofu-default-policy unknown
1041     enable-large-rsa
1042     enable-dsa2
1043     # cert-digest-algo SHA256
1044     cert-digest-algo SHA512
1045     default-preference-list TWOFISH CAMELLIA256 AES256 CAMELLIA192 AES192 CAMELLIA128 AES BLOWFISH IDEA CAST5 3DES SHA512 SHA384 SHA256 SHA224 RIPEMD160 SHA1 ZLIB BZIP2 ZIP Uncompressed
1046     personal-cipher-preferences TWOFISH CAMELLIA256 AES256 CAMELLIA192 AES192 CAMELLIA128 AES BLOWFISH IDEA CAST5 3DES
1047     personal-digest-preferences SHA512 SHA384 SHA256 SHA224 RIPEMD160 SHA1
1048     personal-compress-preferences ZLIB BZIP2 ZIP Uncompressed
1049   #+end_src
1050
1051
1052 ** Primary key
1053    :PROPERTIES:
1054    :CUSTOM_ID: keygen-primary
1055    :END:
1056
1057    Generating a primary key uses the =create_key= method in a Context.
1058    It contains multiple arguments and keyword arguments, including:
1059    =userid=, =algorithm=, =expires_in=, =expires=, =sign=, =encrypt=,
1060    =certify=, =authenticate=, =passphrase= and =force=.  The defaults
1061    for all of those except =userid=, =algorithm=, =expires_in=,
1062    =expires= and =passphrase= is =False=.  The defaults for
1063    =algorithm= and =passphrase= is =None=.  The default for
1064    =expires_in= is =0=.  The default for =expires= is =True=.  There
1065    is no default for =userid=.
1066
1067    If =passphrase= is left as =None= then the key will not be
1068    generated with a passphrase, if =passphrase= is set to a string
1069    then that will be the passphrase and if =passphrase= is set to
1070    =True= then gpg-agent will launch pinentry to prompt for a
1071    passphrase.  For the sake of convenience, these examples will keep
1072    =passphrase= set to =None=.
1073
1074    #+begin_src python
1075      import gpg
1076
1077      c = gpg.Context()
1078
1079      c.home_dir = "~/.gnupg-dm"
1080      userid = "Danger Mouse <dm@secret.example.net>"
1081
1082      dmkey = c.create_key(userid, algorithm = "rsa3072", expires_in = 31536000,
1083                           sign = True, certify = True)
1084    #+end_src
1085
1086    One thing to note here is the use of setting the =c.home_dir=
1087    parameter.  This enables generating the key or keys in a different
1088    location.  In this case to keep the new key data created for this
1089    example in a separate location rather than adding it to existing
1090    and active key store data.  As with the default directory,
1091    =~/.gnupg=, any temporary or separate directory needs the
1092    permissions set to only permit access by the directory owner.  On
1093    posix systems this means setting the directory permissions to 700.
1094
1095    The =temp-homedir-config.py= script in the HOWTO examples directory
1096    will create an alternative homedir with these configuration options
1097    already set and the correct directory and file permissions.
1098
1099    The successful generation of the key can be confirmed via the
1100    returned =GenkeyResult= object, which includes the following data:
1101
1102    #+begin_src python
1103      print("""
1104      Fingerprint:  {0}
1105      Primary Key:  {1}
1106       Public Key:  {2}
1107       Secret Key:  {3}
1108          Sub Key:  {4}
1109         User IDs:  {5}
1110      """.format(dmkey.fpr, dmkey.primary, dmkey.pubkey, dmkey.seckey, dmkey.sub,
1111                 dmkey.uid))
1112    #+end_src
1113
1114    Alternatively the information can be confirmed using the command
1115    line program:
1116
1117    #+begin_src shell
1118      bash-4.4$ gpg --homedir ~/.gnupg-dm -K
1119      ~/.gnupg-dm/pubring.kbx
1120      ----------------------
1121      sec   rsa3072 2018-03-15 [SC] [expires: 2019-03-15]
1122            177B7C25DB99745EE2EE13ED026D2F19E99E63AA
1123      uid           [ultimate] Danger Mouse <dm@secret.example.net>
1124
1125      bash-4.4$
1126    #+end_src
1127
1128    As with generating keys manually, to preconfigure expanded
1129    preferences for the cipher, digest and compression algorithms, the
1130    =gpg.conf= file must contain those details in the home directory in
1131    which the new key is being generated.  I used a cut down version of
1132    my own =gpg.conf= file in order to be able to generate this:
1133
1134    #+begin_src shell
1135      bash-4.4$ gpg --homedir ~/.gnupg-dm --edit-key 177B7C25DB99745EE2EE13ED026D2F19E99E63AA showpref quit
1136      Secret key is available.
1137
1138      sec  rsa3072/026D2F19E99E63AA
1139           created: 2018-03-15  expires: 2019-03-15  usage: SC
1140           trust: ultimate      validity: ultimate
1141      [ultimate] (1). Danger Mouse <dm@secret.example.net>
1142
1143      [ultimate] (1). Danger Mouse <dm@secret.example.net>
1144           Cipher: TWOFISH, CAMELLIA256, AES256, CAMELLIA192, AES192, CAMELLIA128, AES, BLOWFISH, IDEA, CAST5, 3DES
1145           Digest: SHA512, SHA384, SHA256, SHA224, RIPEMD160, SHA1
1146           Compression: ZLIB, BZIP2, ZIP, Uncompressed
1147           Features: MDC, Keyserver no-modify
1148
1149      bash-4.4$
1150    #+end_src
1151
1152
1153 ** Subkeys
1154    :PROPERTIES:
1155    :CUSTOM_ID: keygen-subkeys
1156    :END:
1157
1158    Adding subkeys to a primary key is fairly similar to creating the
1159    primary key with the =create_subkey= method.  Most of the arguments
1160    are the same, but not quite all.  Instead of the =userid= argument
1161    there is now a =key= argument for selecting which primary key to
1162    add the subkey to.
1163
1164    In the following example an encryption subkey will be added to the
1165    primary key.  Since Danger Mouse is a security conscious secret
1166    agent, this subkey will only be valid for about six months, half
1167    the length of the primary key.
1168
1169    #+begin_src python
1170      import gpg
1171
1172      c = gpg.Context()
1173      c.home_dir = "~/.gnupg-dm"
1174
1175      key = c.get_key(dmkey.fpr, secret = True)
1176      dmsub = c.create_subkey(key, algorithm = "rsa3072", expires_in = 15768000,
1177                              encrypt = True)
1178    #+end_src
1179
1180    As with the primary key, the results here can be checked with:
1181
1182    #+begin_src python
1183      print("""
1184      Fingerprint:  {0}
1185      Primary Key:  {1}
1186       Public Key:  {2}
1187       Secret Key:  {3}
1188          Sub Key:  {4}
1189         User IDs:  {5}
1190      """.format(dmsub.fpr, dmsub.primary, dmsub.pubkey, dmsub.seckey, dmsub.sub,
1191                 dmsub.uid))
1192    #+end_src
1193
1194    As well as on the command line with:
1195
1196    #+begin_src shell
1197      bash-4.4$ gpg --homedir ~/.gnupg-dm -K
1198      ~/.gnupg-dm/pubring.kbx
1199      ----------------------
1200      sec   rsa3072 2018-03-15 [SC] [expires: 2019-03-15]
1201            177B7C25DB99745EE2EE13ED026D2F19E99E63AA
1202      uid           [ultimate] Danger Mouse <dm@secret.example.net>
1203      ssb   rsa3072 2018-03-15 [E] [expires: 2018-09-13]
1204
1205      bash-4.4$
1206    #+end_src
1207
1208
1209 ** User IDs
1210    :PROPERTIES:
1211    :CUSTOM_ID: keygen-uids
1212    :END:
1213
1214    By comparison to creating primary keys and subkeys, adding a new
1215    user ID to an existing key is much simpler.  The method used to do
1216    this is =key_add_uid= and the only arguments it takes are for the
1217    =key= and the new =uid=.
1218
1219    #+begin_src python
1220      import gpg
1221
1222      c = gpg.Context()
1223      c.home_dir = "~/.gnupg-dm"
1224
1225      dmfpr = "177B7C25DB99745EE2EE13ED026D2F19E99E63AA"
1226      key = c.get_key(dmfpr, secret = True)
1227      uid = "Danger Mouse <danger.mouse@secret.example.net>"
1228
1229      c.key_add_uid(key, uid)
1230    #+end_src
1231
1232    Unsurprisingly the result of this is:
1233
1234    #+begin_src shell
1235      bash-4.4$ gpg --homedir ~/.gnupg-dm -K
1236      ~/.gnupg-dm/pubring.kbx
1237      ----------------------
1238      sec   rsa3072 2018-03-15 [SC] [expires: 2019-03-15]
1239            177B7C25DB99745EE2EE13ED026D2F19E99E63AA
1240      uid           [ultimate] Danger Mouse <danger.mouse@secret.example.net>
1241      uid           [ultimate] Danger Mouse <dm@secret.example.net>
1242      ssb   rsa3072 2018-03-15 [E] [expires: 2018-09-13]
1243
1244      bash-4.4$
1245    #+end_src
1246
1247
1248 ** Key certification
1249    :PROPERTIES:
1250    :CUSTOM_ID: key-sign
1251    :END:
1252
1253    Since key certification is more frequently referred to as key
1254    signing, the method used to perform this function is =key_sign=.
1255
1256    The =key_sign= method takes four arguments: =key=, =uids=,
1257    =expires_in= and =local=.  The default value of =uids= is =None=
1258    and which results in all user IDs being selected.  The default
1259    values of =expires_in= snd =local= is =False=; which result in the
1260    signature never expiring and being able to be exported.
1261
1262    The =key= is the key being signed rather than the key doing the
1263    signing.  To change the key doing the signing refer to the signing
1264    key selection above for signing messages and files.
1265
1266    If the =uids= value is not =None= then it must either be a string
1267    to match a single user ID or a list of strings to match multiple
1268    user IDs.  In this case the matching of those strings must be
1269    precise and it is case sensitive.
1270
1271    To sign Danger Mouse's key for just the initial user ID with a
1272    signature which will last a little over a month, do this:
1273
1274    #+begin_src python
1275      import gpg
1276
1277      c = gpg.Context()
1278      uid = "Danger Mouse <dm@secret.example.net>"
1279
1280      dmfpr = "177B7C25DB99745EE2EE13ED026D2F19E99E63AA"
1281      key = c.get_key(dmfpr, secret = True)
1282      c.key_sign(key, uids = uid, expires_in = 2764800)
1283    #+end_src
1284
1285
1286 * Miscellaneous work-arounds
1287   :PROPERTIES:
1288   :CUSTOM_ID: cheats-and-hacks
1289   :END:
1290
1291
1292 ** Group lines
1293    :PROPERTIES:
1294    :CUSTOM_ID: group-lines
1295    :END:
1296
1297    There is not yet an easy way to access groups configured in the
1298    gpg.conf file from within GPGME.  As a consequence these central
1299    groupings of keys cannot be shared amongst multiple programs, such
1300    as MUAs readily.
1301
1302    The following code, however, provides a work-around for obtaining
1303    this information in Python.
1304
1305    #+begin_src python
1306      import subprocess
1307
1308      lines = subprocess.getoutput("gpgconf --list-options gpg").splitlines()
1309
1310      for i in range(len(lines)):
1311          if lines[i].startswith("group") is True:
1312              line = lines[i]
1313          else:
1314              pass
1315
1316      groups = line.split(":")[-1].replace('"', '').split(',')
1317
1318      group_lines = groups
1319      for i in range(len(group_lines)):
1320          group_lines[i] = group_lines[i].split("=")
1321
1322      group_lists = group_lines
1323      for i in range(len(group_lists)):
1324          group_lists[i][1] = group_lists[i][1].split()
1325    #+end_src
1326
1327    The result of that code is that =group_lines= is a list of lists
1328    where =group_lines[i][0]= is the name of the group and
1329    =group_lines[i][1]= is the key IDs of the group as a string.
1330
1331    The =group_lists= result is very similar in that it is a list of
1332    lists.  The first part, =group_lists[i][0]= matches
1333    =group_lines[i][0]= as the name of the group, but
1334    =group_lists[i][1]= is the key IDs of the group as a string.
1335
1336
1337 * Copyright and Licensing
1338   :PROPERTIES:
1339   :CUSTOM_ID: copyright-and-license
1340   :END:
1341
1342
1343 ** Copyright (C) The GnuPG Project, 2018
1344    :PROPERTIES:
1345    :CUSTOM_ID: copyright
1346    :END:
1347
1348    Copyright © The GnuPG Project, 2018.
1349
1350
1351 ** License GPL compatible
1352    :PROPERTIES:
1353    :CUSTOM_ID: license
1354    :END:
1355
1356    This file is free software; as a special exception the author gives
1357    unlimited permission to copy and/or distribute it, with or without
1358    modifications, as long as this notice is preserved.
1359
1360    This file is distributed in the hope that it will be useful, but
1361    WITHOUT ANY WARRANTY, to the extent permitted by law; without even
1362    the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
1363    PURPOSE.
1364
1365
1366 * Footnotes
1367
1368 [fn:1] =Short_History.org= and/or =Short_History.html=.
1369
1370 [fn:2] The =lang/python/docs/= directory in the GPGME source.
1371
1372 [fn:3] You probably don't really want to do this.  Searching the
1373 keyservers for "gnupg.org" produces over 400 results, the majority of
1374 which aren't actually at the gnupg.org domain, but just included a
1375 comment regarding the project in their key somewhere.