Authentication with OpenID

With this extension, users can connect to iTop using OpenID providers (Facebook, Google, Twitter, LinkedIn, MicrosoftGraph …)

Add capability to configure SSO authentication with most common OpenID Identity providers (Facebook, Google, Twitter, LinkedIn, MicrosoftGraph …)

• It offers new authentication modes based on oAuth and OpenID Single Sign On (SSO) for the following OpenID providers:
• Those modes can be mixed with other modes (internal, SAML …)
  
• It is possible to configure several Identity providers if you want to allow access for instance to both Google and MicrosoftGraph
• It relies on HybridAuth library library, which provides a unified interface to identify a user and retrieve contact information.
• Some of those Identity providers are able to provide user information to allow automatic User and Person provisioning in iTop.
  Check the third column of the Providers table, it is required for automatic User/Person provisioning on User first connection.

There is no mapping capability for contact provisioning.

This capability may not work if you have changed the default datamodel

You have to configure the iTop application on your Identity provider to allow communication between iTop and this one. Look at your Identity provider documentation for more details.

Use the Standard installation process for this extension.

First, you have to configure the iTop provider on your identity provider (Google, Facebook …)

• The iTop landing page to provide to your Identity provider is:

<itop url>/env-production/combodo-hybridauth/landing.php

Once iTop is configured,

• open the file 'config-itop.php'
• add to the allowed_login_types parameter, the corresponding provider in the form of hybridauth-<provider name>

config-itop.php

allowed_login_types => 'form|hybridauth-Facebook|hybridauth-Google|hybridauth-MicrosoftGraph|basic|external',

• form must remain the first, for all the others to be proposed to the user.
• If an hybridauth option is entered first, then the login page directly jump to the remote provider login page. basic must be left in the list for REST to still work.

The configuration is located in the section combodo-hybridauth.
In the providers section you can configure several providers. The “enabled” flag allows to activate the each authentication provider or not

For each provider, you have to specify the application id configure on the provider side, and the secret for authentication

It should look as shown below:

Example of a configuration in which Google is configured but deactivated and MicrosoftGraph is activated:

config-itop.php

'combodo-hybridauth' => array (
    'debug' => true,
    'synchronize_user' => true,
    'synchronize_contact' => true,
    'default_organization' => 'demo',
    'default_profile' => 'Portal User',
    'providers' => array (
      'Google' =>
      array (
        'enabled' => false,
        'keys' =>
        array (
          'id' => 'your-google-client-id',
          'secret' => 'your-google-client-secret',
        ),
      ),
      'MicrosoftGraph' => 
        array (
            'enabled' => true,
            'keys' => 
                    array (
                      'id' => 'xxxx-xxxxx-xxxxx-xxxxx',
                      'secret' => 'xxxxxx',
          ),
       ),
   ),
),

Options set globally in the module section, can be override for a specific provider:

• default_organization,
• default_profile,
• synchronize_user,
• synchronize_contact

Example with Google here, that describes how to use different profile and organization for a given provider:

      'combodo-hybridauth' => array (
                'debug' => false,
                'synchronize_user' => false,
                'synchronize_contact' => false,
                'default_organization' => 'GlobalOrg',
                'default_profile' => 'Configuration Manager',
                'providers' => array (
                  'Google' => 
                  array (
                    'keys' => 
                    array (
                      'id' => 'id',
                      'secret' => 'secret',
                    ),
                    'enabled' => true,
                    'synchronize_user' => true,
                    'synchronize_contact' => true,
                    'default_profile' => 'PortalUser',
                    'default_organization' => 'IT Department',
                  ),
                ),
        ),

If you don't use the automatic provisionning, you have to create in iTop SSO users using the type External user when prompted for a “New user Account”:

Once configured, the Login form will look like

If you activate the User/Person provisioning, here is what will be filled automatically with what the hybridauth provider returns (Not all data are provided by each provider)

• Person fields provisioned regardless of the Provider: first_name, name, email, phone, org_id with the fixed value from the Configuration File
• User field provisioned: login, person_id

The rest of the fields got their default value.

If the iTop standard datamodel was changed by adding mandatory field without default value on User and/or Person, this can break the provisioning

Q: Can I mix OpenID Connect and a captcha?
A: Yes this is possible using the Combodo's customer extension Brute Force Protection.

Q: What is Hybridauth, OpenID Connect and OAuth2?
A:

• Hybridauth is the PHP library used by iTop to run the OpenID Connect protocol
• OpenID Connect is the 3rd version of the OpenID protocol, it uses OAuth2, it's a protocol used exclusively for Authentication and user provisionning

More info in french

Q: Can we change the layout of the login page (name, button,…)?
A: Since version 1.2.0 (inclued in iTop pro 3.1.1) this is possible to customize the label, tooltip and icon on the buttons.

For example, if you would like to change the label and the icon to connect to google provider you can replace de default button by the one below

Define in module section theirs settings:

config-itop.php

'combodo-hybridauth' => array (
        'debug' => false,
        'synchronize_user' => false,
        'synchronize_contact' => false,
        'default_organization' => '',
        'default_profile' => 'Portal User',
        'providers' => array (
          'Google' => 
                array (
                  'enabled' => true,
                   'label' => 'Login like a bear',
                   'tooltip' => 'Login with your paw',
                   'icon_url' => 'fas fa-paw',
                  'keys' => 
                  array (
                    'id' => 'your-google-client-id',
                    'secret' => 'your-google-client-secret',
                  ),
                ),
        ),
),

In this case, the provider is still Google but the icon and the label display on the button to connect to Google won't be the default ones anymore

Q: Can we implement several connexion for a given provider to implement several tenant?
A: Since version 1.2.0 (inclued in iTop pro 3.1.1) this is possible to configure several connexion to different tenant using the same provider.

In the example below we configure connexion with MicrosoftGraph to TENANT1 and TENANT2

You have to configure the module combodo-hybridauth to define 2 providers using the same adpater (method to access the provide). It is MicrosoftGraph in our example.

The code TENANT1 and TENANT2 are the idenfier that will be used in the variable allowed_login_type to allow those connexions

You can specify application id and secret corresponding to your tenant and define label, tooltip and icon specific to help the user to chose the good connexion method.

config-itop.php

'combodo-hybridauth' => array (
                'debug' => true,
                'synchronize_user' => false,
                'synchronize_contact' => false,
                'default_organization' => '',
                'default_profile' => 'Portal User',
                'providers' => array (
                  'TENANT1' => 
                  array (
                    'adapter' => 'Hybridauth\\Provider\\MicrosoftGraph',
                    'label' => 'Authentification On Tenant 1',
                    'tooltip' => 'Connexion from O365 - Tenant 1',
                    'enabled' => true,
                    'keys' => 
                    array (
                      'id' => 'MyApplicationIdOnTOnMyTenant-1.fr',
                      'secret' => 'MySecretOnMyTenant-1',
                    ),
                    'synchronize_user' => true,
                    'synchronize_contact' => true,
                    'tenant' => 'MyTenant-1.fr',
                    'default_organization' => 'MyCompagny',
                  ),
                  'TENANT2' => 
                  array (
                    'adapter' => 'Hybridauth\\Provider\\MicrosoftGraph',
                    'label' => 'Authentification On Tenant 2',
                    'tooltip' => 'Connexion from O365 - Tenant 2',
                    'enabled' => true,
                    'keys' => 
                    array (
                      'id' => 'MyApplicationIdOnTOnMyTenant-2.fr',
                      'secret' => 'MySecretOnMyTenant-2',
                    ),
                    'synchronize_user' => true,
                    'synchronize_contact' => true,
                    'tenant' => 'MyTenant-2.fr',
                    'default_organization' => 'Demo',
                  ),
                ),
        ),

In this case, the provider 'TENANT1' gives access to iTop with a MicrosoftGraph connexion to MyTenant-1.fr, and the provider 'TENANT2' to MyTenant-2.fr

in your configuration file, you have to add values hybridauth-TENANT1 and hybridauth-TENANT2 in field allowed_login_types:

config-itop.php

'allowed_login_types' => 'url|form|hybridauth-TENANT1|hybridauth-TENANT2|external|basic',