IOATHTokenPlugin

This is the OATH Token provisioning plugin interface to implement when a customer-defined way to retrieve OATH token settings is wanted.

Methods

Name Description

GetTokenData

GetTokenData is called by Pointsharp ID or PSIDAdmin when an OATH Token is to be provisioned for a user. For example, when using the auto-provisioning feature, or in PSIDAdmin when adding a hardware-typed OATH token on a user.

For the out parameters and their requirements, see the RFC 4226 for the OATH HOTP algorithm.

Parameters

Name Description

addCheckSum (System.Boolean)

Is true if a checksum is to be added on the OTP.

codeDigits (System.Int32)

The number of code digits in the OATH code, valid values are: 6, 7 or 8.

counter (System.Int64)

A 64 bit integer holding the initial counter value.

dynamicTruncation (System.Int32)

Set to a truncation value between 0 and 15. If set to 16 or above, dynamic truncation is assumed.

identifier (System.String)

The unique identifier or serial number to use when associating an OATH token to a user.

secret (System.String)

The secret to be used. Base64-encoded binary data. The length of the secret MUST be at least 128 bits. Pointsharp recommends to use a secret length of 160 bits.

Returns

True if found the OATH token for the specified identifier.

False if not found or in any other error case.