indispensable/at.asitplus.signum.indispensable.symmetric/SymmetricKey/Authenticating

Authenticating

interface Authenticating<A : AuthCapability.Authenticated<K>, I : NonceTrait, K : KeyType> : SymmetricKey<A, I, K> (source)

Inheritors

WithDedicatedMac

Properties

additionalProperties

abstract val additionalProperties: MutableMap<String, String>

This is meant for storing additional properties, which may be relevant for certain use cases. For example, Json Web Keys or COSE keys may define an arbitrary key IDs. This is not meant for Algorithm parameters! If an algorithm needs parameters, the implementing classes should be extended

abstract val algorithm: SymmetricEncryptionAlgorithm<A, I, K>

val <I : NonceTrait> SymmetricKey<AuthCapability.Authenticated.WithDedicatedMac, I, out KeyType.WithDedicatedMacKey>.encryptionKey: KmmResult<ByteArray>

The encryption key bytes, if present.

val <I : NonceTrait> SymmetricKey<AuthCapability.Authenticated.WithDedicatedMac, I, out KeyType.WithDedicatedMacKey>.macKey: KmmResult<ByteArray>

The dedicated MAC key bytes, if present.

val <A : AuthCapability<out KeyType.Integrated>, I : NonceTrait> SymmetricKey<A, I, out KeyType.Integrated>.secretKey: KmmResult<ByteArray>

The actual encryption key bytes

Functions

hasDedicatedMacKey

fun <A : AuthCapability<*>, I : NonceTrait> SymmetricKey<A, I, *>.hasDedicatedMacKey(): Boolean

Use to smart cast

isAuthenticated

fun <A : AuthCapability<K>, K : KeyType, I : NonceTrait> SymmetricKey<A, I, K>.isAuthenticated(): Boolean

Use to smart cast

fun <A : AuthCapability.Authenticated<*>, I : NonceTrait> SymmetricKey<A, I, *>.isIntegrated(): Boolean

Use to smart cast

fun <A : AuthCapability<K>, K : KeyType> SymmetricKey<A, *, K>.requiresNonce(): Boolean

Use to smart cast