Skip to content

Seald: documentation

Main NavigationSDK Desktop App Reference Public website

English

Français

English

Français

Sidebar Navigation

Introduction

Guides

Overview

Adapt your application

First steps

Imports

Identity management

Groups

Encryption Sessions

Proxy Sessions

TMR Accesses

Group TMR Temporary Key

File encryption

Integrate 2-man-rule on your backend

Reversibility

Anonymous encryption

SymEncKeys

JSON Web Tokens

Staging vs. prod servers

Example project

Presentation

Quick-start

Pre-derivation of the password

Persistent database in localStorage

Protection with 2-man-rule

Examples

JavaScript SDK Reference

Seald SDK

Type Alias: SDKConstructor()

Interface: SealdSDK

Interface: EncryptionSession

Helpers

Type Alias: AccountInfo

Type Alias: AddMultipleTmrAccessesResult

Type Alias: AuthorizeRecipientResult

Type Alias: EncryptionSessionCache

Type Alias: EncryptionSessionCacheEntry

Type Alias: EncryptionSessionRetrievalDetails

Type Alias: GroupTMRTemporaryKey

Type Alias: PreGeneratedIdentityKey

Type Alias: Recipients

Type Alias: RecipientsList

Type Alias: RecipientsToRevoke

Type Alias: RecipientsWithRights

Type Alias: RevokeResult

Type Alias: SCrypt()

Type Alias: SDKConstructor()

Type Alias: SSCrypto

Type Alias: TmrAccess

Type Alias: TmrRecipientWithRights

Type Alias: UserRights

SSKS Password Plugin

Variable: default()

Interface: SSKSPassword

Helpers

Type Alias: KeyStorePassword

SSKS Two-man Rule Plugin

Variable: default()

Interface: SSKS2MR

Helpers

Type Alias: KeyStore2MR

Anonymous SDK

Type Alias: AnonymousSDKConstructor()

Interface: AnonymousSDK

Interface: AnonymousEncryptionSession

Helpers

Type Alias: AnonymousSDKConstructor()

Type Alias: Recipients

Type Alias: SCrypt()

Type Alias: TmrRecipient

Android SDK Reference

SealdSDK

addConnectorAsync

addConnector

addGroupMembersAsync

addGroupMembers

checkSigchainHashAsync

checkSigchainHash

closeAsync

close

convertGroupTMRTemporaryKeyAsync

convertGroupTMRTemporaryKey

convertTmrAccessesAsync

convertTmrAccesses

createAccountAsync

createAccount

createEncryptionSessionAsync

createEncryptionSession

createGroupAsync

createGroupTMRTemporaryKeyAsync

createGroupTMRTemporaryKey

createGroup

createSubIdentityAsync

createSubIdentity

deleteGroupTMRTemporaryKeyAsync

deleteGroupTMRTemporaryKey

deserializeEncryptionSession

devicesMissingKeysAsync

devicesMissingKeys

exportIdentityAsync

exportIdentity

getConnectorsFromSealdIdAsync

getConnectorsFromSealdId

getCurrentAccountInfoAsync

getCurrentAccountInfo

getSealdIdsFromConnectorsAsync

getSealdIdsFromConnectors

getSigchainHashAsync

getSigchainHash

heartbeatAsync

heartbeat

importIdentityAsync

importIdentity

listConnectorsAsync

listConnectors

listGroupTMRTemporaryKeysAsync

listGroupTMRTemporaryKeys

massReencryptAsync

massReencrypt

prepareRenewAsync

prepareRenew

pushJWTAsync

pushJWT

removeConnectorAsync

removeConnector

removeGroupMembersAsync

removeGroupMembers

renewGroupKeyAsync

renewGroupKey

renewKeysAsync

renewKeys

retrieveConnectorAsync

retrieveConnector

retrieveEncryptionSessionAsync

retrieveEncryptionSessionByTmrAsync

retrieveEncryptionSessionByTmr

retrieveEncryptionSessionFromBytesAsync

retrieveEncryptionSessionFromBytes

retrieveEncryptionSessionFromFileAsync

retrieveEncryptionSessionFromFile

retrieveEncryptionSessionFromMessageAsync

retrieveEncryptionSessionFromMessage

retrieveEncryptionSession

retrieveMultipleEncryptionSessionsAsync

retrieveMultipleEncryptionSessions

searchGroupTMRTemporaryKeysAsync

searchGroupTMRTemporaryKeys

setGroupAdminsAsync

setGroupAdmins

updateCurrentDeviceAsync

updateCurrentDevice

validateConnectorAsync

validateConnector

EncryptionSession

addMultipleTmrAccessesAsync

addMultipleTmrAccesses

addProxySessionAsync

addProxySession

addRecipientsAsync

addRecipients

addTmrAccessAsync

addTmrAccess

decryptFileAsync

decryptFileFromURIAsync

decryptFileFromURI

decryptFile

decryptMessageAsync

decryptMessage

encryptFileAsync

encryptFileFromURIAsync

encryptFileFromURI

encryptFile

encryptMessageAsync

encryptMessage

listRecipientsAsync

listRecipients

retrievalDetails

revokeAllAsync

revokeAll

revokeOthersAsync

revokeOthers

revokeRecipientsAsync

revokeRecipients

serialize

sessionId

AnonymousSealdSDK

createAnonymousEncryptionSessionAsync

createAnonymousEncryptionSession

deserializeAnonymousEncryptionSession

AnonymousEncryptionSession

decryptFileAsync

decryptFileFromURIAsync

decryptFileFromURI

decryptFile

decryptMessageAsync

decryptMessage

encryptFileAsync

encryptFileFromURIAsync

encryptFileFromURI

encryptFile

encryptMessageAsync

encryptMessage

serialize

sessionId

SealdSSKSPasswordPlugin

changeIdentityPasswordAsync

changeIdentityPassword

retrieveIdentityFromPasswordAsync

retrieveIdentityFromPassword

retrieveIdentityFromRawKeysAsync

retrieveIdentityFromRawKeys

saveIdentityFromPasswordAsync

saveIdentityFromPassword

saveIdentityFromRawKeysAsync

saveIdentityFromRawKeys

SealdSSKSTmrPlugin

getFactorTokenAsync

getFactorToken

retrieveIdentityAsync

retrieveIdentity

saveIdentityAsync

saveIdentity

Helper Classes

AccountInfo

deviceExpires

deviceId

userId

ActionStatus

errorCode

result

success

AnonymousTmrRecipient

authFactor

rawOverEncryptionKey

AuthFactor

type

value

AuthFactorType

AP

EM

entries

valueOf

value

values

BeardError

code

id

CheckSigchainResponse

found

lastPosition

position

ClearFile

fileContent

filename

sessionId

Connector

id

sealdId

state

type

value

ConnectorState

PENDING

REMOVED

REVOKED

VALIDATED

entries

state

valueOf

values

ConnectorType

AP

EM

entries

type

valueOf

values

ConnectorTypeValue

type

value

ConvertTmrAccessesResponse

converted

errored

status

succeeded

CreateSubIdentityResponse

backupKey

deviceId

DeviceMissingKeys

deviceId

EncryptionSessionRetrievalDetails

flow

fromCache

groupId

proxySessionId

EncryptionSessionRetrievalFlow

CREATED

DIRECT

LOCAL

VIA_GROUP

VIA_PROXY

VIA_SYM_ENC_KEY

VIA_TMR_ACCESS

entries

valueOf

value

values

GetFactorTokenResponse

authenticatedSessionId

token

GetSigchainResponse

position

sigchainHash

GroupTmrTemporaryKey

authFactorType

createdById

created

groupId

id

isAdmin

ListedGroupTMRTemporaryKeys

gTMRTKeys

nbPage

MassReencryptOptions

forceLocalAccountUpdate

retries

retrieveBatchSize

waitBetweenRetries

waitProvisioningRetries

waitProvisioningTimeMax

waitProvisioningTimeStep

waitProvisioningTime

waitProvisioning

MassReencryptResponse

failed

reencrypted

PreGeneratedKeys

PreValidationToken

domainValidationKeyId

nonce

token

ProxySession

created

proxySessionId

rights

RecipientRights

forward

read

revoke

RecipientWithRights

recipientId

rights

RecipientsList

proxySessions

sealdRecipients

symEncKeys

tmrAccesses

RetrieveIdentityResponse

authenticatedSessionId

identity

shouldRenewKey

RevokeResult

proxySessions

recipients

SEALD_SDK_VERSION

SaveIdentityResponse

authenticatedSessionId

ssksId

SealdException

code

description

details

id

message

nativeStack

raw

status

toString

SealdRecipient

addedById

readFirst

readLast

readTime

rights

sealdId

SealdSSKSPasswordPlugin

changeIdentityPasswordAsync

changeIdentityPassword

retrieveIdentityFromPasswordAsync

retrieveIdentityFromPassword

retrieveIdentityFromRawKeysAsync

retrieveIdentityFromRawKeys

saveIdentityFromPasswordAsync

saveIdentityFromPassword

saveIdentityFromRawKeysAsync

saveIdentityFromRawKeys

SealdSSKSTmrPlugin

getFactorTokenAsync

getFactorToken

retrieveIdentityAsync

retrieveIdentity

saveIdentityAsync

saveIdentity

SearchGroupTMRTemporaryKeysOpts

all

groupId

page

SymEncKey

rights

symEncKeyId

TMRAccessesConvertFilters

createdById

sessionId

tmrAccessId

TMRAccessesRetrievalFilters

createdById

tmrAccessId

TmrAccess

authFactorType

created

rights

tmrAccessId

TmrRecipientWithRights

authFactor

overEncryptionKey

rights

generatePrivateKeysAsync

generatePrivateKeys

parseSessionIdFromBytes

parseSessionIdFromFile

parseSessionIdFromMessage

iOS SDK Reference

class SealdSdk

class SealdEncryptionSession

class SealdSsksPasswordPlugin

class SealdSsksTMRPlugin

Helper Classes

class SealdAccountInfo

class SealdActionStatus

class SealdAddKeysResponse

class SealdAnonymousEncryptionSession

class SealdAnonymousSdk

class SealdAnonymousTmrRecipient

class SealdBeardError

class SealdCheckSigchainResponse

class SealdClearFile

class SealdConnector

class SealdConnectorTypeValue

class SealdConvertTmrAccessesResult

class SealdCreateSubIdentityResponse

class SealdDeviceMissingKeys

class SealdEncryptionSessionRetrievalDetails

class SealdGetSigchainResponse

class SealdGroupTmrTemporaryKey

class SealdListedGroupTMRTemporaryKeys

class SealdMassReencryptOptions

class SealdMassReencryptResponse

class SealdPreValidationToken

class SealdProxySession

class SealdRecipientRights

class SealdRecipientWithRights

class SealdRecipientsList

class SealdRevokeResult

class SealdSealdRecipient

class SealdSearchGroupTMRTemporaryKeys

class SealdSsksGetFactorTokenResponse

class SealdSsksPasswordPlugin

class SealdSsksRetrieveIdentityResponse

class SealdSsksSaveIdentityResponse

class SealdSsksTMRPlugin

class SealdSymEncKey

class SealdTmrAccess

class SealdTmrAccessesConvertFilters

class SealdTmrAccessesRetrievalFilters

class SealdTmrAuthFactor

class SealdTmrRecipientWithRights

class SealdUtils

Flutter SDK

SSKS Server API Reference

Dashboard API Reference

DashboardAPI Authentication

Seald Dashboard API Reference

DashboardAPI Events

On this page

ActionStatus

constructor(success: Boolean, errorCode: String, result: String)

Pager

Previous pageActionStatus

Next pageerrorCode

AccountInfo

ActionStatus

AnonymousTmrRecipient

AuthFactor

AuthFactorType

BeardError

CheckSigchainResponse

ClearFile

Connector

ConnectorState

ConnectorType

ConnectorTypeValue

ConvertTmrAccessesResponse

CreateSubIdentityResponse

DeviceMissingKeys

EncryptionSessionRetrievalDetails

EncryptionSessionRetrievalFlow

GetFactorTokenResponse

GetSigchainResponse

GroupTmrTemporaryKey

ListedGroupTMRTemporaryKeys

MassReencryptOptions

MassReencryptResponse

PreGeneratedKeys

PreValidationToken

ProxySession

RecipientRights

RecipientWithRights

RecipientsList

RetrieveIdentityResponse

RevokeResult

SaveIdentityResponse

SealdException

SealdRecipient

SealdSSKSPasswordPlugin

SealdSSKSTmrPlugin

SearchGroupTMRTemporaryKeysOpts

SymEncKey

TMRAccessesConvertFilters

TMRAccessesRetrievalFilters

TmrAccess

TmrRecipientWithRights

ActionStatus ​

ActionStatus