# sqrl

**Repository Path**: vue-quasar/sqrl

## Basic Information

- **Project Name**: sqrl
- **Description**: php的二维码验证库
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-30
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center"><img src="assets/sqrl_php_logo_150px.png"></p>

<p align="center">
<a href="https://travis-ci.org/trianglman/sqrl"><img src="https://travis-ci.org/trianglman/sqrl.svg" alt="Build Status"></a>
</p>

# sqrl

PHP Server side implementation of a SQRL generator/listener

This project is in *pre-alpha* until there is a defined reference implementation.

Follow the conversation at [grc sqrl newsgroup](https://www.grc.com/groups/sqrl) for updates on the 
standard.


## Software Requirements

  - Composer - http://getcomposer.org
  - Endroid/qrcode Loaded automatically by Composer - https://github.com/endroid/QrCode

## Purpose

The goal of this software is to provide a simple PHP implementation of Steve
Gibson's SQRL authentication proposal. This library will allow any site using it
to generate the QR code with a nonce, validate a signed nonce, and store the 
public key for connection to a site account. 

## Installation

### Composer

1. Download the [`composer.phar`](https://getcomposer.org/composer.phar) executable or use the installer.

    ``` sh
    $ curl -sS https://getcomposer.org/installer | php
    ```

2. Create a composer.json defining your dependencies. Note that this example is
a short version for applications that are not meant to be published as packages
themselves. To create libraries/packages please read the
[documentation](http://getcomposer.org/doc/02-libraries.md).

    ``` json
        "require": {
            "trianglman/sqrl": "dev-master"
        }
    ```

3. Run Composer: `php composer.phar update`

### Configuration

If you want to have the library automatically store generated nonces and validated
public keys, first generate the database tables based on the supplied 
[ExampleStatefulStorage.php](examples/server/includes/ExampleStatefulStorage.php), then create a JSON config file based on the sample
provided in sqrl/config.sample.json. You can then configure the
generator or validator by calling the appropriate `configure($filepath);`
method.

If you would rather manage storage of this information in your own tables, you can
configure the generator manually:

```php
$generator = new \Trianglman\Sqrl\SqrlGenerate();
//whether SQRL responses should come back over SSL (sqrl://)
$generator->setSecure(true);
//the domain sqrl clients should generate their key off of
$generator->setKeyDomain('www.example.com');
//the path to the SQRL authentication script relative to the key domain
$generator->setAuthenticationPath('sqrl/login.php');

//The above would generate a SQRL URL pointing to 
//sqrl://www.example.com/sqrl/login.php
//...
```

You can also configure the size of the QR code generated and the amount of 
padding between the image edge and the start of the code, as well as supply
your own salt for the nonce:

```php
//...
$generator->setHeight(300);
$generator->setPadding(10);
$generator->setSalt('foo');
//...
```

### Usage

**Generate a nonce**
```php
//Initialize the generator
$generator = new \Trianglman\Sqrl\SqrlGenerate();
$generator->configure('/path/to/config');

//output the QR file to stdout
$generator->render();

//get the nonce for other uses, i.e. link, etc.
$nonce = $generator->getNonce();
```

**Verify a user's input**
```php
//initialize the validator
$validator = new \Trianglman\Sqrl\SqrlValidate();
$validator->configure('/path/to/config');
$validator->setValidator(new \Trianglman\Sqrl\ed25519\Crypto());

//initialize the request handler
$requestResponse = new \Trianglman\Sqrl\SqrlRequestHandler($validator);
$requestResponse->parseRequest($_GET, $_POST, $_SERVER);

//check validation
$requestResponse = $obj->getResponseMessage();
$requestResponseCode = $obj->getResponseCode();

//OR

//Let the request handler also handle the response
$reqHandler->sendResponse();
```

# Resources

* [GRC.com - SQRL Explainted](https://www.grc.com/sqrl/SQRL_Explained.pdf) (pdf)
* [GRC.com - SQRL Semantincs](https://www.grc.com/sqrl/semantics.htm)
* [GRC.com - SQRL Protocol](https://www.grc.com/sqrl/protocol.htm)