elliptic curve point in homogeneous coordinates (X,Y,Z) to access affine coordinates, normalize the point. the point at infinity cannot be normalized.

ECPointSerializer

object ECPointSerializer : KSerializer<ECPoint.Normalized>

EncryptedPrivateKey

class EncryptedPrivateKey(val encryptionAlgorithm: ObjectIdentifier, val encryptedData: ByteArray) : PemEncodable<Asn1Sequence>

Representation of an encrypted private key structure as per RFC 5208

HMAC

enum HMAC : Enum<HMAC> , MessageAuthenticationCode, Identifiable, Asn1Encodable<Asn1Sequence>

RFC 2104 HMAC

IosHomebrewAttestation

@Serializable

@SerialName(value = "ios-appattest")

data class IosHomebrewAttestation(val attestation: ByteArray, val clientDataJSON: ByteArray) : Attestation

KeyAgreementPrivateValue

sealed interface KeyAgreementPrivateValue

Key agreement private value. Always comes with the matching publicValue.

KeyAgreementPublicValue

sealed interface KeyAgreementPublicValue : PemEncodable<Asn1Sequence>

Key agreement public value. Must be PEM encodable/decodable.

MessageAuthenticationCode

sealed interface MessageAuthenticationCode : DataIntegrityAlgorithm

RSAPadding

enum RSAPadding : Enum<RSAPadding>

SecretExposure

annotation class SecretExposure

This guards a secret. Do not expose it lightly!

SelfAttestation

@Serializable

@SerialName(value = "self")

data class SelfAttestation(val certificate: X509Certificate) : Attestation

SignatureAlgorithm

sealed interface SignatureAlgorithm : DataIntegrityAlgorithm

SpecializedCryptoPublicKey

interface SpecializedCryptoPublicKey

SpecializedDataIntegrityAlgorithm

interface SpecializedDataIntegrityAlgorithm

SpecializedMessageAuthenticationCode

interface SpecializedMessageAuthenticationCode : SpecializedDataIntegrityAlgorithm

SpecializedSignatureAlgorithm

interface SpecializedSignatureAlgorithm : SpecializedDataIntegrityAlgorithm

X509SignatureAlgorithm

sealed class X509SignatureAlgorithm : X509SignatureAlgorithmDescription, SpecializedSignatureAlgorithm

X509SignatureAlgorithmDescription

sealed class X509SignatureAlgorithmDescription : Asn1Encodable<Asn1Sequence> , Identifiable

Properties

iosEncoded

val CryptoSignature.iosEncoded: ByteArray

iosEncodedPrivateKeyLength

val ECCurve.iosEncodedPrivateKeyLength: Int

Returns the length of a private key, when it is exported from iOS. This is handy, because Apple does not encode curve identifiers, but implies them based on the length of the key

iosEncodedPublicKeyLength

val ECCurve.iosEncodedPublicKeyLength: Int

Returns the length of a public key, when it is exported from iOS. This is handy, because Apple does not encode curve identifiers, but implies them based on the length of the key

jcaAlgorithmComponent

val Digest?.jcaAlgorithmComponent: String

jcaKeySpec

val SymmetricEncryptionAlgorithm<*, *, *>.jcaKeySpec: String

jcaName

val Digest.jcaName: String

val ECCurve.jcaName: String

val HMAC.jcaName: String

val SymmetricEncryptionAlgorithm<*, *, *>.jcaName: String

val AsymmetricEncryptionAlgorithm.jcaName: String

An encryption algorithm's JCA name. This is publicly exposed because it could come in handy under very specific circumstances. Double and triple check before feeding this into Cipher.getInstance!. Then think again, pull in Signum Supreme and call encryptorFor/decryptorFor on whatever pre-configured instance of AsymmetricEncryptionAlgorithm you will be actually using.

jcaParameterSpec

val AsymmetricEncryptionAlgorithm.jcaParameterSpec: <Error class: unknown class>?

An encryption algorithm's JCA parameters. This is publicly exposed because it could come in handy under very specific circumstances. Double and triple check before feeding this into Cipher.init!. Then think again, pull in Signum Supreme and call encryptorFor/decryptorFor on whatever pre-configured instance of AsymmetricEncryptionAlgorithm you will be actually using.

jcaPSSParams

val Digest.jcaPSSParams: <Error class: unknown class>

jcaSignatureBytes

val CryptoSignature.jcaSignatureBytes: ByteArray

In Java EC signatures are returned as DER-encoded, RSA signatures however are raw bytearrays

jsonEncoded

val Attestation.jsonEncoded: String

nativeDigest

val ECCurve.nativeDigest: Digest

A digest well-suited to operations on this curve, with output length near the curve's coordinate length.

secKeyAlgorithm

val SignatureAlgorithm.secKeyAlgorithm: SecKeyAlgorithm

val SpecializedSignatureAlgorithm.secKeyAlgorithm: CPointer<__CFString>

val AsymmetricEncryptionAlgorithm.secKeyAlgorithm: SecKeyAlgorithm

secKeyAlgorithmPreHashed

val SignatureAlgorithm.secKeyAlgorithmPreHashed: SecKeyAlgorithm

val SpecializedSignatureAlgorithm.secKeyAlgorithmPreHashed: CPointer<__CFString>

StrictJson

val StrictJson: Json

Functions

byJcaName

fun ECCurve.Companion.byJcaName(name: String): ECCurve?

ceilDiv

inline fun Int.ceilDiv(other: Int): Int

inline fun UInt.ceilDiv(other: UInt): UInt

contentEqualsIfArray

infix inline fun <T> Any.contentEqualsIfArray(other: T): Boolean

contentHashCodeIfArray

inline fun Any.contentHashCodeIfArray(): Int

equalsCryptographically

fun CryptoPublicKey.equalsCryptographically(other: CryptoPublicKey): Boolean

Alias of equals provided for convenience (and alignment with SpecializedCryptoPublicKey)

fun CryptoPublicKey.equalsCryptographically(other: SpecializedCryptoPublicKey): Boolean

fun SpecializedCryptoPublicKey.equalsCryptographically(other: CryptoPublicKey): Boolean

fun SpecializedCryptoPublicKey.equalsCryptographically(other: SpecializedCryptoPublicKey): Boolean

Whether the actual underlying key (irrespective of any format-specific metadata) is equal

fromIosEncodedPrivateKeyLength

fun ECCurve.Companion.fromIosEncodedPrivateKeyLength(length: Int): ECCurve?

Returns the curve associated with a public key exported from iOS based on the length of the key material This is handy, because Apple does not encode curve identifiers, but implies them based on the length of the key

fromIosEncodedPublicKeyLength

fun ECCurve.Companion.fromIosEncodedPublicKeyLength(length: Int): ECCurve?

fromJcaPublicKey

fun CryptoPublicKey.Companion.~~fromJcaPublicKey~~(publicKey: <Error class: unknown class>): KmmResult<CryptoPublicKey>

fun CryptoPublicKey.EC.Companion.~~fromJcaPublicKey~~(publicKey: <Error class: unknown class>): KmmResult<CryptoPublicKey.EC>

fun CryptoPublicKey.RSA.Companion.~~fromJcaPublicKey~~(publicKey: <Error class: unknown class>): KmmResult<CryptoPublicKey.RSA>

getJCADecryptorInstance

fun AsymmetricEncryptionAlgorithm.getJCADecryptorInstance(privateKey: CryptoPrivateKey.RSA, provider: String? = null): <Error class: unknown class>

Get a pre-configured JCA Cipher instance for this algorithm to use for decryption

getJCAEncryptorInstance

fun AsymmetricEncryptionAlgorithm.getJCAEncryptorInstance(publicKey: CryptoPublicKey.RSA, provider: String? = null): <Error class: unknown class>

Get a pre-configured JCA Cipher instance for this algorithm to use for encryption

getJcaPublicKey

fun CryptoPublicKey.~~getJcaPublicKey~~(): KmmResult<<Error class: unknown class>>

fun CryptoPublicKey.EC.~~getJcaPublicKey~~(): KmmResult<<Error class: unknown class>>

fun CryptoPublicKey.RSA.~~getJcaPublicKey~~(): KmmResult<<Error class: unknown class>>

getJCASignatureInstance

fun SignatureAlgorithm.getJCASignatureInstance(provider: String? = null): <Error class: unknown class>

fun SpecializedSignatureAlgorithm.getJCASignatureInstance(provider: String? = null): <Error class: unknown class>

Get a pre-configured JCA instance for this algorithm

getJCASignatureInstancePreHashed

fun SignatureAlgorithm.getJCASignatureInstancePreHashed(provider: String? = null): KmmResult<Nothing>

fun SpecializedSignatureAlgorithm.getJCASignatureInstancePreHashed(provider: String? = null): KmmResult<Nothing>

Get a pre-configured JCA instance for pre-hashed data for this algorithm

isSupported

fun X509SignatureAlgorithmDescription.isSupported(): Boolean

smart-casts the receiver to an X509SignatureAlgorithm.Supported if supported.

parseFromJca

fun CryptoSignature.EC.Companion.parseFromJca(input: ByteArray): CryptoSignature.EC.IndefiniteLength

Parses a signature produced by the JCA digestwithECDSA algorithm.

fun CryptoSignature.RSA.Companion.parseFromJca(input: ByteArray): CryptoSignature.RSA

fun CryptoSignature.Companion.parseFromJca(input: ByteArray, algorithm: SpecializedSignatureAlgorithm): CryptoSignature

fun CryptoSignature.Companion.parseFromJca(input: ByteArray, algorithm: SignatureAlgorithm): CryptoSignature

In Java EC signatures are returned as DER-encoded, RSA signatures however are raw bytearrays

parseFromJcaP1363

fun CryptoSignature.EC.Companion.parseFromJcaP1363(input: ByteArray): CryptoSignature.EC.DefiniteLength

Parses a signature produced by the JCA digestWithECDSAinP1363Format algorithm.

requireSupported

fun X509SignatureAlgorithmDescription.requireSupported()

throws if the X509SignatureAlgorithm is unsupported

toCryptoPrivateKey

fun <Error class: unknown class>.toCryptoPrivateKey(): KmmResult<CryptoPrivateKey.EC.WithPublicKey>

fun <Error class: unknown class>.toCryptoPrivateKey(): KmmResult<CryptoPrivateKey.WithPublicKey<*>>

fun <Error class: unknown class>.toCryptoPrivateKey(): KmmResult<CryptoPrivateKey.RSA>

fun SecKeyRef?.toCryptoPrivateKey(): <Error class: unknown class>

toCryptoPublicKey

fun <Error class: unknown class>.toCryptoPublicKey(): KmmResult<CryptoPublicKey.EC>

fun <Error class: unknown class>.toCryptoPublicKey(): KmmResult<CryptoPublicKey>

fun <Error class: unknown class>.toCryptoPublicKey(): KmmResult<CryptoPublicKey.RSA>

toJcaCertificate

suspend fun X509Certificate.toJcaCertificate(): KmmResult<<Error class: unknown class>>

Converts this X509Certificate to a java.security.cert.X509Certificate. This function is suspending, because it uses a mutex to lock the underlying certificate factory (which is reused for performance reasons

toJcaCertificateBlocking

fun X509Certificate.toJcaCertificateBlocking(): KmmResult<<Error class: unknown class>>

blocking implementation of toJcaCertificate

toJcaPrivateKey

fun CryptoPrivateKey.EC.WithPublicKey.toJcaPrivateKey(): KmmResult<<Error class: unknown class>>

fun CryptoPrivateKey.RSA.toJcaPrivateKey(): KmmResult<<Error class: unknown class>>

fun CryptoPrivateKey.WithPublicKey<*>.toJcaPrivateKey(): KmmResult<<Error class: unknown class>>

toJcaPublicKey

fun CryptoPublicKey.toJcaPublicKey(): KmmResult<<Error class: unknown class>>

fun CryptoPublicKey.EC.toJcaPublicKey(): KmmResult<<Error class: unknown class>>

fun CryptoPublicKey.RSA.toJcaPublicKey(): KmmResult<<Error class: unknown class>>

toKmpCertificate

fun <Error class: unknown class>.toKmpCertificate(): <Error class: unknown class>

Converts this java.security.cert.X509Certificate to an X509Certificate

toSecKey

fun CryptoPrivateKey.WithPublicKey<*>.toSecKey(): KmmResult<OwnedCFValue<SecKeyRef>>

Converts this privateKey into a SecKeyRef, making it usable on iOS

fun CryptoPublicKey.toSecKey(): KmmResult<Unit>

toX509SignatureAlgorithm

fun SignatureAlgorithm.toX509SignatureAlgorithm(): KmmResult<X509SignatureAlgorithm>

fun SpecializedSignatureAlgorithm.toX509SignatureAlgorithm(): KmmResult<X509SignatureAlgorithm>

Finds a X.509 signature algorithm matching this algorithm. Curve restrictions are not preserved.