Metadata-Version: 2.0
Name: pywnedpasswords
Version: 0.6
Summary: Client for HIBP passwords api using K-Anonymity method
Home-page: http://github.com/xmatthias/pywnedpasswords
Author: Matthias Voppichler
Author-email: xmatthias@outlook.com
License: MIT
Project-URL: Source Code, http://github.com/xmatthias/pywnedpasswords
Description-Content-Type: UNKNOWN
Keywords: pwnedpasswords,passwords,pwned,security
Platform: UNKNOWN
Requires-Python: >=3
Requires-Dist: requests (>=2)


pywnedPasswords
===============


.. image:: https://travis-ci.org/xmatthias/pywnedpasswords.svg?branch=master
   :target: https://travis-ci.org/xmatthias/pywnedpasswords
   :alt: Build Status


This script uses the pwnedpasswords.com v2 api to check your password in
a secure way (using the `K-anonymity <https://en.wikipedia.org/wiki/K-anonymity>`_ method)

The full Hash is never transmitted over the wire, only the first 5 characters.
The comparison happens offline.

Special thanks to Troy Hunt (\ `@troyhunt <https://twitter.com/troyhunt>`_\ ) for making this script possible.

Installation
------------

.. code-block:: bash

   pip install pywnedpasswords

Usage
-----

Interactive
^^^^^^^^^^^

.. code-block:: bash

   pywnedpasswords

Insert your password when asked.

the output will either be:

..

   Password to check:

   Found your password 47205 times.


or in case your password is secure

..

   Password to check:

   Your password did not appear in PwnedPasswords yet.


Passing the password as a command line argument
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Discouraged - as it might leaves the password in your shell history**

.. code-block:: bash

   pywnedpasswords Passw0rd

..

   Found your password 46980 times.


Piping the password
^^^^^^^^^^^^^^^^^^^

**Discouraged - as it might leaves the password in your shell history**

.. code-block:: bash

   echo -n 'Passw0rd!' | pywnedpasswords

..

   Found your password 46980 times.


Reading passwords from a file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: bash

   pywnedpasswords -f list-of-passwords.txt

Result is in the form: ``<line number>: <number of time the password was found>``. ``0`` meaning the password is not known from Have I Been Pwned yet.

..

   .. raw:: html

      <pre>
      0: 7026
      1: 45337
      2: 376
      3: 51
      4: 27
      5: 11
      6: 136
      7: 1
      8: 6
      9: 1
      10: 0
      11: 0
      12: 0
      </pre>


Exit code
---------

The ``pywnedpasswords`` exits with code ``2`` if the password is know of Have I Been Pwned already, and exit code ``0`` otherwise.

© xmatthias 2018


