cryptography-core/dev.whyoleg.cryptography.algorithms/ECDSA

ECDSA

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface ECDSA : EC<ECDSA.PublicKey, ECDSA.PrivateKey, ECDSA.KeyPair> (source)

Elliptic Curve Digital Signature Algorithm (ECDSA) as defined in FIPS 186-5.

ECDSA provides digital signature generation and verification using elliptic curve keys. The EC.Curve is selected when creating key decoders or generators via the inherited EC methods.

val keys = provider.get(ECDSA).keyPairGenerator(EC.Curve.P256).generateKey()
val signature = keys.privateKey.signatureGenerator(SHA256, ECDSA.SignatureFormat.DER).generateSignature(data)
keys.publicKey.signatureVerifier(SHA256, ECDSA.SignatureFormat.DER).verifySignature(data, signature)

For signatures using Edwards curves, see EdDSA.

Types

object Companion : CryptographyAlgorithmId<ECDSA>

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface KeyPair : EC.KeyPair<ECDSA.PublicKey, ECDSA.PrivateKey>

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface PrivateKey : EC.PrivateKey<ECDSA.PublicKey>

An ECDSA private key that provides signature generation via signatureGenerator.

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface PublicKey : EC.PublicKey

An ECDSA public key that provides signature verification via signatureVerifier.

SignatureFormat

enum SignatureFormat : Enum<ECDSA.SignatureFormat>

Encoding format for ECDSA signatures.

Properties

open override val id: CryptographyAlgorithmId<ECDSA>

The typed identifier that uniquely distinguishes this algorithm and is used to look it up from a CryptographyProvider.

Functions

keyPairGenerator

abstract fun keyPairGenerator(curve: EC.Curve): KeyGenerator<ECDSA.KeyPair>

Returns a KeyGenerator that generates EC key pairs on the given curve.

privateKeyDecoder

abstract fun privateKeyDecoder(curve: EC.Curve): Decoder<EC.PrivateKey.Format, ECDSA.PrivateKey>

Returns a Decoder that decodes EC private keys on the given curve from the specified PrivateKey.Format.

publicKeyDecoder

abstract fun publicKeyDecoder(curve: EC.Curve): Decoder<EC.PublicKey.Format, ECDSA.PublicKey>

Returns a Decoder that decodes EC public keys on the given curve from the specified PublicKey.Format.