multipaz/org.multipaz.crypto

Package-level declarations

Types

Algorithm

enum Algorithm : Enum<Algorithm>

Algorithm identifiers.

AsymmetricKey

sealed class AsymmetricKey : AutoCloseable

Private key that can be used to sign messages or used for key agreement, optionally with some kind of identification.

Crypto

expect object Crypto

Cryptographic support routines.

actual object Crypto

Cryptographic support routines.

actual object Crypto

EcCurve

enum EcCurve : Enum<EcCurve>

Elliptic curve identifiers.

EcPrivateKey

sealed class EcPrivateKey : PrivateKey

An EC private key.

EcPrivateKeyDoubleCoordinate

class EcPrivateKeyDoubleCoordinate(val curve: EcCurve, d: ByteArray, val x: ByteArray, val y: ByteArray) : EcPrivateKey

EC Private Key with two coordinates.

EcPrivateKeyOkp

class EcPrivateKeyOkp(val curve: EcCurve, d: ByteArray, val x: ByteArray) : EcPrivateKey

EC Private Key with Octet Key Pairs.

EcPublicKey

sealed class EcPublicKey : PublicKey

An EC Public Key.

EcPublicKeyDoubleCoordinate

data class EcPublicKeyDoubleCoordinate(val curve: EcCurve, val x: ByteArray, val y: ByteArray) : EcPublicKey

EC Public Key with two coordinates.

EcPublicKeyOkp

data class EcPublicKeyOkp(val curve: EcCurve, val x: ByteArray) : EcPublicKey

EC Public Key with Octet Key Pairs.

EcSignature

data class EcSignature(val r: ByteArray, val s: ByteArray) : Signature

An Elliptic Curve Cryptography signature.

EncapsulatedBits

interface EncapsulatedBits : JsAny

Hkdf

object Hkdf

HMAC-based Extract-and-Expand Key Derivation Function (HKDF) according to RFC 5869.

Hpke

object Hpke

Hybrid Public Key Encryption according to RFC 9180.

JsonWebEncryption

object JsonWebEncryption

JSON Web Encryption (JWE) support routines

JsonWebSignature

object JsonWebSignature

JSON Web Signature support

KemResult

class KemResult(val sharedSecret: SecureByteString, val ciphertext: ByteArray) : AutoCloseable

Result of a Key Encapsulation Mechanism (KEM) encapsulation operation.

MlDsaPrivateKey

class MlDsaPrivateKey(val algorithm: Algorithm, encoded: ByteArray, val publicKey: MlDsaPublicKey) : PrivateKey

An ML-DSA (FIPS 204) private key.

MlDsaPublicKey

data class MlDsaPublicKey(val algorithm: Algorithm, val encoded: ByteString) : PublicKey

An ML-DSA (FIPS 204) public key.

MlDsaSignature

data class MlDsaSignature(val signature: ByteArray) : Signature

An ML-DSA digital signature (FIPS 204).

MlKemPrivateKey

class MlKemPrivateKey(val algorithm: Algorithm, encoded: ByteArray, val publicKey: MlKemPublicKey) : PrivateKey

An ML-KEM (FIPS 203) private key.

MlKemPublicKey

data class MlKemPublicKey(val algorithm: Algorithm, val encoded: ByteString) : PublicKey

An ML-KEM (FIPS 203) public key.

Pkcs12

data class Pkcs12(val privateKey: EcPrivateKey, val certChain: X509CertChain)

A PKCS#12 (PFX) container holding an EC private key and its associated certificate chain according to RFC 7292.

Pkcs12WrongPassphraseException

class Pkcs12WrongPassphraseException(message: String, cause: Throwable? = null) : Exception

Thrown when decoding a PKCS#12 archive fails due to an invalid passphrase, MAC verification failure, or cipher padding error.

PrivateKey

sealed class PrivateKey : AutoCloseable

An asymmetric private key.

PublicKey

sealed class PublicKey

An asymmetric public key.

RsaHashedKeyGenParams

interface RsaHashedKeyGenParams : Algorithm

RsaPrivateKey

class RsaPrivateKey(val publicKey: RsaPublicKey, privateExponent: ByteArray, p: ByteArray? = null, q: ByteArray? = null, dp: ByteArray? = null, dq: ByteArray? = null, qInv: ByteArray? = null) : PrivateKey

An RSA Private Key.

RsaPssParams

interface RsaPssParams : Algorithm

RsaPublicKey

data class RsaPublicKey(val modulus: ByteArray, val publicExponent: ByteArray) : PublicKey

An RSA Public Key.

RsaSignature

data class RsaSignature(val signature: ByteArray) : Signature

An RSA digital signature.

SecretKey

class SecretKey(keyMaterial: ByteArray) : SecureByteString

A cryptographic secret key (symmetric key or shared secret) with memory clearing on disposal.

SecureByteString

open class SecureByteString(data: ByteArray) : AutoCloseable

An immutable sequence of bytes containing sensitive data with memory clearing on disposal.

SecurityException

sealed class SecurityException : Exception

Base class for all security exceptions.

Signature

sealed interface Signature

A digital signature produced by an asymmetric private key.

SignatureVerificationException

class SignatureVerificationException(message: String, cause: Throwable? = null) : SecurityException

Exception thrown when a cryptographic signature fails to validate.

X500Name

class X500Name(val components: Map<String, ASN1String>)

This represents a X.501 Name as used for X.509 certificates.

X509Cert

data class X509Cert(val encoded: ByteString) : X509Signed

A data type for a X.509 certificate.

X509CertChain

data class X509CertChain(val certificates: List<X509Cert>)

A chain of certificates.

X509CertChainValidationException

sealed class X509CertChainValidationException : Exception

Exception thrown when X509 certificate chain validation fails.

X509Crl

data class X509Crl(val encoded: ByteString) : X509Signed

X.509 CRL (Certificate Revocation List).

X509Extension

data class X509Extension(val oid: String, val isCritical: Boolean, val data: ByteString)

A data type representing an X.509 certificate extension information.

X509KeyUsage

enum X509KeyUsage : Enum<X509KeyUsage>

X509Signed

sealed class X509Signed

Base class for signed X.509 sequences: certificates and CRLs.

X509SignedBuilder

sealed class X509SignedBuilder<BuilderT : X509SignedBuilder<BuilderT>>

Base builder class for X509 signed sequences (certificates and CRLs).

XdhKeyDeriveParams

interface XdhKeyDeriveParams : Algorithm

Properties

javaPrivateKey

val EcPrivateKey.javaPrivateKey: PrivateKey

val RsaPrivateKey.javaPrivateKey: ERROR CLASS: Symbol not found for RSAPrivateKey

javaPublicKey

val EcPublicKey.javaPublicKey: PublicKey

val RsaPublicKey.javaPublicKey: ERROR CLASS: Symbol not found for RSAPublicKey

javaX509Certificate

val X509Cert.javaX509Certificate: ERROR CLASS: Symbol not found for X509Certificate

The Java X509 certificate from the encoded certificate data.

javaX509Certificates

val X509CertChain.javaX509Certificates: List<ERROR CLASS: Symbol not found for X509Certificate>

Converts the certificate chain to a list of Java X.509 certificates.

Functions

buildX509Cert

inline suspend fun buildX509Cert(publicKey: PublicKey, signingKey: AsymmetricKey, serialNumber: ASN1Integer, subject: X500Name, issuer: X500Name, validFrom: Instant, validUntil: Instant, builderAction: X509Cert.Builder.() -> Unit): X509Cert

Builds a new X509Cert.

buildX509Crl

inline suspend fun buildX509Crl(signingKey: AsymmetricKey, issuer: X500Name, thisUpdate: Instant, nextUpdate: Instant?, block: X509Crl.Builder.() -> Unit): X509Crl

checkSignature

suspend fun Crypto.checkSignature(publicKey: PublicKey, message: ByteArray, algorithm: Algorithm, signature: Signature)

Checks signature validity for a generic PublicKey and Signature.

fromJavaX509Certificates

fun X509CertChain.Companion.fromJavaX509Certificates(javaX509Certificates: Array<ERROR CLASS: Symbol not found for Certificate>): X509CertChain

fun X509CertChain.Companion.fromJavaX509Certificates(javaX509Certificates: List<ERROR CLASS: Symbol not found for X509Certificate>): X509CertChain

secureZero

expect fun ByteArray.secureZero()

Securely zeroes out the contents of this byte array in memory.

actual fun ByteArray.secureZero()

sign

suspend fun Crypto.sign(key: PrivateKey, signatureAlgorithm: Algorithm, message: ByteArray): Signature

Signs data with a private key.

toEcPrivateKey

fun PrivateKey.toEcPrivateKey(publicKey: PublicKey, curve: EcCurve): EcPrivateKey

toEcPublicKey

fun PublicKey.toEcPublicKey(curve: EcCurve): EcPublicKey

toRsaPrivateKey

fun ERROR CLASS: Symbol not found for JavaPrivateKey.toRsaPrivateKey(publicKey: RsaPublicKey? = null): RsaPrivateKey

toRsaPublicKey

fun ERROR CLASS: Symbol not found for JavaPublicKey.toRsaPublicKey(): RsaPublicKey

toSecretKey

fun ByteArray.toSecretKey(): SecretKey

Creates a SecretKey from this byte array. A defensive copy of the key material is stored.

fun SecureByteString.toSecretKey(): SecretKey

Converts this SecureByteString to a SecretKey.

toSecureByteString

fun ByteArray.toSecureByteString(): SecureByteString

Creates a SecureByteString from this byte array. A defensive copy of the data is stored.