search

jugmac00 / hibpcli

A Python CLI application to access the API of haveibeenpwned.com
MIT License
8 stars 4 forks source link

Interface design #17

Closed jugmac00 closed 5 years ago

jugmac00 commented 5 years ago

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
  2. 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
  3. 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 commented 5 years ago

  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