Frequently Asked Questions#
Common administrative tasks#
Where are the logs?#
The application logs are located at
/opt/gluu/jetty/casa/logs. By default, Casa uses the INFO level for messages. You can change the log level at will using the app's admin UI.
How do I restart the application?#
Just restart casa service.
How do I custom brand Casa?#
We have a dedicated page covering the topic of custom branding here.
What ports are used by the application?#
Casa uses port
8099. One way to see if the app is up and running is by checking whether this port is open by issuing a command like
How to turn 2FA off for a user?#
If a user has been locked out for any reason (e.g. lost devices), you can reset his "authentication method" to password by accessing the admin console and choosing the menu item labelled "Reset users preference". Type the username (or part of) in the text field and then press search. Once you locate the user in the result grid, click the corresponding row and then hit "Change to password". The row will become disabled, and you'll see a success message.
If you've followed the steps as described above, next time he attempts to log in, he won't be asked to present any credentials other than password to enter.
How to adjust the issuer for OTP tokens#
When people add OTP mobile apps, the enrollment appears in the device associated with an "issuer", so it is easy to recognize where the OTPs generated can be used. To keep track of which OTPs are valid for which IDPs, the issuer property can be adjusted in the Gluu Server OTP script. For example, you might want to set the
issuer property to
ACME Dev on your dev server, and
ACME, Inc. on your production server.
See the screenshot below to see where to edit this property in your Gluu Server IDP.
Errors shown in the UI#
A page with a "Service Temporarily Unavailable" message appears when accessing the application#
This is the 503 HTTP error. There is an Apache server in front of the application (as with oxAuth/oxTrust) and this means the reverse proxy couldn't establish a communication internally with the app. This usually happens when Casa hasn't started completely, so it's usually a matter of waiting a few seconds.
For instance, when you restart the
gluu-server service, it may take some time for Casa and oxd to become available even when the prompt is back in the console terminal. See also this question.
An "incorrect email or password" error is shown when pressing the login button in the SSO form#
This reveals a problem in execution of casa custom script. Check if
oxauth_script.log is showing an error related to the authentication method in question.
If you cannot diagnose the issue, please use the support forum to ask for help.
An "Unauthorized access" error is shown when accessing the application#
This is caused by an unauthorized access attempt (e.g. users requesting URLs without ever logging in or after session has expired).
"An error occurred during authorization step" is shown when accessing the application#
This is shown when it is not possible to initiate a "conversation" with the authorization server. Check that the oxd server is up and running and that the oxd settings are properly configured. Find them at the administration console or directly in the database.
"An error occurred: Casa did not start properly" is shown when accessing the application#
This occurs whenever the application failed to start successfully and may be caused by a syntax problem in the application configuration or an inconsistent configuration supplied. Check the log to diagnose the problem. Try to find a message like "WEBAPP INITIALIZATION FAILED" and see the traces above it. Often, error messages are self-explanatory.
Once fixed, please restart the application. You will have to see a "WEBAPP INITIALIZED SUCCESSFULLY" message to know that it's working.
In case of lockout#
For versions 4.1 or earlier, when there were problems with the OIDC client used by oxd to communicate with oxAuth, the solution involved editing a configuration file and doing a restart. Starting with version 4.2, such file contents were moved to the underlying database. To make it easy for admins to apply the tweak required (no low-level ldap or couchbase commands), we deliver a small CLI tool that allows flushing some oxd configurations.
Please do the following:
- Stop casa if still running
cdto a temp location
- Extract required files:
jar -xf /opt/gluu/jetty/casa/webapps/casa.war WEB-INF/classes/org/gluu/casa/misc WEB-INF/lib
java -cp .:../lib/* org.gluu.casa.misc.ClientReset
Some output feedback will be printed to console; ensure the process acknowledges success. To finish, restart casa. This will trigger a client registration for the application to become accessible again.
If the above went fine, feel free to remove the temporary directory you created earlier.
Casa log shows "Setting oxd-server configs failed"#
oxd-server 4.x uses https for communication so it is expected to use a production ready SSL certificate. If your log also shows "javax.net.ssl.SSLPeerUnverifiedException: peer not authenticated" or "unable to find valid certification path to requested target", this is due to self-signed certificate usage (as is the case in a default oxd installation). You can configure oxd to use a production cert or add the self-signed cert to the trusted Java certificates file. For the latter take the
.keystore file referenced in the
oxd-https.yml config file, and export the certificate (this file contains the password too). Then run a command like the following in the Gluu chroot:
keytool -import -trustcacerts -keystore /opt/jre/jre/lib/security/cacerts -storepass changeit -noprompt -alias mycert -file PATH_TO_CERT_FILE
Finally, restart casa.
If you are using the oxd-server installed by casa installer, this is automatically done for you.
Registration of clients fail#
Ensure dynamic client registration is enabled: in your Gluu Server admin UI ("oxTrust"), navigate to
JSON Configuration >
oxAuth configuration, find the
dynamicRegistrationEnabled property, and confirm it is set to
true. Do the same for property
Note both properties can be turned off after Casa client registration succeds.
Admin console is not shown#
If you have logged in using an administrative account and cannot find any admin features in the UI ensure you have performed this step.
How to remove the consent form shown upon first login?#
By default, Gluu server will present users a consent form for release of personal data to the application (Casa). In case this prompt is shown, edit the OIDC Casa client this way using oxTrust: Go to
OpenID Connect >
Clients, then select the gluu_casa* entry and check the
Pre-Authorization field, finally, save changes by pressing on
Troubleshooting interception scripts#
In order to ensure authentication scripts are properly configured in Gluu, it is advisable to:
Check the contents of the
oxauth_script.logfile (found at
/opt/gluu/jetty/oxauth/logs). There should be no errors; only successful initialization messages. Every time a new script is enabled, give the server a minute to pick up the changes.
Scripts included in the default Gluu Server distribution will provide basic working functionality. To see a script in action, enable a script in
Manage custom scripts, then set it as the default oxTrust acr in
Default authentication method>
oxTrust acr. Open an incognito browser and login to your oxTrust dashboard. By default, your 2FA credential will be enrolled during the first authentication attempt.
A previously enabled method is not available anymore#
If for some reason you disabled the custom script of an authentication method used by Casa, such method will not be available for enrollment or authentication until you enable both the custom script (in oxTrust) and the method (in Casa admin dashboard).
What kind of TOTP/HOTP devices are supported?#
Both soft (mobile apps) or hard tokens (keyfobs, cards, etc.) are supported. Supported algorithms are
Authentication fails when using TOTP or HOTP with no apparent reason#
For Time-based OTP, ensure the time of your server is correctly synchronized (use NTP for instance). The time lag of the authentication device used (for instance, a mobile phone) with respect to server time should not be representative.
Big time differences can cause unsuccessful attempts to enroll TOTP credentials in Casa.
For Event-based OTP (HOTP), ensure you are using a suitable value for
look ahead window (we suggest at least 10). Check contents of file
/etc/certs/otp_configuration.json. If you apply editions, it is recommended to press the "Update" button of the "Manage Custom Scripts" form in oxTrust and wait a couple of minutes before retrying..
It is recommended not to use U2F but FIDO2 as authentication method. Visit this page for more information.
U2F keys (for enrollment or authentication) are supported in the following desktop browsers only:
- Chrome >= 70
- Firefox >= 71
- Opera >= 57
In all cases, the app interface will display appropriate messages about u2f support, and instructions in case action is needed to use the feature. Currently Casa does not support adding U2F devices from mobile browsers.
The user interface is not showing any means to enroll credentials#
Ensure the following are met:
You have enabled custom scripts as needed. For instance, if you want to offer users the ability to authenticate using Google Authenticator, you have to enable the script "HOTP/TOPT authentication module". Whenever you enable or disable scripts, please wait a couple of minutes for oxAuth to pick the changes.
In the administration console, you can see which methods are already enabled in the server, and modify those you want to offer.
A user cannot turn 2FA on#
To turn 2FA on, the user has to have enrolled at least a certain number of credentials through the app. Only after this is met, he will be able to perform this action.
In the administration console you can specify the minimum number of enrolled credentials needed to enable second factor authentication for users. Please check the 2FA Settings plugin for more details.
The log shows an error related to Obtaining "acr_values_supported" from server#
Upon startup, the application needs to query the OpenID metadata URL of oxAuth to build the list of available authentication mechanisms. This warning is shown when the URL is not yet accessible or the list hasn't loaded fully. However, the application does several (around 15) evenly timed attempts in order to gather the required info. These messages are not a sign of a malfunction.
My problem is not listed here#
Feel free to open a support ticket.