ADD README.md and docblock

README.md

@@ -0,0 +1,33 @@
+# hash-verifier
+
+hash verification using a nonce & verifying the hmac from the URL for a laravel application
+
+## Installation
+
+```bash
+composer require dpc/hash-verifier
+```
+
+## Usage
+
+TODO: Write usage instructions
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## History
+
+TODO: Write history
+
+## Credits
+
+[Dylan DPC](https://github.com/Dylan-DPC)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

src/AuthValidator.php

@@ -2,9 +2,12 @@
 
 namespace Dpc\HashVerifier;
 
-
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * Class AuthValidator
+ * @package Dpc\HashVerifier
+ */
 class AuthValidator implements AuthValidatorContract
 {
     protected $generator;
@@ -60,4 +63,4 @@ public function validate(array $params) : bool
         return $this->validator->verify($params);
     }
 
-}
+}

src/AuthValidatorContract.php

@@ -2,9 +2,12 @@
 
 namespace Dpc\HashVerifier;
 
-
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * Interface AuthValidatorContract
+ * @package Dpc\HashVerifier
+ */
 interface AuthValidatorContract
 {
 
@@ -35,4 +38,4 @@ public function matches(Model $content, string $nonce) : bool;
      * @return bool
      */
     public function validate(array $params) : bool;
-}
+}

src/AuthValidatorServiceProvider.php

@@ -4,6 +4,10 @@
 
 use Illuminate\Support\ServiceProvider;
 
+/**
+ * Class AuthValidatorServiceProvider
+ * @package Dpc\HashVerifier
+ */
 class AuthValidatorServiceProvider extends ServiceProvider
 {
     /**

src/Exceptions/HashFailedException.php

@@ -2,7 +2,10 @@
 
 namespace Dpc\HashVerifier\Exceptions;
 
-
+/**
+ * Class HashFailedException
+ * @package Dpc\HashVerifier\Exceptions
+ */
 class HashFailedException extends \Exception
 {
 
@@ -13,4 +16,4 @@ public function __construct()
     {
         parent::__construct('Hash Validation Failed');
     }
-}
+}

src/Exceptions/NonceFailedException.php

@@ -2,7 +2,10 @@
 
 namespace Dpc\HashVerifier\Exceptions;
 
-
+/**
+ * Class NonceFailedException
+ * @package Dpc\HashVerifier\Exceptions
+ */
 class NonceFailedException extends \Exception
 {
 
@@ -13,4 +16,4 @@ public function __construct()
     {
         parent::__construct('Authentication failed because nonce does not match');
     }
-}
+}

src/HMacValidator.php

@@ -2,7 +2,10 @@
 
 namespace Dpc\HashVerifier;
 
-
+/**
+ * Class HMacValidator
+ * @package Dpc\HashVerifier
+ */
 class HMacValidator implements HMacValidatorContract
 {
 
@@ -60,4 +63,4 @@ protected function validate(array $params, $hmac) : bool
         return hash_equals($hmac, $hash);
 
     }
-}
+}

src/HMacValidatorContract.php

@@ -2,7 +2,10 @@
 
 namespace Dpc\HashVerifier;
 
-
+/**
+ * Interface HMacValidatorContract
+ * @package Dpc\HashVerifier
+ */
 interface HMacValidatorContract
 {
     /**
@@ -13,4 +16,4 @@ interface HMacValidatorContract
      * @return bool
      */
     public function verify(array $params) : bool;
-}
+}

src/NonceContract.php

@@ -2,9 +2,12 @@
 
 namespace Dpc\HashVerifier;
 
-
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * Interface NonceContract
+ * @package Dpc\HashVerifier
+ */
 interface NonceContract
 {
     /**
@@ -35,4 +38,4 @@ public function store(Model $content, string $nonce) : void;
      * @return bool
      */
     public function matches(Model $content, string $nonce) : bool;
-}
+}

src/NonceGenerator.php

@@ -5,6 +5,10 @@
 use Illuminate\Database\Eloquent\Model;
 use function Sodium\randombytes_buf;
 
+/**
+ * Class NonceGenerator
+ * @package Dpc\HashVerifier
+ */
 class NonceGenerator implements NonceContract
 {
     /**
@@ -55,4 +59,4 @@ public function matches(Model $content, string $nonce) : bool
 
         return $nonce && $stored === $nonce;
     }
-}
+}