Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Interface design #17

Closed
jugmac00 opened this issue Jan 25, 2019 · 1 comment
Closed

Interface design #17

jugmac00 opened this issue Jan 25, 2019 · 1 comment
Labels
help wanted Extra attention is needed question Further information is requested

Comments

@jugmac00
Copy link
Owner

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

  1. 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
  1. 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
  1. 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?

@jugmac00 jugmac00 added help wanted Extra attention is needed question Further information is requested labels Jan 25, 2019
jugmac00 added a commit that referenced this issue Jan 25, 2019
In order to prepare for the new interface #17, the keepass check
was moved into its own subcommand.

modified:   README.md
modified:   hibpcli/cli.py
modified:   tests/test_cli.py
jugmac00 added a commit that referenced this issue Jan 25, 2019
In order to prepare for the new interface #17, the keepass check
was moved into its own subcommand.

modified:   README.md
modified:   hibpcli/cli.py
modified:   tests/test_cli.py
@jugmac00
Copy link
Owner Author

jugmac00 commented Nov 2, 2019

  1. and 2. got implemented (roughly)

  2. is no longer possible, as the hipb API for emails is no longer free of charge, see
    https://www.troyhunt.com/authentication-and-the-have-i-been-pwned-api/

For now the issue can be closed.

P.S: I still think about renaming the subcommands to

  • check-db
  • check-password

@jugmac00 jugmac00 closed this as completed Nov 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant