Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added links

This article describes the supported authentication methods (called authenticators) in  in Nexus Service Station along  along with their parameters.

Expandall

Expand
titleSupported authenticators

There are three supported authentication methods (authenticators) in Service Station:

LDAP AuthenticatorLogin using an existing Active Directory (AD) username and password.
Offline AuthenticatorLogin using username-password combinations which are pre-generated by the customer in a separate application released by Nexus, and handed out to end users.
IDC Account AuthenticatorLogin via Identity Connector (IDC)



Expand
titleAdd authenticators

The authenticators are added and configured in the configuration file (App.config), where this shall be specified:

SettingPossible ValuesMandatoryDescription
authenticator<class name>YesThe name of the C# class defining this authenticator

assembly

<assembly name>.dll

Yes

The name of the assembly where this authenticator is defined

parameters

Different parameters, depending on which authenticator is used

See description of each authenticator below



Expand
titleOffline Authenticator parameters


Parameter

Possible Values

Mandatory

Description

nexusCodeKey

Any text

Yes

The key used in Nexus Offline Authenticator Manager when generating username-password combinations



Expand
titleNexus Offline Authenticator Manager

Nexus Offline Authenticator Manager is a software developed by Nexus. Nexus Offline Authenticator Manager is a small helper application for generating passwords which, in combination with their usernames, later can be used to login to Nexus Service Station using the Offline Authenticator.

Expand
titleInstallation requirements

The following installation requirements must be completed:

  • Administrator privileges are required
  • Microsoft .NET Framework 4.6.2 (bundled with the installer, requires internet access to download)


Expand
titleInstallation procedure
  1. Double click on the .exe file or run Nexus Offline Authenticator Manager Installer.exe from the command line.
  2. Click Install and log on with administrator privileges if necessary.

  3. Once the setup is complete, click Finish to close the installer.


Expand
titleResult after installation
  • The software is installed in the folder …\Program Files (x86)\Nexus\Nexus Offline Authenticator Manager\ along with its dependencies.
  • The shortcut Nexus Offline Authenticator Manager, used to start the Nexus Offline Authenticator Manager application, is installed under Windows Start Menu.


Expand
titleConfiguring procedure

  1. In order to use the application a key needs to be specified. It should be a random string that is hard to guess. A random key can be generated by clicking Generate new key.

    Warning

    It is critical that the exact same key is added to the ‘key’ parameter in the authentication setting of the instance of Nexus Service Station where the logins are to be used. Without having the exact same key specified in both places, the generated passwords will not work.


  2. Input a semi colon separated list of usernames to generate passwords for (e.g. first@email.com; second@email.com). The list is not case sensitive.
  3. When all usernames have been added, click Generate passwords which will produce a list of usernames and passwords.
  4. The list can be copied to the clipboard by clicking Copy to Clipboard.
Info

In order to use the logins, a Nexus Service Station must be set up with an Offline Authenticator and a NexusCodeKey setting with the exact same key as is specified in the Key text box in Nexus Offline Authenticator Manager when the passwords were generated. When Nexus Offline Authenticator Manager is closed, the latest used key will be remembered.



Expand
titleRepair procedure

If files have gone missing from the application it can be repaired by running the Nexus Offline Authenticator Manager Installer.exe again.

  1. Double click the .exe file or run Nexus Offline Authenticator Manager Installer.exe from the command line.
  2. Click Repair.
  3. Log on with administrator privileges if necessary.

The repair process is completed.


Expand
titleUninstall procedure

You uninstall the Nexus Offline Authenticator Manager application through Windows Add/Remove Programs. Alternatively the application can be uninstalled by running the Nexus Offline Authenticator Manager Installer.exe again.

  1. Double click the .exe file or run Nexus Offline Authenticator Manager Installer.exe from the command line.
  2. Click Uninstall.
  3. Log on with administrator privileges if necessary.

The uninstall process is completed.



Expand
titleLDAP Authenticator parameters


Parameter

Possible Values

Mandatory

Description

useSsl

true, false

No

A flag indicating whether to use SSL or not

useSealing

true, false

No

A flag indicating whether to use Sealing or not

useUdp

true, false

No

A flag indicating whether to use UDP or not

port

Any positive integer

No

The port number

defaultDomains

A comma separated list of text values representing the default domains

No

A list of default domains to use if the user does not specify a domain

servers

A comma separated list of text values representing the servers

No

A list of servers to use

authType

A valid authentication type

Yes

The authentication type to use


Expand
titleAuthentication types

The available authentication types are:

  • Anonymous (not supported)
  • Basic
  • Negotiate
  • Ntlm
  • Digest
  • Sicily
  • Dpa
  • Msn
  • External
  • Kerberos



Expand
titleIDC Account Authenticator parameters


Parameter

Possible Values

Mandatory

Description

client

Any text

No

If provided, this is the name the authenticator will use to identify itself to the web service. If not provided the authenticator will use “IdcAccountAuthenticator”

username

Web service username

Yes

The username used in the web service

password

Web service password

Yes

The password used in the web service



Expand
titleIDC User Authenticator parameters


Parameter

Possible Values

Mandatory

Description

client

Any text

No

If provided, this is the name the authenticator will use to identify itself to the web service. If not provided the authenticator will use “IdcUserAuthenticator”