Tokens

An OATH authentication method requires each user to have a token, in order to be able to complete an authentication. Pointsharp ID supports any token that complies with the OATH token standard, and can provision tokens to its users.

Tokens can be divided into two main groups:

Hardware tokens

Hardware tokens exist in different form factors, such as the key-chain token and the credit card token.

Mobile tokens

A software token, unlike the hardware tokens, is a program that is installed on a device; typically a user’s mobile device. Pointsharp ID includes software tokens for most mobile platforms, as well as Microsoft Windows operating system.

There are several ways to distribute a token to a user:

  • An administrator can send the token to the user.

  • The user can send a token to themselves using the User Portal.

  • Pointsharp ID can use Live Provisioning to automatically provision a token to a user depending on a value in a Directory attribute.

Pointsharp ID token management

The token management is configured in the Pointsharp ID Admin GUI client. There are general settings which applies to all tokens, and settings for the distribution of each token type.

Press the Help button for detailed information on each field and function.

Add General Settings for all tokens

The general settings apply to all tokens. To configure the general settings for tokens, follow these steps:

  1. Start Pointsharp ID Admin GUI as an administrator.

  2. Click the Tokens tab.

  3. Click General Settings in the Pointsharp ID token management window.

    • Initial OATH Window Size: Set this system-wide setting (used by all OATH authentication methods) when the user authenticates with a certain OATH token for the very first time. By using this setting, customers can re-use tokens in a simple and seamless way. In contrast to the OATH Window Size setting, which is configured on the authentication method, this setting is only used the first time (Pointsharp ID holds information about the "initial counter" so it can determine whether the token has been used or not by a certain user).

    • Unique Token Check: Enable this checkbox when there is a requirement that an OATH token must NOT be associated to more than one user at the time.

    • Live Provisioning Separators: Set the separator characters to use when interpreting the user attribute value (stored in the User Storage) when performing Live Provisioning. This character list is used when splitting the value to deploy multiple OATH tokens per user. For example the value windowsmobile,hardware:123|javaunsigned would require this setting to be ,| in order to function properly. Default is |.

    • Live Provisioning Code digits: Set the default OTP length in the OATH Tokens when deployed to the user in Live Provisioning.

  4. Click Apply in the bottom-right corner to apply the configuration.

  5. Go to the General tab.

  6. Restart. A Restart can be done from anywhere in the GUI by pressing CTRL-R.

For more information about Live Provisioning, see the OATH authentication method documentation.

Pointsharp Login

These settings are used by Pointsharp ID whenever a configuration for a Pointsharp Login client is created.

Parameter Description

Request URL

The URL used by the client when sending its OTP to the server.

Example: https://example.org/path

Add OTP Authenticator

Automatically add one OTP authenticator together with enrollment or QR scanning. If the user already has it, new authenticator will be created and added.

Time-based OATH

Pointsharp ID supports time-based OATH which, unlike event based tokens, change their one-time password as time progress.

These settings are used when a time-based OATH token is used for authentication. The time-based OATH token calculates a one-time password based on time, by calculating the number of timesteps since the so-called Epoch for the token.

Pointsharp ID comes with one pre-configured time-based OATH setting, which is the RFC 6238-compliant timestep of 30 seconds. This is used for Google Authenticator and all other authenticator apps.

It is possible to add additional time-based OATH settings for the case when the OATH token is using a timestep of 60 seconds. This is evaluated from top to bottom and the OATH Token name matching is controlling what settings to use. Click the Add, Edit, and Remove button to manage these time-based OATH settings.

Parameter Description

SHA Length

Specify the SHA length and its algorithm to use, for example, SHA-1, SHA-256 or SHA-512.

Default Values

Click timestep button 30 secs or timestep button 60 secs to restore the default values for time-based OATH tokens.

Token Name Prefix

Token Name Prefix that must match for this setting to take effect. This can be used for time-based OATH tokens that are using the 60 second timestep. Note that the default, last time-based OATH setting, must not be changed from the wild card pattern *.

TOTP Counter Window

Defines the timestep window that Pointsharp ID will test when validating a time-based OATH one-time password.

For example a value of 5 means that the timesteps corresponding to -5, -4, -3, -2, -1, 0, 1, 2, 3, 4 and 5 are tested. When the OTP is found, this adjustment timestep is stored for the user and the next OTP calculation will adjust its "center" when calculating the next OTP.

When the adjustment is equal to the TOTP Counter Window (or larger), the system will use a doubled value for TOTP Counter Window (to allow for larger drift values than this window).

The default value is set to 5.

TOTP Initial Counter Window

Set this to the timestep window that Pointsharp ID will test when validating a time-based OATH one-time password when the OATH token is used for the first time.

The default value is set to 15.

TOTP Seconds Per Timestep

Set this setting to define the number of seconds per timestep in the time-based OTP calculation.

The default value is set to 30.

TOTP Epoch Timestep

Set this to the epoch timestep. According to the time-based OATH RFC standard in January 1st of 1970, this value is 2071186560. Note that for some OATH tokens using the timestep 60 seconds, this epoch value should be set to 1035593280.

The default value is set to 2071186560.

FIDO

These settings are used by Pointsharp ID whenever a configuration for a FIDO security key is created.

See FIDO — How to configure and use for more information.

admin gui tokens fido

Parameter Description

Relying Party Name

This name is used when adding a new FIDO security key.

Relying Party Id

This id is used to decide which domain is allowed to be used for registration/authentication with the FIDO security key via Pointsharp ID.

Challenge Size

The length of challenge to be used when doing attestation/assertion.

The default value is set to 16.

Timeout

The time that the caller is willing to wait for the call to complete. This is treated as a hint, and may be overridden by the client.

The default value is set to 3 minutes.

User Verification

Required: This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set.

Preferred: This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set.

Discouraged: This value indicates that the Relying Party does not want user verification employed during the operation (for example,, in the interest of minimizing disruption to the user interaction flow).

The default value is Preferred.

Security Key Limit

How many security keys users can have.

Access Timeout

Configuration on if the registered security key should have a access timeout or not.

Attestation Preference

In the context of FIDO, attestation involves the authenticator issuing an attestation statement that contains a cryptographic signature and other data about the authenticator itself.

The Relying Party uses an attestation conveyance preference, to tell which type of attestation information it wants; none, indirect, direct, or enterprise, offering different levels of detail and anonymization.

None: This value indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA.

Indirect: The Relying Party prefers verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. This means that the client may replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user’s privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.

Direct: This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.

Enterprise: This value indicates that the Relying Party wants to receive an attestation statement that may include uniquely identifying information.

Authenticator attestation

A whitelist of allowed FIDO authenticators by defining friendly name and AAGUID (FIDO2).

The default value is All:* (Allow all).

Name Version FIDO2 AAGUID

Windows Hello

Software Authenticator

6028B017-B1D4-4C02-B4B3-AFCDAFC96BB2

Windows Hello

VBS Software Authenticator

6E96969E-A5CF-4AAD-9B56-305FE6C82795

Windows Hello

Hardware Authenticator(TPM)

08987058-CADC-4B81-B6E1-30DE50DCBE96

Windows Hello VBS

Hardware Authenticator(TPM)

9DDD1817-AF5A-4672-A2B9-3E3DD95000A9

YubiKey 5 (USB-A, No NFC)

5.1.X

cb69481e-8ff7-4039-93ec-0a2729a154a8

YubiKey 5 (USB-A, No NFC)

5.2.X

ee882879-721c-4913-9775-3dfcce97072a

YubiKey 5 NFC

5.1.X

fa2b99dc-9e39-4257-8f92-4a30d23c4118

YubiKey 5 NFC

5.2.X

2fc0579f-8113-47ea-b116-bb5a8db9202a

YubiKey 5 Nano

5.1.X

cb69481e-8ff7-4039-93ec-0a2729a154a8

YubiKey 5 Nano

5.2.X

ee882879-721c-4913-9775-3dfcce97072a

YubiKey 5C

5.1.X

cb69481e-8ff7-4039-93ec-0a2729a154a8

YubiKey 5C

5.2.X

ee882879-721c-4913-9775-3dfcce97072a

YubiKey 5C Nano

5.1.X

cb69481e-8ff7-4039-93ec-0a2729a154a8

YubiKey 5C Nano

5.2.X

ee882879-721c-4913-9775-3dfcce97072a

YubiKey 5Ci

5.2.X

c5ef55ff-ad9a-4b9f-b580-adebafe026d0

Security Key By Yubico

5.1.X

f8a011f3-8c0a-4d15-8006-17111f9edc7d

Security Key By Yubico

5.2.X

b92c3f9a-c014-4056-887f-140a2501163b

Security Key NFC

5.1.X

6d44ba9b-f6ec-2e49-b930-0c8fe920cb73

Security Key NFC

5.2.X

149a2021-8ef6-4133-96b8-81f8d5b7f1f5

Entra ID

These settings are used by Pointsharp ID whenever a configuration for an Entra ID security key is created.

Parameter Description

Enabled

Enable to use Entra ID.

Client ID

The Client ID is a public identifier.

Client Secret

The client secret is a secret known only to the application and the authorization server.

Tenant ID

Is a unique, globally unique identifier (GUID), for a specific organization’s instance of a Microsoft cloud service.

User ID Attribute

The attribute value to be used as the unique User ID for Entra ID.

Certificate

Security Key Certificate

These settings are used by Pointsharp ID whenever a configuration for a security key certificate is created.

Parameter Description

CA name

Certificate CA name.

Certificate Template

Certificate template to be used for enrollment.

PSKC Security settings

Portable Symmetric Key Container (PSKC)

Configure the OATH token security setting and click the OK button for the crypto feature, which deploys the decryption functionality for the encrypted file. For testing purposes, click the Test Encryption Key/Password button to test the encryption key on the defined pskc file.

To specify pskc file, click Browse and file browser window will pop up in the /bin/tokens folder, showing files only with extension *.pskc. The format of the *.pskc files is unencrypted or encrypted PSKC standard.

All pskc files must be in the installation folder /bin/token.
Parameter Description

Name

Set a display name for the pskc file.

Filename

Choose the encrypted file to be configured.

Encryption Type

The encryption type of the file.

Symmetric

Shared Encryption Key.

PBE

Password-based Encryption

Encryption Key/Password

The Encryption Key/Password used for decryption of the encrypted file.

Portal settings

Here are the settings for the token distribution using the Pointsharp Web Portals: Admin Portal and User Portal. These settings are related to the visibility of the activation code and whether the token should be sent using the configured notification method for the token or not.

Parameter Description

Activation Code Display Method

Set the default display method for the activation code. The selected value will determine how, or if, the activation code can be displayed in a portal at token distribution. Note that a token that is not configured using an activation code, will not be affected by this setting.

Enabled display methods are:

Image: Displays the activation code as an image representation.

None: Will not display the activation code at all (Will set Use Notification Method to true).

Text: Displays the activation code as text representation.

The default value is set to: Image.

Use Notification Method

Disable this checkbox when there is a requirement that the activation code should NOT be sent to the user with default notification method, at mobile token distribution. Note that the download URL will be displayed in the User Portal instead.

Display Download URL

Enable this checkbox when there is a requirement that the download URL should be displayed to the user at mobile token distribution.

Mobile token settings (token distribution)

These settings are used whenever a software-based OATH token is distributed to a user, for example, when a token is sent to a user in Pointsharp ID Admin GUI or Pointsharp ID Web Application, or when the user accesses the User Portal.

Note that setting the notification method is enough for the distribution to work.
Parameter Description

URL

Set the URL to the client platform binary (i.e. the OATH Software Token binary). This value will be parsed into the message to the user, where the URL will replace the {url} parameter.

See URL table below.

Text

Add a descriptive text for the message that sends the OATH token settings.

Where {conf}/{activation} and {url} will be replaced by Pointsharp ID with the OATH token settings and the URL parameter above.

Notification

Set the notification method to use. These are configured in the Notification tab.

Notification Attribute

Set the notification attribute to use.

The attribute on the user (in the user storage, for example, "mobile" in the Directory) to retrieve the value for, and use as the recipient address when sending the OATH token settings.

URL (PIN)

A PIN protected mobile token can be sent to the user. The user must state a PIN code in order to generate a one-time password. The PIN protection is local on the device and administrated by the users themselves.

Set the URL to the PIN protected client platform binary (that is, the OATH Software Token binary). This value will be parsed into the message to the user, where the URL will replace the {url} parameter.

See URL (PIN) table below.

Default

Press the Default button whenever you want to revert the settings to the pre-defined built-in default settings for the selected OATH token client platform.

URL

The default values are (depending on platform):

Platform URL

Mobile Token

http://ps.cloudapp.net/

Windows Store

http://ps.cloudapp.net/4/w8/

Windows Phone

http://ps.cloudapp.net/4/wp7/

Windows Desktop

http://ps.cloudapp.net/4/wn/

Windows Mobile

http://ps.cloudapp.net/4/wm/

Java signed

http://ps.cloudapp.net/4/jmes/

Java unsigned

http://ps.cloudapp.net/4/jmeu/

Java Standard

http://ps.cloudapp.net/4/js/

Java Mobile

http://ps.cloudapp.net/4/jm/

Android

http://ps.cloudapp.net/4/apk/

Android Market

http://ps.cloudapp.net/4/and/

Google Authenticator (Event-based OTP)

http://ps.cloudapp.net/4/ghgr/

Google Authenticator (Time-based OTP)

http://ps.cloudapp.net/4/gtgr/

iPhone

http://ps.cloudapp.net/4/app/

The mobile token uses terminal detection to give the user the correct mobile token. The administrator does not need to know what kind of device the user has. If desired, the user can be allowed to select the type of platform without the automatic detection. Then URL should be configured to: http://ps.cloudapp.net/man
URL (PIN)

The default values (depending on platform):

Platform URL

Mobile Token

http://ps.cloudapp.net/p/

Windows Store

http://ps.cloudapp.net/4/w8/p/

Windows Phone

http://ps.cloudapp.net/4/wp7/p/

Windows Desktop

N/A

Windows Mobile

N/A

Java signed

http://ps.cloudapp.net/4/jmes/p/

Java unsigned

http://ps.cloudapp.net/4/jmeu/p/

Java Standard

http://ps.cloudapp.net/4/js/p/

Java Mobile

http://ps.cloudapp.net/4/jm/p/

Android

http://ps.cloudapp.net/4/apk/p/

Android Market

http://ps.cloudapp.net/4/and/p/

Google Authenticator (Event-based OTP)

N/A

Google Authenticator (Time-based OTP)

N/A

iPhone

http://ps.cloudapp.net/4/app/p/

Additional mobile token settings

Additional mobile tokens are software-based OATH tokens that is configured by using an activation code. You are able to specify the distribution by supported platform.

Personalized mobile token

Personalized mobile tokens are software-based OATH tokens that is configured by the mobile token distribution server. These tokens require no user configuration or activation codes, making them very easy for the user to install. You are able to specify the distribution by supported platform.