RSA.ToXmlString(Boolean) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Creates and returns an XML string containing the key of the current RSA object.
public:
override System::String ^ ToXmlString(bool includePrivateParameters);public override string ToXmlString (bool includePrivateParameters);override this.ToXmlString : bool -> stringPublic Overrides Function ToXmlString (includePrivateParameters As Boolean) As StringParameters
- includePrivateParameters
- Boolean
true to include a public and private RSA key; false to include only the public key.
Returns
An XML string containing the key of the current RSA object.
Exceptions
.NET Core and .NET 5+ only: In all cases.
Remarks
The ToXmlString method creates an XML string that contains either the public and private key of the current RSA object or contains only the public key of the current RSA object.
Use the ToXmlString method whenever you need to conveniently persist RSA key information. To initialize an RSA object with the key in an XML string, use the FromXmlString method.
Caution
Persisting an XML string containing a private key to an insecure location is a security threat. The security of your application can be compromised if a malicious third party can access your private key. To safely persist a private key, use a secure key container. For more information about persisting private keys in a key container, see How to: Store Asymmetric Keys in a Key Container.
When you pass true to the ToXmlString method, the resulting XML string takes the following form:
<RSAKeyValue>
<Modulus>…</Modulus>
<Exponent>…</Exponent>
<P>…</P>
<Q>…</Q>
<DP>…</DP>
<DQ>…</DQ>
<InverseQ>…</InverseQ>
<D>…</D>
</RSAKeyValue>
When you pass false to the ToXmlString method, the resulting XML string takes the following form:
<RSAKeyValue>
<Modulus>…</Modulus>
<Exponent>…</Exponent>
</RSAKeyValue>
