Package io.seald.seald_sdk
:::warning This package is still early-access:
the interface will probably still have breaking changes
the installation instructions may change in the future
some quality-of-life features are still missing
some bugs may still be present
the documentation may still be incomplete, or not very readable
Feel free to give us feedback! :::
This package is the Seald SDK for Android : io.seald.seald_sdk
To install it, you need two files: seald-sdk-internals-VERSION.aar and seald-sdk-VERSION.aar.
You can download these files here:
https://api-dev.soyouz.seald.io/go-seald-sdk/android/seald-sdk-internals-VERSION.aar
https://api-dev.soyouz.seald.io/go-seald-sdk/android/seald-sdk-VERSION.aar
:::warning These URLs will change for each new version published. :::
After that, you can place these files in your app/libs/ folder, and add the following lines to your app/build.gradle:
dependencies {
/* ... */
implementation files('libs/seald-sdk-internals-52543.aar')
implementation files('libs/seald-sdk-52543.aar')
}You can then import it in your code with:
import io.seald.seald_sdk.SealdSDKYou can also see the example app.
This package contains the main SealdSDK class, the EncryptionSession class, as well as multiple helper classes.
SealdSDK is the main class for the Seald SDK. It represents an instance of the Seald SDK.
You can instantiate it this way:
val seald = SealdSDK(
apiURL = "https://api.seald.io/",
appId = "YourAppId",
dbPath = "/myApp/seald_db",
dbb64SymKey = "A Secret Key to encrypt the local database, encoded in b64"
)This class then allows you to create an account, create or retrieve an EncryptionSession, etc.
See the SealdSDK reference for more information.
An EncryptionSession allows you to encrypt / decrypt multiple messages or files.
This should not be instantiated directly, and should be either created with SealdSDK.createEncryptionSession or retrieved with SealdSDK.retrieveEncryptionSession or SealdSDK.retrieveEncryptionSessionFromMessage.
See: Description
-
Class Summary Class Description EncryptionSession An encryption session, with which you can then encrypt / decrypt multiple messages or files. ClearFile ClearFile represents a decrypted file. AccountInfo AccountInfo is returned when calling SealdSDK.createAccount or SealdSDK.getCurrentAccountInfo, containing information about the local account. CreateSubIdentityResponse CreateSubIdentityResponse represents a newly created sub identity. BeardError BeardError represents an error returned by the server. ConnectorTypeValue ConnectorTypeValue is a simplified representation of a connector for which we don't know all details. Connector Connector represents all details about a connector. PreValidationToken PreValidationToken represents a way for your server to authorize the adding of a connector. MassReencryptOptions Options for SealdSDK.massReencrypt function. MassReencryptResponse Represents the results of a call to SealdSDK.massReencrypt. DeviceMissingKeys Represents a device of the current account which is missing some keys, and for which you probably want to call SealdSDK.massReencrypt. ActionStatus Represents the status of an operation on single user/device. SealdSSKSPasswordPlugin The SealdSSKSPassword class allows to use the SSKS key storage service to store Seald identities easily and securely, encrypted by a user password. SealdSSKSTmrPlugin 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. SealdSDK This is the main class for the Seald SDK. AuthFactor Represents a user's authentication factor RetrieveIdentityResponse RetrieveIdentityResponse holds a retrieved identity -
Enum Summary Enum Description ConnectorType ConnectorType represents the allowed values for Connector types: EMfor email connectorsAPfor App connectors
ConnectorState ConnectorState represents the allowed values for Connector states. AuthFactorType