Merge pull request #115 from delphi-hub/authTest

Authentication tests, additional user management endpoints

Author: johannesduesing

OpenAPISpecification.yaml

@@ -31,7 +31,9 @@ paths:
       tags:
         - Meta
       summary: Retreives general configuration information
-      description: Retrieves an object containing the most important configuration values of the registry. This contains the docker and traefik URIs.
+      description: >-
+        Retrieves an object containing the most important configuration values
+        of the registry. This contains the docker and traefik URIs.
       operationId: configurationInfo
       responses:
         '200':
@@ -41,51 +43,52 @@ paths:
             properties:
               DockerHttpApi:
                 type: string
-                example: "172.0.2.1:9095"
+                example: '172.0.2.1:9095'
               TraefikProxyUri:
                 type: string
-                example: "172.0.2.1:80"
+                example: '172.0.2.1:80'
   /users/authenticate:
     post:
       tags:
         - User Management
       summary: Authenticates a user and returns a valid JWT
-      description: >- 
-        This endpoints validates the username and password that must 
-        be supplied in the Authorization header (using HTTP Basic Authentication).
-        If valid, a JSON Web Token will be generated and returned, that may be used 
-        to authenticate the user for subsequent requests.
+      description: >-
+        This endpoints validates the username and password that must  be
+        supplied in the Authorization header (using HTTP Basic Authentication).
+        If valid, a JSON Web Token will be generated and returned, that may be
+        used  to authenticate the user for subsequent requests.
       operationId: authenticate
       parameters:
         - in: header
           name: Delphi-Authorization
-          description: >-
-            Valid JWT that autenticates the calling entity.
+          description: Valid JWT that autenticates the calling entity.
           type: string
           required: true
         - in: header
           name: Authorization
-          description: >- 
-            HTTP Basic Authentication following the schema 'Basic <User:Password>
-            where the concatination of username and password is Base64-Encoded.
+          description: >-
+            HTTP Basic Authentication following the schema 'Basic
+            <User:Password> where the concatination of username and password is
+            Base64-Encoded.
           type: string
           required: true
       responses:
         '200':
-          description: Supplied data is valid, a JWT is returned
+          description: 'Supplied data is valid, a JWT is returned'
           schema:
             type: string
-            example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+            example: >-
+              eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
         '401':
-          description: Unauthorized, invalid username / password supplied.
+          description: 'Unauthorized, invalid username / password supplied.'
   /users/add:
     post:
       tags:
         - User Management
       summary: Adds a new users for the registry
       description: >-
-        Adds a new user that is passed in the requests entity. The id of the user
-        will be returned.
+        Adds a new user that is passed in the requests entity. The id of the
+        user will be returned.
       operationId: addUser
       parameters:
         - in: body
@@ -113,13 +116,70 @@ paths:
                   - Component
       responses:
         '200':
-          description: OK, user has been added, id is returned
+          description: 'OK, user has been added, id is returned'
           schema:
             type: integer
             format: int64
             example: 42
         '400':
-          description: Bad request, name already exists
+          description: 'Bad request, name already exists'
+  /users:
+    get:
+      tags:
+        - User Management
+      summary: Gets a list of all registered users
+      description: >-
+        Returns a list of all users registered at the registry. Requires caller to have admin privileges.
+      operationId: allUsers
+      responses:
+        '200':
+          description: "OK, list of users is being returned"
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/User'
+  /users/{Id}:
+    get:
+      tags:
+        - User Management
+      summary: Gets the user with the specified id
+      description: >-
+        Returns the user with the specified id, if that id is present at the registry.
+      operationId: retrieveUser
+      parameters:
+        - in: path
+          name: Id
+          required: true
+          description: Id of the user to retrieve
+          type: integer
+          format: int64
+      responses:
+        '200':
+          description: "OK, user is being returned"
+          schema:
+            $ref: '#/definitions/User'
+        '404':
+          description: "Id not found"
+  /users/{Id}/remove:
+    post:
+      tags:
+        - User Management
+      summary: Removes the user with the specified id
+      description: >-
+        Removes the user with the specified id, if that id is present at the registry.
+      operationId: removeUser
+      parameters:
+        - in: path
+          name: Id
+          required: true
+          description: Id of the user to remove
+          type: integer
+          format: int64
+      responses:
+        '200':
+          description: "OK, user has been removed"
+        '404':
+          description: "Id not found"
   /instances/register:
     post:
       tags:
@@ -886,6 +946,27 @@ paths:
         '500':
           description: 'Internal server error, unknown operation result DESCRIPTION'
 definitions:
+  User:
+    type: object
+    required:
+      - userName
+      - secret
+      - userType
+    properties:
+      id:
+        type: integer
+        format: int64
+      userName:
+        type: string
+        example: Ben
+      secret:
+        type: string
+        example: 0DE19F6FAAFB7CF372172CEA658800999A75DB9E79AF5F378F274E47DF810CEE
+      userType:
+        type: string
+        enum:
+          - User
+          - Admin
   InstanceLink:
     type: object
     required:

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/RequestHandler.scala

@@ -956,38 +956,72 @@ class RequestHandler(configuration: Configuration, authDao: AuthDAO, instanceDao
     }
   }
 
+  def isInstanceIdPresent(id: Long): Boolean = {
+    instanceDao.hasInstance(id)
+  }
+
+  def getInstance(id: Long): Option[Instance] = {
+    instanceDao.getInstance(id)
+  }
+
+  def instanceHasState(id: Long, state: InstanceState): Boolean = {
+    instanceDao.getInstance(id) match {
+      case Some(instance) => instance.instanceState == state
+      case None => false
+    }
+  }
+
   /**
     * Add user to user database
     *
     * @param user The user to add
     * @return Id assigned to that user
     */
-  def handleAddUser(user: DelphiUser): Try[Long] = {
+  def handleAddUser(user: DelphiUser): Try[String] = {
 
     val noIdUser = DelphiUser(id = None, userName = user.userName, secret = user.secret, userType = user.userType)
 
     authDao.addUser(noIdUser) match {
-      case Success(id) =>
+      case Success(username) =>
         log.info(s"Successfully handled create user request")
-        Success(id)
+        Success(username)
       case Failure(x) => Failure(x)
     }
   }
 
+  /**
+    * Remove a user with id
+    *
+    * @param id
+    * @return
+    */
+  def handleRemoveUser(id: Long): Try[Long] = {
 
-  def isInstanceIdPresent(id: Long): Boolean = {
-    instanceDao.hasInstance(id)
+    authDao.removeUser(id) match {
+      case Success(_) =>
+        log.info(s"Successfully handled remove user request")
+        Success(id)
+      case Failure(x) => Failure(x)
+    }
   }
 
-  def getInstance(id: Long): Option[Instance] = {
-    instanceDao.getInstance(id)
+  /**
+    * Get a user with id
+    *
+    * @param id
+    * @return
+    */
+  def getUser(id: Long): Option[DelphiUser] = {
+    authDao.getUserWithId(id)
   }
 
-  def instanceHasState(id: Long, state: InstanceState): Boolean = {
-    instanceDao.getInstance(id) match {
-      case Some(instance) => instance.instanceState == state
-      case None => false
-    }
+  /**
+    * Get all user
+    *
+    * @return
+    */
+  def getAllUsers(): List[DelphiUser] = {
+    authDao.getAllUser()
   }
 
   def isInstanceDockerContainer(id: Long): Boolean = {