jugmac00 / hibpcli Goto Github PK

View Code? Open in Web Editor NEW

8.0 8.0 3.0 112 KB

A Python CLI application to access the API of haveibeenpwned.com

License: MIT License

Python 100.00%

hacktoberfest

hibpcli's People

Contributors

Stargazers

Watchers

Forkers

donhege harryet admdev8 denvera

hibpcli's Issues

Introduce "black" code formatter

In order to not have to think about code formatting, the black code formatter should be used for all Python code, cf https://github.com/ambv/black

coverage report seems to be broken

upstream error: wrong password triggers ValueError instead CredentialsError

see libkeepass/pykeepass#244

This has been fixed upstream, but not released yet -> cannot use PyKeePass 4.0.0

Create a dedicated CHANGELOG.md

extract "release history" from README.md
introduce a "unreleased" section at the top of the new CHANGELOG.md
introduce sub headings like
-- added
-- changed
-- fixed

Make use of pyflakes incl. click linter

https://pypi.org/project/flake8-click/

make a new release

Enable single password testing

One should be able to check single password against the hibp API for being leaked or not.

Also see #17 for more information about the new interface.

Update outdated packages.

The newly introduced requires.io badge shows that some packages are outdated.

move flake8 from tox to pre-commit

... and run pre-commit via tox.

Travis integration seems to be broken

Travis builds do no longer show up on the pr page.

Introduce coverage via travis

Do not show password in prompt

mypy error since release of the new `click` version

tox: mypy
  mypy run-test-pre: PYTHONHASHSEED='3025488449'
  mypy run-test: commands[0] | mypy --strict src
  src/hibpcli/cli.py:10: error: Module has no attribute "group"; maybe "Group"?
  src/hibpcli/cli.py:10: error: Untyped decorator makes function "main" untyped
  src/hibpcli/cli.py:16: error: Module has no attribute "command"; maybe "Command"?
  src/hibpcli/cli.py:16: error: Untyped decorator makes function "check_keepass" untyped
  src/hibpcli/cli.py:17: error: Module has no attribute "argument"; maybe "Argument"?
  src/hibpcli/cli.py:17: error: Untyped decorator makes function "check_keepass" untyped
  src/hibpcli/cli.py:18: error: Module has no attribute "option"; maybe "Option"?
  src/hibpcli/cli.py:18: error: Untyped decorator makes function "check_keepass" untyped
  src/hibpcli/cli.py:22: error: Module has no attribute "prompt"
  src/hibpcli/cli.py:28: error: Module has no attribute "echo"; maybe "secho"?
  src/hibpcli/cli.py:30: error: Module has no attribute "echo"; maybe "secho"?
  src/hibpcli/cli.py:33: error: Module has no attribute "echo"; maybe "secho"?
  src/hibpcli/cli.py:34: error: Module has no attribute "echo"; maybe "secho"?
  src/hibpcli/cli.py:36: error: Module has no attribute "echo"; maybe "secho"?
  src/hibpcli/cli.py:39: error: Module has no attribute "command"; maybe "Command"?
  src/hibpcli/cli.py:39: error: Untyped decorator makes function "check_password" untyped
  src/hibpcli/cli.py:40: error: Module has no attribute "option"; maybe "Option"?
  src/hibpcli/cli.py:40: error: Untyped decorator makes function "check_password" untyped
  src/hibpcli/cli.py:44: error: Module has no attribute "prompt"
  src/hibpcli/cli.py:51: error: Module has no attribute "echo"; maybe "secho"?
  src/hibpcli/cli.py:54: error: Module has no attribute "echo"; maybe "secho"?
  src/hibpcli/cli.py:56: error: Module has no attribute "echo"; maybe "secho"?
  Found 22 errors in 1 file (checked 5 source files)
  ERROR: InvocationError for command /home/runner/work/hibpcli/hibpcli/.tox/mypy/bin/mypy --strict src (exited with code 1)

Catch file system errors

current behaviour
When the user enters a wrong path, a nasty traceback is returned to the user.

wished behaviour
When the user enters a wrong path, a decent error message is returned.

bonus
The user gets another prompt and has a chance to enter a correct path, again.

Test cli.py

cli.py makes use of the click framework, and thus it is a bit harder to test it.

Fortunately, click supports testing.

There is some documenation how to test a click application at
https://click.palletsprojects.com/en/7.x/testing/

An open stream object is being garbage collected; call "stream.close()" explicitly.

Above message is shown when checking the local test.kdbx / on Python 3.8.

add support for Python 3.10

Interface design

Not only for graphical applications, but also for CLI applications a good interface is important.

I will collect ideas about how to desgin the interface, ie the commands, subcommands, arguments and options.

I'd be very happy if you share your ideas.

Current favorite design

hibpcli keepass --password --password-only/--email-only

you are able to enter the password if you want - otherwise you get prompted for it
you can also provide an option so the keepass database only gets checked for leaked passwords, or only for leaked emails
defaults to both

hibpcli password [password]

check a single password
if no password entered, you get a prompt
security implications:
-- possibly password will be in the bash_history
-- password will be visible when you type it

hibpcli email [email]

check a single email
if no email entered, you get a prompt

The above checks will be tested against the online API - local checks will be added later.

Any thoughts?

catch exception when keepass password is wrong

currently users get to see:

pykeepass.exceptions.CredentialsIntegrityError: Credentials are wrong or integrity check failed

document release process

Change the message if no leak found

The wording of messages “Hooray, everything is safe!” and “Your password is safe!” implies these passwords are safe. Actually they only have not been reported as unsafe until now.

How about: “Your password is probably safe.” or “This password has not been reported unsafe until now.” or let's find a better message in the discussion.

Catch network/API errors

current behaviour
When the hibp API is not available, the user gets a nasty traceback.

wished behaviour
When the hibp API is not available, the user gets a decent error message.

Mock calls to hibp API in tests

Currently, the test calls the real hibp API -when the internet connection is down, the test would fail.

=> mock the call