Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class System.Security.Cryptography.DSA
Assembly: System.Security.Cryptography
Inheritance: object → AsymmetricAlgorithm → DSA
Represents the abstract base class from which all implementations of the Digital Signature Algorithm ( <see cref="T:System.Security.Cryptography.DSA" /> ) must inherit.
Fields and Constants
protected
int
KeySizeValue
Represents the size, in bits, of the key modulus used by the asymmetric algorithm.
protected
KeySizes[]
LegalKeySizesValue
Specifies the key sizes that are supported by the asymmetric algorithm.
Properties
public
string
KeyExchangeAlgorithm
When overridden in a derived class, gets the name of the key exchange algorithm. Otherwise, throws an <see cref="T:System.NotImplementedException" /> .
public
int
KeySize
Gets or sets the size, in bits, of the key modulus used by the asymmetric algorithm.
public
KeySizes[]
LegalKeySizes
Gets the key sizes that are supported by the asymmetric algorithm.
public
string
SignatureAlgorithm
When implemented in a derived class, gets the name of the signature algorithm. Otherwise, always throws a <see cref="T:System.NotImplementedException" /> .
Methods
public
byte[]
CreateSignature(byte[] rgbHash)
rgbHash
The hash value to be signed.
Returns The digital signature for the specified hash value.
When overridden in a derived class, creates the <see cref="T:System.Security.Cryptography.DSA" /> signature for the specified hash value.
public
byte[]
CreateSignature(byte[] rgbHash,
DSASignatureFormat signatureFormat)
rgbHash
The hash value to sign.
signatureFormat
The encoding format to use for the signature.
Returns The DSA signature for the specified data.
Creates the DSA signature for the specified hash value in the indicated format.
public
DSAParameters
ExportParameters(bool includePrivateParameters)
includePrivateParameters
<see langword="true" /> to include private parameters; otherwise, <see langword="false" /> .
Returns The parameters for <see cref="T:System.Security.Cryptography.DSA" /> .
When overridden in a derived class, exports the <see cref="T:System.Security.Cryptography.DSAParameters" /> .
public
void
FromXmlString(string xmlString)
xmlString
The XML string to use to reconstruct the <see cref="T:System.Security.Cryptography.DSA" /> object.
Reconstructs a <see cref="T:System.Security.Cryptography.DSA" /> object from an XML string.
public
int
GetMaxSignatureSize(DSASignatureFormat signatureFormat)
signatureFormat
The encoding format for a signature.
Returns The largest size, in bytes, for a signature produced by this key in the indicated format.
Gets the largest size, in bytes, for a signature produced by this key in the indicated format.
protected
byte[]
HashData(byte[] data,
int offset,
int count,
HashAlgorithmName hashAlgorithm)
data
The data to be hashed.
offset
The index of the first byte in <paramref name="data" /> that is to be hashed.
count
The number of bytes to hash.
hashAlgorithm
The algorithm to use to hash the data.
Returns The hashed data.
When overridden in a derived class, computes the hash value of a specified portion of a byte array by using a specified hashing algorithm.
protected
byte[]
HashData(IO.Stream data,
HashAlgorithmName hashAlgorithm)
data
The binary stream to hash.
hashAlgorithm
The algorithm to use to hash the data.
Returns The hashed data.
When overridden in a derived class, computes the hash value of a specified binary stream by using a specified hashing algorithm.
public
void
ImportEncryptedPkcs8PrivateKey(ReadOnlySpan`1 passwordBytes,
ReadOnlySpan`1 source,
Int32& bytesRead)
public
void
ImportEncryptedPkcs8PrivateKey(ReadOnlySpan`1 password,
ReadOnlySpan`1 source,
Int32& bytesRead)
public
void
ImportParameters(DSAParameters parameters)
parameters
The parameters for <see cref="T:System.Security.Cryptography.DSA" /> .
When overridden in a derived class, imports the specified <see cref="T:System.Security.Cryptography.DSAParameters" /> .
public
byte[]
SignData(byte[] data,
int offset,
int count,
HashAlgorithmName hashAlgorithm)
data
The input data for which to compute the hash.
offset
The offset into the array at which to begin using data.
count
The number of bytes in the array to use as data.
hashAlgorithm
The hash algorithm to use to create the hash value.
Returns The DSA signature for the specified data.
Computes the hash value of a portion of the specified byte array using the specified hash algorithm and signs the resulting hash value.
public
byte[]
SignData(byte[] data,
int offset,
int count,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
data
The data to sign.
offset
The offset into <paramref name="data" /> at which to begin hashing.
count
The number of bytes to read from <paramref name="data" /> .
hashAlgorithm
The hash algorithm to use to create the hash value.
signatureFormat
The encoding format to use for the signature.
Returns The DSA signature for the specified data.
Computes the hash value of the specified data and signs it using the specified signature format.
public
byte[]
SignData(byte[] data,
HashAlgorithmName hashAlgorithm)
data
The input data for which to compute the hash.
hashAlgorithm
The hash algorithm to use to create the hash value.
Returns The DSA signature for the specified data.
Computes the hash value of the specified byte array using the specified hash algorithm and signs the resulting hash value.
public
byte[]
SignData(byte[] data,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
data
The data to sign.
hashAlgorithm
The hash algorithm to use to create the hash value.
signatureFormat
The encoding format to use for the signature.
Returns The DSA signature for the specified data.
Computes the hash value of the specified data and signs it using the specified signature format.
public
byte[]
SignData(IO.Stream data,
HashAlgorithmName hashAlgorithm)
data
The input stream for which to compute the hash.
hashAlgorithm
The hash algorithm to use to create the hash value.
Returns The DSA signature for the specified data.
Computes the hash value of the specified stream using the specified hash algorithm and signs the resulting hash value.
public
byte[]
SignData(IO.Stream data,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
data
The data to sign.
hashAlgorithm
The hash algorithm to use to create the hash value.
signatureFormat
The encoding format to use for the signature.
Returns The DSA signature for the specified data.
Computes the hash value of the specified data and signs it using the specified signature format.
protected
byte[]
SignDataCore(IO.Stream data,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
data
The data to sign.
hashAlgorithm
The hash algorithm to use to create the hash value.
signatureFormat
The encoding format to use for the signature.
Returns The DSA signature for the specified data.
Computes the hash value of the specified data and signs it using the specified signature format.
protected
byte[]
SignDataCore(ReadOnlySpan`1 data,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
public
string
ToXmlString(bool includePrivateParameters)
includePrivateParameters
<see langword="true" /> to include private parameters; otherwise, <see langword="false" /> .
Returns An XML string encoding of the current <see cref="T:System.Security.Cryptography.DSA" /> object.
Creates and returns an XML string representation of the current <see cref="T:System.Security.Cryptography.DSA" /> object.
public
bool
TryCreateSignature(ReadOnlySpan`1 hash,
Span`1 destination,
DSASignatureFormat signatureFormat,
Int32& bytesWritten)
protected
bool
TryCreateSignatureCore(ReadOnlySpan`1 hash,
Span`1 destination,
DSASignatureFormat signatureFormat,
Int32& bytesWritten)
public
bool
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan`1 passwordBytes,
PbeParameters pbeParameters,
Span`1 destination,
Int32& bytesWritten)
public
bool
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan`1 password,
PbeParameters pbeParameters,
Span`1 destination,
Int32& bytesWritten)
protected
bool
TryHashData(ReadOnlySpan`1 data,
Span`1 destination,
HashAlgorithmName hashAlgorithm,
Int32& bytesWritten)
public
bool
TrySignData(ReadOnlySpan`1 data,
Span`1 destination,
HashAlgorithmName hashAlgorithm,
Int32& bytesWritten)
public
bool
TrySignData(ReadOnlySpan`1 data,
Span`1 destination,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat,
Int32& bytesWritten)
protected
bool
TrySignDataCore(ReadOnlySpan`1 data,
Span`1 destination,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat,
Int32& bytesWritten)
public
bool
VerifyData(byte[] data,
byte[] signature,
HashAlgorithmName hashAlgorithm)
data
The signed data.
signature
The signature data to be verified.
hashAlgorithm
The hash algorithm used to create the hash value of the data.
Returns <see langword="true" /> if the digital signature is valid; otherwise, <see langword="false" /> .
Verifies that a digital signature is valid by calculating the hash value of the specified data using the specified hash algorithm and comparing it to the provided signature.
public
bool
VerifyData(byte[] data,
byte[] signature,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
data
The signed data.
signature
The signature to verify.
hashAlgorithm
The hash algorithm used to hash the data for the verification process.
signatureFormat
The encoding format for <paramref name="signature" /> .
Returns <see langword="true" /> if the digital signature is valid for the provided data; otherwise, <see langword="false" /> .
Verifies that a digital signature is valid for the provided data.
public
bool
VerifyData(byte[] data,
int offset,
int count,
byte[] signature,
HashAlgorithmName hashAlgorithm)
data
The signed data.
offset
The starting index at which to compute the hash.
count
The number of bytes to hash.
signature
The signature data to be verified.
hashAlgorithm
The hash algorithm used to create the hash value of the data.
Returns <see langword="true" /> if the digital signature is valid; otherwise, <see langword="false" /> .
Verifies that a digital signature is valid by calculating the hash value of the data in a portion of a byte array using the specified hash algorithm and comparing it to the provided signature.
public
bool
VerifyData(byte[] data,
int offset,
int count,
byte[] signature,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
data
An array that contains the signed data.
offset
The starting index of the signed portion of <paramref name="data" /> .
count
The number of bytes in <paramref name="data" /> that were signed.
signature
The signature to verify.
hashAlgorithm
The hash algorithm used to hash the data for the verification process.
signatureFormat
The encoding format for <paramref name="signature" /> .
Returns <see langword="true" /> if the digital signature is valid for the provided data; otherwise, <see langword="false" /> .
Verifies that a digital signature is valid for the provided data.
public
bool
VerifyData(IO.Stream data,
byte[] signature,
HashAlgorithmName hashAlgorithm)
data
The signed data.
signature
The signature data to be verified.
hashAlgorithm
The hash algorithm used to create the hash value of the data.
Returns <see langword="true" /> if the digital signature is valid; otherwise, <see langword="false" /> .
Verifies that a digital signature is valid by calculating the hash value of the specified stream using the specified hash algorithm and comparing it to the provided signature.
public
bool
VerifyData(IO.Stream data,
byte[] signature,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
data
The signed data.
signature
The signature to verify.
hashAlgorithm
The hash algorithm used to hash the data for the verification process.
signatureFormat
The encoding format for <paramref name="signature" /> .
Returns <see langword="true" /> if the digital signature is valid for the provided data; otherwise, <see langword="false" /> .
Verifies that a digital signature is valid for the provided data.
public
bool
VerifyData(ReadOnlySpan`1 data,
ReadOnlySpan`1 signature,
HashAlgorithmName hashAlgorithm)
public
bool
VerifyData(ReadOnlySpan`1 data,
ReadOnlySpan`1 signature,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
protected
bool
VerifyDataCore(IO.Stream data,
ReadOnlySpan`1 signature,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
protected
bool
VerifyDataCore(ReadOnlySpan`1 data,
ReadOnlySpan`1 signature,
HashAlgorithmName hashAlgorithm,
DSASignatureFormat signatureFormat)
public
bool
VerifySignature(byte[] rgbHash,
byte[] rgbSignature)
rgbHash
The hash of the data signed with <paramref name="rgbSignature" /> .
rgbSignature
The signature to be verified for <c>rgbData</c> .
Returns <see langword="true" /> if <paramref name="rgbSignature" /> matches the signature computed using the specified hash algorithm and key on <paramref name="rgbHash" /> ; otherwise, <see langword="false" /> .
When overridden in a derived class, verifies the <see cref="T:System.Security.Cryptography.DSA" /> signature for the specified data.
public
bool
VerifySignature(byte[] rgbHash,
byte[] rgbSignature,
DSASignatureFormat signatureFormat)
rgbHash
The signed hash.
rgbSignature
The signature to verify.
signatureFormat
The encoding format for <paramref name="rgbSignature" /> .
Returns <see langword="true" /> if the digital signature is valid for the provided data; otherwise, <see langword="false" /> .
Verifies that a digital signature is valid for the provided hash.
public
bool
VerifySignature(ReadOnlySpan`1 hash,
ReadOnlySpan`1 signature,
DSASignatureFormat signatureFormat)
protected
bool
VerifySignatureCore(ReadOnlySpan`1 hash,
ReadOnlySpan`1 signature,
DSASignatureFormat signatureFormat)
Releases all resources used by the <see cref="T:System.Security.Cryptography.AsymmetricAlgorithm" /> class.
Releases all resources used by the current instance of the <see cref="T:System.Security.Cryptography.AsymmetricAlgorithm" /> class.
protected
void
Dispose(bool disposing)
Inherited from AsymmetricAlgorithm
disposing
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.
Releases the unmanaged resources used by the <see cref="T:System.Security.Cryptography.AsymmetricAlgorithm" /> class and optionally releases the managed resources.
public
byte[]
ExportEncryptedPkcs8PrivateKey(ReadOnlySpan`1 passwordBytes,
PbeParameters pbeParameters)
Inherited from AsymmetricAlgorithm
public
byte[]
ExportEncryptedPkcs8PrivateKey(ReadOnlySpan`1 password,
PbeParameters pbeParameters)
Inherited from AsymmetricAlgorithm
public
string
ExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan`1 passwordBytes,
PbeParameters pbeParameters)
Inherited from AsymmetricAlgorithm
public
string
ExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan`1 password,
PbeParameters pbeParameters)
Inherited from AsymmetricAlgorithm
public
byte[]
ExportPkcs8PrivateKey()
Inherited from AsymmetricAlgorithm
Returns A byte array containing the PKCS#8 PrivateKeyInfo representation of this key.
Exports the current key in the PKCS#8 PrivateKeyInfo format.
public
string
ExportPkcs8PrivateKeyPem()
Inherited from AsymmetricAlgorithm
Returns A string containing the PEM-encoded PKCS#8 PrivateKeyInfo.
Exports the current key in the PKCS#8 PrivateKeyInfo format, PEM encoded.
public
byte[]
ExportSubjectPublicKeyInfo()
Inherited from AsymmetricAlgorithm
Returns A byte array containing the X.509 SubjectPublicKeyInfo representation of the public-key portion of this key.
Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format.
public
string
ExportSubjectPublicKeyInfoPem()
Inherited from AsymmetricAlgorithm
Returns A string containing the PEM-encoded X.509 SubjectPublicKeyInfo.
Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format, PEM encoded.
public
bool
TryExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan`1 passwordBytes,
PbeParameters pbeParameters,
Span`1 destination,
Int32& charsWritten)
Inherited from AsymmetricAlgorithm
public
bool
TryExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan`1 password,
PbeParameters pbeParameters,
Span`1 destination,
Int32& charsWritten)
Inherited from AsymmetricAlgorithm
public
bool
TryExportPkcs8PrivateKeyPem(Span`1 destination,
Int32& charsWritten)
Inherited from AsymmetricAlgorithm
public
bool
TryExportSubjectPublicKeyInfoPem(Span`1 destination,
Int32& charsWritten)
Inherited from AsymmetricAlgorithm
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object