X509CertificateToXmlDoc (String function) - Revision history

JAL: /* See also */ add method to list

2018-09-06T15:08:26Z

JAL: /* Usage notes */ typos

2016-08-22T17:26:43Z

Usage notes: typos

← Older revision		Revision as of 17:26, 22 August 2016
Line 16:		Line 16:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Prior to version 7.7 of Model 204, input to this method that created any element in the result <var>XmlDoc</var> with a text child whose length exceeded 650 characters produced an error. As of version 7.7, ~~that restriction is removed, and~~ the lengths of the created text nodes are not restricted. </li>		<li>Prior to version 7.7 of Model 204, input to this method that created any element in the result <var>XmlDoc</var> with a text child whose length exceeded 650 characters produced an error. As of version 7.7, the lengths of the created text nodes are not restricted. </li>

	<li><var>X509CertificateToXmlDoc</var> is very similar to		<li><var>X509CertificateToXmlDoc</var> is very similar to

JAL: /* See also */ typo

2016-08-22T16:59:12Z

JAL: note re removal of length issue

2016-08-22T16:35:54Z

note re removal of length issue

← Older revision		Revision as of 16:35, 22 August 2016
Line 1:		Line 1:
	{{Template:String:X509CertificateToXmlDoc subtitle}}		{{Template:String:X509CertificateToXmlDoc subtitle}}
	X509 is a general authentication framework that establishes standard formats for for public-key certificates, certificate revocation lists (CRLs), and more. <var>X509CertificateToXmlDoc</var> converts a string (<var>Longstring</var>) that contains a certificate to an <var>[[XmlDoc class\|XmlDoc]]</var>. 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.		X509 is a general authentication framework that establishes standard formats for for public-key certificates, certificate revocation lists (CRLs), and more. <var>X509CertificateToXmlDoc</var> converts a string (<var>Longstring</var>) that contains a certificate to an <var>[[XmlDoc class\|XmlDoc]]</var>. 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==		==Syntax==
	{{Template:String:X509CertificateToXmlDoc syntax}}		{{Template:String:X509CertificateToXmlDoc syntax}}

	===Syntax terms===		===Syntax terms===
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>%doc</th><td>An <var>XmlDoc</var> object variable to contain the decoded value of the method object, <var class="term">string</var>.</td></tr>		<tr><th>%doc</th>
			<td>An <var>XmlDoc</var> object variable to contain the decoded value of the method object, <var class="term">string</var>.</td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>A DER encoded string that contains the contents of a digital certificate. ~~<p class="note">'''Note:''' This method fails if the XML representation of <var class="term">string</var> is longer than 650 characters.</p>~~</td></tr>		<td>A DER encoded string that contains the contents of a digital certificate. </td></tr>
	</table>		</table>

	~~===Exceptions===~~
	~~<var>X509CertificateToXmlDoc</var> can throw the following [[Exceptions\|exception]]:~~
	~~<dl>~~
	~~<dt><var>[[InvalidBerData class\|InvalidBerData]]</var>~~
	~~<dd>If the method encounters non-BER-conforming data, properties of the exception object may indicate the position and description of the error.~~
	~~</dl>~~

	==Usage notes==		==Usage notes==
	<ul>		<ul>
			<li>Prior to version 7.7 of Model 204, input to this method that created any element in the result <var>XmlDoc</var> with a text child whose length exceeded 650 characters produced an error. As of version 7.7, that restriction is removed, and the lengths of the created text nodes are not restricted. </li>

	<li><var>X509CertificateToXmlDoc</var> is very similar to		<li><var>X509CertificateToXmlDoc</var> is very similar to
	<var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var>, except that <var>X509CertificateToXmlDoc</var> understands the semantics of the certificate tags, so it provides more meaningful XML element names. Contrast the [[DerToXmlDoc (String function)#Examples\|DerToXmlDoc example]] with the <var>X509CertificateToXmlDoc</var> [[X509CertificateToXmlDoc (String function)#Examples\|example]], below. </li>		<var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var>, except that <var>X509CertificateToXmlDoc</var> understands the semantics of the certificate tags, so it provides more meaningful XML element names. Contrast the [[DerToXmlDoc (String function)#Examples\|DerToXmlDoc example]] with the <var>X509CertificateToXmlDoc</var> [[X509CertificateToXmlDoc (String function)#Examples\|example]], below. </li>

JAL: /* Syntax terms */ minor formatting

2016-07-20T21:08:10Z

Syntax terms: minor formatting

← Older revision		Revision as of 21:08, 20 July 2016
Line 9:		Line 9:

	<tr><th>string</th>		<tr><th>string</th>
	<td>A DER encoded string that contains the contents of a digital certificate. <br>'''Note:''' This method fails if the XML representation of <var class="term">string</var> is longer than 650 characters.</td></tr>		<td>A DER encoded string that contains the contents of a digital certificate. <p class="note">'''Note:''' This method fails if the XML representation of <var class="term">string</var> is longer than 650 characters.</p></td></tr>
	</table>		</table>

JAL: /* Usage notes */ minor formatting

2016-06-06T15:09:56Z

Usage notes: minor formatting

← Older revision		Revision as of 15:09, 6 June 2016
Line 22:		Line 22:
	<ul>		<ul>
	<li><var>X509CertificateToXmlDoc</var> is very similar to		<li><var>X509CertificateToXmlDoc</var> is very similar to
	<var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var>, except that <var>X509CertificateToXmlDoc</var> understands the semantics of the certificate tags, so it provides more meaningful XML element names. Contrast the [[DerToXmlDoc (String function)#Examples\|DerToXmlDoc example]] with the <var>X509CertificateToXmlDoc</var> [[X509CertificateToXmlDoc (String function)#Examples\|example]], below.		<var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var>, except that <var>X509CertificateToXmlDoc</var> understands the semantics of the certificate tags, so it provides more meaningful XML element names. Contrast the [[DerToXmlDoc (String function)#Examples\|DerToXmlDoc example]] with the <var>X509CertificateToXmlDoc</var> [[X509CertificateToXmlDoc (String function)#Examples\|example]], below. </li>
	<li><var>X509CertificateToXmlDoc</var> is a complete implementation of the PKCS standards for X509 certificates.
	<li>While <var>X509CertificateToXmlDoc</var> is a complete implementation of the PKCS standard, the <~~var~~><RelativeDistinguishedName></~~var~~> element can contain a wide variety of attributes that <var>X509CertificateToXmlDoc</var> does not understand. Under Model 204 7.6, and earlier, this ~~would result~~ in a parse exception but under 7.7 and later, such attributes are added as <~~var~~><unknown></~~var~~> elements with an <~~var~~><ObjectIdentifier></~~var~~> ~~elemnt~~ that indicates the ASN.1 object identifier. ~~One should generally~~ not ~~try~~ to use ~~such elements as~~, ~~if/when~~ <var>X509CertificateToXmlDoc</var> ~~adds~~ support for it, the element name will change to a proper name. If such an element is of interest, contact Rocket Software technical support.		<li><var>X509CertificateToXmlDoc</var> is a complete implementation of the PKCS standards for X509 certificates. </li>

			<li>While <var>X509CertificateToXmlDoc</var> is a complete implementation of the PKCS standard, the <code><RelativeDistinguishedName></code> element can contain a wide variety of attributes that <var>X509CertificateToXmlDoc</var> does not understand. Under Model 204 7.6 and earlier, this results in a parse exception, but under 7.7 and later, such attributes are added as <code><unknown></code> elements with an <code><ObjectIdentifier></code> element that indicates the ASN.1 object identifier.
			<p class="note"><b>Note:</b> You are advised not to use an <code><unknown></code> element in your programs, since future updates to the <var>X509CertificateToXmlDoc</var> method may add support for the element, in which case the element name will change to a proper name. If such an element is of interest, [[Contacting Rocket Software Technical Support\|contact Rocket Software technical support]]. </p></li>

	<li>Currently, no method is available to produce a DER stream from an <var>XmlDoc</var> nor to validate the signature on a certificate.		<li>Currently, no method is available to produce a DER stream from an <var>XmlDoc</var> nor to validate the signature on a certificate.
	</ul>		</ul>

Alex: /* Usage notes */

2016-06-04T01:56:55Z

Usage notes

← Older revision		Revision as of 01:56, 4 June 2016
Line 24:		Line 24:
	<var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var>, except that <var>X509CertificateToXmlDoc</var> understands the semantics of the certificate tags, so it provides more meaningful XML element names. Contrast the [[DerToXmlDoc (String function)#Examples\|DerToXmlDoc example]] with the <var>X509CertificateToXmlDoc</var> [[X509CertificateToXmlDoc (String function)#Examples\|example]], below.		<var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var>, except that <var>X509CertificateToXmlDoc</var> understands the semantics of the certificate tags, so it provides more meaningful XML element names. Contrast the [[DerToXmlDoc (String function)#Examples\|DerToXmlDoc example]] with the <var>X509CertificateToXmlDoc</var> [[X509CertificateToXmlDoc (String function)#Examples\|example]], below.
	<li><var>X509CertificateToXmlDoc</var> is a complete implementation of the PKCS standards for X509 certificates.		<li><var>X509CertificateToXmlDoc</var> is a complete implementation of the PKCS standards for X509 certificates.
			<li>While <var>X509CertificateToXmlDoc</var> is a complete implementation of the PKCS standard, the <var><RelativeDistinguishedName></var> element can contain a wide variety of attributes that <var>X509CertificateToXmlDoc</var> does not understand. Under Model 204 7.6, and earlier, this would result in a parse exception but under 7.7 and later, such attributes are added as <var><unknown></var> elements with an <var><ObjectIdentifier></var> elemnt that indicates the ASN.1 object identifier. One should generally not try to use such elements as, if/when <var>X509CertificateToXmlDoc</var> adds support for it, the element name will change to a proper name. If such an element is of interest, contact Rocket Software technical support.
	<li>Currently, no method is available to produce a DER stream from an <var>XmlDoc</var> nor to validate the signature on a certificate.		<li>Currently, no method is available to produce a DER stream from an <var>XmlDoc</var> nor to validate the signature on a certificate.
	</ul>		</ul>

JAL: /* See also */ add item

2016-05-16T21:18:10Z

JAL: /* Usage notes */ typo

2016-04-01T18:14:39Z

Usage notes: typo

← Older revision		Revision as of 18:14, 1 April 2016
Line 22:		Line 22:
	<ul>		<ul>
	<li><var>X509CertificateToXmlDoc</var> is very similar to		<li><var>X509CertificateToXmlDoc</var> is very similar to
	<var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var>, except that <var>~~X509CrlToXmlDoc~~</var> understands the semantics of the certificate tags, so it provides more meaningful XML element names. Contrast the [[DerToXmlDoc (String function)#Examples\|DerToXmlDoc example]] with the <var>X509CertificateToXmlDoc</var> [[X509CertificateToXmlDoc (String function)#Examples\|example]], below.		<var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var>, except that <var>X509CertificateToXmlDoc</var> understands the semantics of the certificate tags, so it provides more meaningful XML element names. Contrast the [[DerToXmlDoc (String function)#Examples\|DerToXmlDoc example]] with the <var>X509CertificateToXmlDoc</var> [[X509CertificateToXmlDoc (String function)#Examples\|example]], below.
	<li><var>X509CertificateToXmlDoc</var> is a complete implementation of the PKCS standards for X509 certificates.		<li><var>X509CertificateToXmlDoc</var> is a complete implementation of the PKCS standards for X509 certificates.
	<li>Currently, no method is available to produce a DER stream from an <var>XmlDoc</var> nor to validate the signature on a certificate.		<li>Currently, no method is available to produce a DER stream from an <var>XmlDoc</var> nor to validate the signature on a certificate.

JAL: fix example

2016-03-30T21:29:00Z

fix example

← Older revision		Revision as of 21:29, 30 March 2016
Line 45:		Line 45:

	%ls = %sl:pemToString('X509 CERTIFICATE')		%ls = %sl:pemToString('X509 CERTIFICATE')
	~~%doc =~~ %ls:x509certificateToXmldoc:print		%ls:x509certificateToXmldoc:print
	~~%doc:print~~
	... </p>		... </p>

← Older revision		Revision as of 15:08, 6 September 2018
Line 151:		Line 151:

	<li><var>[[SignedCertificate (String function)\|SignedCertificate]]</var> </li>		<li><var>[[SignedCertificate (String function)\|SignedCertificate]]</var> </li>

			<li><var>[[SignedClientCertificate (String function)\|SignedClientCertificate]]</var> </li>

	<li><var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var> </li>		<li><var>[[DerToXmlDoc (String function)\|DerToXmlDoc]]</var> </li>

← Older revision		Revision as of 16:59, 22 August 2016
Line 168:		Line 168:
	<var>System</var> methods: </p>		<var>System</var> methods: </p>
	<ul>		<ul>
	<li><var>[[ClientCertificate (System function)\|ClientCertificate]]</var>, <li><var>[[GeneratedPrivateKey (System function)\|GeneratedPrivateKey]]</var> </li>		<li><var>[[ClientCertificate (System function)\|ClientCertificate]]</var> </li>
			<li><var>[[GeneratedPrivateKey (System function)\|GeneratedPrivateKey]]</var> </li>
	</ul>		</ul>
	<p>		<p>

← Older revision		Revision as of 21:18, 16 May 2016
Line 145:		Line 145:
	<ul>		<ul>
	<li><var>[[CertificateRequest (String function)\|CertificateRequest]]</var> </li>		<li><var>[[CertificateRequest (String function)\|CertificateRequest]]</var> </li>

			<li><var>[[ClientCertificateRequest (String function)\|ClientCertificateRequest]]</var> </li>

	<li><var>[[SignedCertificate (String function)\|SignedCertificate]]</var> </li>		<li><var>[[SignedCertificate (String function)\|SignedCertificate]]</var> </li>