<commit_before>pySQRL
====

**Pyhton SQRL (Secure QR Login) Client**


What is SQRL?

A newly proposed authentication scheme from <NAME> of GRC.com. It allows
for user authentication without the need for:

* Username / Password pair
* OTP (One Time Password)
* Third party Interactions
* Revealing your identity during login
* An in-band authentication exchange

In a normal web authentication system your credentials are stored with the site
you are trying to access. If the site were to be compromised the yours and
every other users account information may be accessible allowing the intruder
to attempt to use you credentials with elsewhere. The best part about SQRL is
that the site never has your login credentials. You keep your never send your
**_"password"_**. The site authenticates you using by verifying you are who you
are by using a private / public key signatures. This ends up being vastly more
secure.

Details can be found here: https://www.grc.com/sqrl/sqrl.htm


Usage
-----
     Usage: sqrl [-d] [-n] [--path=<Dir>] <SQRLURL>

     Options:
          -d               Debugging output
          -n               Notify via libnotify (Gnome)
          -p --path=<Dir>  Path for config and key storage

     Example:
         sqrl "sqrl://example.com/login/sqrl?d=6&nut=a95fa8e88dc499758"

You feed the sqrl URL provided by the authentication service to the script and
it uses it to submit and authentication request on your behalf. Based on how
the sight is design, you may automatically be logged in. **It's that simple**.

Feature
-------

* Debug - Displays the content of the payload for your to veriy
* Notification - Displays notifications on successful or fail auth attemps
  (Gnome Only)<commit_msg>Added debug example to README<commit_after>pySQRL
====

**Pyhton SQRL (Secure QR Login) Client**


What is SQRL?

A newly proposed authentication scheme from <NAME> of GRC.com. It allows
for user authentication without the need for:

* Username / Password pair
* OTP (One Time Password)
* Third party Interactions
* Revealing your identity during login
* An in-band authentication exchange

In a normal web authentication system your credentials are stored with the site
you are trying to access. If the site were to be compromised the yours and
every other users account information may be accessible allowing the intruder
to attempt to use you credentials with elsewhere. The best part about SQRL is
that the site never has your login credentials. You keep your never send your
**_"password"_**. The site authenticates you using by verifying you are who you
are by using a private / public key signatures. This ends up being vastly more
secure.

Details can be found here: https://www.grc.com/sqrl/sqrl.htm


Usage
-----
     Usage: sqrl [-d] [-n] [--path=<Dir>] <SQRLURL>

     Options:
          -d               Debugging output
          -n               Notify via libnotify (Gnome)
          -p --path=<Dir>  Path for config and key storage

     Example:
         sqrl "sqrl://example.com/login/sqrl?d=6&nut=a95fa8e88dc499758"

You feed the sqrl URL provided by the authentication service to the script and
it uses it to submit and authentication request on your behalf. Based on how
the sight is design, you may automatically be logged in. **It's that simple**.

Features
--------

* Debug - Displays the content of the payload for your to veriy
* Notification - Displays notifications on successful or fail auth attemps
  (Gnome Only)

Debug
-----

When the [-d] argument is given the script outputs all the components of the
request.

    **url**: localhost:8080/sqrl?nut=1bfe7ef6f9989bd5709d61f7ac28195e&sqrlver=1&sqrlkey=<KEY>
    **Domin**: "localhost:8080"
    **Publick Key**: Zl_nrges0MGPRelRoH9SEwwPcARQSA0QmYNx-ZDcOKU
    **Signed url**: LtYQU_j5Lwp6c0TrWEGhP0tj5o_PM8yni_tLmrG375aEIkUNdJzWl_XmLUN-dtZHuKWP1pf8iNUVSSyYRq3QDA
    **signature is good**

{'fraction_non_alphanumeric': 0.07260133401744484, 'fraction_numerical': 0.01718830169317599, 'mean_word_length': 3.4919354838709675, 'pattern_counts': {'":': 0, '<': 12, '<?xml version=': 0, '>': 12, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6041075', 'n_tokens_mistral': 1198, 'n_tokens_neox': 1106, 'n_words': 508}