CoreCrypto/com.wire.crypto

Package-level declarations

Types

AcmeChallenge

data class AcmeChallenge(var delegate: ByteArray, var url: String, var target: String)

For creating a challenge.

AcmeDirectory

data class AcmeDirectory(var newNonce: String, var newAccount: String, var newOrder: String, var revokeCert: String)

Holds URLs of all the standard ACME endpoint supported on an ACME server.

BufferedDecryptedMessage

data class BufferedDecryptedMessage(var message: ByteArray?, var isActive: Boolean, var commitDelay: ULong?, var senderClientId: ClientId?, var hasEpochChanged: Boolean, var identity: WireIdentity, var crlNewDistributionPoints: List<String>?) : Disposable

to avoid recursive structs

BuildMetadata

data class BuildMetadata(var timestamp: String, var cargoDebug: String, var cargoFeatures: String, var optLevel: String, var targetTriple: String, var gitBranch: String, var gitDescribe: String, var gitSha: String, var gitDirty: String)

Metadata describing the conditions of the build of this software.

Ciphersuite

enum Ciphersuite : Enum<Ciphersuite>

MLS ciphersuites.

ClientId

open class ClientId : Disposable, AutoCloseable, ClientIdInterface

A Client identifier

ClientIdInterface

interface ClientIdInterface

A Client identifier

CommitBundle

data class CommitBundle(var welcome: Welcome?, var commit: ByteArray, var groupInfo: GroupInfoBundle, var encryptedMessage: ByteArray?) : Disposable

Information returned when a commit is created.

ConversationConfiguration

data class ConversationConfiguration(var ciphersuite: Ciphersuite?, var externalSenders: List<ExternalSenderKey>, var custom: CustomConfiguration) : Disposable

The configuration parameters for a group/conversation

ConversationId

open class ConversationId : Disposable, AutoCloseable, ConversationIdInterface

A unique identifier for a single conversation.

ConversationIdInterface

interface ConversationIdInterface

A unique identifier for a single conversation.

CoreCrypto

class CoreCrypto(cc: CoreCryptoFfi)

A high-level wrapper around a CoreCrypto client as emitted by Uniffi.

CoreCryptoCommand

interface CoreCryptoCommand

A CoreCryptoCommand has an execute method which accepts a CoreCryptoContext and returns nothing.

CoreCryptoCommandImpl

open class CoreCryptoCommandImpl : Disposable, AutoCloseable, CoreCryptoCommand

A CoreCryptoCommand has an execute method which accepts a CoreCryptoContext and returns nothing.

CoreCryptoContext

open class CoreCryptoContext : Disposable, AutoCloseable, CoreCryptoContextInterface

The CoreCryptoContext holds the primary CoreCrypto APIs.

CoreCryptoContextInterface

interface CoreCryptoContextInterface

The CoreCryptoContext holds the primary CoreCrypto APIs.

CoreCryptoException

sealed class CoreCryptoException : Exception

CoreCryptoFfi

open class CoreCryptoFfi : Disposable, AutoCloseable, CoreCryptoFfiInterface

CoreCrypto wraps around MLS and Proteus implementations and provides a transactional interface for each.

CoreCryptoFfiInterface

interface CoreCryptoFfiInterface

CoreCrypto wraps around MLS and Proteus implementations and provides a transactional interface for each.

CoreCryptoLogger

interface CoreCryptoLogger

This trait is used to provide a callback mechanism to hook up the respective platform logging system.

CoreCryptoLoggerImpl

open class CoreCryptoLoggerImpl : Disposable, AutoCloseable, CoreCryptoLogger

This trait is used to provide a callback mechanism to hook up the respective platform logging system.

CoreCryptoLogLevel

enum CoreCryptoLogLevel : Enum<CoreCryptoLogLevel>

Defines the log level for a CoreCrypto

CredentialType

enum CredentialType : Enum<CredentialType>

Type of Credential

CrlRegistration

data class CrlRegistration(var dirty: Boolean, var expiration: ULong?)

Supporting struct for CRL registration result

CustomConfiguration

data class CustomConfiguration(var keyRotationSpan: Duration?, var wirePolicy: WirePolicy?)

see core_crypto::MlsCustomConfiguration

Database

open class Database : Disposable, AutoCloseable, DatabaseInterface

The database acting as a core crypto keystore.

DatabaseInterface

interface DatabaseInterface

The database acting as a core crypto keystore.

DatabaseKey

open class DatabaseKey : Disposable, AutoCloseable, DatabaseKeyInterface

The key used to encrypt the database.

DatabaseKeyInterface

interface DatabaseKeyInterface

The key used to encrypt the database.

DecryptedMessage

data class DecryptedMessage(var message: ByteArray?, var isActive: Boolean, var commitDelay: ULong?, var senderClientId: ClientId?, var hasEpochChanged: Boolean, var identity: WireIdentity, var bufferedMessages: List<BufferedDecryptedMessage>?, var crlNewDistributionPoints: List<String>?) : Disposable

A decrypted message and various associated metadata

DeviceStatus

enum DeviceStatus : Enum<DeviceStatus>

Indicates the standalone status of a device Credential in a MLS group at a moment T.

Disposable

interface Disposable

E2eiConversationState

enum E2eiConversationState : Enum<E2eiConversationState>

Indicates the state of a Conversation regarding end-to-end identity.

E2eiEnrollment

open class E2eiEnrollment : Disposable, AutoCloseable, E2eiEnrollmentInterface

Wire end to end identity solution for fetching a x509 certificate which identifies a client.

E2eiEnrollmentInterface

interface E2eiEnrollmentInterface

Wire end to end identity solution for fetching a x509 certificate which identifies a client.

EpochChangedReportingException

sealed class EpochChangedReportingException : Exception

EpochObserver

interface EpochObserver

An EpochObserver is notified whenever a conversation's epoch changes.

EpochObserverImpl

open class EpochObserverImpl : Disposable, AutoCloseable, EpochObserver

An EpochObserver is notified whenever a conversation's epoch changes.

ExternalSenderKey

open class ExternalSenderKey : Disposable, AutoCloseable, ExternalSenderKeyInterface

The raw public key of an external sender.

ExternalSenderKeyInterface

interface ExternalSenderKeyInterface

The raw public key of an external sender.

FfiConverterTypeMlsTransportData

typealias FfiConverterTypeMlsTransportData = FfiConverterByteArray

GroupInfo

open class GroupInfo : Disposable, AutoCloseable, GroupInfoInterface

MLS Group Information

GroupInfoBundle

data class GroupInfoBundle(var encryptionType: MlsGroupInfoEncryptionType, var ratchetTreeType: MlsRatchetTreeType, var payload: GroupInfo) : Disposable

A GroupInfo with some metadata

GroupInfoInterface

interface GroupInfoInterface

MLS Group Information

HistoryObserver

interface HistoryObserver

An HistoryObserver is notified whenever a new history client is created.

HistoryObserverImpl

open class HistoryObserverImpl : Disposable, AutoCloseable, HistoryObserver

An HistoryObserver is notified whenever a new history client is created.

HistorySecret

data class HistorySecret(var clientId: ClientId, var data: ByteArray) : Disposable

A HistorySecret encodes sufficient client state that it can be used to instantiate an ephemeral client.

InternalException

class InternalException(message: String) : Exception

KeyPackage

open class KeyPackage : Disposable, AutoCloseable, KeyPackageInterface

A signed object describing a client's identity and capabilities.

KeyPackageInterface

interface KeyPackageInterface

A signed object describing a client's identity and capabilities.

LoggingException

sealed class LoggingException : Exception

MlsException

sealed class MlsException : Exception

MLS produces these kinds of error

MlsGroupInfoEncryptionType

enum MlsGroupInfoEncryptionType : Enum<MlsGroupInfoEncryptionType>

MlsRatchetTreeType

enum MlsRatchetTreeType : Enum<MlsRatchetTreeType>

MlsTransport

interface MlsTransport

Used by core crypto to send commits or application messages to the delivery service. This trait must be implemented before calling any functions that produce commits.

MlsTransportData

typealias MlsTransportData = ByteArray

Typealias from the type name used in the UDL file to the builtin type. This is needed because the UDL type name is used in function/method signatures. It's also what we have an external type that references a custom type.

MlsTransportImpl

open class MlsTransportImpl : Disposable, AutoCloseable, MlsTransport

Used by core crypto to send commits or application messages to the delivery service. This trait must be implemented before calling any functions that produce commits.

MlsTransportResponse

sealed class MlsTransportResponse

MLS transport may or may not succeeed; this response indicates to CC the outcome of the transport attempt.

NewAcmeAuthz

data class NewAcmeAuthz(var identifier: String, var keyauth: String?, var challenge: AcmeChallenge)

Result of an authorization creation.

NewAcmeOrder

data class NewAcmeOrder(var delegate: ByteArray, var authorizations: List<String>)

Result of an order creation.

NewHistoryClientReportingException

sealed class NewHistoryClientReportingException : Exception

ProteusAutoPrekeyBundle

data class ProteusAutoPrekeyBundle(var id: UShort, var pkb: ByteArray)

Encapsulates a prekey id and a cbor-serialized prekey

ProteusException

sealed class ProteusException : Exception

Proteus produces these kinds of error

SecretKey

open class SecretKey : Disposable, AutoCloseable, SecretKeyInterface

A secret key derived from the group secret.

SecretKeyInterface

interface SecretKeyInterface

A secret key derived from the group secret.

Welcome

open class Welcome : Disposable, AutoCloseable, WelcomeInterface

A TLS-serialized Welcome message.

WelcomeBundle

data class WelcomeBundle(var id: ConversationId, var crlNewDistributionPoints: List<String>?) : Disposable

see core_crypto::WelcomeBundle

WelcomeInterface

interface WelcomeInterface

A TLS-serialized Welcome message.

WireIdentity

data class WireIdentity(var clientId: String, var status: DeviceStatus, var thumbprint: String, var credentialType: CredentialType, var x509Identity: X509Identity?)

Represents the identity claims identifying a client Those claims are verifiable by any member in the group

WirePolicy

enum WirePolicy : Enum<WirePolicy>

See core_crypto::MlsWirePolicy

X509Identity

data class X509Identity(var handle: String, var displayName: String, var domain: String, var certificate: String, var serialNumber: String, var notBefore: Instant, var notAfter: Instant)

Represents the parts of crate::WireIdentity that are specific to a X509 certificate (and not a Basic one).