restx.security

Class FileBasedUserRepository<U extends RestxPrincipal>

java.lang.Object

restx.security.FileBasedUserRepository<U>

All Implemented Interfaces:

UserRepository<U>

public class FileBasedUserRepository<U extends RestxPrincipal>
extends Object
implements UserRepository<U>

A UserRepository implementation using 2 files to load data. One file is used to store users, in json format as a Map<String, U> read with jackson. Example:

         [
             {
                 "name": "admin",
                 "principalRoles": ["restx-admin"]
             }
         ]
     

Another file is used to store user credentials. Storing credentials separately is a good practice, which allow to have different security policies on the two files, and avoid to have credentials part of the user class. Example:

         {
             "admin": "tuyvuicxvcx78vdsfuisd"
         }
     

Constructor Summary

Constructors

Constructor and Description
FileBasedUserRepository(Class<U> userClass, com.fasterxml.jackson.databind.ObjectMapper mapper, U defaultAdmin, java.nio.file.Path usersPath, java.nio.file.Path credentialsPath, boolean reloadOnChange)

Method Summary

Modifier and Type	Method and Description
U	defaultAdmin() Returns the default admin to use if none is defined and authentication succeeds.
com.google.common.base.Optional<String>	findCredentialByUserName(String userName) Finds a user credentials by userName
com.google.common.base.Optional<U>	findUserByName(String name) Finds a user by name in the repository.
boolean	isAdminDefined() Tells wether a restx admin is defined in this repository.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileBasedUserRepository

public FileBasedUserRepository(Class<U> userClass,
                               com.fasterxml.jackson.databind.ObjectMapper mapper,
                               U defaultAdmin,
                               java.nio.file.Path usersPath,
                               java.nio.file.Path credentialsPath,
                               boolean reloadOnChange)

Method Detail

findUserByName

public com.google.common.base.Optional<U> findUserByName(String name)

Description copied from interface: UserRepository

Finds a user by name in the repository.

Specified by:

findUserByName in interface UserRepository<U extends RestxPrincipal>

Parameters:

name - user name

Returns:

Optional user

findCredentialByUserName

public com.google.common.base.Optional<String> findCredentialByUserName(String userName)

Description copied from interface: UserRepository

Finds a user credentials by userName

Specified by:

findCredentialByUserName in interface UserRepository<U extends RestxPrincipal>

Parameters:

userName - user name

Returns:

Optional credential

isAdminDefined

public boolean isAdminDefined()

Description copied from interface: UserRepository

Tells wether a restx admin is defined in this repository. This allows to access restx admin console even when the user repository is empty or does not contain a restx admin. Returning true will simply bypass the default admin behavior, and thus prevent any connection to the admin console if no restx admin user is actually present in the UserRepository. Note that default admin password check is performed based on a string injected password hash which is not very secured.

Specified by:

isAdminDefined in interface UserRepository<U extends RestxPrincipal>

Returns:

true is a restx admin is defined in this repo.

defaultAdmin

public U defaultAdmin()

Description copied from interface: UserRepository

Returns the default admin to use if none is defined and authentication succeeds. Note that implementation must return a value even if they always return true on isAdminDefined(), because the default admin user name is checked before isAdminDefined() because in most implementations returning defaultAdmin is less expensive than checking if admin is defined.

Specified by:

defaultAdmin in interface UserRepository<U extends RestxPrincipal>

Returns:

the default restx admin user. See restx-admin module for details on restx admin.