Tiny-gnupg

=========================


Minor Changes
-------------

- Fixed inaccuracies & mess-ups in the tests. Added tests for parsing
some legacy keys' packets with ``raw_packets()``.


Major Changes
-------------

- Bug in the packet parser has been patched which did not correctly
handle or recognize some legacy key packet types. This patch widens
the pool of compatible OpenPGP versions.

=========================


Minor Changes
-------------

- Removed coverage.py html results. They are too big, & reveal device
specific information.

=========================


Minor Changes
-------------

- Various code cleanups.
- Added to test cases for auto fetch methods & packet parsing.
- Documentation improvements: ``README.rst`` edits. ``CHANGES.rst``
Known Issues moved to its own section at the top. Docstrings now
indicate code args & kwargs in restructured text, double tick
format.
- Added ``use-agent`` back into the gpg2.conf file to help gnupg to not
open the system pinentry window. This may have implications for
anonymity since multiple instances runnning on a user machine will
be able to use the same agent to decrypt message's, even if the
decrypting instance wasn't the **intended** recipient. This may be
removed again. A factor in this decision is that, it's not clear
whether removing it or adding ``no-use-agent`` would even `have an impact`_
on the gpg-agent's decisions.
- ``_session``, ``_connector``, ``session`` & ``connector`` contructors
were renamed to title case, since they are class references or are
class factories. They are now named ``_Session``, ``_Connector``,
``Session`` & ``Connector``.
- Added some functionality to ``setup.py`` so that the ``long_description``
on PyPI which displays both ``README.rst`` & ``CHANGES.rst``, will
also be displayed on github through a combined ``README.rst`` file.
The old ``README.rst`` is now renamed ``PREADME.rst``.

.. _have an impact: https://stackoverflow.com/questions/47273922/purpose-of-gpg-agent-in-gpg2


Major Changes
-------------

- 100% test coverage!
- Fixed bug in ``raw_packets()`` which did not return the packet
information when gnupg throws a "no private key" error. Now the
packet information is passed in the ``output`` attribute of the
``KeyError`` exception up to ``packet_fingerprint()`` and
``list_packets()``. If another cause is determined for the error, then
``CalledProcessError`` is raised instead.
- ``packet_fingerprint()`` now returns a 16 byte key ID when parsing
packets of encrypted messages which would throw a gnupg "no private
key" error. The longer 40 byte fingerprint is not available in the
plaintext packets.
- New ``list_packets()`` method added to handle the error scraping of
``raw_packets()`` & return the ``target``'s metadata information in
a more readable format.
- Fixed bug in ``format_list_keys()`` which did not properly parse
``raw_list_keys(secret=False)`` when ``secret`` was toggled to ``True``
to display secret keys. The bug would cause the program to falsely
show that only one secret key exists in the package keyring,
irrespective of how many secret keys were actually there.
- Added a second round of fingerprint finding in ``decrypt()`` and
``verify()`` to try at returning more accurate results to callers and
in the raised exception's ``value`` attribute used by ``auto_decrypt()``
& ``auto_verify()``.

=========================


Minor Changes
-------------

- Fixed typos across the code.
- Added to test cases.
- Documentation improvements. ``CHANGES.md`` has been converted to
``CHANGES.rst`` for easy integration into ``README.rst`` and
``long_description`` of ``setup.py``.
- ``README.rst`` tutorial expanded.
- Condensed command constructions in ``set_base_command()`` and
``gen_key()`` by reducing redundancy.
- Fixed ``delete()`` method's print noisy output when called on a key
which doesn't have a secret key in the package's keyring.


Major Changes
-------------

- Added a ``secret`` kwarg to ``list_keys()`` method which is a boolean
toogle between viewing keys with public keys & viewing keys with
secret keys.
- Added a reference to the asyncio.get_event_loop().run_until_complete
function in the package. It is now importable with
``from tiny_gnupg import run`` or ``from tiny_gnupg import *``. It
was present in all of the tutorials, & since we haven’t decided to
go either all async or sync yet, it’s a nice helper.
- Added ``raw_packets(target="")`` method which takes in OpenPGP data,
like a message or key, & outputs the raw terminal output of the
``--list-packets`` option. Displays very detailed information of all
the OpenPGP metadata on ``target``.
- Added ``packet_fingerprint(target="")`` method which returns the
issuer fingerprint scraped off of the metadata returned from
``raw_packets(target)``. This is a very effective way to retrieve
uid information from OpenPGP signatures, messages & keys to
determine beforehand whether the associated sender's key is or isn't
already in the package's keyring.

=========================


Minor Changes
-------------

- Fixed typos across the code.
- Added to test cases.
- Added tests explanation in ``test_tiny_gnupg.py``.
- Documentation improvements.


Major Changes
-------------

- Added exception hooks to ``decrypt()`` & ``verify()`` methods. They
now raise ``KeyError`` when the OpenPGP data they’re verifying
require a signing key that’s not in the package’s keyring. The
fingerprint of the required key is printed out & stored in the
``value`` attribute of the raised exception.
- Added new ``auto_decrypt()`` & ``auto_verify()`` async methods
which catch the new exception hooks to automatically try a torified
keyserver lookup before raising a KeyError exception. If a key is
found, it’s downloaded & an attempt is made to verify the data.

=========================


Minor Changes
-------------

- Added to test cases.
- Changed the project long description in the ``README.rst``.
- Added docstrings to all the methods in the ``GnuPG`` class, & the
class itself.


Major Changes
-------------

- Turned off options in gpg2.conf ``require-cross-certification`` and
``no-comment`` because one or both may be causing a bug where using
private keys raises an “unusable private key” error.