A Python wrapper for Troy Hunt's Pwned Passwords API.
Project description
pwnedpasswords
==============
Python Library and CLI for Troy Hunt’s pwnedpasswords’s API
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|Version| |Python Versions|
Features
--------
- [x] Command-line utility
- [x] Support for Python 3.5 and 3.6
- [ ] Python 2.7 support
- [ ] Tests
Installation
------------
pwnedpasswords is available for download through the Python Package
Index (PyPi). You can install it right away using pip.
.. code:: bash
pip install pwnedpasswords
Usage
-----
.. code:: python
import pwnedpasswords
password = pwnedpasswords.Password("testing 123")
pwnedpasswords will automatically check to see if your provided input
looks like a SHA-1 hash. If it looks like plain text, it’ll
automatically hash it before sending it to the Pwned Passwords API.
If you’d like to check an already hashed password *before* providing it
as input, set the ``plain_text`` parameter when initializing the
``Password`` object. There’s not much value to doing this, since
pwnedpasswords does this for your automatically, but it’s just a little
extra control in case you’re extra paranoid.
.. code:: python
password = pwnedpasswords.Password("b8dfb080bc33fb564249e34252bf143d88fc018f")
Likewise, if a password looks like a SHA-1 hash, but is actually a
user-provided password, set ``plain_text`` to ``True``.
.. code:: python
password = pwnedpasswords.Password("1231231231231231231231231231231231231231", plain_text=True)
check
~~~~~
This is the preferred method to call the Pwned Passwords API. By
default, the ``check`` method uses the
``https://api.pwnedpasswords.com/range/`` endpoint.
.. code:: python
password = pwnedpasswords.Password("username")
password.check()
# 8340
If you’d like to force pwnedpasswords to use the search endpoint instead
(https://api.pwnedpasswords.com/pwnedpassword/), set the ``anonymous``
parameter to ``False``.
.. code:: python
password = pwnedpasswords.Password("password")
password.check(anonymous=False)
# 3303003
You might want to do this if you’d prefer faster response times, and
aren’t that worried about leaking passwords you’re searching for over
the network.
Search
~~~~~~
If you just want to call the two endpoints manually, you can do that
too.
.. code:: python
password = pwnedpasswords.Password("testing 123")
password.search()
# outputs 1
CLI Usage
---------
pwnedpasswords comes bundled with a handy command-line utility for
checking passwords against the Pwned Passwords database.
.. code:: bash
$ pwnedpasswords 123456password
240
The output is simply the number of entries returned from the Pwned
Passwords database.
If you’d like to use the CLI in a script, pwnedpasswords returns an exit
code equal to the base-10 log of the result count, plus 1. If there are
no matches in the API, the exit status will be ``0``.
If you’d like to take a look under the hood to make sure things are
working as they should, set the ``--verbose`` flag.
.. code:: bash
$ pwnedpasswords 123456password --verbose
INFO:pwnedpasswords.pwnedpasswords:https://api.pwnedpasswords.com/range/5052C
INFO:pwnedpasswords.pwnedpasswords:Entry found
240
Support/Questions
-----------------
Please file an issue in GitHub if you run into any issues, or would like
to contribute. Thanks!
License
-------
Apache License, Version 2.0. See `LICENSE <https://github.com/lionheart/pwnedpasswords/blob/master/LICENSE>`__ for details.
.. raw:: html
<!-- Images -->
.. raw:: html
<!-- Links -->
.. |Version| image:: https://img.shields.io/pypi/v/pwnedpasswords.svg?style=flat
:target: https://github.com/lionheart/pwnedpasswords/blob/master/https://pypi.python.org/pypi/pwnedpasswords
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pwnedpasswords.svg?style=flat
:target: https://github.com/lionheart/pwnedpasswords/blob/master/https://pypi.python.org/pypi/pwnedpasswords
==============
Python Library and CLI for Troy Hunt’s pwnedpasswords’s API
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|Version| |Python Versions|
Features
--------
- [x] Command-line utility
- [x] Support for Python 3.5 and 3.6
- [ ] Python 2.7 support
- [ ] Tests
Installation
------------
pwnedpasswords is available for download through the Python Package
Index (PyPi). You can install it right away using pip.
.. code:: bash
pip install pwnedpasswords
Usage
-----
.. code:: python
import pwnedpasswords
password = pwnedpasswords.Password("testing 123")
pwnedpasswords will automatically check to see if your provided input
looks like a SHA-1 hash. If it looks like plain text, it’ll
automatically hash it before sending it to the Pwned Passwords API.
If you’d like to check an already hashed password *before* providing it
as input, set the ``plain_text`` parameter when initializing the
``Password`` object. There’s not much value to doing this, since
pwnedpasswords does this for your automatically, but it’s just a little
extra control in case you’re extra paranoid.
.. code:: python
password = pwnedpasswords.Password("b8dfb080bc33fb564249e34252bf143d88fc018f")
Likewise, if a password looks like a SHA-1 hash, but is actually a
user-provided password, set ``plain_text`` to ``True``.
.. code:: python
password = pwnedpasswords.Password("1231231231231231231231231231231231231231", plain_text=True)
check
~~~~~
This is the preferred method to call the Pwned Passwords API. By
default, the ``check`` method uses the
``https://api.pwnedpasswords.com/range/`` endpoint.
.. code:: python
password = pwnedpasswords.Password("username")
password.check()
# 8340
If you’d like to force pwnedpasswords to use the search endpoint instead
(https://api.pwnedpasswords.com/pwnedpassword/), set the ``anonymous``
parameter to ``False``.
.. code:: python
password = pwnedpasswords.Password("password")
password.check(anonymous=False)
# 3303003
You might want to do this if you’d prefer faster response times, and
aren’t that worried about leaking passwords you’re searching for over
the network.
Search
~~~~~~
If you just want to call the two endpoints manually, you can do that
too.
.. code:: python
password = pwnedpasswords.Password("testing 123")
password.search()
# outputs 1
CLI Usage
---------
pwnedpasswords comes bundled with a handy command-line utility for
checking passwords against the Pwned Passwords database.
.. code:: bash
$ pwnedpasswords 123456password
240
The output is simply the number of entries returned from the Pwned
Passwords database.
If you’d like to use the CLI in a script, pwnedpasswords returns an exit
code equal to the base-10 log of the result count, plus 1. If there are
no matches in the API, the exit status will be ``0``.
If you’d like to take a look under the hood to make sure things are
working as they should, set the ``--verbose`` flag.
.. code:: bash
$ pwnedpasswords 123456password --verbose
INFO:pwnedpasswords.pwnedpasswords:https://api.pwnedpasswords.com/range/5052C
INFO:pwnedpasswords.pwnedpasswords:Entry found
240
Support/Questions
-----------------
Please file an issue in GitHub if you run into any issues, or would like
to contribute. Thanks!
License
-------
Apache License, Version 2.0. See `LICENSE <https://github.com/lionheart/pwnedpasswords/blob/master/LICENSE>`__ for details.
.. raw:: html
<!-- Images -->
.. raw:: html
<!-- Links -->
.. |Version| image:: https://img.shields.io/pypi/v/pwnedpasswords.svg?style=flat
:target: https://github.com/lionheart/pwnedpasswords/blob/master/https://pypi.python.org/pypi/pwnedpasswords
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pwnedpasswords.svg?style=flat
:target: https://github.com/lionheart/pwnedpasswords/blob/master/https://pypi.python.org/pypi/pwnedpasswords
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for pwnedpasswords-0.1.10-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32fe477ed27a7088fe6468125b2a22891b7520539e5ab3f7421436ad74a43254 |
|
MD5 | 7c91dc9ea07e37664070de36ee73fde7 |
|
BLAKE2b-256 | 0ca353a25059c99b75f11669bc0f34f6b633b012e465873155c13ddd4cff0d02 |