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

DSA

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

interface DSA : CryptographyAlgorithm(source)

Digital Signature Algorithm (DSA) as defined in FIPS 186-5.

DSA provides digital signature generation and verification using finite-field arithmetic. Domain Parameters define the group and must be generated via parametersGenerator or decoded via parametersDecoder before key pairs can be created.

val params = provider.get(DSA).parametersGenerator(2048.bits).generateParameters()
val keys = params.keyPairGenerator().generateKey()
val signature = keys.privateKey.signatureGenerator(SHA256, DSA.SignatureFormat.DER).generateSignature(data)
keys.publicKey.signatureVerifier(SHA256, DSA.SignatureFormat.DER).verifySignature(data, signature)

For the elliptic curve variant, see ECDSA.

Types

object Companion : CryptographyAlgorithmId<DSA>

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

interface KeyPair

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

interface Parameters : Encodable<DSA.Parameters.Format>

DSA domain parameters that provide key pair generation via keyPairGenerator.

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

interface PrivateKey : Encodable<DSA.PrivateKey.Format> , PublicKeyAccessor<DSA.PublicKey>

A DSA private key that provides signature generation via signatureGenerator.

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

interface PublicKey : Encodable<DSA.PublicKey.Format>

A DSA public key that provides signature verification via signatureVerifier.

SignatureFormat

enum SignatureFormat : Enum<DSA.SignatureFormat>

Encoding format for DSA signatures.

Properties

open override val id: CryptographyAlgorithmId<DSA>

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

Functions

parametersDecoder

abstract fun parametersDecoder(): Decoder<DSA.Parameters.Format, DSA.Parameters>

Returns a Decoder that decodes DSA domain parameters from the specified Parameters.Format.

parametersGenerator

abstract fun parametersGenerator(primeSize: BinarySize, subprimeSize: BinarySize? = null): ParametersGenerator<DSA.Parameters>

Returns a ParametersGenerator that generates DSA domain parameters with the specified primeSize and optional subprimeSize.

privateKeyDecoder

abstract fun privateKeyDecoder(): Decoder<DSA.PrivateKey.Format, DSA.PrivateKey>

Returns a Decoder that decodes DSA private keys from the specified PrivateKey.Format.

publicKeyDecoder

abstract fun publicKeyDecoder(): Decoder<DSA.PublicKey.Format, DSA.PublicKey>

Returns a Decoder that decodes DSA public keys from the specified PublicKey.Format.