Merge pull request #21 from nicklog/feature/password_by_hash

add "by_hash" function

Author: DivineOmega

README.md

@@ -57,8 +57,15 @@ If you prefer to avoid using helper functions, the following syntax is also avai
 $passwordStatus = (new PasswordExposedChecker())->passwordExposed($password);
 ```
 
+### SHA1 Hash
 You can also supply the SHA1 hash instead of the plain text password, by using the following method.
 
 ```php
 $passwordStatus = (new PasswordExposedChecker())->passwordExposedByHash($hash);
 ```
+
+or...
+
+```php
+$passwordStatus = password_exposed_by_hash($hash);
+```

src/PasswordExposedFunction.php

@@ -11,3 +11,13 @@ function password_exposed($password)
 {
     return (new PasswordExposedChecker())->passwordExposed($password);
 }
+
+/**
+ * @param string $hash
+ *
+ * @return string
+ */
+function password_exposed_by_hash($hash)
+{
+    return (new PasswordExposedChecker())->passwordExposedByHash($hash);
+}

tests/Unit/PasswordExposedByHashTest.php

@@ -17,6 +17,11 @@ protected function setUp()
         $this->checker = new PasswordExposedChecker();
     }
 
+    public function testFunctionExists()
+    {
+        $this->assertTrue(function_exists('password_exposed_by_hash'));
+    }
+
     /**
      * @return array
      */
@@ -37,6 +42,7 @@ public function exposedPasswordHashProvider()
     public function testExposedPasswords($hash)
     {
         $this->assertEquals($this->checker->passwordExposedByHash($hash), PasswordStatus::EXPOSED);
+        $this->assertEquals(password_exposed_by_hash($hash), PasswordStatus::EXPOSED);
     }
 
     public function testNotExposedPasswords()
@@ -45,6 +51,10 @@ public function testNotExposedPasswords()
             $this->checker->passwordExposedByHash($this->getPasswordHashUnlikelyToBeExposed()),
             PasswordStatus::NOT_EXPOSED
         );
+        $this->assertEquals(
+            password_exposed_by_hash($this->getPasswordHashUnlikelyToBeExposed()),
+            PasswordStatus::NOT_EXPOSED
+        );
     }
 
     /**