oath/com.pingidentity.mfa.oath

Package-level declarations

Types

DateSerializer

object DateSerializer : KSerializer<Date>

Custom serializer for the Date class to convert to/from Long (milliseconds since epoch)

OathAlgorithm

enum OathAlgorithm : Enum<OathAlgorithm>

Enum representing the different OATH algorithm types.

OathAlgorithmSerializer

object OathAlgorithmSerializer : KSerializer<OathAlgorithm>

Custom serializer for the OathAlgorithm enum

OathClient

class OathClient : BaseMfaClient, MfaClient

Implementation of OathClient that provides OATH functionality. This client handles TOTP and HOTP credential management and code generation.

OathCodeInfo

@Serializable

data class OathCodeInfo(val code: String, val timeRemaining: Int, val counter: Long, val progress: Double, val totalPeriod: Int)

Class that contains OTP code information, including the actual code and validity details.

OathConfiguration

class OathConfiguration : MfaConfiguration

Configuration class specific for OATH MFA functionality. Extends the base MfaConfiguration with OATH-specific settings.

OathCredential

@Serializable

data class OathCredential(val id: String = UUID.randomUUID().toString(), val userId: String? = null, val resourceId: String? = null, val issuer: String, val displayIssuer: String = issuer, val accountName: String, val displayAccountName: String = accountName, val oathType: OathType, val secret: String, val oathAlgorithm: OathAlgorithm = OathAlgorithm.SHA1, val digits: Int = 6, val period: Int = 30, val counter: Long = 0, val createdAt: Date = Date(), val imageURL: String? = null, val backgroundColor: String? = null, val policies: String? = null, var lockingPolicy: String? = null, var isLocked: Boolean = false)

Represents an OATH (TOTP/HOTP) credential. This model holds all necessary information to generate OTP codes and identify the credential.

OathType

enum OathType : Enum<OathType>

Enum representing the different types of OATH credentials.

OathTypeSerializer

object OathTypeSerializer : KSerializer<OathType>

Custom serializer for the OathType enum

OathUriParser

object OathUriParser : UriParser

Utility class for parsing OATH URIs.