openxava / documentation / Security and user management

All the features in this article are available only in XavaPro

User management

XavaPro adds the modules Roles, Modules and Users to your application, in a folder called Admin. These modules allows you to configure the access levels for different user types.

Usually, you create a new role and assign some modules to it. Then, go to the Users module, choose a user and assign the new role to him. By default, there are two roles already created: admin with access to Users, Roles, Modules and Folders , and user with access to all the modules of your application. New modules are not added automatically to user role (or any role), so you have to add new modules explicitly to role user (or any other role) using the Roles module.
If you remove access to the default module of an entity, modifying and creating references to that entity is not allowed. For example, if the users of a particular role cannot access the Customer module, they cannot create or modify customers from the Invoice module either (new in v5.3).
The above user management system is only available in XavaPro, with plain OpenXava you have to add users in the naviox-users.properties file inside properties folder of your project.

Restricting user access to actions

If you want to restrict users of certain roles from executing certain actions, go to the Roles module and choose that role to edit in detail mode. Then click in the module where you want to restrict those actions, and a dialog like the next one will appear:

Select the actions you want to exclude and click on Save. From now on, all the users of that role will not be able to execute those actions in that module.
Restricting access to New and Save restricts access for creating and modifying from references also, if you do it for the default module of that entity. For example, if you restrict access to Save action in Customer module, the user will not be able to modify Customer data from Invoice module (new in v5.3).
Restricting user access to actions is only available in XavaPro.

Restricting user access to properties, references and collections (new in v5.5)

If you want to restrict users of certain roles from accessing certain properties, references or collections, go to the Roles module and choose that role to edit in detail mode. Then click in the module where you want to restrict those members, and a dialog like the next one will appear:

Select the members you want to exclude in Excluded data and click on Save. From now on, all the users of that role will not be able to access those members in that module. Note you also have Read only data to allow the users to see the data but not to change it.
Restricting user access to properties, references or collections is only available in XavaPro.

Read only module with one click (new in v7.2)

Since version 5.5, you have the capability to designate specific data as read-only for a particular role and control the actions available for that role. With this feature, you can easily make a module read-only for a specific role. However, this approach had its drawbacks, especially when new fields were introduced to the entity, as it required constant configuration adjustments.
To address these challenges, starting from version 7.2, the module rights configuration dialog for a role now includes a convenient checkbox labeled Read only. This checkbox enables you to mark a module as read-only for the selected role with a single click, simplifying the process significantly:

A read only module has all member not editable and only has navigation and print actions.
Read only modules are only available in XavaPro.

Hiding a module in the menu without restricting it (new in v6.5)

If you want that a module will be not shown in the menu for users of certain roles but that at the same time that module would be accessible by those users, typing the URL in the browser, for example. Go to the Roles module and choose that role to edit in detail mode, once there click on the module you want to hide in the menu, and a dialog like the next one will appear:

Check the Not in menu option and click on Save. From now on, all the users of that role will not see the module, Customer in our example, in the left menu, however it will be still accessible, so if the user goes to http://yoursite.com/YourApp/m/Customer with his browser the module will work.
Hiding modules in the menu is only available in XavaPro.

User and password policies

There are a lot of options available for user management and password policies. In the Admin folder you'll find a Configuration module:

You can configure these policies in order for your system to be PCI-DSS compliant, which is required for any applications which handles credit card data!
These policies for users and passwords are only available in XavaPro.

LDAP

XavaPro allows the users to be authenticated via LDAP. To configure LDAP edit the naviox.properties file and add the next entries:

# LDAP Config
ldapHost=192.168.0.0
ldapDomain=XX
ldapDN=DC=XX,DC=XX,DC=XX
ldapPort=389

If you use OpenLDAP omit the ldapDomain entry (since v5.9.1), like in this example:

# Example of OpenLDAP Config
ldapHost=192.168.2.xxx
ldapDomain=
ldapDN=ou=people,dc=dgrtdf,dc=gov,dc=ar
ldapPort=389

Note as ldapDomain has no value.
By default all the users are authenticated using XavaPro stored passwords. To enable LDAP you have to select the users and check Authenticate with LDAP option:

LDAP support is only available in XavaPro.

Guest can create a user account himself

In the sign in box you have a link labeled as SIGN UP:

The user can click on it to go to a form to registering:

After submitting this form the user is created and signed in. There is a self sign up role to determine the rights for the autocreated users.
You can disable this feature with the configuration module.
Since v6.0 you can show a privacy policy in the sign up page, the privacy policy text is get from privacy_policy entry in the messages i18n files. It's required that the user check the checkbox to accept the policy to do the sign up. The date of the policy acceptance is stored with the user data. You can hide the privacy policy on sign up using the configuration module.

Creation date and record of logins for each user

Just go to the users module to see that data:

Password recovery (new in v5.7)

The user can recover his password by himself. When he fails to put the correct password a "Forgot your password?" message with a link is shown:

When the user clicks on the link goes to a page to enter his email:

After clicking on the "Recover password" button an email with instructions to recover the password is sent. Of course, a user with that email has to be registered in the system.
To use the recover password feature you have to configure the email properties in xava.properties, something like this:

#SMTP related information
smtpHost=smtp.gmail.com
smtpPort=587
smtpUserId=myemail@gmail.com
smtpUserPassword=mypassword
smtpHostTrusted=true
smtpStartTLSEnable=true

User is asked to enter his email (new in v5.7)

In order the recovering password mechanism works it's needed that each user has his email registered in the system. So now if the user has no email XavaPro asks for it after sign in:

Entering the email is not required, the user can go to any other module and leaves the email blank if he wishes.
This new "My personal data" module is always available for all users to edit their own personal data.

To disable this feature, so the user is not asked to enter his email each time he sign in, you have to remove the "My personal data" module from the role of the user.

Email as user name (new in v6.0)

In the Configuration module there is an option called Use email as user name. If you check it it's required that when a new user sign up uses an email as user name. Moreover, the already created users can sign in using their emails instead of user names.
The validation of the email on sign up can be customizing with the emailValidatorForSignUpClass in naviox.properties, for example:

emailValidatorForSignUpClass=com.mycompany.myapp.MyEmailValidator

In this case the validation logic of MyEmailValidator (must implement IPropertyValidator) is applied on sign up for the email. The default validation for email just verifies that email has the correct syntax, but sometimes you want to have different validation, such as the email would be a company email, for example. You can do that validation in your custom email validator.

Restrict access by IP (new in v6.4)

It's possible to define an "allowed IP" for a user so that user can only access from that IP. For that, go to the Users module in the Admin folder, choose an user and then give a value to the Allowed IP field:

Finally, click on Save. If the Allowed IP value is blank the user can access from any IP.

Custom authentication code (new in v7.0)

To define your own logic for user authentication you have to create a class that implements the ISignInHelperProvider interface. The typical case is to refine the standard way XavaPro authenticates users, for that extend ProSignInHelperProvider, in this way:

package com.mycompany.myapp.impl;

import javax.servlet.*;
import org.openxava.util.*;
import com.openxava.naviox.impl.*;

public class MyCustomSignInHelperProvider extends ProSignInHelperProvider {
	
    @Override
    public boolean isAuthorized(
		ServletRequest request, String userName, 
		String password, Messages errors, String unauthorizedMessage) 
	{
        // This is your custom authentication logic
        if (userName.equals("admin") && password.equals("masterkey")) return true; 
		
		
        // In the next line we rely in the default XavaPro authentication logic
        return super.isAuthorized(request, userName, password, errors, unauthorizedMessage);
    }

}

In this case the logic is simple, if the user type "masterkey" as password for "admin" user it access to the application as "admin", otherwise the regular authentication logic of XavaPro is applied. However, here you can write any logic you want, including calling web services, reading your own users database, consulting your LDAP directory in the way you want, etc.

In order your application uses the above class for authentication you have to add the next entry in the naviox.properties file of your project:

signInHelperProviderClass=com.mycompany.myapp.impl.MyCustomSignInHelperProvider

Single Sign-On (SSO) (new in v7.1)

Since XavaPro 7.1 you can use Azure AD to give SSO to your OpenXava applications. Look at the SSO with Azure AD guide.

Two-Factor Authentication (2FA) (new in v7.1)

Since XavaPro 7.1 you can use Azure AD to give Two-Factor Authentication to your OpenXava applications. Look at the SSO with Azure AD guide.