Subject |
This guide explains how to use the Enterprise SSO Configuration Editor, which enables you to describe the applications for which Enterprise SSO will implement Single Sign-On (SSO). | ||
Audience |
This guide is intended for:
| ||
Required Software |
EAM 9.0 evolution 2 and later versions. For more information about the versions of the required operating systems and software solutions quoted in this guide, please refer to One Identity EAM Release Notes. | ||
Typographical Conventions |
Bold Indicates:
| ||
|
Italics - Indicates references to other guides. | ||
|
Code - Indicates portions of program codes, command lines or messages displayed in command windows. | ||
|
CAPITALIZATI ON Indicates specific objects within the application (in addition to standard capitalization rules). | ||
|
< > Identifies parameters to be supplied by the user. | ||
|
| ||
|
| ||
|
| ||
Documentation support |
The information contained in this document is subject to change without notice. As our products are continuously enhanced, certain pieces of information in this guide can be incorrect. Send us your comments or suggestions regarding the documentation on the One Identity support website. |
This section presents Enterprise SSO basic concepts.
ESSO Enterprise Studio, the Enterprise SSO configuration editor is used to describe the applications for which Enterprise SSO will enable Single Sign-On (SSO).
An application is defined by:
The application windows or HTML pages that refer to the authentication management tool must be described in Enterprise SSO using the configuration editor tools.
This description allows to recognize the window or HTML page whenever it is displayed to the user. Enterprise SSO intercepts these pages and implements SSO.
In addition to the elements that allow window/page detection, the description contains the actions that the SSO engine has to perform.
Each window is defined by a type that characterizes the target application technology and the actions that the SSO engine will perform. Indeed, the events that refer to the user’s authentication in an application can be of different kinds: authentication, password update request, etc.
Enterprise SSO manages the different events relating to the application behavior.
Application profiles include the parameters of one or more applications that can then be defined differently, depending on the users that access them.
These profiles are used to assign applications to users.
An application access profile is includes by the following parameters:
A PFCP defines:
The PFCP is applied only when E-SSO detects a password update is requested by the application (example: see Updating the Password of a User Account upon Application Request). When the password is changed manually or when the account data is collected for the first time, the PFCP is not applied.
A user authenticates to a secure application as follows:
Once connected, the user can change the password, either at will or at the application’s request:
The following schema illustrates the diagram of an application behavior.
Enterprise SSO manages the application behavior regarding to the user authentication we have just described. This behavior is configured by choosing a type for the defined windows.
A window type indicates the SSO engine behavior and the technology of the managed application.
An application’s behavior includes:
The technologies managed by Enterprise SSO are:
Several types of LDAP directories are supported for user security data storage.
|
NOTE:
|
The Access Collector mode is an option of Enterprise SSO; which automatically collects all user accounts and stores them in the users' directory. This mode only works if the workstations are configured as "without Controller".
The goal of this feature is to report to the administrators all the accounts used to access the applications of the enterprise, so that they can create an access policy adjusted to the needs. Only one account can be collected for one application (multi-account is not supported).
When a user launches an application that is detected by Enterprise SSO, the latter starts the account collect.
Once the account is collected, the SSO is deactivated for the application.
The SSO is only performed if there is no collected account for the detected application login window.
The passwords entered by the users are never sent to the directory: they are only kept temporarily in memory for SSO purposes.
Users are not allowed to stop or suspend Enterprise SSO, they have no access to the Personal SSO Studio and cannot manage their accounts through the user Account panel.
Only the Application, Technical definition and Parameter objects are retrieved from the directory. They are retrieved in an asynchronous way to avoid the update during the user authentication.
All users can access all the applications downloaded by the workstation.
Enterprise SSO is built with the components described in this section.
ESSO Enterprise Studio is the Enterprise SSO configuration editor. It allows the creation of Enterprise SSO configuration files and the management of the Enterprise SSO LDAP objects.
This program is designed to be used by people who define and setup SSO.
SSO Studio can be used in Enterprise or Personal mode, to modify the corresponding configuration files:
SSO configuration is easily performed through "drag and drop".
Enterprise SSO plug-ins are extensions of the Enterprise SSO and of the Enterprise SSO configuration editor; they add SSO management methods for different types of applications.
Besides the management of standard Windows applications, several plug-ins are available:
|
NOTE: For more information on the supported versions, see Evidian EAM Release Notes. |
The administration module of the SSO engine enables to manage:
This section describes the Enterprise SSO interface and how to use it.
Enterprise SSO is in charge of the following SSO operations:
The Enterprise SSO configuration stores the SSO data. It can be defined by two kinds of users:
This section gives an overview of the Enterprise SSO interface. Depending on the E-SSO version installed on your station (connected to the Enterprise or the Cloud), some elements of the graphical interface may differ. When you are connected to the:
The Enterprise SSO icon is displayed in the Windows notification area.
Depending on the Enterprise SSO state, this icon can have several states:
Icons |
Description | |
Enterprise |
Cloud |
Enterprise SSO is activated: the SSO feature is enabled (whenever it detects a configured application login window, Enterprise SSO automatically provides the required SSO data). |
|
| |
|
|
Enterprise SSO is suspended: the SSO feature is disabled. |
|
|
Enterprise SSO is locked: when the Enterprise SSO detects a configured application login window, or when you want to display the user accounts associated with applications (see Displaying your Enterprise SSO User Accounts), Enterprise SSO may ask you to reauthenticate. Upon a successful authentication, Enterprise SSO state switches to activated. |
The Enterprise SSO pop-up menu appears when you right-click the Enterprise SSO icon. It enables you to control Enterprise SSO:
|
IMPORTANT: Depending on your Enterprise SSO configuration, some menu commands may not appear, as detailed in the following table.Replace this text with a notation that requires the reader's attention. |
The following table describes the Enterprise SSO pop-up menu.
Menu Command |
Description | ||
About Enterprise SSO
|
Displays the Enterprise SSO version and the storage mode of the Enterprise SSO configuration file:
| ||
Account delegation |
Enables you to delegate one or several of your accounts to specific users of your choice during a specific length of time. | ||
Open ESSO Enterprise Studio
|
Opens the SSO Account panel; which allows you to manage your user accounts.
| ||
Add application |
Starts Enterprise SSO Wizard, which is the easiest way to set up your personal Enterprise SSO configuration. For an example of how to use the Enterprise SSO Wizard, see Evidian EAM in a Nutshell.
| ||
Open ESSO Enterprise Studio |
Starts Personal SSO Studio, the editor tool of your personal Enterprise SSO configuration. For details on how to use ESSO Enterprise Studio, see Configuration Editor: ESSO Enterprise Studio.
| ||
Suspend, Activate
|
Manages the states of Enterprise SSO.
| ||
Reset Configuration
|
Stops and restarts Enterprise SSO to take into account modifications of the Enterprise SSO configuration.In Access Collector mode, this command only synchronizes SSO Account data. | ||
Exit Enterprise SSO |
Closes Enterprise SSO.
|
The Enterprise SSO window appears when you click Open in the pop-up menu, or just by double-clicking the Enterprise SSO icon. It is composed of the following panels:
When you open the Enterprise SSO window, the Account panel appears. It lists your user accounts managed by Enterprise SSO. From this panel, you can modify several user account parameters, as described in Managing User Accounts.
From the Home panel, you can perform the following tasks:
Manage the states of Enterprise SSO (Area 1), as described in the following sections:
If you are using several user accounts for a same application, select the Current role (Area 2) that will be valid only for the current Windows session and/or until Enterprise SSO is reinitialized.
To execute Cloud E-SSO, you must have a corresponding account.
The authentication window appears.
The register form appears.
|
IMPORTANT: The email address must be unique, valid and accessible. |
A confirmation code is sent to the email address provided for validation.
The password creation window appears.
Your account has been created, you can now authenticate to access Cloud E-SSO (see E-SSO connected to the Cloud).
This section describes how to start and exit Enterprise SSO.
Usually, Enterprise SSO starts automatically when you log on. You must start it manually in the following cases:
Depending on the E-SSO version installed on your station, connected to your enterprise (see E-SSO connected to the Enterprise) or to the Cloud (see E-SSO connected to the Cloud); the E-SSO start will be different.
/notrayicon
: starts Enterprise SSO without displaying the icon located in Windows notification area.
/nosplashscreen
: starts Enterprise SSO without displaying the welcome window (splash screen).
C:\Configs SSOWatch\SSOConfig2.sso
The Enterprise SSO window appears.
A welcome message appears in a balloon help on the bottom right-hand side of your screen.
|
NOTE: This is configurable in the EAM Console by creating one message per user. |
If you are using a roaming session, a balloon help appears telling you when your session expires. You can display it at all times by passing the cursor over the Enterprise SSO icon in the notification area.
To use Cloud E-SSO, you must own a Cloud E-SSO account. If it is not the case, when starting Cloud E-SSO, click the I want to register link and go to Creating a Cloud E-SSO Account.
|
IMPORTANT: If the Cloud server was not provided during installation, you must enter the DNS name of this server. |
|
IMPORTANT:If you have forgotten your password, click I have forgotten my password. You must provide your email to receive the confirmation code to provide for the reset. |
|
IMPORTANT: If the certification authority was not defined during the installation, you must accept the proposed certificate by clicking Yes, always. |
The Enterprise SSO window appears.
|
NOTE: This is configurable in the EAM Console by creating one message per user. |
To exit Enterprise SSO, right-click the Enterprise SSO icon and select Exit Enterprise SSO.
The Enterprise SSO icon disappears. The SSO feature is disabled.
|
NOTE: Depending on your configuration, this menu command may not be available (unavailable in Access Collector mode). |
|
NOTE: In Access Collector mode, this feature is deactivated. |
The Enterprise SSO icon state changes, as described in The Enterprise SSO Window. While it is suspended, no single sign-on is performed.
|
NOTE:
|
The Enterprise SSO icon state changes, as described in Enterprise SSO Icon. The SSO feature is enabled.
By default, if the Enterprise SSO configuration changes, a notification message automatically appears asking you if you want to take the modifications into account, as shown in the following illustration:
You can take manually the modifications of the Enterprise SSO configuration file into account, using the Reset Configuration command, as described in the following procedure.
In Access Collector mode, this command only synchronizes SSO Account data.
|
NOTE: In Access Collector mode, Enterprise SSO automatically reloads the SSO configuration every 6 hours: this allows taking into account modifications in the SSO data updated by the asynchronous update. You can change this value (in hours) in the following registry key/GPO: HKLM\Software\Enatel\SSOWatch\CommonConfig\ |
This section describes how to manage your Enterprise SSO user accounts from the Enterprise SSO Account panel.
In this section:
At the first launch of an SSO enabled application, when the application requests the user’s authentication, the Enterprise SSO collect window appears in the foreground (the application is temporarily unavailable) and requests the user name and password for the application.
Simply provide your usual user name for this application, your password (and confirm it to avoid mistype errors), and validate by clicking the OK button.
This data will be stored in a secure way by Enterprise SSO so that it can reuse it afterwards, without requesting any new data. Single Sign-On is now enabled for this application.
Depending on your configuration:
|
NOTE: The dialog box may not appear if you start another application instance (without exiting the first one). In this case, exit all the application instances and restart the application. |
The following controls can be available:
For more information on how to enable/disable these controls and this link, see Access Strategy Tab of an Application Profile or Evidian EAM Console - Guide de l'administrateur.
This section describes how to display the user accounts that are defined in your Enterprise SSO configuration.
The Enterprise SSO window appears.
The Account panel displays one line per user account. For each account, the following information is available:
Column Name |
Description |
Application |
Name of the application, as defined in.
For accounts that are not associated with an application, <None> is displayed. |
Login Name
|
Login name of the user account. If you have not used this application yet, <not registered> is displayed (the login name and password of the account have never been collected). Note: You can hide applications for which the user is not registered. To do so, right-click any application and select Hide applications without credential. |
Account |
By default, Standard Account is displayed. If you are using several user accounts for a same application, this column displays the name of the account. For more information, see Creating a New Account for an Application. |
In Access Collector mode, this feature is deactivated.
The following window appears:
The Information Tab
Depending on your user account properties, you may be allowed to modify your user account security data. For more details, see Changing the Login Name and/or Password of a User Account.
The Properties Tab
The Properties tab is a read-only tab. It displays the account properties and application properties available for the selected user account.
The Delegation Tab
Depending on your EAM configuration, the Delegation tab may not appear. It allows you to delegate your user account to other users.
Depending on your Enterprise SSO configuration, this command may be disabled for some or all the listed user accounts (unavailable in Access Collector mode).
For information on how to enable/disable this command, see Access Strategy Tab of an Application Profile.
The following window appears:
The modification is taken immediately into account.
|
NOTE: You can also modify the login name and/or password of a user account from the Account details window, which is described in Displaying the Properties of a User Account. |
When an SSO enabled application requests a password update, this request is intercepted by Enterprise SSO, which displays the Password Change window.
To check the validity of your new password, execute the following procedure:
The following area appears:
Enterprise SSO updates and stores the data in the security database, so that it can reuse afterwards, without requesting any new data.
Depending on your Enterprise SSO configuration, this command may be disabled for some or all the listed applications (unavailable in Access Collector mode).
|
NOTE: For information on how to enable/disable this command, see The "Application Profile" Tab. |
The following window appears:
The new account appears in the Account panel.
If you have several accounts for an application, the following window appears by default when Enterprise SSO detects the authentication window of the application:
This window allows you to select an account to log on to the application.
|
IMPORTANT: If you select:
|
|
NOTE: You can also log on to the application with one of the accounts by double-clicking the desired account in the Enterprise SSO Window. |
This section describes how to delete one or more accounts associated with an application.
|
NOTE: In Access Collector mode, this feature is deactivated. |
A warning message appears.
The account is deleted.
|
NOTE: If many accounts are associated with an application, the account line will be deleted. If you delete the last account, <not registered> will be displayed instead of the login name. |
Depending on your Enterprise SSO configuration, this command may be disabled for some or all the listed user accounts (unavailable in Access Collector mode).
|
NOTE: For information on how to enable/disable this command, see Access Strategy Tab of an Application Profile. |
The EAM re-authentication window appears.
The following window appears:
You can delegate one or several user accounts by using the Wizard, the EAM Portal (see Evidian EAM Portal - Guide de l’utilisateur) or by doing it manually.
Depending on your Enterprise SSO configuration, this command may be disabled for some or all the listed user accounts (unavailable in Access Collector mode).
|
NOTE: For information on how to enable/disable this command, see Delegation Tab of an Application Profile. |
In this section:
Use the Account Delegation Wizard to delegate one or several user accounts quickly and simply. To do so, follow this procedure:
The Enterprise SSO pop-up menu appears.
The Account Delegation Wizard appears.
The Account delegation window appears.
The User Selection window appears.
The list of users found in the directory is displayed.
Your selected account(s) has/have been delegated to the selected user(s).
The Account Delegation window appears.
The list of users found in the directory is displayed.
The account is delegated to the selected user from the start date to the expiration date.
The Enterprise SSO pop-up menu appears.
The Account Delegation Wizard appears.
The Account Delegation List window appears.
The account is not delegated anymore.
By default, SSO is enabled for all the applications listed in the Enterprise SSO Account panel.
You can disable SSO for an application in a permanent way, or only for the current SSO session, as explained in the following procedure.
In Access Collector mode, the SSO is automatically disabled for the applications for which the account has been collected.
|
IMPORTANT: Depending on your configuration, the commands of the following procedure may be disabled. For more information, see Access Strategy Tab of an Application Profile, or Evidian EAM Console - Guide de l'administrateur. |
Disabling SSO for an Application
In the Account panel, right-click the wanted application and select Disable the application.
The SSO is disabled for the application during the SSO session. At SSO Engine restart or reset, the SSO will be re-enabled.
The SSO is permanently disabled for the application: the application stays disabled even if the Enterprise SSO is restarted.
|
NOTE: If you have several disabled applications and want to enable all of them at the same time, select Enable all applications. |
When Enterprise SSO is integrated with Identity & Access Manager, you can request an access to an SSO enabled application in the following cases:
The Request Manager portal appears.
The Enterprise SSO engine includes a test tool, which allows you to check if an application is correctly configured. It tests the following elements:
You have configured the Application Profile associated with the application to test: the test tool is launched by clicking Test application on the shortcut menu that appears when you right-click an application displayed in the Account panel. This command is available only if the Application Profile associated with the selected application is correctly configured, as detailed in:
Personal SSO Studio is your personal configuration editor. It allows you to describe personal applications for which you want to enable SSO.
In Access Collector mode, the access to Personal SSO Studio is forbidden.
|
NOTE: You can also open Personal SSO Studio from the Start menu. |
This menu command is disabled if Personal SSO Studio is not installed on the workstation, or if Enterprise SSO is used in Access Collector mode.
To start an application from the Account panel, execute the following procedure.
|
NOTE: In Access Collector mode, this feature is deactivated. |
The application starts and Enterprise SSO performs SSO.
Subject
You can create shortcuts for applications from the Account panel, as described in the following procedure.
|
NOTE: In Access Collector mode, this feature is deactivated. |
A shortcut for the selected application is created on your Windows desktop.
Once Enterprise SSO is started, an icon appears in the Windows notification area. In some cases, it is preferable to remove this icon:
|
NOTE: The first key has precedence over the second; the |
/notrayicon
parameter .
NoTrayIcon
in one of these keys:
HKLM\SOFTWARE\Policies\Enatel\SSOWatch\CommonConfig
HKLM\SOFTWARE\Enatel\SSOWatch\CommonConfig
ESSO Enterprise Studio is the Enterprise SSO configuration editor. It allows you to describe the applications for which you want Enterprise SSO to enable Single Sign-On or account collect (in Access Collector mode), but which could not be configured through the Enterprise SSO Wizard (as explained in the One Identity EAM in a Nutshell).
Additionally, for those applications that have been configured using Enterprise SSO Wizard, ESSO Enterprise Studio enables you to modify or enhance their configuration.
If Enterprise SSO is used in Access Collector mode, ESSO Enterprise Studio allows the administrator to configure all the enterprise applications for the users, so that users' account can be automatically collected in the users' directory.
ESSO Enterprise Studio provides a graphical interface for defining these elements. It is dedicated to application administrators, or to "super-users" who have access to all necessary parameters.
An application is defined by:
The two following ESSO Enterprise Studio configurations are available:
Personal SSO Studio is not available in Access Collector mode.
The SSO Studio configuration can be stored in the Windows registry (file storage mode) or in the LDAP directory (LDAP storage mode).
|
NOTE: The storage mode is defined during the installation phase. |
|
NOTE: The Access Collector mode works only in LDAP storage mode. |
ESSO can be installed in two different modes: With and without Controller (for more details, see One Identity EAM Installation Guide).
|
NOTE: The Access Collector mode works only without Controller. |
ESSO Enterprise Studio presents target application parameters as SSO objects organized in a tree structure.
ESSO Enterprise Studio enables you to create, modify or delete objects and to store them in an LDAP directory (LDAP mode) or in an Enterprise SSO configuration file (local storage mode). It is a "single-document" application (only one configuration can be edited at a time):
The following screenshot illustrates an interface example of ESSO Enterprise Studio used in LDAP storage with Controller.
In LDAP mode, the objects can be created anywhere the administrator has object-creation rights.
The LDAP administrator is responsible for ensuring that the structure has a branch reserved for the management of EAM objects.
As the objects are created directly in the LDAP directory, the directory must be accessible when ESSO Enterprise Studio is being used.
The following screenshot illustrates an interface example of Personal SSO Studio.
In local storage mode, the configuration is defined with a root node called Local Enterprise SSO Configuration, to which two other nodes are attached: Applications and Configuration Objects, used for EAM object declarations.
The ESSO Enterprise Studio main window is composed of:
ESSO Enterprise Studio Mode |
Button |
Description |
Common buttons
|
|
(ESSO Enterprise Studio only) |
|
(ESSO Enterprise Studio only) | |
|
Cuts the selected item. | |
|
Copies the selected item. | |
|
Pastes the selected item. | |
|
Displays the properties of the selected item. | |
|
(LDAP storage mode only) Refreshes the displayed LDAP directory. | |
|
Deletes the selected item. | |
|
Renames the selected item. | |
Without Controller buttons
|
|
Creates a new Application. |
|
Creates a new Window object. | |
|
Creates a new Application profile. | |
|
Creates a new PFCP. | |
|
(ESSO Enterprise Studio only) | |
|
Saves the configuration. | |
With Controller buttons
|
|
Creates a new Technical Definition. |
|
Saves the Directory modifications. | |
|
Tests the selected SSO. | |
|
Adds the selected item to the test list. | |
|
removes the selected item from the test list. |
This section explains how to start and stop ESSO Enterprise Studio or Personal SSO Studio.
The following procedure explains how to start ESSO Enterprise Studio or Personal SSO Studio.
Starting SSO Studio Using the Windows Taskbar
An authentication window appears.
ESSO Enterprise Studio appears.
Starting ESSO Enterprise Studio Using Command Lines
The following table lists the command line arguments that you can use to start ESSO Enterprise Studio (builder.exe):
/user
: starts Personal SSO Studio.
/wizard
: starts the Enterprise SSO wizard.
The following procedure explains how to stop ESSO Enterprise Studio or Personal SSO Studio.
With ESSO Enterprise Studio used in local storage mode, you can create as many configurations as you wish (each configuration is saved in a different file).
This section explains how to create a new configuration, or open an existing one.
|
NOTE: In local storage mode, the configuration file to be used can be specified during installation. For more information, see One Identity EAM Installation Guide |
The feature described in this section is only available in ESSO Enterprise Studio used in local storage mode.
To open an existing configuration:
The Explorer window appears.
The selected configuration appears in ESSO Enterprise Studio main window.
ESSO Enterprise Studio displays the default configuration.
The following procedure explains how to define the general SSO configuration parameters.
The configuration described in this section is only available in ESSO Enterprise Studio used in local storage mode without Controller.
The following window appears:
If you use ESSO Enterprise Studio without Controller or Personal SSO Studio, you can define the following properties:
|
NOTE: With Controller, this configuration can be performed with the EAM administration console (see One Identity EAM Console - Guide de l'administrateur. |
In this section:
This section explains how to create or modify a PFCP for the applications for which you want to activate the SSO.
A default PFCP configuration exists in ESSO Enterprise Studio: you can modify it or create a new one.
The PFCP configuration is only available if you use ESSO Enterprise Studio without Controller mode or Personal SSO Studio.
With Controller, the PFCP configuration must be done with the administration console (see One Identity EAM Console - Guide de l'administrateur).
The Password Management Policy tab allows you to define the following PFCP elements:
The Password Format Policy tab allows you to define the advanced parameters:
The following special characters are allowed:
& |
~ |
" |
# |
' |
{ |
( |
[ |
- |
| |
` |
£ |
_ |
\ |
@ |
) |
° |
] |
= |
+ |
} |
$ |
% |
* |
, |
? |
; |
. |
: |
/ |
! |
|
|
IMPORTANT: Accented characters are forbidden. |
Application profiles are security objects that define a set of rights and properties that are applied generically for one or more applications.
This section explains how to configure the application profiles for the applications for which you want to activate the SSO.
A default Application profile configuration exists in ESSO Enterprise Studio: you can modify it or create a new one.
The Application profile configuration is only available if you use ESSO Enterprise Studio without Controller or Personal SSO Studio.
With Controller, the Application profile configuration must be done with the administration console (see One Identity EAM Console - Guide de l'administrateur).
The application profile properties window appears.
The Properties tab allows you to configure the following parameters:
For details on how to create a Password Policy, see Defining Password Format Control Policies (PFCP).
Enterprise SSO Desktop options:
Test the applications associated with this profile to check if the SSO configuration works. For details on how to use the test mode, see Testing the SSO Configuration of an Application.
|
NOTE: This option is available with Personal SSO Studio. It is also available with ESSO Enterprise Studio in the Application Profile in EAM Console. |
The Access Strategy tab allows you to configure the following parameters:
|
IMPORTANT: If you select Store on token, check that the proper authentication method is supported. For more information, contact your security administrator. |
|
NOTE: If a problem occurs (for example, if the authentication data cannot be saved due to network issues), the Cancel button is available again to allow the user to log on manually or to quit the application. |
|
NOTE:
For more details on the commands and controls that are modified by this option, see the following sections:
|
|
IMPORTANT: If the user forgets his/her primary password or loses his/her smart card, it is impossible to recover his/her secondary accountsReplace this text with a notation that requires the reader's attention. |
The Delegation tab is only available if you use ESSO Enterprise Studio without Controller and in LDAP storage mode.
The Delegation tab allows you to define the methods for delegating accounts to another user:
You can ask the person delegating the account(s) to reauthenticate on the workstation where the Studio is installed by setting the following registry key: SOFTWARE\Enatel\SSOWatch\CommonConfig\
ReauthOnDelegate DWORD 1.
This section explains how to create and define Application and Technical definition objects.
An application object implies the definition of:
ESSO Enterprise Studio allows you to create application objects with some predefined parameters for SAP and Windows applications: see Creating a New Application Object or Technical Definition.
For Application objects, ESSO Enterprise Studio allows you to use templates to create SAP and Windows application objects.
The Template Application item allows you to create an Application object with a number of pre-defined parameters. They are used for specific authentication scenarios. The predefined template applications are:
Template applications are managed in the same way as Application objects. They enable the Single Sign-On feature for specific authentication procedures. An application template has a number of predefined parameters.
The following procedure explains how to create a new technical definition or application (with or without template).
The Application properties window appears.
The following procedure explains how to modify the properties of an existing Application Object or Technical Definition.
The Application properties window appears.
The Properties tab described in this section only appears if you use ESSO Enterprise Studio without Controller, or Personal SSO Studio.
The Properties tab of an Application Object allows you to define the basic parameters of an Application.
The Properties tab described in this section only appears if you use ESSO Enterprise Studio with Controller.
The Properties tab of a Technical Definition object allows you to define the basic parameters of a Technical definition.
The Account Base tab only appears if you use ESSO Enterprise Studio without Controller or Personal SSO Studio.
The Account base tab allows you to define the Account Base associated with an application. An Account is a username/password pair that allows connection to an application. There is also an account parameter that can store complementary authentication data; for instance: a Windows Domain name is a complementary parameter of a Windows account.
The account name is internal to Enterprise SSO: it is used to store and retrieve security data and to give a user-friendly name to this data. A user-friendly name is particularly useful when using multiple accounts: you can give names such as: "Notes Admin" or "Notes User" if a Notes user is also the administrator.
|
NOTE: Accounts are shared: by applications as well as Enterprise SSO configurations, since they refer to objects stored in the security system storage and which is bound to the user. |
You can also share an account base between two Applications using command line arguments. This feature may allow you to create batch files to automate this task.
|
NOTE: You can combine this feature with the possibility of importing objects using command lines. This is described in Importing Objects using Command Line Arguments (without Controller). |
Procedure
To share an Account base, at the Windows prompt, type the following command:
<SSOWatch Installation Directory>
/SSOBuilder.exe
[/login <name>
][
/password] /share <Master Application> <Slave Application
>
|
NOTE: Arguments between square brackets [ ] are optional. |
Explanations in the following table:
Argument name |
Values | ||
<Enterprise SSO installation folder> |
C:\Program Files\Evidian\WG SSOWatch\SSOBuilder.exe" by default. | ||
/login <name> and /password <password>
|
Login name and password of the EAM administrator Note: Use the DOMAIN\login format. If the login name and password of the administrator are not specified, the ESSO Enterprise Studio authentication window will appear. The administrator account used to run the import must own sufficient rights. | ||
/share <MasterApplication> <SlaveApplication>
|
<MasterApplication>: name of the Application owning the Account base to share. <SlaveApplication>: name of the Application that will use the Account base.
|
Example
The following command allows you to share the Account Base AB1 owned by APP1 with APP2:
"C:\Program Files\Evidian\WG SSOWatch\SSOBuilder.exe" /login DOMAIN\WGAdmin /password AdminPWD /share APP1 APP2
External Names: this button only appears if you use ESSO Enterprise Studio without Controller and in LDAP storage mode. It allows you to define a mapping between the EAM application that you are configuring and the name of an external application that must be identified by EAM. This option is particularly useful to integrate Web Access Manager with EAM. For example, if you are defining an application called MyHTMLApplication that already uses Web Access Manager Account Bases, click this button and in the displayed window, enter the names of the Web Access Manager Account Bases defined for this application. This way, EAM will be able to use these Web Access Manager Account Bases to perform SSO with this application. For more information, see Mobile E-SSO Installation and Configuration Guide.
|
NOTE: Each external application name must be unique in the directory. |
The Launcher tab is used to define how Enterprise SSO can start an application.
This window allows you to define the following parameters:
Authentication methods required if automatic start is used
Since Enterprise SSO can launch applications during session opening, this option enables you to control which applications are launched regarding the authentication method used to log on.
Select the check box and in the drop down list, select the authentication methods required to launch the applications.
The QRentry keyboard tab enables you to configure the behavior of the key of the QRentry keyboard to perform an SSO in a Store application (Android only). For more information on Store applications, refer to the QRentry - Guide de l’utilisateur.
This window allows you to define the following parameters:
Parameters Tab of an Application Object (without Controller)
The Parameters tab allows you to add a list of additional authentication parameters (such as Windows Domains or Languages for example). These parameters will enable you to define more fields than simply the couple of fields user name/password of the target application authentication window.
|
NOTE: The Windows Domain parameter must be used only with Applications that may use Authentication Manager. |
The properties to defines are the following:
Default: the value of the parameter is collected for each SSO account and can be modified by the user.
If you have selected Rule in the Parameter type area, between parentheses, retrieve the exact LDAP attribute name (using an LDAP browser) and type it in the Value field. For example, type (mail) to indicate that the parameter value is the user's mail address.
|
NOTE: If you want to add several LDAP attributes, type them one after another, without a comma. Example: (mail)(dn). |
You can be more specific about the parameter value by using the following rules:
To keep only the first n characters of the LDAP value, use the (attLDAP,n) syntax.
Three functions are used to process LDAP values: UPPER, LOWER and CAPITALIZED. Example: UPPER(mail,10) will return the first 10 characters of the user's mail address in upper case.
This window appears when you click the External Name button. It allows you to define a mapping between the parameter that you are configuring in EAM and the name of an external parameter (created using another SSO tool) that must be identified by EAM.
|
NOTE: This option is particularly useful to integrate User Provisioning or Web Access Manager with EAM. For more information, see Mobile E-SSO Installation and Configuration Guide. |
The Parameters tab allows you to add a list of additional authentication parameters (as Windows Domains or Languages for example). These parameters will enable you to define more fields than simply the couple of fields name/password of the target application authentication window.
|
IMPORTANT: The list of authentication parameters for the technical definition must be compatible with the parameters defined at application level.The creation of an application is described in the Evidian EAM Console - Guide de l'administrateur. |
To add an existing parameter, select it and click OK.
|
The parameter called Windows Domain (which is created upon the installation of ESSO), must be used only without Controller. |
|
NOTE: To create or modify the parameters present in the list, use the EAM Console. For more information, see Evidian EAM Console - Guide de l'administrateur |
By default, every user is authorized to access the application with an application profile. The Application Profile tab allows you to define the application profile, with an access right granted to all the users by default.
|
IMPORTANT: In LDAP storage mode and Personal mode, only one profile may be assigned per application. |
To:
|
IMPORTANT: The logo must be <30 Ko and in PNG format. |
For more information on QRentry, refer to the QRentry - Guide de l’utilisateur.
ESSO Enterprise Studio allows you to define advanced management of access rights, as explained in the following procedure.
The feature is only available in ESSO Enterprise Studio used without Controller and LDAP storage mode.
The SSO Settings by population window appears.
The SSO settings by population window allows you to define the population (user, organizational group or units) that accesses the application. It is necessary to assign an application profile to each one.
If several profiles are associated with a user, priority is given to the profile:
|
NOTE: If there are several groups, the notion of priority indicated on the interface is applied. It is dedicated only to groups (with 0 as the highest priority level). |
Since window objects are subordinated to Application or Technical definition objects, the window objects can only exist if they are associated with an application object.
The Window Properties window appears.
The General tab allows you to give a name to the window object and to set its type (the type cannot be modified once the window has been created).
The Window Type Description area displays the description of the selected window type.
Window Type |
Technology |
Behavior |
Description |
Generic windows | |||
StandardLogin |
Win32/Java |
Login |
|
BadPassword |
Win32/Java |
BadPassword |
|
NewPassword |
Win32/Java |
NewPassword |
|
BadNewPassword |
Win32/Java |
BadNewPassword |
|
ConfirmPassword |
Win32/Java |
ConfirmPassword |
|
Terminal |
Terminal |
All |
|
HTML Pages (reserved for old versions. Do not use to detect new windows) | |||
IELogin |
Win32 |
Login + BadPassword |
HTTP authentication window |
HTMLLogin |
HTML/IE |
Login |
Authentication in HTML pages
|
HTMLBadPassword |
HTML/IE |
BadPassword | |
HTMLNewPassword |
HTML/IE |
NewPassword + ConfirmPassword | |
HTMLBadNewPassword |
HTML/IE |
BadNewPassword | |
Customizable window types | |||
CustomScript
|
Win32
|
All
|
Graphical scripts enabling customized SSO creation. |
CustomScriptHTML
|
HTML/IE
|
All
|
Graphical scripts allowing customized SSO creation for web applications in Internet Explorer. |
Microsoft applications | |||
MSTelnet |
Terminal |
All |
Not supported. |
MSTelnetW2KXP |
Terminal |
All |
Telnet Microsoft for Windows 2000 and XP |
Lotus Notes windows | |||
NotesLogin |
Win32 |
Login |
Lotus 4.x and 5.x authentication |
SAP windows | |||
SAPLogin |
Win32 |
Login |
SAP R/3 Authentication |
SAPExpired |
Win32 |
NewPassword | |
SAPGUI Scripting |
Win32 |
Login |
Authentication for SAP R/3 version 6.20 |
Plugin HLL API windows | |||
HLLAPI Login |
Win32 |
Login |
|
HLLAPI Bad Password |
Win32 |
BadPassword |
|
HLLAPI New Password |
Win32 |
NewPassword + LoginNewPassword |
|
HLLAPI Confirm Password |
Win32 |
ConfirmPassword |
|
HLLAPI Bad New Password |
Win32 |
BadNewPassword |
|
HLLAPI Standard |
Win32 |
|
|
The Options tab allows you to define the following elements:
This option allows you to trigger the SSO only if the selected language is one of the input languages installed on the computer. This option can be useful to optimize response times.
|
NOTE:
|
This option allows you to trigger the SSO only if the selected SSO states are met.
|
NOTE: This option is particularly useful for the Customizable Window Type (Custom Script and Custom Script HTML types). |
Click the Configure button to select the conditions of the window activation depending on the state of the application. The following table lists the available options:
Option name |
Description |
The window is always detected | This option is selected by default: the window is always detected and processed by Enterprise SSO, without any condition. |
SSO has not been performed
|
Select this option to trigger Enterprise SSO only if the SSO operation has not been performed. With this option, Enterprise SSO can perform SSO upon the first detection of the window, then, as long as the application runs, this window is no longer detected. |
SSO has been performed and the password is valid | The window is detected and processed by Enterprise SSO only if the SSO operation has been performed with a valid password. |
SSO has been performed and the password has expired and must be changed | This option depends on the password validity period parameter (defined in the PFCP properties window). This window is detected and processed only if the SSO operation has been performed and that the password validity period has expired. |
The password has been refused and resynchronized (BadPassword) | These options can be particularly useful for applications that use several authentication windows that you have defined using custom scripts. For example, if you have to define the following windows for the same application:A custom BadPassword window.A custom NewPassword window, which contains only a field for the old password and a field for the new password.A custom ConfirmPassword window, which contains only one field to confirm the new password.A custom BadNewPassword window, which appears when the user enters a wrong new password.To avoid inopportune detection and processing of these windows by Enterprise SSO, select for each window, the appropriate option in the Application State Conditions window. |
A new password has been provided but not confirmed | |
The new password has been confirmed | |
A new password has been refused (after a rollback)
|
Example of use with the "SSO has been performed and the password has expired and must be changed" option
To display automatically the change password window of an application, do the following:
|
NOTE: We consider in the following example that the change password window appears when you click a button. |
|
NOTE: The Password Expire window is a virtual window, which allows you to display automatically the Change Password window when the password has expired. |
This option allows you to hide the window of an application with an Enterprise SSO window displaying a customizable text. You can use this option if you do not want that the user to see his login/password for example.
Select this option for login windows that are displayed at least twice in case of bad login/password values: the application rejecting the authentication redisplays its connection window, which is considered by E-SSO as a bad password window; this prompts a login/password collect window.
|
NOTE: To benefit from this bad password feature on an E-SSO window of type CustomScript, you must declare a special event in the script. |
User the timer associated with this field as follows: if the authentication window reappears before x seconds, this window is then considered as a bad password window.
This is the case for the authentication window used by Internet Explorer to log on to restricted areas.
Select this option to reactivate the window detection after a certain delay (seconds).
Select the check boxes to activate the following actions:
Do not disable the window during SSO and Do not disable the window when asking for user input
Select these options so that the user can interact with the window detected during SSO.
|
IMPORTANT: This is only relevant for IE, Firefox and Chrome. |
Select this option so that:
|
NOTE: If this option slows down the window detection then you must select one window for each IE version. |
You must start the configuration over again if you select this option.
|
NOTE: This option may not work with all web pages. |
Select this option so that the window definition for IE is also applied to Firefox.
|
NOTE: If this option does not work, you must create a specific window definition for Firefox. |
You must start the configuration over again if you select this option.
Select this option if you are using this window for QRentry E-SSO and that this window is an HTTP authentication window.
|
NOTE: For more information on QRentry, refer to the QRentry - Guide de l’utilisateur. |
Select this option to force E-SSO to update continuously the information of the application.
Forces the compatibility of the technical definition with all the versions of Internet Explorer.
Select this check box to not perform SSO again as long as the URL of the page is identical.
Select one or more check boxes to refine the SSO detection of windows by process architecture and/or Operating System:
|
IMPORTANT: By default, all the check boxes are selected. |
The Detection and Actions tabs are described in the sections of this guide that are related to the "plug-in types", as their content depends on the selected window type.
ESSO Enterprise Studio allows you to test the SSO configuration you have created.
This feature is available only if you use ESSO Enterprise Studio with Controller.
This feature is not available with Personal SSO Studio.
|
NOTE: To remove a technical definition from the list, right-click the object and select Remove from Test List. |
A small check appears in the Technical definition icon.
A confirmation window appears, to inform you that Enterprise SSO is about to be started in test mode.
The Enterprise SSO Account panel displays only the selected technical definitions: you can start the applications corresponding to these technical definitions to test the windows detection and the collection of the security data, without any modifications in the directory.
The following window appears:
The backup of the EAM Services solution is done at the same time as the backup of the directory that hosts EAM.
Therefore there is no backup of the EAM solution alone, however you can backup the objects created in EAM such as: user/group/OU.
The Import/Export feature allows you to backup and therefore reuse SSO configurations.
When testing SSO configurations: if the Application and Window objects that you have created in your test environment are working, use the import/export feature to exploit them in the live environment.
You can export/import the following objects:
|
NOTE: Each exported object is saved in an .SSE (Enterprise SSO Export) file. |
In this section:
To export an object, do the following:
The Explorer window appears.
To import an object, do the following:
|
NOTE: To import a window, select the application that will receive this window. |
The Explorer window appears.
The object appears in the tree, at the selected location.
You can import .SSE files using command line arguments/ This feature can allow you to create batch files to automate the import of several objects from your test environment to the live environment.
|
IMPORTANT: This feature is more powerful than the import of objects using the graphical interface. You can use it to define accesses to applications in addition to the import operation. |
|
NOTE: For more details on the objects that you can import, see Backuping Objects. |
To import an object, at the Windows prompt, type the following command:
<Installation directory of
Enterprise SSO>/SSOBuilder.exe
[/login <name>
][
/password <password>]
/import <filename.sse> /location <Organization DN>
[/access <group>] [/profile <profile>]
Arguments between square brackets [ ] are optional.
Explanations in the following table:
Argument name |
Value |
<SSOWatch installation folder> |
"C:\Program Files\Evidian\WG SSOWatch\SSOBuilder.exe" by default. |
/login <name> and /password <password>
|
Login name and password of the EAM administrator. Note: Use the DOMAIN\login format. If the login name and password of the administrator are not specified, the ESSO Enterprise Studio authentication window will appear. The administrator account used to run the import must own sufficient rights. |
/import <filename.sse>
|
Full path name of the .SSE file, which contains the object(s) to import. Note: if the object to import is associated with another ESSO object (an Application associated with a PFCP for example), and if the name of this object (PFCP) is used by other objects, the first name found is used. If no object is found, the default object is used. |
/location <Organization DN> |
Distinguished Name of the organization where the object will be created. |
/access <group>
|
Name of the group of users for whom you want to specify an access to the imported Application. Note: You can use either the format "Group Name" or "Group DN". If you do not specify this argument, check the access configuration using ESSO Enterprise Studio. This argument works only with Application objects. |
/profile <profile>
|
Name of the Application Profile that will be associated with the imported Application. Note: You can use either the format "Group Name" or "Group DN". If you do not specify this argument, the default Application profile will be used. This argument works only with Application objects. |
The following command allows you to import MyExportedFile.sse into the Applications container.
"C:\Program Files\Evidian\WG SSOWatch\SSOBuilder.exe"
/login DOMAIN\WGAdmin /password AdminPWD /import C:\MyExportedFile.sse /location
O
U=Applications,OU=Organization,DC=domain,DC=acme,
DC=com
You have created the APP application, for which the access is restricted to the group of users GROOP. To import this application and keep the restricted access to GROOP, use the following command:
"C:\Program Files\Evidian\WG SSOWatch\SSOBuilder.exe"
/login DOMAIN\WGAdmin /password AdminPWD /import C:\MyExportedAPP.sse /location OU=Applications,OU=Organization,DC=domain,DC=acme,DC=com /access GROOP
This section explains how to copy, cut, paste, rename and delete objects of the tree.
You can perform basic operations with tree objects, as explained in the following procedure.
The object appears in the tree at the selected location.
The object name is selected.
The object is renamed.
If you use ESSO Enterprise Studio in LDAP mode, the tree displayed corresponds to the LDAP directory. If you delete an object from the tree, it will not be deleted from the LDAP directory as long as you have not updated it (see Refreshing the Tree).
A confirmation window appears.
The object is deleted from the tree.
This section explains how to save the object configurations. In ESSO Enterprise Studio used in:
In LDAP storage mode, centralized configuration is defined in the LDAP directory for which SSO access is either authorized or denied for a given user or group of users.
In ESSO Enterprise Studio (used in LDAP storage and with Controller), in the File menu, click Update directory.
The LDAP directory is updated with the configurations defined in ESSO Enterprise Studio.
In local storage mode, the storage operation depends on the ESSO Enterprise Studio version used:
The configuration is saved in the Windows Registry.
The Explorer window appears.
Name the configuration and select the location where you want to save the configuration.
The configuration is saved in an .SSO file in the selected location.
To optimize network traffic, you can use the update management feature: by default: by default, the EAM workstations retrieve the whole SSO configuration periodically. The update management feature allows you to post an update, which generates a unique identifier. The workstations retrieve the application data and this identifier. As long as the identifier is unchanged between the directory and the cache of the workstations, the workstations do not update their SSO configuration.
The feature described in this section is only available in ESSO Enterprise Studio used in LDAP storage mode and without Controller.
|
NOTE: When a workstation runs an update, it retrieves the entire configuration (and not only the configuration corresponding to the last posted update). So this feature does not avoid workstations retrieving the applications configured by administrators after the last posted update if the data on the workstation is older than the last posted update. |
Refreshing the tree means updating it so that it displays the current corresponding LDAP directory.
|
IMPORTANT: If you have performed modifications in the tree and have not saved them, refreshing the tree will cancel all your unsaved modifications. |
This feature is only available in ESSO Enterprise Studio used in LDAP storage mode.
In ESSO Enterprise Studio main window, in the Edit menu, click Refresh.
The displayed tree is updated with the current LDAP directory.
© 2021 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy