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.RSA
Assembly: System.Security.Cryptography
Inheritance: object → AsymmetricAlgorithm → RSA
Represents the base class from which all implementations of the <see cref="T:System.Security.Cryptography.RSA" /> algorithm 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
Gets the name of the key exchange algorithm available with this implementation of <see cref="T:System.Security.Cryptography.RSA" /> .
public
string
SignatureAlgorithm
Gets the name of the signature algorithm available with this implementation of <see cref="T:System.Security.Cryptography.RSA" /> .
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.
Methods
public
byte[]
Decrypt(byte[] data,
RSAEncryptionPadding padding)
data
The data to decrypt.
padding
The padding mode.
Returns The decrypted data.
When overridden in a derived class, decrypts the input data using the specified padding mode.
public
byte[]
DecryptValue(byte[] rgb)
rgb
The cipher text to be decrypted.
Returns The resulting decryption of the <paramref name="rgb" /> parameter in plain text.
When overridden in a derived class, decrypts the input data using the private key.
public
byte[]
Encrypt(byte[] data,
RSAEncryptionPadding padding)
data
The data to encrypt.
padding
The padding mode.
Returns The encrypted data.
When overridden in a derived class, encrypts the input data using the specified padding mode.
public
byte[]
EncryptValue(byte[] rgb)
rgb
The plain text to be encrypted.
Returns The resulting encryption of the <paramref name="rgb" /> parameter as cipher text.
When overridden in a derived class, encrypts the input data using the public key.
public
RSAParameters
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.RSA" /> .
When overridden in a derived class, exports the <see cref="T:System.Security.Cryptography.RSAParameters" /> .
public
byte[]
ExportRSAPrivateKey() Returns A byte array containing the PKCS#1 RSAPrivateKey representation of this key.
Exports the current key in the PKCS#1 RSAPrivateKey format.
public
string
ExportRSAPrivateKeyPem() Returns A string containing the PEM-encoded PKCS#1 RSAPrivateKey.
Exports the current key in the PKCS#1 RSAPrivateKey format, PEM encoded.
public
byte[]
ExportRSAPublicKey() Returns A byte array containing the PKCS#1 RSAPublicKey representation of this key.
Exports the public-key portion of the current key in the PKCS#1 RSAPublicKey format.
public
string
ExportRSAPublicKeyPem() Returns A string containing the PEM-encoded PKCS#1 RSAPublicKey.
Exports the public-key portion of the current key in the PKCS#1 RSAPublicKey format, PEM encoded.
public
void
FromXmlString(string xmlString)
xmlString
The XML string containing <see cref="T:System.Security.Cryptography.RSA" /> key information.
Initializes an <see cref="T:System.Security.Cryptography.RSA" /> object from the key information from an XML string.
public
int
GetMaxOutputSize() Returns The maximum number of bytes an RSA operation can produce.
Gets the maximum number of bytes an RSA operation can produce.
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 in 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 hash algorithm.
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(RSAParameters parameters)
parameters
The parameters for <see cref="T:System.Security.Cryptography.RSA" /> .
When overridden in a derived class, imports the specified <see cref="T:System.Security.Cryptography.RSAParameters" /> .
public
byte[]
SignData(byte[] data,
int offset,
int count,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
data
The input data to hash and sign.
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.
padding
The padding mode.
Returns The RSA signature for the specified data.
Computes the hash value of a portion of the specified byte array using the specified hash algorithm and padding mode, and signs the resulting hash value.
public
byte[]
SignData(byte[] data,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
data
The input data to hash and sign.
hashAlgorithm
The hash algorithm to use to create the hash value.
padding
The padding mode.
Returns The RSA signature for the specified data.
Computes the hash value of the specified byte array using the specified hash algorithm and padding mode, and signs the resulting hash value.
public
byte[]
SignData(IO.Stream data,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
data
The input stream to hash and sign.
hashAlgorithm
The hash algorithm to use to create the hash value.
padding
The padding mode.
Returns The RSA signature for the specified data.
Computes the hash value of the specified stream using the specified hash algorithm and padding mode, and signs the resulting hash value.
public
byte[]
SignData(ReadOnlySpan`1 data,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
public
int
SignData(ReadOnlySpan`1 data,
Span`1 destination,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
public
byte[]
SignHash(byte[] hash,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
hash
The hash value of the data to be signed.
hashAlgorithm
The hash algorithm used to create the hash value of the data.
padding
The padding.
Returns The RSA signature for the specified hash value.
When overridden in a derived class, computes the signature for the specified hash value using the specified padding.
public
byte[]
SignHash(ReadOnlySpan`1 hash,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
public
int
SignHash(ReadOnlySpan`1 hash,
Span`1 destination,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
public
string
ToXmlString(bool includePrivateParameters)
includePrivateParameters
<see langword="true" /> to include a public and private RSA key; <see langword="false" /> to include only the public key.
Returns An XML string containing the key of the current <see cref="T:System.Security.Cryptography.RSA" /> object.
Creates and returns an XML string containing the key of the current <see cref="T:System.Security.Cryptography.RSA" /> object.
public
bool
TryDecrypt(ReadOnlySpan`1 data,
Span`1 destination,
RSAEncryptionPadding padding,
Int32& bytesWritten)
public
bool
TryEncrypt(ReadOnlySpan`1 data,
Span`1 destination,
RSAEncryptionPadding padding,
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,
RSASignaturePadding padding,
Int32& bytesWritten)
public
bool
TrySignHash(ReadOnlySpan`1 hash,
Span`1 destination,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding,
Int32& bytesWritten)
public
bool
VerifyData(byte[] data,
byte[] signature,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
data
The signed data.
signature
The signature data to be verified.
hashAlgorithm
The hash algorithm used to create the hash value of the data.
padding
The padding mode.
Returns <see langword="true" /> if the 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 padding, and comparing it to the provided signature.
public
bool
VerifyData(byte[] data,
int offset,
int count,
byte[] signature,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
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.
padding
The padding mode.
Returns <see langword="true" /> if the 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 padding, and comparing it to the provided signature.
public
bool
VerifyData(IO.Stream data,
byte[] signature,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
data
The signed data.
signature
The signature data to be verified.
hashAlgorithm
The hash algorithm used to create the hash value of the data.
padding
The padding mode.
Returns <see langword="true" /> if the 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 padding, and comparing it to the provided signature.
public
bool
VerifyData(ReadOnlySpan`1 data,
ReadOnlySpan`1 signature,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
public
bool
VerifyHash(byte[] hash,
byte[] signature,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
hash
The hash value of the signed data.
signature
The signature data to be verified.
hashAlgorithm
The hash algorithm used to create the hash value.
padding
The padding mode.
Returns <see langword="true" /> if the signature is valid; otherwise, <see langword="false" /> .
Verifies that a digital signature is valid by determining the hash value in the signature using the specified hash algorithm and padding, and comparing it to the provided hash value.
public
bool
VerifyHash(ReadOnlySpan`1 hash,
ReadOnlySpan`1 signature,
HashAlgorithmName hashAlgorithm,
RSASignaturePadding padding)
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