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.CompositeMLDsaCng
Assembly: System.Security.Cryptography
Inheritance: object → CompositeMLDsa → CompositeMLDsaCng
Implemented Interfaces
- IDisposable Implemented by: CompositeMLDsa
Provides a Cryptography Next Generation (CNG) implementation of Composite ML-DSA.
Properties
public
CompositeMLDsaAlgorithm
Algorithm
Gets the specific Composite ML-DSA algorithm for this key.
Methods
public
CngKey
GetKey()
Gets a new <see cref="T:System.Security.Cryptography.CngKey" /> representing the key used by the current instance.
protected
int
SignDataCore(ReadOnlySpan<byte> data,
ReadOnlySpan<byte> context,
Span<byte> destination)
protected
bool
VerifyDataCore(ReadOnlySpan<byte> data,
ReadOnlySpan<byte> context,
ReadOnlySpan<byte> signature)
public
void
Dispose()
Inherited from CompositeMLDsa
Releases all resources used by the <see cref="T:System.Security.Cryptography.CompositeMLDsa" /> class.
protected
void
Dispose(bool disposing)
Inherited from CompositeMLDsa
<para>Called by the <see cref="M:System.Security.Cryptography.CompositeMLDsa.Dispose" /> method to release the managed and unmanaged resources used by the current instance of the <see cref="T:System.Security.Cryptography.CompositeMLDsa" /> class.</para>
disposing
<para>
<see langword="true" /> to release managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</para>
public
byte[]
ExportCompositeMLDsaPrivateKey()
Inherited from CompositeMLDsa
Exports the private-key portion of the current key.
Returns The Composite ML-DSA private key.
public
int
ExportCompositeMLDsaPrivateKey(Span<byte> destination)
Inherited from CompositeMLDsa
Exports the private-key portion of the current key into the provided buffer.
Returns The number of bytes written to the <paramref name="destination" /> buffer.
destination
The buffer to receive the Composite ML-DSA private key value.
public
byte[]
ExportCompositeMLDsaPublicKey()
Inherited from CompositeMLDsa
Exports the public-key portion of the current key.
Returns The Composite ML-DSA public key.
public
int
ExportCompositeMLDsaPublicKey(Span<byte> destination)
Inherited from CompositeMLDsa
Exports the public-key portion of the current key into the provided buffer.
Returns The number of bytes written to the <paramref name="destination" /> buffer.
destination
The buffer to receive the Composite ML-DSA public key value.
public
byte[]
ExportEncryptedPkcs8PrivateKey(ReadOnlySpan<byte> passwordBytes,
PbeParameters pbeParameters)
Inherited from CompositeMLDsa
Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password.
Returns A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of the this key.
passwordBytes
The bytes to use as a password when encrypting the key material.
pbeParameters
The password-based encryption (PBE) parameters to use when encrypting the key material.
public
byte[]
ExportEncryptedPkcs8PrivateKey(ReadOnlySpan<char> password,
PbeParameters pbeParameters)
Inherited from CompositeMLDsa
Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password.
Returns A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of the this key.
password
The password to use when encrypting the key material.
pbeParameters
The password-based encryption (PBE) parameters to use when encrypting the key material.
public
byte[]
ExportEncryptedPkcs8PrivateKey(string password,
PbeParameters pbeParameters)
Inherited from CompositeMLDsa
Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password.
Returns A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of the this key.
password
The password to use when encrypting the key material.
pbeParameters
The password-based encryption (PBE) parameters to use when encrypting the key material.
public
string
ExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<byte> passwordBytes,
PbeParameters pbeParameters)
Inherited from CompositeMLDsa
<para>Exports the current key in a PEM-encoded representation of the PKCS#8 EncryptedPrivateKeyInfo representation of this key, using a byte-based password.</para>
Returns A string containing the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo.
passwordBytes
The bytes to use as a password when encrypting the key material.
pbeParameters
The password-based encryption (PBE) parameters to use when encrypting the key material.
public
string
ExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<char> password,
PbeParameters pbeParameters)
Inherited from CompositeMLDsa
<para>Exports the current key in a PEM-encoded representation of the PKCS#8 EncryptedPrivateKeyInfo representation of this key, using a char-based password.</para>
Returns A string containing the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo.
password
The password to use when encrypting the key material.
pbeParameters
The password-based encryption (PBE) parameters to use when encrypting the key material.
public
string
ExportEncryptedPkcs8PrivateKeyPem(string password,
PbeParameters pbeParameters)
Inherited from CompositeMLDsa
<p>Exports the current key in a PEM-encoded representation of the PKCS#8 EncryptedPrivateKeyInfo representation of this key, using a char-based password.</p>
Returns A string containing the PEM-encoded PKCS#8 EncryptedPrivateKeyInfo.
password
The password to use when encrypting the key material.
pbeParameters
The password-based encryption (PBE) parameters to use when encrypting the key material.
public
byte[]
ExportPkcs8PrivateKey()
Inherited from CompositeMLDsa
Exports the current key in the PKCS#8 PrivateKeyInfo format.
Returns A byte array containing the PKCS#8 PrivateKeyInfo representation of the this key.
public
string
ExportPkcs8PrivateKeyPem()
Inherited from CompositeMLDsa
Exports the current key in a PEM-encoded representation of the PKCS#8 PrivateKeyInfo format.
Returns <para>A string containing the PEM-encoded representation of the PKCS#8 PrivateKeyInfo representation of the public-key portion of this key.</para>
public
byte[]
ExportSubjectPublicKeyInfo()
Inherited from CompositeMLDsa
Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format.
Returns A byte array containing the X.509 SubjectPublicKeyInfo representation of the public-key portion of this key.
public
string
ExportSubjectPublicKeyInfoPem()
Inherited from CompositeMLDsa
<para>Exports the public-key portion of the current key in a PEM-encoded representation of the X.509 SubjectPublicKeyInfo format.</para>
Returns <para>A string containing the PEM-encoded representation of the X.509 SubjectPublicKeyInfo representation of the public-key portion of this key.</para>
public
byte[]
SignData(byte[] data,
byte[] context = null)
Inherited from CompositeMLDsa
Signs the specified data.
Returns The Composite ML-DSA signature of the specified data.
data
The data to sign.
context
<para>An optional context-specific value to limit the scope of the signature.</para> <para>The default value is <see langword="null" />.</para>
public
int
SignData(ReadOnlySpan<byte> data,
Span<byte> destination,
ReadOnlySpan<byte> context = null)
Inherited from CompositeMLDsa
Signs the specified data, writing the signature into the provided buffer.
Returns The number of bytes written to the <paramref name="destination" /> buffer.
data
The data to sign.
destination
The buffer to receive the signature. Its length must be at least <see cref="P:System.Security.Cryptography.CompositeMLDsaAlgorithm.MaxSignatureSizeInBytes" /> .
context
<para>An optional context-specific value to limit the scope of the signature.</para> <para>The default value is an empty buffer.</para>
public
bool
TryExportCompositeMLDsaPrivateKey(Span<byte> destination,
Int32& bytesWritten)
Inherited from CompositeMLDsa
public
bool
TryExportCompositeMLDsaPublicKey(Span<byte> destination,
Int32& bytesWritten)
Inherited from CompositeMLDsa
public
bool
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan<byte> passwordBytes,
PbeParameters pbeParameters,
Span<byte> destination,
Int32& bytesWritten)
Inherited from CompositeMLDsa
public
bool
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan<char> password,
PbeParameters pbeParameters,
Span<byte> destination,
Int32& bytesWritten)
Inherited from CompositeMLDsa
public
bool
TryExportEncryptedPkcs8PrivateKey(string password,
PbeParameters pbeParameters,
Span<byte> destination,
Int32& bytesWritten)
Inherited from CompositeMLDsa
public
bool
TryExportPkcs8PrivateKey(Span<byte> destination,
Int32& bytesWritten)
Inherited from CompositeMLDsa
public
bool
TryExportSubjectPublicKeyInfo(Span<byte> destination,
Int32& bytesWritten)
Inherited from CompositeMLDsa
public
bool
VerifyData(byte[] data,
byte[] signature,
byte[] context = null)
Inherited from CompositeMLDsa
Verifies that the specified signature is valid for this key and the provided data.
Returns <see langword="true" /> if the signature validates the data; otherwise, <see langword="false" /> .
data
The data to verify.
signature
The signature to verify.
context
<para>The context value which was provided during signing.</para> <para>The default value is <see langword="null" />.</para>
public
bool
VerifyData(ReadOnlySpan<byte> data,
ReadOnlySpan<byte> signature,
ReadOnlySpan<byte> context = null)
Inherited from CompositeMLDsa
Verifies that the specified signature is valid for this key and the provided data.
Returns <see langword="true" /> if the signature validates the data; otherwise, <see langword="false" /> .
data
The data to verify.
signature
The signature to verify.
context
<para>The context value which was provided during signing.</para> <para>The default value is an empty buffer.</para>
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