docs python bindings howto
[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 the 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, add_encrypt_to=True)
541
542       with open("secret_plans.txt.asc", "wb") as afile:
543           afile.write(ciphertext)
544     #+end_src
545
546     If the =recipients= paramater is empty then the plaintext is
547     encrypted symmetrically.  If no =passphrase= is supplied as a
548     parameter or via a callback registered with the =Context()= then
549     an out-of-band prompt for the passphrase via pinentry will be
550     invoked.
551
552
553 *** Encrypting to multiple keys
554     :PROPERTIES:
555     :CUSTOM_ID: howto-basic-encryption-multiple
556     :END:
557
558     Encrypting to multiple keys essentially just expands upon the key
559     selection process and the recipients from the previous examples.
560
561     The following example encrypts a message (=text=) to everyone with
562     an email address on the =gnupg.org= domain,[fn:3] but does /not/ encrypt
563     to a default key or other key which is configured to normally
564     encrypt to.
565
566     #+begin_src python
567       import gpg
568
569       text = b"""Oh look, another test message.
570
571       The same rules apply as with the previous example and more likely
572       than not, the message will actually be drawn from reading the
573       contents of a file or, maybe, from entering data at an input()
574       prompt.
575
576       Since the text in this case must be bytes, it is most likely that
577       the input form will be a separate file which is opened with "rb"
578       as this is the simplest method of obtaining the correct data
579       format.
580       """
581
582       c = gpg.Context(armor=True)
583       rpattern = list(c.keylist(pattern="@gnupg.org", secret=False))
584       logrus = []
585
586       for i in range(len(rpattern)):
587           if rpattern[i].can_encrypt == 1:
588               logrus.append(rpattern[i])
589
590       ciphertext, result, sign_result = c.encrypt(text, recipients=logrus, sign=False,
591                                                   always_trust=True)
592
593       with open("secret_plans.txt.asc", "wb") as afile:
594           afile.write(ciphertext)
595     #+end_src
596
597     All it would take to change the above example to sign the message
598     and also encrypt the message to any configured default keys would
599     be to change the =c.encrypt= line to this:
600
601     #+begin_src python
602       ciphertext, result, sign_result = c.encrypt(text, recipients=logrus,
603                                                   always_trust=True,
604                                                   add_encrypt_to=True)
605     #+end_src
606
607     The only keyword arguments requiring modification are those for
608     which the default values are changing.  The default value of
609     =sign= is =True=, the default of =always_trust= is =False=, the
610     default of =add_encrypt_to= is =False=.
611
612     If =always_trust= is not set to =True= and any of the recipient
613     keys are not trusted (e.g. not signed or locally signed) then the
614     encryption will raise an error.  It is possible to mitigate this
615     somewhat with something more like this:
616
617     #+begin_src python
618       import gpg
619
620       with open("secret_plans.txt.asc", "rb") as afile:
621           text = afile.read()
622
623       c = gpg.Context(armor=True)
624       rpattern = list(c.keylist(pattern="@gnupg.org", secret=False))
625       logrus = []
626
627       for i in range(len(rpattern)):
628           if rpattern[i].can_encrypt == 1:
629               logrus.append(rpattern[i])
630
631       try:
632           ciphertext, result, sign_result = c.encrypt(text, recipients=logrus,
633                                                       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,
643                                                           add_encrypt_to=True)
644           except:
645               pass
646
647       with open("secret_plans.txt.asc", "wb") as afile:
648           afile.write(ciphertext)
649     #+end_src
650
651     This will attempt to encrypt to all the keys searched for, then
652     remove invalid recipients if it fails and try again.
653
654
655 ** Decryption
656    :PROPERTIES:
657    :CUSTOM_ID: howto-basic-decryption
658    :END:
659
660    Decrypting something encrypted to a key in one's secret keyring is
661    fairly straight forward.
662
663    In this example code, however, preconfiguring either
664    =gpg.Context()= or =gpg.core.Context()= as =c= is unnecessary
665    because there is no need to modify the Context prior to conducting
666    the decryption and since the Context is only used once, setting it
667    to =c= simply adds lines for no gain.
668
669    #+begin_src python
670      import gpg
671
672      ciphertext = input("Enter path and filename of encrypted file: ")
673      newfile = input("Enter path and filename of file to save decrypted data to: ")
674
675      with open(ciphertext, "rb") as cfile:
676          plaintext, result, verify_result = gpg.Context().decrypt(cfile)
677
678      with open(newfile, "wb") as nfile:
679          nfile.write(plaintext)
680    #+end_src
681
682    The data available in =plaintext= in this example is the decrypted
683    content as a byte object, the recipient key IDs and algorithms in
684    =result= and the results of verifying any signatures of the data in
685    =verify_result=.
686
687
688 ** Signing text and files
689    :PROPERTIES:
690    :CUSTOM_ID: howto-basic-signing
691    :END:
692
693    The following sections demonstrate how to specify keys to sign with.
694
695
696 *** Signing key selection
697     :PROPERTIES:
698     :CUSTOM_ID: howto-basic-signing-signers
699     :END:
700
701     By default GPGME and the Python bindings will use the default key
702     configured for the user invoking the GPGME API.  If there is no
703     default key specified and there is more than one secret key
704     available it may be necessary to specify the key or keys with
705     which to sign messages and files.
706
707     #+begin_src python
708       import gpg
709
710       logrus = input("Enter the email address or string to match signing keys to: ")
711       hancock = gpg.Context().keylist(pattern=logrus, secret=True)
712       sig_src = list(hancock)
713     #+end_src
714
715     The signing examples in the following sections include the
716     explicitly designated =signers= parameter in two of the five
717     examples; once where the resulting signature would be ASCII
718     armoured and once where it would not be armoured.
719
720     While it would be possible to enter a key ID or fingerprint here
721     to match a specific key, it is not possible to enter two
722     fingerprints and match two keys since the patten expects a string,
723     bytes or None and not a list.  A string with two fingerprints
724     won't match any single key.
725
726
727 *** Normal or default signing messages or files
728     :PROPERTIES:
729     :CUSTOM_ID: howto-basic-signing-normal
730     :END:
731
732     The normal or default signing process is essentially the same as
733     is most often invoked when also encrypting a message or file.  So
734     when the encryption component is not utilised, the result is to
735     produce an encoded and signed output which may or may not be ASCII
736     armoured and which may or may not also be compressed.
737
738     By default compression will be used unless GnuPG detects that the
739     plaintext is already compressed.  ASCII armouring will be
740     determined according to the value of =gpg.Context().armor=.
741
742     The compression algorithm is selected in much the same way as the
743     symmetric encryption algorithm or the hash digest algorithm is
744     when multiple keys are involved; from the preferences saved into
745     the key itself or by comparison with the preferences with all
746     other keys involved.
747
748    #+begin_src python
749      import gpg
750
751      text0 = """Declaration of ... something.
752
753      """
754      text = text0.encode()
755
756      c = gpg.Context(armor=True, signers=sig_src)
757      signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.NORMAL)
758
759      with open("/path/to/statement.txt.asc", "w") as afile:
760          afile.write(signed_data.decode())
761    #+end_src
762
763    Though everything in this example is accurate, it is more likely
764    that reading the input data from another file and writing the
765    result to a new file will be performed more like the way it is done
766    in the next example.  Even if the output format is ASCII armoured.
767
768    #+begin_src python
769      import gpg
770
771      with open("/path/to/statement.txt", "rb") as tfile:
772          text = tfile.read()
773
774      c = gpg.Context()
775      signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.NORMAL)
776
777      with open("/path/to/statement.txt.sig", "wb") as afile:
778          afile.write(signed_data)
779    #+end_src
780
781
782 *** Detached signing messages and files
783     :PROPERTIES:
784     :CUSTOM_ID: howto-basic-signing-detached
785     :END:
786
787     Detached signatures will often be needed in programmatic uses of
788     GPGME, either for signing files (e.g. tarballs of code releases)
789     or as a component of message signing (e.g. PGP/MIME encoded
790     email).
791
792     #+begin_src python
793       import gpg
794
795       text0 = """Declaration of ... something.
796
797       """
798       text = text0.encode()
799
800       c = gpg.Context(armor=True)
801       signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.DETACH)
802
803       with open("/path/to/statement.txt.asc", "w") as afile:
804           afile.write(signed_data.decode())
805     #+end_src
806
807     As with normal signatures, detached signatures are best handled as
808     byte literals, even when the output is ASCII armoured.
809
810     #+begin_src python
811       import gpg
812
813       with open("/path/to/statement.txt", "rb") as tfile:
814           text = tfile.read()
815
816       c = gpg.Context(signers=sig_src)
817       signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.DETACH)
818
819       with open("/path/to/statement.txt.sig", "wb") as afile:
820           afile.write(signed_data)
821     #+end_src
822
823
824 *** Clearsigning messages or text
825     :PROPERTIES:
826     :CUSTOM_ID: howto-basic-signing-clear
827     :END:
828
829     Though PGP/in-line messages are no longer encouraged in favour of
830     PGP/MIME, there is still sometimes value in utilising in-line
831     signatures.  This is where clear-signed messages or text is of
832     value.
833
834     #+begin_src python
835       import gpg
836
837       text0 = """Declaration of ... something.
838
839       """
840       text = text0.encode()
841
842       c = gpg.Context()
843       signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.CLEAR)
844
845       with open("/path/to/statement.txt.asc", "w") as afile:
846           afile.write(signed_data.decode())
847     #+end_src
848
849     In spite of the appearance of a clear-signed message, the data
850     handled by GPGME in signing it must still be byte literals.
851
852     #+begin_src python
853       import gpg
854
855       with open("/path/to/statement.txt", "rb") as tfile:
856           text = tfile.read()
857
858       c = gpg.Context()
859       signed_data, result = c.sign(text, mode=gpg.constants.sig.mode.CLEAR)
860
861       with open("/path/to/statement.txt.asc", "wb") as afile:
862           afile.write(signed_data)
863     #+end_src
864
865
866 ** Signature verification
867    :PROPERTIES:
868    :CUSTOM_ID: howto-basic-verification
869    :END:
870
871    Essentially there are two principal methods of verification of a
872    signature.  The first of these is for use with the normal or
873    default signing method and for clear-signed messages.  The second is
874    for use with files and data with detached signatures.
875
876    The following example is intended for use with the default signing
877    method where the file was not ASCII armoured:
878
879    #+begin_src python
880      import gpg
881      import time
882
883      filename = "statement.txt"
884      gpg_file = "statement.txt.gpg"
885
886      c = gpg.Context()
887
888      try:
889          data, result = c.verify(open(gpg_file))
890          verified = True
891      except gpg.errors.BadSignatures as e:
892          verified = False
893          print(e)
894
895      if verified is True:
896          for i in range(len(result.signatures)):
897              sign = result.signatures[i]
898              print("""Good signature from:
899      {0}
900      with key {1}
901      made at {2}
902      """.format(c.get_key(sign.fpr).uids[0].uid,
903                 sign.fpr, time.ctime(sign.timestamp)))
904      else:
905          pass
906    #+end_src
907
908    Whereas this next example, which is almost identical would work
909    with normal ASCII armoured files and with clear-signed files:
910
911    #+begin_src python
912      import gpg
913      import time
914
915      filename = "statement.txt"
916      asc_file = "statement.txt.asc"
917
918      c = gpg.Context()
919
920      try:
921          data, result = c.verify(open(asc_file))
922          verified = True
923      except gpg.errors.BadSignatures as e:
924          verified = False
925          print(e)
926
927      if verified is True:
928          for i in range(len(result.signatures)):
929              sign = result.signatures[i]
930              print("""Good signature from:
931      {0}
932      with key {1}
933      made at {2}
934      """.format(c.get_key(sign.fpr).uids[0].uid,
935                 sign.fpr, time.ctime(sign.timestamp)))
936      else:
937          pass
938    #+end_src
939
940    In both of the previous examples it is also possible to compare the
941    original data that was signed against the signed data in =data= to
942    see if it matches with something like this:
943
944    #+begin_src python
945      with open(filename, "rb") as afile:
946          text = afile.read()
947
948      if text == data:
949          print("Good signature.")
950      else:
951          pass
952    #+end_src
953
954    The following two examples, however, deal with detached signatures.
955    With his method of verification the data that was signed does not
956    get returned since it is already being explicitly referenced in the
957    first argument of =c.verify=.  So =data= is =None= and only the
958    information in =result= is available.
959
960    #+begin_src python
961      import gpg
962      import time
963
964      filename = "statement.txt"
965      sig_file = "statement.txt.sig"
966
967      c = gpg.Context()
968
969      try:
970          data, result = c.verify(open(filename), open(sig_file))
971          verified = True
972      except gpg.errors.BadSignatures as e:
973          verified = False
974          print(e)
975
976      if verified is True:
977          for i in range(len(result.signatures)):
978              sign = result.signatures[i]
979              print("""Good signature from:
980      {0}
981      with key {1}
982      made at {2}
983      """.format(c.get_key(sign.fpr).uids[0].uid,
984                 sign.fpr, time.ctime(sign.timestamp)))
985      else:
986          pass
987    #+end_src
988
989    #+begin_src python
990      import gpg
991      import time
992
993      filename = "statement.txt"
994      asc_file = "statement.txt.asc"
995
996      c = gpg.Context()
997
998      try:
999          data, result = c.verify(open(filename), open(asc_file))
1000          verified = True
1001      except gpg.errors.BadSignatures as e:
1002          verified = False
1003          print(e)
1004
1005      if verified is not None:
1006          for i in range(len(result.signatures)):
1007              sign = result.signatures[i]
1008              print("""Good signature from:
1009      {0}
1010      with key {1}
1011      made at {2}
1012      """.format(c.get_key(sign.fpr).uids[0].uid,
1013                 sign.fpr, time.ctime(sign.timestamp)))
1014      else:
1015          pass
1016    #+end_src
1017
1018
1019 * Creating keys and subkeys
1020   :PROPERTIES:
1021   :CUSTOM_ID: key-generation
1022   :END:
1023
1024   The one thing, aside from GnuPG itself, that GPGME depends on, of
1025   course, is the keys themselves.  So it is necessary to be able to
1026   generate them and modify them by adding subkeys, revoking or
1027   disabling them, sometimes deleting them and doing the same for user
1028   IDs.
1029
1030   In the following examples a key will be created for the world's
1031   greatest secret agent, Danger Mouse.  Since Danger Mouse is a secret
1032   agent he needs to be able to protect information to =SECRET= level
1033   clearance, so his keys will be 3072-bit keys.
1034
1035   The pre-configured =gpg.conf= file which sets cipher, digest and
1036   other preferences contains the following configuration parameters:
1037
1038   #+begin_src conf
1039     expert
1040     allow-freeform-uid
1041     allow-secret-key-import
1042     trust-model tofu+pgp
1043     tofu-default-policy unknown
1044     enable-large-rsa
1045     enable-dsa2
1046     # cert-digest-algo SHA256
1047     cert-digest-algo SHA512
1048     default-preference-list TWOFISH CAMELLIA256 AES256 CAMELLIA192 AES192 CAMELLIA128 AES BLOWFISH IDEA CAST5 3DES SHA512 SHA384 SHA256 SHA224 RIPEMD160 SHA1 ZLIB BZIP2 ZIP Uncompressed
1049     personal-cipher-preferences TWOFISH CAMELLIA256 AES256 CAMELLIA192 AES192 CAMELLIA128 AES BLOWFISH IDEA CAST5 3DES
1050     personal-digest-preferences SHA512 SHA384 SHA256 SHA224 RIPEMD160 SHA1
1051     personal-compress-preferences ZLIB BZIP2 ZIP Uncompressed
1052   #+end_src
1053
1054
1055 ** Primary key
1056    :PROPERTIES:
1057    :CUSTOM_ID: keygen-primary
1058    :END:
1059
1060    Generating a primary key uses the =create_key= method in a Context.
1061    It contains multiple arguments and keyword arguments, including:
1062    =userid=, =algorithm=, =expires_in=, =expires=, =sign=, =encrypt=,
1063    =certify=, =authenticate=, =passphrase= and =force=.  The defaults
1064    for all of those except =userid=, =algorithm=, =expires_in=,
1065    =expires= and =passphrase= is =False=.  The defaults for
1066    =algorithm= and =passphrase= is =None=.  The default for
1067    =expires_in= is =0=.  The default for =expires= is =True=.  There
1068    is no default for =userid=.
1069
1070    If =passphrase= is left as =None= then the key will not be
1071    generated with a passphrase, if =passphrase= is set to a string
1072    then that will be the passphrase and if =passphrase= is set to
1073    =True= then gpg-agent will launch pinentry to prompt for a
1074    passphrase.  For the sake of convenience, these examples will keep
1075    =passphrase= set to =None=.
1076
1077    #+begin_src python
1078      import gpg
1079
1080      c = gpg.Context()
1081
1082      c.home_dir = "~/.gnupg-dm"
1083      userid = "Danger Mouse <dm@secret.example.net>"
1084
1085      dmkey = c.create_key(userid, algorithm="rsa3072", expires_in=31536000,
1086                           sign=True, certify=True)
1087    #+end_src
1088
1089    One thing to note here is the use of setting the =c.home_dir=
1090    parameter.  This enables generating the key or keys in a different
1091    location.  In this case to keep the new key data created for this
1092    example in a separate location rather than adding it to existing
1093    and active key store data.  As with the default directory,
1094    =~/.gnupg=, any temporary or separate directory needs the
1095    permissions set to only permit access by the directory owner.  On
1096    posix systems this means setting the directory permissions to 700.
1097
1098    The =temp-homedir-config.py= script in the HOWTO examples directory
1099    will create an alternative homedir with these configuration options
1100    already set and the correct directory and file permissions.
1101
1102    The successful generation of the key can be confirmed via the
1103    returned =GenkeyResult= object, which includes the following data:
1104
1105    #+begin_src python
1106      print("""
1107      Fingerprint:  {0}
1108      Primary Key:  {1}
1109       Public Key:  {2}
1110       Secret Key:  {3}
1111          Sub Key:  {4}
1112         User IDs:  {5}
1113      """.format(dmkey.fpr, dmkey.primary, dmkey.pubkey, dmkey.seckey, dmkey.sub,
1114                 dmkey.uid))
1115    #+end_src
1116
1117    Alternatively the information can be confirmed using the command
1118    line program:
1119
1120    #+begin_src shell
1121      bash-4.4$ gpg --homedir ~/.gnupg-dm -K
1122      ~/.gnupg-dm/pubring.kbx
1123      ----------------------
1124      sec   rsa3072 2018-03-15 [SC] [expires: 2019-03-15]
1125            177B7C25DB99745EE2EE13ED026D2F19E99E63AA
1126      uid           [ultimate] Danger Mouse <dm@secret.example.net>
1127
1128      bash-4.4$
1129    #+end_src
1130
1131    As with generating keys manually, to preconfigure expanded
1132    preferences for the cipher, digest and compression algorithms, the
1133    =gpg.conf= file must contain those details in the home directory in
1134    which the new key is being generated.  I used a cut down version of
1135    my own =gpg.conf= file in order to be able to generate this:
1136
1137    #+begin_src shell
1138      bash-4.4$ gpg --homedir ~/.gnupg-dm --edit-key 177B7C25DB99745EE2EE13ED026D2F19E99E63AA showpref quit
1139      Secret key is available.
1140
1141      sec  rsa3072/026D2F19E99E63AA
1142           created: 2018-03-15  expires: 2019-03-15  usage: SC
1143           trust: ultimate      validity: ultimate
1144      [ultimate] (1). Danger Mouse <dm@secret.example.net>
1145
1146      [ultimate] (1). Danger Mouse <dm@secret.example.net>
1147           Cipher: TWOFISH, CAMELLIA256, AES256, CAMELLIA192, AES192, CAMELLIA128, AES, BLOWFISH, IDEA, CAST5, 3DES
1148           Digest: SHA512, SHA384, SHA256, SHA224, RIPEMD160, SHA1
1149           Compression: ZLIB, BZIP2, ZIP, Uncompressed
1150           Features: MDC, Keyserver no-modify
1151
1152      bash-4.4$
1153    #+end_src
1154
1155
1156 ** Subkeys
1157    :PROPERTIES:
1158    :CUSTOM_ID: keygen-subkeys
1159    :END:
1160
1161    Adding subkeys to a primary key is fairly similar to creating the
1162    primary key with the =create_subkey= method.  Most of the arguments
1163    are the same, but not quite all.  Instead of the =userid= argument
1164    there is now a =key= argument for selecting which primary key to
1165    add the subkey to.
1166
1167    In the following example an encryption subkey will be added to the
1168    primary key.  Since Danger Mouse is a security conscious secret
1169    agent, this subkey will only be valid for about six months, half
1170    the length of the primary key.
1171
1172    #+begin_src python
1173      import gpg
1174
1175      c = gpg.Context()
1176      c.home_dir = "~/.gnupg-dm"
1177
1178      key = c.get_key(dmkey.fpr, secret=True)
1179      dmsub = c.create_subkey(key, algorithm="rsa3072", expires_in=15768000,
1180                              encrypt=True)
1181    #+end_src
1182
1183    As with the primary key, the results here can be checked with:
1184
1185    #+begin_src python
1186      print("""
1187      Fingerprint:  {0}
1188      Primary Key:  {1}
1189       Public Key:  {2}
1190       Secret Key:  {3}
1191          Sub Key:  {4}
1192         User IDs:  {5}
1193      """.format(dmsub.fpr, dmsub.primary, dmsub.pubkey, dmsub.seckey, dmsub.sub,
1194                 dmsub.uid))
1195    #+end_src
1196
1197    As well as on the command line with:
1198
1199    #+begin_src shell
1200      bash-4.4$ gpg --homedir ~/.gnupg-dm -K
1201      ~/.gnupg-dm/pubring.kbx
1202      ----------------------
1203      sec   rsa3072 2018-03-15 [SC] [expires: 2019-03-15]
1204            177B7C25DB99745EE2EE13ED026D2F19E99E63AA
1205      uid           [ultimate] Danger Mouse <dm@secret.example.net>
1206      ssb   rsa3072 2018-03-15 [E] [expires: 2018-09-13]
1207
1208      bash-4.4$
1209    #+end_src
1210
1211
1212 ** User IDs
1213    :PROPERTIES:
1214    :CUSTOM_ID: keygen-uids
1215    :END:
1216
1217    By comparison to creating primary keys and subkeys, adding a new
1218    user ID to an existing key is much simpler.  The method used to do
1219    this is =key_add_uid= and the only arguments it takes are for the
1220    =key= and the new =uid=.
1221
1222    #+begin_src python
1223      import gpg
1224
1225      c = gpg.Context()
1226      c.home_dir = "~/.gnupg-dm"
1227
1228      dmfpr = "177B7C25DB99745EE2EE13ED026D2F19E99E63AA"
1229      key = c.get_key(dmfpr, secret=True)
1230      uid = "Danger Mouse <danger.mouse@secret.example.net>"
1231
1232      c.key_add_uid(key, uid)
1233    #+end_src
1234
1235    Unsurprisingly the result of this is:
1236
1237    #+begin_src shell
1238      bash-4.4$ gpg --homedir ~/.gnupg-dm -K
1239      ~/.gnupg-dm/pubring.kbx
1240      ----------------------
1241      sec   rsa3072 2018-03-15 [SC] [expires: 2019-03-15]
1242            177B7C25DB99745EE2EE13ED026D2F19E99E63AA
1243      uid           [ultimate] Danger Mouse <danger.mouse@secret.example.net>
1244      uid           [ultimate] Danger Mouse <dm@secret.example.net>
1245      ssb   rsa3072 2018-03-15 [E] [expires: 2018-09-13]
1246
1247      bash-4.4$
1248    #+end_src
1249
1250
1251 ** Key certification
1252    :PROPERTIES:
1253    :CUSTOM_ID: key-sign
1254    :END:
1255
1256    Since key certification is more frequently referred to as key
1257    signing, the method used to perform this function is =key_sign=.
1258
1259    The =key_sign= method takes four arguments: =key=, =uids=,
1260    =expires_in= and =local=.  The default value of =uids= is =None=
1261    and which results in all user IDs being selected.  The default
1262    values of =expires_in= snd =local= is =False=; which result in the
1263    signature never expiring and being able to be exported.
1264
1265    The =key= is the key being signed rather than the key doing the
1266    signing.  To change the key doing the signing refer to the signing
1267    key selection above for signing messages and files.
1268
1269    If the =uids= value is not =None= then it must either be a string
1270    to match a single user ID or a list of strings to match multiple
1271    user IDs.  In this case the matching of those strings must be
1272    precise and it is case sensitive.
1273
1274    To sign Danger Mouse's key for just the initial user ID with a
1275    signature which will last a little over a month, do this:
1276
1277    #+begin_src python
1278      import gpg
1279
1280      c = gpg.Context()
1281      uid = "Danger Mouse <dm@secret.example.net>"
1282
1283      dmfpr = "177B7C25DB99745EE2EE13ED026D2F19E99E63AA"
1284      key = c.get_key(dmfpr, secret=True)
1285      c.key_sign(key, uids=uid, expires_in=2764800)
1286    #+end_src
1287
1288
1289 * Miscellaneous work-arounds
1290   :PROPERTIES:
1291   :CUSTOM_ID: cheats-and-hacks
1292   :END:
1293
1294
1295 ** Group lines
1296    :PROPERTIES:
1297    :CUSTOM_ID: group-lines
1298    :END:
1299
1300    There is not yet an easy way to access groups configured in the
1301    gpg.conf file from within GPGME.  As a consequence these central
1302    groupings of keys cannot be shared amongst multiple programs, such
1303    as MUAs readily.
1304
1305    The following code, however, provides a work-around for obtaining
1306    this information in Python.
1307
1308    #+begin_src python
1309      import subprocess
1310
1311      lines = subprocess.getoutput("gpgconf --list-options gpg").splitlines()
1312
1313      for i in range(len(lines)):
1314          if lines[i].startswith("group") is True:
1315              line = lines[i]
1316          else:
1317              pass
1318
1319      groups = line.split(":")[-1].replace('"', '').split(',')
1320
1321      group_lines = groups
1322      for i in range(len(group_lines)):
1323          group_lines[i] = group_lines[i].split("=")
1324
1325      group_lists = group_lines
1326      for i in range(len(group_lists)):
1327          group_lists[i][1] = group_lists[i][1].split()
1328    #+end_src
1329
1330    The result of that code is that =group_lines= is a list of lists
1331    where =group_lines[i][0]= is the name of the group and
1332    =group_lines[i][1]= is the key IDs of the group as a string.
1333
1334    The =group_lists= result is very similar in that it is a list of
1335    lists.  The first part, =group_lists[i][0]= matches
1336    =group_lines[i][0]= as the name of the group, but
1337    =group_lists[i][1]= is the key IDs of the group as a string.
1338
1339
1340 * Copyright and Licensing
1341   :PROPERTIES:
1342   :CUSTOM_ID: copyright-and-license
1343   :END:
1344
1345
1346 ** Copyright (C) The GnuPG Project, 2018
1347    :PROPERTIES:
1348    :CUSTOM_ID: copyright
1349    :END:
1350
1351    Copyright © The GnuPG Project, 2018.
1352
1353
1354 ** License GPL compatible
1355    :PROPERTIES:
1356    :CUSTOM_ID: license
1357    :END:
1358
1359    This file is free software; as a special exception the author gives
1360    unlimited permission to copy and/or distribute it, with or without
1361    modifications, as long as this notice is preserved.
1362
1363    This file is distributed in the hope that it will be useful, but
1364    WITHOUT ANY WARRANTY, to the extent permitted by law; without even
1365    the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
1366    PURPOSE.
1367
1368
1369 * Footnotes
1370
1371 [fn:1] =Short_History.org= and/or =Short_History.html=.
1372
1373 [fn:2] The =lang/python/docs/= directory in the GPGME source.
1374
1375 [fn:3] You probably don't really want to do this.  Searching the
1376 keyservers for "gnupg.org" produces over 400 results, the majority of
1377 which aren't actually at the gnupg.org domain, but just included a
1378 comment regarding the project in their key somewhere.