multipaz/org.multipaz.crypto

Package-level declarations

Types

Algorithm

enum Algorithm : Enum<Algorithm>

Algorithm identifiers.

AsymmetricKey

sealed class AsymmetricKey

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.

EcCurve

enum EcCurve : Enum<EcCurve>

Elliptic curve identifiers.

EcPrivateKey

sealed class EcPrivateKey

An EC private key.

EcPrivateKeyDoubleCoordinate

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

EC Private Key with two coordinates.

EcPrivateKeyOkp

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

EC Private Key with Octet Key Pairs.

EcPublicKey

sealed class EcPublicKey

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)

An Elliptic Curve Cryptography signature.

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

SecurityException

sealed class SecurityException : Exception

Base class for all security exceptions.

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.

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).

Properties

javaPrivateKey

val EcPrivateKey.javaPrivateKey: <Error class: unknown class>

javaPublicKey

val EcPublicKey.javaPublicKey: <Error class: unknown class>

javaX509Certificate

val X509Cert.javaX509Certificate: <Error class: unknown class>

The Java X509 certificate from the encoded certificate data.

javaX509Certificates

val X509CertChain.javaX509Certificates: List<<Error class: unknown class>>

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

Functions

buildCrl

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

buildX509Cert

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

Builds a new X509Cert.

fromJavaX509Certificates

fun X509CertChain.Companion.fromJavaX509Certificates(javaX509Certificates: Array<<Error class: unknown class>>): X509CertChain

fun X509CertChain.Companion.fromJavaX509Certificates(javaX509Certificates: List<<Error class: unknown class>>): X509CertChain

toEcPrivateKey

fun <Error class: unknown class>.toEcPrivateKey(publicKey: <Error class: unknown class>, curve: EcCurve): EcPrivateKey

toEcPublicKey

fun <Error class: unknown class>.toEcPublicKey(curve: EcCurve): EcPublicKey