kjwt-cryptography-kotlin-processor/co.touchlab.kjwt.cryptography/EncryptionKey

EncryptionKey

sealed class EncryptionKey : BaseJweProcessor(source)

Represents a cryptographic key (or key pair) used for JWE encryption and/or decryption.

Instances are identified by a (EncryptionAlgorithm, optional key ID) pair captured in identifier. Depending on which key material is available, an EncryptionKey may be:

EncryptionOnlyKey — holds only the public key; used by co.touchlab.kjwt.builder.JwtBuilder to encrypt tokens.
DecryptionOnlyKey — holds only the private key; used by co.touchlab.kjwt.parser.JwtParser to decrypt tokens.
EncryptionKeyPair — holds both keys; supports both encryption and decryption.

Complementary keys that share the same Identifier can be merged into an EncryptionKeyPair via mergeWith. This happens automatically when both are registered with the same co.touchlab.kjwt.model.registry.DefaultJwtProcessorRegistry.

Each subtype directly implements the appropriate processor interface (JweEncryptor, JweDecryptor, or JweProcessor) and carries the cryptographic logic for its role.

Inheritors

EncryptionOnlyKey

DecryptionOnlyKey

EncryptionKeyPair

Types

DecryptionOnlyKey

class DecryptionOnlyKey(val identifier: EncryptionKey.Identifier, val privateKey: Key) : EncryptionKey, JweDecryptor

A decryption-only key that holds only the private key material, implementing JweDecryptor.

EncryptionKeyPair

class EncryptionKeyPair(val identifier: EncryptionKey.Identifier, val publicKey: Key, val privateKey: Key) : EncryptionKey, JweProcessor

A complete key pair that holds both public and private key material, implementing JweProcessor.

EncryptionOnlyKey

class EncryptionOnlyKey(val identifier: EncryptionKey.Identifier, val publicKey: Key) : EncryptionKey, JweEncryptor

An encryption-only key that holds only the public key material, implementing JweEncryptor.

Identifier

data class Identifier(val algorithm: EncryptionAlgorithm, val keyId: String?)

Identifies an EncryptionKey within a co.touchlab.kjwt.model.registry.DefaultJwtProcessorRegistry by algorithm and optional key ID.

Properties

algorithm

open override val algorithm: EncryptionAlgorithm

identifier

abstract val identifier: EncryptionKey.Identifier

The algorithm and key ID that identify this key within a registry.

keyId

open override val keyId: String?

privateKey

abstract val privateKey: Key

The private key material used for decryption; throws on subtypes that do not hold a private key.

publicKey

abstract val publicKey: Key

The public key material used for encryption; throws on subtypes that do not hold a public key.

Functions

mergeWith

fun mergeWith(other: EncryptionKey?): EncryptionKey

EncryptionKey

See also

Inheritors

Types

Properties

Functions