Merge pull request #196 from AtlasOfLivingAustralia/develop

Biosecurity admin feature
AtlasOfLivingAustralia · Jun 27, 2024 · 6ab738a · 6ab738a
2 parents 5aa6c3a + 0a0abd6
commit 6ab738a
Show file tree

Hide file tree

Showing 15 changed files with 119 additions and 27 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,6 +5,7 @@ sudo: false
 branches:
   only:
     - dev
+    - develop
     - master
     - /^hotfix.*$/
     - grails3

diff --git a/build.gradle b/build.gradle
@@ -17,7 +17,7 @@ plugins {
     id "com.gorylenko.gradle-git-properties" version "2.4.1"
 }
 
-version "3.0.3"
+version "3.1.0-SNAPSHOT"
 group "au.org.ala"
 
 apply plugin:"eclipse"

diff --git a/grails-app/controllers/au/org/ala/userdetails/AdminController.groovy b/grails-app/controllers/au/org/ala/userdetails/AdminController.groovy
@@ -32,7 +32,18 @@ class AdminController {
     def profileService
     def authorisedSystemService
 
-    def index() {}
+    @PreAuthorise(allowedRoles = ["ROLE_ADMIN", "ROLE_USER_CREATOR"])
+    def index() {
+        def user = userService.currentUser
+
+        if (user) {
+            def isBiosecurityAdmin = request.isUserInRole("ROLE_USER_CREATOR")
+            [isBiosecurityAdmin: isBiosecurityAdmin]
+        } else {
+            log.info('my-profile without a user?')
+            render(status: SC_UNAUTHORIZED)
+        }
+    }
 
     def resetPasswordForUser(){
     }

diff --git a/grails-app/controllers/au/org/ala/userdetails/ProfileController.groovy b/grails-app/controllers/au/org/ala/userdetails/ProfileController.groovy
@@ -50,7 +50,8 @@ class ProfileController {
         if (user) {
             def props = user.propsAsMap()
             def isAdmin = request.isUserInRole("ROLE_ADMIN")
-            render(view: "myprofile", model: [user: user, props: props, isAdmin: isAdmin])
+            def isBiosecurityAdmin = request.isUserInRole("ROLE_USER_CREATOR")
+            render(view: "myprofile", model: [user: user, props: props, isAdmin: isAdmin, isBiosecurityAdmin: isBiosecurityAdmin])
         } else {
             log.info('my-profile without a user?')
             render(status: SC_UNAUTHORIZED)

diff --git a/grails-app/controllers/au/org/ala/userdetails/PropertyController.groovy b/grails-app/controllers/au/org/ala/userdetails/PropertyController.groovy
@@ -89,7 +89,7 @@ class PropertyController extends BaseController {
     )
     @Path("getProperty")
     @Produces("application/json")
-    @PreAuthorise(requiredScope = 'users/read', requiredRole = '')
+    @PreAuthorise(requiredScope = 'users/read', allowedRoles = [])
     def getProperty() {
         String name = params.name
         Long alaId = params.long('alaId')
@@ -166,7 +166,7 @@ class PropertyController extends BaseController {
     )
     @Path("saveProperty")
     @Produces("application/json")
-    @PreAuthorise(requiredScope = 'users/write', requiredRole = '')
+    @PreAuthorise(requiredScope = 'users/write', allowedRoles = [])
     def saveProperty(){
         String name = params.name;
         String value = params.value;

diff --git a/grails-app/controllers/au/org/ala/userdetails/RoleBasedInterceptor.groovy b/grails-app/controllers/au/org/ala/userdetails/RoleBasedInterceptor.groovy
@@ -42,7 +42,7 @@ class RoleBasedInterceptor {
             PreAuthorise pa = method.getAnnotation(PreAuthorise) ?: controllerClass.getAnnotation(PreAuthorise)
             response.withFormat {
                 json {
-                    if (!authorisedSystemService.isAuthorisedRequest(request, response, pa.requiredRole(), pa.requiredScope())) {
+                    if (!authorisedSystemService.isAuthorisedRequest(request, response, pa.allowedRoles(), pa.requiredScope())) {
                         log.warn("Denying access to $actionName from remote addr: ${request.remoteAddr}, remote host: ${request.remoteHost}")
                         response.status = HttpStatus.SC_UNAUTHORIZED
                         render(['error': "Unauthorized"] as JSON)
@@ -51,8 +51,8 @@ class RoleBasedInterceptor {
                     }
                 }
                 '*' {
-                    def requiredRole = pa.requiredRole()
-                    def inRole = request?.isUserInRole(requiredRole)
+                    def allowedRoles = pa.allowedRoles()
+                    def inRole = allowedRoles.any { role -> request?.isUserInRole(role) }
 
                     if (!inRole) {
                         log.warn("Denying access to $controllerName, $actionName to ${request?.userPrincipal?.name}")

diff --git a/grails-app/controllers/au/org/ala/userdetails/UserController.groovy b/grails-app/controllers/au/org/ala/userdetails/UserController.groovy
@@ -40,10 +40,13 @@ class UserController {
         }
     }
 
+    @PreAuthorise(allowedRoles = ["ROLE_ADMIN", "ROLE_USER_CREATOR"])
     def create() {
-        [userInstance: new User(params)]
+        def isBiosecurityAdmin = request.isUserInRole("ROLE_USER_CREATOR")
+        [userInstance: new User(params), isBiosecurityAdmin: isBiosecurityAdmin]
     }
 
+    @PreAuthorise(allowedRoles = ["ROLE_ADMIN", "ROLE_USER_CREATOR"])
     @Transactional
     def save() {
         def userInstance = new User(params)
@@ -58,9 +61,18 @@ class UserController {
         }
 
         userService.updateProperties(userInstance, params)
+        userService.addUserRole(userInstance, "ROLE_USER")
+
+        def isBiosecurityAdmin = request.isUserInRole("ROLE_USER_CREATOR")
 
         flash.message = message(code: 'default.created.message', args: [message(code: 'user.label', default: 'User'), userInstance.id])
-        redirect(action: "show", id: userInstance.id)
+        if(!isBiosecurityAdmin) {
+            redirect(action: "show", id: userInstance.id)
+        }
+        else{
+            //ROLE_USER_CREATOR role does not have permission to show(id) action
+            redirect(controller: "user", action: 'create')
+        }
     }
 
     def show(Long id) {

diff --git a/grails-app/services/au/org/ala/userdetails/AuthorisedSystemService.groovy b/grails-app/services/au/org/ala/userdetails/AuthorisedSystemService.groovy
@@ -49,11 +49,11 @@ class AuthorisedSystemService {
     /**
      * Validate a JWT Bearer token instead of the API key.
      * @param fallbackToLegacy Whether to fall back to legacy authorised systems if the JWT is not present.
-     * @param role The user role required to continue
+     * @param roles The user roles required to continue. The user must have at least one role to be authorized.
      * @param scope The JWT scope required for the request to be authorized
      * @return true
      */
-    def isAuthorisedRequest(HttpServletRequest request, HttpServletResponse response, String role, String scope) {
+    def isAuthorisedRequest(HttpServletRequest request, HttpServletResponse response, String[] roles, String scope) {
         def result = false
 
         if (jwtProperties.enabled) {
@@ -73,8 +73,8 @@ class AuthorisedSystemService {
                     )
 
                     result = true
-                    if (role) {
-                        result = userProfile.roles.contains(role)
+                    if (roles) {
+                        result = roles.any { role -> userProfile.roles.contains(role) }
                     }
 
                     if (result && scope) {

diff --git a/grails-app/services/au/org/ala/userdetails/UserService.groovy b/grails-app/services/au/org/ala/userdetails/UserService.groovy
@@ -272,6 +272,17 @@ class UserService {
         }
     }
 
+    def addUserRole(User user, String roleString) {
+
+        def role = Role.findByRole(roleString)
+
+        def userRole = UserRole.findByUserAndRole(user, role)
+
+        if(!userRole) {
+            new UserRole(user:user, role:role).save(flush:true, failOnError: true)
+        }
+    }
+
     def deleteUser(User user) {
 
         if (user) {

diff --git a/grails-app/views/admin/index.gsp b/grails-app/views/admin/index.gsp
@@ -25,16 +25,21 @@
         <div class="col-md-12" id="page-body" role="main">
             <h1>User Administration</h1>
             <ul class="userdetails-menu">
-                <li><g:link controller="user" action="list">Find a user</g:link></li>
-                <li><g:link controller="admin" action="resetPasswordForUser">Reset user password</g:link></li>
-                <li><g:link controller="role" action="list">Roles</g:link></li>
-                <li><g:link controller="authorisedSystem" action="list">Authorised systems</g:link></li>
-                <li><g:link controller="admin" action="bulkUploadUsers">Bulk create user accounts</g:link></li>
-                <li><g:link controller="admin" action="exportUsers">Export users to CSV file</g:link></li>
-                <g:if test="${grailsApplication.config.getProperty('attributes.affiliations.enabled', Boolean, false)}">
-                    <li><g:link controller="admin" action="surveyResults">Get user survey results</g:link></li>
+                <g:if test="${!isBiosecurityAdmin}">
+                    <li><g:link controller="user" action="list">Find a user</g:link></li>
+                    <li><g:link controller="admin" action="resetPasswordForUser">Reset user password</g:link></li>
+                    <li><g:link controller="role" action="list">Roles</g:link></li>
+                    <li><g:link controller="authorisedSystem" action="list">Authorised systems</g:link></li>
+                    <li><g:link controller="admin" action="bulkUploadUsers">Bulk create user accounts</g:link></li>
+                    <li><g:link controller="admin" action="exportUsers">Export users to CSV file</g:link></li>
+                    <g:if test="${grailsApplication.config.getProperty('attributes.affiliations.enabled', Boolean, false)}">
+                        <li><g:link controller="admin" action="surveyResults">Get user survey results</g:link></li>
+                    </g:if>
+                    <li><g:link controller="alaAdmin" action="index">ALA admin page</g:link></li>
                 </g:if>
-                <li><g:link controller="alaAdmin" action="index">ALA admin page</g:link></li>
+                <g:else>
+                    <li><g:link controller="user" action="create">Create a user</g:link></li>
+                </g:else>
             </ul>
 
             <h2>Web services (HTTP POST)</h2>

diff --git a/grails-app/views/profile/myprofile.gsp b/grails-app/views/profile/myprofile.gsp
@@ -60,7 +60,7 @@
                         </div>
                     </div>
 
-                    <g:if test="${isAdmin}">
+                    <g:if test="${isAdmin || isBiosecurityAdmin}">
                         <div class="d-flex">
                             <div class="image">
                                 <i class="glyphicon glyphicon-cog"></i>

diff --git a/grails-app/views/user/_form.gsp b/grails-app/views/user/_form.gsp
@@ -18,7 +18,7 @@
 <div class="row">
     <div class="col-md-6">
         <div class="form-group fieldcontain ${hasErrors(bean: userInstance, field: 'firstName', 'error')} ">
-            <label for="fi rstName">
+            <label for="firstName">
                 <g:message code="user.firstName.label" default="First Name"/>
             </label>
             <g:textField name="firstName" class="form-control" value="${userInstance?.firstName}"/>
@@ -92,6 +92,7 @@
 
 <hr/>
 
+<g:if test="${!isBiosecurityAdmin}">
 <div class="fieldcontain ${hasErrors(bean: userInstance, field: 'userRoles', 'error')} ">
     <label for="userRoles">
         <g:message code="user.userRoles.label" default=" Roles"/>
@@ -119,6 +120,7 @@
                     params="['user.id': userInstance?.id]">${message(code: 'default.add.label', args: [message(code: 'userRole.label', default: 'UserRole')])}</g:link>
 
 </div>
+</g:if>
 
 </div>
 

diff --git a/grails-app/views/user/create.gsp b/grails-app/views/user/create.gsp
@@ -42,7 +42,7 @@
             </g:hasErrors>
             <g:form action="save">
                 <fieldset class="form">
-                    <g:render template="form"/>
+                    <g:render template="form" model="[isBiosecurityAdmin: isBiosecurityAdmin]"/>
                 </fieldset>
                 <fieldset class="buttons">
                     <g:submitButton name="create" class="btn btn-primary"

diff --git a/src/main/groovy/au/org/ala/auth/PreAuthorise.groovy b/src/main/groovy/au/org/ala/auth/PreAuthorise.groovy
@@ -30,7 +30,11 @@ import java.lang.annotation.Target
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 public @interface PreAuthorise {
-    String requiredRole() default "ROLE_ADMIN"
+    /***
+     *  A list of roles that is allowed to access the method. The user must have at least one role to access the method.
+     * @return
+     */
+    String[] allowedRoles() default ["ROLE_ADMIN"]
     String redirectController() default "userdetails"
     String redirectAction() default "index"
     String requiredScope() default "users/read"

diff --git a/src/test/groovy/au/org/ala/userdetails/RoleBasedInterceptorSpec.groovy b/src/test/groovy/au/org/ala/userdetails/RoleBasedInterceptorSpec.groovy
@@ -107,4 +107,49 @@ class RoleBasedInterceptorSpec extends UserDetailsSpec implements InterceptorUni
         response.status == HttpStatus.SC_OK
 
     }
+
+    void "ROLE_USER_CREATOR users should not be able to access the user role UI"(String action, boolean result) {
+
+        setup:
+        request.addUserRole("ROLE_USER_CREATOR")
+
+        when:
+        request.setAttribute(GrailsApplicationAttributes.CONTROLLER_NAME_ATTRIBUTE, 'userRole')
+        request.setAttribute(GrailsApplicationAttributes.ACTION_NAME_ATTRIBUTE, action)
+        withRequest(action: action)
+
+        then:
+        interceptor.before() == result
+
+        where:
+        action | result
+        'list' | false
+        'create' | false
+        'addRole' | false
+        'deleteRole' | false
+    }
+
+    void "ROLE_USER_CREATOR users should be able to access the user UI"(String action, boolean result) {
+
+        setup:
+        request.addUserRole("ROLE_USER_CREATOR")
+        controller = new UserController()
+        grailsApplication.addArtefact("Controller", UserController)
+
+        when:
+        request.setAttribute(GrailsApplicationAttributes.CONTROLLER_NAME_ATTRIBUTE, 'user')
+        request.setAttribute(GrailsApplicationAttributes.ACTION_NAME_ATTRIBUTE, action)
+        withRequest(action: action)
+
+        then:
+        interceptor.before() == result
+
+        where:
+        action | result
+        'list' | false
+        'create' | true
+        'save' | true
+        'edit' | false
+        'show' | false
+    }
 }