gpgme/lang/python/docs/dita/howto/part03/key-selection.dita
Ben McGinnes f0063afa71 docs: python bindings HOWTO - DITA XML version
* Due to the org-babel bug which breaks Python source code examples
  beyond the most simple snippets, ported the HOWTO to a source format
  which I *know* for sure won't break it.
* Details of the org-mode bug is in https://dev.gnupg.org/T3977
* DITA project uses DITA-OT 2.x (2.4 or 2.5, IIRC) with support for DITA 1.3.
* source files were written with oXygenXML Editor 20.0, hence the
  oXygenXML project file in the directory; however only the .ditamap
  and .dita files are required to generate any output with the
  DITA-OT.

Signed-off-by: Ben McGinnes <ben@adversary.org>
2018-05-15 13:13:16 +10:00

54 lines
2.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<topic id="topic_flg_p3y_5db">
<title>Key Selection</title>
<body>
<p>Selecting keys to encrypt to or to sign with will be a common occurrence when working with
GPGMe and the means available for doing so are quite simple.</p>
<p>They do depend on utilising a Context; however once the data is recorded in another
variable, that Context does not need to be the same one which subsequent operations are
performed.</p>
<p>The easiest way to select a specific key is by searching for that key's key ID or
fingerprint, preferably the full fingerprint without any spaces in it. A long key ID will
probably be okay, but is not advised and short key IDs are already a problem with some being
generated to match specific patterns. It does not matter whether the pattern is upper or
lower case.</p>
<p>So this is the best method:</p>
<p>
<codeblock id="keysel-01" outputclass="language-python">import gpg
k = gpg.Context().keylist(pattern="258E88DCBD3CD44D8E7AB43F6ECB6AF0DEADBEEF")
keys = list(k)
</codeblock>
</p>
<p>This is passable and very likely to be common:</p>
<p>
<codeblock id="keysel-02" outputclass="language-python">import gpg
k = gpg.Context().keylist(pattern="0x6ECB6AF0DEADBEEF")
keys = list(k)
</codeblock>
</p>
<p>And this is a really bad idea:</p>
<p>
<codeblock id="keysel-03" outputclass="language-python">import gpg
k = gpg.Context().keylist(pattern="0xDEADBEEF")
keys = list(k)
</codeblock>
</p>
<p>Alternatively it may be that the intention is to create a list of keys which all match a
particular search string. For instance all the addresses at a particular domain, like
this:</p>
<p>
<codeblock id="keysel-04" outputclass="language-python">import gpg
ncsc = gpg.Context().keylist(pattern="ncsc.mil")
nsa = list(ncsc)
</codeblock>
</p>
</body>
</topic>
</dita>