Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To improve login security, Abiquo supports two-factor authentication for the UI with basic authentication.

Abiquo can send an authentication code:

  • via email

  • using Google Authenticator

The steps to use 2FA are:

  1. Configure the authentication options in the platform

  2. Activate 2FA for the platform

  3. If 2FA must be used in an enterprise, edit the enterprise and select the required option

  4. Users activate 2FA for their accounts.

    1. This is optional if 2FA is not mandatory for their enterprise

Tip

When you enable the Abiquo OpenID Connect integration, Abiquo disables two-factor authentication.

Configure 2FA for the platform

Excerpt

Basic requirements of 2FA:

Requirements for integrations:

For

each enterprise that uses 2FA, migrate automation and integrations to OAuth. See Authentication#OAuthv1.0VersionAAuthentication.
  • To implement two-factor authentication for a portal, see Authentication

  • Requirements for events and event streaming:

  • if the M-user belongs to a tenant that must use 2FA, configure the M-user to use OAuth.

  • Enter the OAuth credentials in the Abiquo properties file. See Abiquo configuration properties and search for .m. See Authentication#OAuthv1.0VersionAAuthentication

    integration and events requirements, see below.

    To configure 2FA, customize properties and files, and enable it on the platform:

    1. Log in to the Abiquo API Server

    2. Go to /opt/abiquo/config and edit the abiquo.properties file. For full details about any Abiquo property see Abiquo configuration properties

    3. For Google Authenticator,

      1. set the property with the name of the issuer of authentication codes.

        Code Block
        abiquo.2fa.issuer=Abiquo
    4. For email, :

      1. configure the mail server with server.mail properties, including the sender with the from property. You can also set custom properties by replacing {javax mail property}with a property name.

        Code Block
        abiquo.server.mail.from=  
        abiquo.server.mail.password=none  
        abiquo.server.mail.port=25
        abiquo.server.mail.server=127.0.0.1  
        abiquo.server.mail.ssl=false
        abiquo.server.mail.tls=false
        abiquo.server.mail.user=none@none.es
        abiquo.server.mail.extra.{javax mail property}=  
      2. Optionally, change the length of time in seconds that the email codes will be valid for

        Code Block
         abiquo.2fa.email.timestep=60 
      For email authentication, you can
      1. To customize the email message

      . See Customize email and SMS messages
      1. , see Customize emails for two factor authentication

    5. In Abiquo, enable two-factor authentication for the platform:

      1. Go to Configuration → Security

      2. Edit the options and select Enable two factor authentication

    Enable 2FA in Configuration view

    Requirements for integrations:

    Requirements for events and event streaming:


    Require 2FA for a tenant

    To configure a tenant so that all the users must work with two-factor authentication:

    1. Go to Users

    2. Edit an enterprise and go to General

    3. Select the checkbox to Require two-factor authentication for all users in the enterprise

    4. Click Save

    Select a checkbox to require two-factor authentication for a tenant


    2FA for users

    When a user’s enterprise requires two-factor authentication, the user must enable it from the user icon menu.

    Even if the enterprise does not require two-factor authentication, the user can enable it for their own account from the user icon menu.

    For details of how the user must enable 2FA, see https://abiquo.atlassian.net/wiki/spaces/doc/pages/311370224/Starting+Abiquo+for+the+first+time#Use-two-factor-authentication.

    User icon menu with 2FA optionImage RemovedUser icon menu with 2FA optionImage Added


    Remove the option for users to enable 2fa

    By default, the option to enable 2fa appears in the user icon menu. To remove the Two factor authentication option, edit the client-config-custom.json file, and set the following property:

    Code Block
    client.2fa.activated=false

    For more details, see Configure Abiquo UI.


    Manage two factor authentication via the API

    To require 2fa mandatory for a tenant, edit the enterprise and set the value of the twoFactorAuthenticationMandatory attribute to true.

    To enable or disable 2fa for a user, post the authentication method to the action link of the user.

    ...