sudouser/com.sudoplatform.sudouser

Package-level declarations

Types

ApiResult

sealed class ApiResult

Encapsulates a generic API result.

AuthenticationInfo

interface AuthenticationInfo

Encapsulates an authentication information.

AuthenticationProvider

interface AuthenticationProvider

Encapsulates an authentication provider responsible to generating authentication information required to sign into the backend.

AuthenticationTokens

data class AuthenticationTokens(val idToken: String, val accessToken: String, val refreshToken: String, val lifetime: Int)

Encapsulates the authentication tokens obtained from a successful authentication.

AuthUI

interface AuthUI

Responsible for managing the authentication flow for browser based federated sign in.

CognitoAuthUI

class CognitoAuthUI(val config: JSONObject, val context: Context) : AuthUI

AuthUI implementation that uses Cognito Auth UI.

DefaultLogger

class DefaultLogger

Default logger.

DefaultSudoUserClient

class DefaultSudoUserClient(context: Context, namespace: String = "ids", logger: Logger = DefaultLogger.instance, config: JSONObject? = null, keyManager: KeyManagerInterface? = null, identityProvider: IdentityProvider? = null, apiClient: GraphQLClient? = null, credentialsProvider: CognitoCredentialsProvider? = null, authUI: AuthUI? = null, idGenerator: IdGenerator = IdGenerateImpl(), databaseName: String = AndroidSQLiteStore.DEFAULT_DATABASE_NAME) : SudoUserClient

Default implementation of SudoUserClient interface.

FederatedSignInResult

sealed class FederatedSignInResult

Encapsulates a federated sign-in result.

IdentityProvider

interface IdentityProvider

Encapsulates interface requirements for an external identity provider to register and authenticate an identity within Sudo platform ecosystem.

IdGenerateImpl

class IdGenerateImpl : IdGenerator

Default ID generator implementation.

IdGenerator

interface IdGenerator

Interface for generating universally unique identifiers (UUIDs).

JWT

data class JWT(val issuer: String, val audience: String, val subject: String, val id: String? = null, val algorithm: String = DEFAULT_ALGORITHM, val keyId: String? = null, val expiry: Date = Date(Date().time + (DEFAULT_LIFETIME * 1000)), val issuedAt: Date = Date(), val notValidBefore: Date? = null, val payload: JSONObject = JSONObject())

Encapsulates a JSON Web Token.

LocalAuthenticationInfo

class LocalAuthenticationInfo(jwt: String, username: String) : AuthenticationInfo

Authentication info consisting of a JWT signed using the locally stored private key.

LocalAuthenticationProvider

class LocalAuthenticationProvider(name: String, privateKey: String, publicKey: String?, keyManager: KeyManagerInterface, keyId: String, username: String, customAttributes: Map<String, Any>? = null) : AuthenticationProvider

Authentication provider for generating authentication info using a locally stored private key.

PasswordGenerator

interface PasswordGenerator

Generates a password complying to a specific set of rules.

PasswordGeneratorImpl

class PasswordGeneratorImpl : PasswordGenerator

Default password generator implementation.

PublicKey

data class PublicKey(val keyId: String, val publicKey: ByteArray, val algorithm: String = RSA, val symmetricAlgorithm: String = AES_256)

Encapsulates a public key used for asymmetric cryptographic operations.

RegisterResult

sealed class RegisterResult

Encapsulates a registration result.

SignInResult

sealed class SignInResult

Encapsulates a sign-in result.

SignInStatus

enum SignInStatus : Enum<SignInStatus>

List of possible values for sign in status.

SignInStatusObserver

interface SignInStatusObserver

Protocol for sign in status observer. If you wish to observe the the changes to the progress of sign in or refresh token operation then you must implement this protocol.

SudoUserClient

interface SudoUserClient

Interface encapsulating a library of functions for calling Sudo Platform identity service, managing keys, performing cryptographic operations.

TESTAuthenticationInfo

class TESTAuthenticationInfo(jwt: String) : AuthenticationInfo

Authentication info consisting of a JWT signed using the TEST registration key.

TESTAuthenticationProvider

class TESTAuthenticationProvider(name: String, privateKey: String, publicKey: String?, keyManager: KeyManagerInterface, keyId: String = REGISTER_KEY_NAME, customAttributes: Map<String, Any>? = null) : AuthenticationProvider

Authentication provider for generating authentication info using a TEST registration key.