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
ssksURL | The SSKS server for this instance to use. This value is given on your Seald dashboard. |
appId | The ID given by the Seald server to your app. This value is given on your Seald dashboard. |
instanceName | An 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. |
logLevel | The 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. |
logNoColor | Should be set to false if you want to enable colors in the log output. Defaults to true . |
Constructors
SealdSSKSTmrPlugin | constructor(ssksURL: String = "https://ssks.seald.io/", appId: String, instanceName: String = "SealdSSKSTmrPlugin", logLevel: Byte = 0, logNoColor: Boolean = true) |
Functions
Name | Summary |
---|---|
getFactorToken | fun getFactorToken(sessionId: String, authFactor: AuthFactor, challenge: String? = null): GetFactorTokenResponse Retrieve the TMR JWT associated with an authentication factor. |
getFactorTokenAsync | suspend fun getFactorTokenAsync(sessionId: String, authFactor: AuthFactor, challenge: String? = null): GetFactorTokenResponse Retrieve the TMR JWT associated with an authentication factor. |
retrieveIdentity | fun retrieveIdentity(sessionId: String, authFactor: AuthFactor, challenge: String, rawTMRSymKey: ByteArray): RetrieveIdentityResponse Retrieve the Seald account previously saved with SealdSSKSTmrPlugin.saveIdentity . |
retrieveIdentityAsync | suspend fun retrieveIdentityAsync(sessionId: String, authFactor: AuthFactor, challenge: String, rawTMRSymKey: ByteArray): RetrieveIdentityResponse Retrieve the Seald account previously saved with SealdSSKSTmrPlugin.saveIdentity . |
saveIdentity | fun saveIdentity(sessionId: String, authFactor: AuthFactor, rawTMRSymKey: ByteArray, identity: ByteArray, challenge: String? = null): SaveIdentityResponse Save the Seald account to SSKS. |
saveIdentityAsync | suspend fun saveIdentityAsync(sessionId: String, authFactor: AuthFactor, rawTMRSymKey: ByteArray, identity: ByteArray, challenge: String? = null): SaveIdentityResponse Save the Seald account to SSKS. |