RSAPrivateKeyToXmlDoc (String function): Difference between revisions
m (minor cleanup) |
m (→See also: add links) |
||
| Line 81: | Line 81: | ||
Related methods: | Related methods: | ||
<ul> | <ul> | ||
<li><var>String</var> class: <var>[[ | <li><var>String</var> class: | ||
<var>[[DerToXmlDoc_(String_function)|DerToXmlDoc]]</var>, <var>[[X509CertificateToXmlDoc_(String_function)|X509CertificateToXmlDoc]]</var>, <var>[[X509CrlToXmlDoc_(String_function)|X509CrlToXmlDoc]]</var>, <var>[[CertificateRequest (String function)|CertificateRequest]]</var> <var>[[SignedCertificate (String function)|SignedCertificate]]</var> </li> | |||
<li><var>System</var> class: <var>[[ClientCertificate (System function)|ClientCertificate]]</var>, <var>[[GeneratedPrivateKey (System function)|GeneratedPrivateKey]]</var></li> | |||
<li><var>Socket</var> class: <var>[[Certificate (Socket function)|Certificate]]</var> </li> | <li><var>Socket</var> class: <var>[[Certificate (Socket function)|Certificate]]</var> </li> | ||
<li><var>HttpRequest</var> class: <var>[[Get (HttpRequest function)|Get]]</var>, <var>[[Post (HttpRequest function)|Post]]</var>, and <var>[[Send (HttpRequest function)|Send]]</var> </li> | <li><var>HttpRequest</var> class: <var>[[Get (HttpRequest function)|Get]]</var>, <var>[[Post (HttpRequest function)|Post]]</var>, and <var>[[Send (HttpRequest function)|Send]]</var> </li> | ||
<li><var>Stringlist</var> class: <var>[[PemToString_(Stringlist_function)|PemToString]]</var> </li> | <li><var>Stringlist</var> class: <var>[[AppendPemData (Stringlist function)|AppendPemData]]</var>, <var>[[PemToString_(Stringlist_function)|PemToString]]</var>, <var>[[AppendCertificateRequest (Stringlist function)|AppendCertificateRequest]]</var>, and several more </li> | ||
</ul> | </ul> | ||
Revision as of 19:58, 14 March 2016
Convert BER encoded RSA private key to XML (String class)
[Introduced in Sirius Mods 8.0]
RSAPrivateKeyToXmlDoc converts a string (Longstring) that contains an RSA-generated private key to an XmlDoc. DER (Distinguished Encoding Rules), a subset of BER (Basic Encoding Rules, provide a way to uniquely encode an Abstract Syntax Notation One (ASN.1) type value as a string of eight-bit octets.
Syntax
%doc = string:RSAPrivateKeyToXmlDoc Throws InvalidBerData
Syntax terms
| %doc | An XmlDoc object variable to contain the decoded value of the method object, string. |
|---|---|
| string | A DER encoded string that contains the contents of a digital certificate. Note: This method fails if the XML representation of string is longer than 650 characters. |
Exceptions
RSAPrivateKeyToXmlDoc can throw the following exception:
- InvalidBerData
- If the method encounters non-BER-conforming data, properties of the exception object may indicate the position and description of the error.
Usage notes
- RSAPrivateKeyToXmlDoc is very similar to DerToXmlDoc, except that RSAPrivateKeyToXmlDoc understands the semantics of the private key tags, so it provides more meaningful XML element names.
- RSAPrivateKeyToXmlDoc is a complete implementation of the PKCS standards for private key syntax.
- Currently, no method is available to produce a DER stream from an XmlDoc nor to validate the signature on a certificate.
- This method's limit of an XML representation of 650 characters means that it cannot process a 4096-bit key (which requires 1024 hex characters). Fortunately, 4K keys are still uncommon.
Examples
In the following example, the PemToString method loads Longstring %ls with the contents of an RSA private key. RSAPrivateKeyToXmlDoc then converts the Longstring to an XmlDoc whose contents are printed:
... text to %sl = new raw -----BEGIN RSA PRIVATE KEY----- MIIEogIBAAKCAQEAm6TwmSXt4+lyrhwy9SBq2LVjdTeJ5kUbU9jzmBCfw/NuC1tX YAAdc0UG5DDJYPHkWkYa7+z50SYzmoxKI8PfCLyxSOPeVW9CEhRSyiIIlyjQikIK a0YMeOXVetGiutl/y346yQYltkbQXb1SOogTg07fTRs7NWcQ4Rrcd6DEnSkrHxbv T04Z0MwoSojA+NRyBCMpa+w+R0dzrBNZIT11WOccecYjEyuPSS2ydcdgr/Rp4WKC UHmRulXWQjhEjwqFPRG4f8BkYJGr8lN262M4ti4Z11KV/lYA/lEpYUkmCaY936p4 IoVoQy8GFn7mj50sxwSa446bTvKlVPsySMDK2wIBAwKCAQAZ8NLEMPz7UZMdBLMo ... aQmxZUwUo7em8Ci6dX17AoGAcmpQ5AUj5vMdRnOmiIhLM+jgbbQjBD+52hwbkkIn sZ00cQ5asvdrHt3ziIqN7RMu5okuwdFTdk5IGHTA43qykel0e7wxwADI7qybJXWF rsIve5XyKCD55gAM4W8y4+CLkCv6dPwmkTq4vfdaYr0/NPIvigzUq0NEXFVPJfQc GncCgYEAlFIEKq0mVWLBtZRwNjehKOaWGkVVHJnoWqlBngfamQkOiGvWScQ0MVbw K3U00KpuNHRF5RVy035uoU2tnQDLyG+RmUO7j2+t90MOmgXqiZlTz08uf/fQaprd NzpmjANA/9cT3rwHD31LsjaDXASM5IW0q7h+vhvVLtVkDzDnW5w= -----END RSA PRIVATE KEY----- end text %ls = %sl:pemToString('RSA PRIVATE KEY') %ls:RSAPrivateKeyToXmlDoc:print ...
The abridged result is shown below:
<RSAPrivateKey> <version>0</version><modulus>196482721346 ... ...685825059547</modulus> <publicExponent>3</publicExponent> <privateExponent>32747120224474 ... ...832238758867</privateExponent> <prime1>163032211406922467 ... ...063864355897</prime1> <primes>120517730607 ... ...628528150451</primes> <exponent1>108688140937 ... ...709242903931</exponent1> <exponent2>803451537383 ... ...419018766967</exponent2> <coefficient>104154110092 ... ...977615354780</coefficient> </RSAPrivateKey>
See also
Related methods:
- String class: DerToXmlDoc, X509CertificateToXmlDoc, X509CrlToXmlDoc, CertificateRequest SignedCertificate
- System class: ClientCertificate, GeneratedPrivateKey
- Socket class: Certificate
- HttpRequest class: Get, Post, and Send
- Stringlist class: AppendPemData, PemToString, AppendCertificateRequest, and several more
Background information: