Skip to content

SealdSSKSTmrPlugin

class SealdSSKSTmrPlugin(ssksURL: String = "https://ssks.seald.io/", appId: String, instanceName: String = "SealdSSKSTmrPlugin", logLevel: Byte = 0, logNoColor: Boolean = true)

The SealdSSKSTmrPlugin class allows to use the SSKS key storage service to store Seald identities easily and securely, encrypted by a key stored on your back-end server.

Parameters

ssksURLThe SSKS server for this instance to use. This value is given on your Seald dashboard.
appIdThe ID given by the Seald server to your app. This value is given on your Seald dashboard.
instanceNameAn arbitrary name to give to this Seald instance. Can be useful for debugging when multiple instances are running in parallel, as it is added to logs.
logLevelThe minimum level of logs you want. All logs of this level or above will be displayed. -1: Trace; 0: Debug; 1: Info; 2: Warn; 3: Error; 4: Fatal; 5: Panic; 6: NoLevel; 7: Disabled.
logNoColorShould be set to false if you want to enable colors in the log output. Defaults to true.

Constructors

SealdSSKSTmrPluginconstructor(ssksURL: String = "https://ssks.seald.io/", appId: String, instanceName: String = "SealdSSKSTmrPlugin", logLevel: Byte = 0, logNoColor: Boolean = true)

Functions

NameSummary
getFactorTokenfun getFactorToken(sessionId: String, authFactor: AuthFactor, challenge: String? = null): GetFactorTokenResponse
Retrieve the TMR JWT associated with an authentication factor.
getFactorTokenAsyncsuspend fun getFactorTokenAsync(sessionId: String, authFactor: AuthFactor, challenge: String? = null): GetFactorTokenResponse
Retrieve the TMR JWT associated with an authentication factor.
retrieveIdentityfun retrieveIdentity(sessionId: String, authFactor: AuthFactor, challenge: String, rawTMRSymKey: ByteArray): RetrieveIdentityResponse
Retrieve the Seald account previously saved with SealdSSKSTmrPlugin.saveIdentity.
retrieveIdentityAsyncsuspend fun retrieveIdentityAsync(sessionId: String, authFactor: AuthFactor, challenge: String, rawTMRSymKey: ByteArray): RetrieveIdentityResponse
Retrieve the Seald account previously saved with SealdSSKSTmrPlugin.saveIdentity.
saveIdentityfun saveIdentity(sessionId: String, authFactor: AuthFactor, rawTMRSymKey: ByteArray, identity: ByteArray, challenge: String? = null): SaveIdentityResponse
Save the Seald account to SSKS.
saveIdentityAsyncsuspend fun saveIdentityAsync(sessionId: String, authFactor: AuthFactor, rawTMRSymKey: ByteArray, identity: ByteArray, challenge: String? = null): SaveIdentityResponse
Save the Seald account to SSKS.