Merge branch 'hotfix/4'

Close #4
Fixes #1

Author: weierophinney

CHANGELOG.md

@@ -2,6 +2,36 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 0.2.0 - 2017-11-27
+
+### Added
+
+- Nothing.
+
+### Changed
+
+- [#4](https://github.com/zendframework/zend-expressive-authentication/pull/4)
+  renames the method `UserInterface::getUserRole()` to
+  `UserInterface::getUserRoles()`. The method MUST return an array of string
+  role names.
+
+- [#4](https://github.com/zendframework/zend-expressive-authentication/pull/4)
+  renames the method `UserRepositoryInterface::getRoleFromUser()` to
+  `UserRepositoryInterface::getRolesFromUser()`. The method MUST return an array
+  of string role names.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 0.1.0 - 2017-11-08
 
 Initial release.

src/UserInterface.php

@@ -14,7 +14,9 @@ interface UserInterface
     public function getUsername() : string;
 
     /**
-     * Get the user role
+     * Get all user roles
+     *
+     * @return string[]
      */
-    public function getUserRole() : string;
+    public function getUserRoles() : array;
 }

src/UserRepository/Htpasswd.php

@@ -59,10 +59,18 @@ public function authenticate(string $credential, string $password = null) : ?Use
         fclose($handle);
 
         return $found && password_verify($password, $hash) ?
-               $this->generateUser($credential, '') :
+               $this->generateUser($credential) :
                null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function getRolesFromUser(string $username) : array
+    {
+        return [];
+    }
+
     /**
      * Check bcrypt usage for security reason
      *

src/UserRepository/HtpasswdFactory.php

@@ -17,12 +17,16 @@ class HtpasswdFactory
      */
     public function __invoke(ContainerInterface $container) : Htpasswd
     {
-        $htpasswd = $container->get('config')['authentication']['htpasswd'] ?? null;
+        $config = $container->has('config') ? $container->get('config') : [];
+        $htpasswd = $config['authentication']['htpasswd'] ?? null;
+
         if (null === $htpasswd) {
-            throw new Exception\InvalidConfigException(
-                'Htpasswd file name is not present in user_register config'
-            );
+            throw new Exception\InvalidConfigException(sprintf(
+                'Config key authentication.htpasswd is not present; cannot create %s user repository adapter',
+                Htpasswd::class
+            ));
         }
+
         return new Htpasswd($htpasswd);
     }
 }

src/UserRepository/PdoDatabase.php

@@ -41,19 +41,52 @@ public function __construct(PDO $pdo, array $config)
     public function authenticate(string $credential, string $password = null) : ?UserInterface
     {
         $sql = sprintf(
-            'SELECT * FROM %s WHERE %s = :username',
+            "SELECT %s FROM %s WHERE %s = :username",
+            $this->config['field']['password'],
             $this->config['table'],
             $this->config['field']['username']
         );
+
         $stmt = $this->pdo->prepare($sql);
         $stmt->bindParam(':username', $credential);
+
         if (! $stmt->execute()) {
             return null;
         }
+
         $result = $stmt->fetchObject();
 
-        return password_verify($password, $result->{$this->config['field']['password']}) ?
-               $this->generateUser($credential, $this->config['field']['role'] ?? '') :
-               null;
+        return password_verify($password, $result->{$this->config['field']['password']})
+            ? $this->generateUser($credential, $this->getRolesFromUser($credential))
+            : null;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getRolesFromUser(string $username) : array
+    {
+        if (! isset($this->config['sql_get_roles'])) {
+            return [];
+        }
+
+        if (false === strpos($this->config['sql_get_roles'], ':username')) {
+            throw new Exception\InvalidConfigException(
+                'The sql_get_roles configuration setting must include a :username parameter'
+            );
+        }
+
+        $stmt = $this->pdo->prepare($this->config['sql_get_roles']);
+        $stmt->bindParam(':username', $username);
+
+        if (! $stmt->execute()) {
+            return [];
+        }
+
+        $roles = [];
+        foreach ($stmt->fetchAll(PDO::FETCH_NUM) as $role) {
+            $roles[] = $role[0];
+        }
+        return $roles;
     }
 }

src/UserRepository/UserTrait.php

@@ -12,28 +12,28 @@
 trait UserTrait
 {
     /**
-     * Generate a user from $username and $role
+     * Generate a user from username and list of roles
      */
-    protected function generateUser(string $username, string $role) : UserInterface
+    protected function generateUser(string $username, ?array $roles = null) : UserInterface
     {
-        return new class($username, $role) implements UserInterface {
+        return new class($username, $roles) implements UserInterface {
             private $username;
-            private $role;
+            private $roles;
 
-            public function __construct($username, $role)
+            public function __construct(string $username, $roles)
             {
                 $this->username = $username;
-                $this->role = $role;
+                $this->roles = $roles ?: [];
             }
 
             public function getUsername() : string
             {
                 return $this->username;
             }
 
-            public function getUserRole() : string
+            public function getUserRoles() : array
             {
-                return $this->role;
+                return $this->roles;
             }
         };
     }

src/UserRepositoryInterface.php

@@ -16,4 +16,12 @@ interface UserRepositoryInterface
      * @param string $credential can be also a token
      */
     public function authenticate(string $credential, string $password = null) : ?UserInterface;
+
+    /**
+     * Get the user roles if present.
+     *
+     * @param string $username
+     * @return string[]
+     */
+    public function getRolesFromUser(string $username) : array;
 }

test/TestAssets/pdo_role.sqlite

@@ -0,0 +1,7 @@
+CREATE TABLE user(
+    username TEXT,
+    password TEXT,
+    role TEXT
+);
+
+INSERT INTO user (username, password, role) VALUES ('test', '$2y$10$C822kPutHb8S/An9pBzJHeaN2/uqytA88O5VtTaY9m9EzWCJPDF7e', 'admin');