cryptography-serialization-asn1-modules/dev.whyoleg.cryptography.serialization.asn1.modules

Package-level declarations

Pre-defined ASN.1 modules/declarations from cryptography-related RFCs.

Types

AlgorithmIdentifier

@Serializable(with = DefaultAlgorithmIdentifierSerializer::class)

interface AlgorithmIdentifier

AlgorithmIdentifierSerializer

@ExperimentalSerializationApi

abstract class AlgorithmIdentifierSerializer : KSerializer<AlgorithmIdentifier>

DhAlgorithmIdentifier

class DhAlgorithmIdentifier(val parameters: DhParameters?) : AlgorithmIdentifier

Algorithm identifier for DH keys in SubjectPublicKeyInfo/PrivateKeyInfo.

@Serializable

class DhParameters(val prime: BigInt, val base: BigInt, val privateValueLength: Int? = null)

As defined in PKCS#3 (RFC 2631). The privateValueLength field is optional and typically omitted.

DsaAlgorithmIdentifier

class DsaAlgorithmIdentifier(val parameters: DsaParameters?) : AlgorithmIdentifier

Algorithm identifier for DSA keys in SubjectPublicKeyInfo/PrivateKeyInfo.

@Serializable

class DsaParameters(val prime: BigInt, val subprime: BigInt, val generator: BigInt)

As defined in FIPS 186 (RFC 3279).

DssSignatureValue

@Serializable

class DssSignatureValue(val r: BigInt, val s: BigInt)

EcAlgorithmIdentifier

class EcAlgorithmIdentifier(val parameters: EcParameters?) : AlgorithmIdentifier

@Serializable

value class EcParameters(val namedCurve: ObjectIdentifier)

Overall while it's CHOICE in ASN.1, but only namedCurve is allowed

@Serializable

value class EcPoint(val bytes: ByteArray)

This is EC publicKey representation for SubjectPublicKeyInfo

@Serializable

class EcPrivateKey(val version: Int, val privateKey: ByteArray, val parameters: EcParameters? = null, val publicKey: BitArray? = null)

Ed25519AlgorithmIdentifier

object Ed25519AlgorithmIdentifier : AlgorithmIdentifier

Ed448AlgorithmIdentifier

object Ed448AlgorithmIdentifier : AlgorithmIdentifier

@Serializable

class PrivateKeyInfo(val version: Int, val privateKeyAlgorithm: AlgorithmIdentifier, val privateKey: ByteArray, val publicKey: BitArray? = null)

OneAsymmetricKey as defined in RFC 5958 (extends PKCS#8 PrivateKeyInfo):

RsaAlgorithmIdentifier

object RsaAlgorithmIdentifier : AlgorithmIdentifier

@Serializable

class RsaPrivateKey(val version: Int, val modulus: BigInt, val publicExponent: BigInt, val privateExponent: BigInt, val prime1: BigInt, val prime2: BigInt, val exponent1: BigInt, val exponent2: BigInt, val coefficient: BigInt)

OtherPrimeInfos is not supported yet:

@Serializable

class RsaPublicKey(val modulus: BigInt, val publicExponent: BigInt)

SubjectPublicKeyInfo

@Serializable

class SubjectPublicKeyInfo(val algorithm: AlgorithmIdentifier, val subjectPublicKey: BitArray)

X25519AlgorithmIdentifier

object X25519AlgorithmIdentifier : AlgorithmIdentifier

X448AlgorithmIdentifier

object X448AlgorithmIdentifier : AlgorithmIdentifier

Properties

val ObjectIdentifier.Companion.DH: ObjectIdentifier

OID for DH key agreement algorithm (PKCS#3) id-dhKeyAgreement OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs-3(3) 1 }

val ObjectIdentifier.Companion.DSA: ObjectIdentifier

OID for DSA algorithm (FIPS 186) id-dsa OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) x9-57(10040) x9algorithm(4) 1 }

val ObjectIdentifier.Companion.EC: ObjectIdentifier

val ObjectIdentifier.Companion.Ed25519: ObjectIdentifier

val ObjectIdentifier.Companion.Ed448: ObjectIdentifier

val ObjectIdentifier.Companion.RSA: ObjectIdentifier

val ObjectIdentifier.Companion.secp256r1: ObjectIdentifier

val ObjectIdentifier.Companion.secp384r1: ObjectIdentifier

val ObjectIdentifier.Companion.secp521r1: ObjectIdentifier

val ObjectIdentifier.Companion.X25519: ObjectIdentifier

val ObjectIdentifier.Companion.X448: ObjectIdentifier