supreme/at.asitplus.signum.supreme.sign

Package-level declarations

Types

sealed class AndroidEphemeralSigner : Signer

typealias ConfigurePlatformVerifier = DSLConfigureFn<PlatformVerifierConfiguration>

class ECPrivateKeySigner(privateKey: CryptoPrivateKey.EC.WithPublicKey, val signatureAlgorithm: SignatureAlgorithm.ECDSA, val publicKey: CryptoPublicKey.EC) : PrivateKeySigner, Signer.ECDSA

EphemeralKey

sealed interface EphemeralKey

An ephemeral keypair, not stored in any kind of persistent storage. Can be either EC or RSA. Has a CryptoPublicKey, and you can obtain a Signer from it.

EphemeralSigner

sealed class EphemeralSigner : Signer

EphemeralSignerConfiguration

actual class EphemeralSignerConfiguration : SignerConfiguration

expect class EphemeralSignerConfiguration : SignerConfiguration

actual class EphemeralSignerConfiguration : SignerConfiguration

actual class EphemeralSignerConfiguration : SignerConfiguration, JvmEphemeralSignerCompatibleConfiguration

EphemeralSignerConfigurationBase

typealias EphemeralSignerConfigurationBase = SignerConfiguration

EphemeralSigningKeyConfiguration

actual class EphemeralSigningKeyConfiguration : EphemeralSigningKeyConfigurationBase

expect class EphemeralSigningKeyConfiguration : EphemeralSigningKeyConfigurationBase

actual class EphemeralSigningKeyConfiguration : EphemeralSigningKeyConfigurationBase

EphemeralSigningKeyConfigurationBase

open class EphemeralSigningKeyConfigurationBase : SigningKeyConfiguration

InvalidSignature

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

JvmEphemeralSignerCompatibleConfiguration

interface JvmEphemeralSignerCompatibleConfiguration

KotlinECDSAVerifier

class KotlinECDSAVerifier : Verifier.EC, KotlinVerifier

KotlinVerifier

sealed interface KotlinVerifier : Verifier

A distinguishing interface for verifiers that are implemented in pure Kotlin

PlatformECDSAVerifier

class PlatformECDSAVerifier : Verifier.EC, PlatformVerifier

PlatformRSAVerifier

class PlatformRSAVerifier : Verifier.RSA, PlatformVerifier

PlatformVerifier

sealed interface PlatformVerifier : Verifier

A distinguishing interface for verifiers that delegate to the underlying platform (JCA, CryptoKit, ...)

PlatformVerifierConfiguration

actual class PlatformVerifierConfiguration : DSL.Data

Configures JVM-specific properties.

expect class PlatformVerifierConfiguration : DSL.Data

actual class PlatformVerifierConfiguration : DSL.Data

Configures iOS-specific properties.

actual class PlatformVerifierConfiguration : DSL.Data

Configures JVM-specific properties.

PrivateKeySigner

sealed class PrivateKeySigner : Signer

RSAPrivateKeySigner

class RSAPrivateKeySigner(privateKey: CryptoPrivateKey.RSA, val signatureAlgorithm: SignatureAlgorithm.RSA, val publicKey: CryptoPublicKey.RSA) : PrivateKeySigner, Signer.RSA

SignatureInput

class SignatureInput

SignatureInputFormat

typealias SignatureInputFormat = Digest?

Signer

interface Signer

Shared interface of all objects that can sign data. Signatures are created using the signatureAlgorithm, and can be verified using publicKey, potentially with a verifierFor this object.

SigningKeyConfiguration

open class SigningKeyConfiguration : DSL.Data

DSL for configuring a signing key.

Verifier

sealed interface Verifier

Properties

curve

val Signer.ECDSA.curve: ECCurve

preHashedSignatureFormat

val SignatureAlgorithm.preHashedSignatureFormat: SignatureInputFormat

Functions

makePlatformVerifier

fun Signer.makePlatformVerifier(configure: ConfigurePlatformVerifier = null): KmmResult<Verifier>

Gets a platform verifier for signatures generated by this Signer.

makeVerifier

fun Signer.makeVerifier(configure: ConfigurePlatformVerifier = null): KmmResult<Verifier>

Get a verifier for signatures generated by this Signer.

platformVerifierFor

fun SignatureAlgorithm.platformVerifierFor(publicKey: CryptoPublicKey, configure: ConfigurePlatformVerifier = null): KmmResult<Verifier>

fun SignatureAlgorithm.ECDSA.platformVerifierFor(publicKey: CryptoPublicKey.EC, configure: ConfigurePlatformVerifier = null): KmmResult<Verifier.EC>

fun SignatureAlgorithm.RSA.platformVerifierFor(publicKey: CryptoPublicKey.RSA, configure: ConfigurePlatformVerifier = null): KmmResult<Verifier.RSA>

Obtains a platform verifier.

fun SpecializedSignatureAlgorithm.platformVerifierFor(publicKey: CryptoPublicKey, configure: ConfigurePlatformVerifier = null): KmmResult<Verifier>

signerFor

fun SignatureAlgorithm.signerFor(privateKey: CryptoPrivateKey.WithPublicKey<*>): KmmResult<Signer>

Creates a signer for the specified privateKey. Fails if the key type does not match the signature algorithm type (EC/RSA)

fun SignatureAlgorithm.signerFor(privateKey: CryptoPrivateKey.WithPublicKey<*>, configure: DSLConfigureFn<JvmEphemeralSignerCompatibleConfiguration>): KmmResult<Signer>

Creates a signer for the specified privateKey. Fails if the key type does not match the signature algorithm type (EC/RSA) or if it has no public key attached This JVM-specific variant allows for optionally specifying a provider

verifierFor

fun SignatureAlgorithm.verifierFor(publicKey: CryptoPublicKey, configure: ConfigurePlatformVerifier = null): KmmResult<Verifier>

fun SignatureAlgorithm.ECDSA.verifierFor(publicKey: CryptoPublicKey.EC, configure: ConfigurePlatformVerifier = null): KmmResult<Verifier.EC>

fun SignatureAlgorithm.RSA.verifierFor(publicKey: CryptoPublicKey.RSA, configure: ConfigurePlatformVerifier = null): KmmResult<Verifier.RSA>

Obtains a verifier.

fun SpecializedSignatureAlgorithm.verifierFor(publicKey: CryptoPublicKey, configure: ConfigurePlatformVerifier = null): KmmResult<Verifier>

verify

fun Verifier.verify(data: ByteArray, sig: CryptoSignature): KmmResult<Verifier.Success>