cryptography/com.wire.kalium.cryptography

Package-level declarations

Types

typealias ApplicationMessage = ByteArray

data class CommitBundle(val commit: ByteArray, val welcome: ByteArray?, val groupInfoBundle: GroupInfoBundle, val encryptedMessage: ByteArray? = null)

CoreCryptoCallbackContext

internal class CoreCryptoCallbackContext(access: AccountResourceAccess)

UniFFI starts awaited native callbacks in unrelated coroutines. Serialize calls to this native owner so a callback can recover the admission of exactly one active operation. Callback re-entry retains that operation, rather than acquiring its mutex a second time.

CoreCryptoCentral

interface CoreCryptoCentral

CoreCryptoCentralImpl

class CoreCryptoCentralImpl(cc: CoreCrypto, rootDir: String, database: Database) : CoreCryptoCentral

CoreCryptoLoggerImpl

internal object CoreCryptoLoggerImpl : CoreCryptoLogger

CoreCryptoOpenCleanupException

class CoreCryptoOpenCleanupException(cause: Throwable) : Exception

Opening failed and closing the native resources it had already opened also failed. Other opening failures leave no native resources behind and can be retried.

CredentialType

enum CredentialType : Enum<CredentialType>

CryptoCertificateStatus

enum CryptoCertificateStatus : Enum<CryptoCertificateStatus>

CryptoClientId

data class CryptoClientId(val value: String)

CryptoCredential

interface CryptoCredential

A Core Crypto credential acquired independently of a client transaction.

CryptoCredentialImpl

internal class CryptoCredentialImpl(val native: Credential) : CryptoCredential

CryptoCredentialRef

interface CryptoCredentialRef

A reference to a credential stored by Core Crypto.

CryptoCredentialRefImpl

internal class CryptoCredentialRefImpl(val native: CredentialRef) : CryptoCredentialRef

CryptographyLogger

object CryptographyLogger

CryptoQualifiedClientId

data class CryptoQualifiedClientId(val value: String, val userId: CryptoQualifiedID)

CryptoQualifiedID

data class CryptoQualifiedID(val value: String, val domain: String)

CryptoSessionId

data class CryptoSessionId(val userId: CryptoUserID, val cryptoClientId: CryptoClientId)

CryptoTransactionContext

interface CryptoTransactionContext

Provides a composite context that can be used inside a crypto transaction.

CryptoUserID

typealias CryptoUserID = CryptoQualifiedID

DecryptedMessageBundle

sealed interface DecryptedMessageBundle

E2EIConversationState

enum E2EIConversationState : Enum<E2EIConversationState>

ExternalSenderKey

@JvmInline

value class ExternalSenderKey(val value: ByteArray)

GroupInfoBundle

open class GroupInfoBundle(var encryptionType: GroupInfoEncryptionType, var ratchetTreeType: RatchetTreeType, var payload: ByteArray)

GroupInfoEncryptionType

enum GroupInfoEncryptionType : Enum<GroupInfoEncryptionType>

HandshakeMessage

typealias HandshakeMessage = ByteArray

MLSCiphersuite

enum MLSCiphersuite : Enum<MLSCiphersuite>

MLSClient

interface MLSClient

MLSClientImpl

class MLSClientImpl : MLSClient

MlsCoreCryptoContext

interface MlsCoreCryptoContext

MlsDBSecret

data class MlsDBSecret(val passphrase: ByteArray)

MLSDecryptResult

sealed interface MLSDecryptResult

MLSEpochObserver

interface MLSEpochObserver

MLSGroupId

typealias MLSGroupId = String

MLSHistorySecret

class MLSHistorySecret(val clientId: CryptoQualifiedClientId, val data: ByteArray)

MLSKeyPackage

typealias MLSKeyPackage = ByteArray

MlsMessageRejectedException

class MlsMessageRejectedException(val reason: String, cause: Throwable? = null) : Exception

The delivery service rejected an outgoing MLS commit.

MLSTransporter

interface MLSTransporter

PkiEnvironmentHooks

interface PkiEnvironmentHooks

Core-Crypto-neutral callbacks used by the v10 PKI environment.

PkiHttpHeader

data class PkiHttpHeader(val name: String, val value: String)

PkiHttpMethod

enum PkiHttpMethod : Enum<PkiHttpMethod>

PkiHttpResponse

data class PkiHttpResponse(val status: UShort, val headers: List<PkiHttpHeader>, val body: ByteArray)

PlainMessage

typealias PlainMessage = ByteArray

PlainUserId

data class PlainUserId(val value: String)

PreKeyCrypto

data class PreKeyCrypto(val id: Int, val pkb: String)

ProteusClient

interface ProteusClient

ProteusClientCoreCryptoImpl

class ProteusClientCoreCryptoImpl : ProteusClient

ProteusCoreCryptoContext

interface ProteusCoreCryptoContext

ProteusDBSecret

data class ProteusDBSecret(val passphrase: ByteArray)

RatchetTreeType

enum RatchetTreeType : Enum<RatchetTreeType>

ReopenableCoreCryptoCentral

class ReopenableCoreCryptoCentral(access: AccountResourceAccess, factory: suspend () -> CoreCryptoCentral) : CoreCryptoCentral

Stable Apple facade; only the native resource generation changes during account handoff.

RequireConfirmedCryptoRollback

object RequireConfirmedCryptoRollback : AbstractCoroutineContextElement

Requires native rollback confirmation before a failed CoreCrypto transaction restores its callback error.

WelcomeMessage

typealias WelcomeMessage = ByteArray

WireIdentity

data class WireIdentity(val clientId: CryptoQualifiedClientId, val status: CryptoCertificateStatus, val thumbprint: String, val credentialType: CredentialType, val x509Identity: WireIdentity.X509Identity?)

X509CredentialAcquisitionConfig

data class X509CredentialAcquisitionConfig(val acmeDirectoryUrl: String, val cipherSuite: MLSCiphersuite, val displayName: String, val clientId: CryptoQualifiedClientId, val handle: String, val teamId: String?, val validity: Duration)

Properties

kaliumLogger

internal var kaliumLogger: KaliumLogger

Functions

coreCryptoCentral

expect suspend fun coreCryptoCentral(rootDir: String, passphrase: ByteArray): CoreCryptoCentral

actual suspend fun coreCryptoCentral(rootDir: String, passphrase: ByteArray): CoreCryptoCentral

createDirectory

internal actual fun createDirectory(path: String): Boolean

Creates a directory at the specified path, including any necessary parent directories.

internal expect fun createDirectory(path: String): Boolean

Creates a directory at the specified path, including any necessary parent directories.

internal actual fun createDirectory(path: String): Boolean

Creates a directory at the specified path, including any necessary parent directories.

internal actual fun createDirectory(path: String): Boolean

Creates a directory at the specified path, including any necessary parent directories.

createSessions

suspend fun ProteusCoreCryptoContext.createSessions(preKeysCrypto: Map<String, Map<String, Map<String, PreKeyCrypto>>>)

deleteFile

internal actual fun deleteFile(path: String): Boolean

Deletes a file or directory at the specified path.

internal expect fun deleteFile(path: String): Boolean

Deletes a file or directory at the specified path.

internal actual fun deleteFile(path: String): Boolean

Deletes a file or directory at the specified path.

internal actual fun deleteFile(path: String): Boolean

Deletes a file or directory at the specified path.

fileExists

internal actual fun fileExists(path: String): Boolean

Checks if a file or directory exists at the specified path.

internal expect fun fileExists(path: String): Boolean

Checks if a file or directory exists at the specified path.

internal actual fun fileExists(path: String): Boolean

Checks if a file or directory exists at the specified path.

internal actual fun fileExists(path: String): Boolean

Checks if a file or directory exists at the specified path.

findPkiTrustAnchorsToAdd

internal fun findPkiTrustAnchorsToAdd(installedAnchors: List<CertificateChain>, pemBundle: String): List<CertificateChain>

Returns the certificates from pemBundle that are not in installedAnchors.

migrateDatabaseKey

actual suspend fun migrateDatabaseKey(rootDir: String, oldKey: String, passphrase: ByteArray)

expect suspend fun migrateDatabaseKey(rootDir: String, oldKey: String, passphrase: ByteArray)

actual suspend fun migrateDatabaseKey(rootDir: String, oldKey: String, passphrase: ByteArray)

toCoreCryptoClientId

internal fun CryptoQualifiedClientId.toCoreCryptoClientId(): ClientId

transaction

internal suspend fun <T> CoreCrypto.transaction(workIdentifier: String, block: suspend (context: CoreCryptoContext) -> T): T

Performs a work using a CC Transaction, returning its result, exactly like the regular withLock function. However, this will monitor the work and log warnings using the provided workIdentifier every 10 seconds, while the work isn't completed.

unwrap

internal fun CryptoCredential.unwrap(): Credential

internal fun CryptoCredentialRef.unwrap(): CredentialRef