ClientCertificate (System function): Difference between revisions

Revision as of 20:25, 15 March 2016

Get client certificate (System class)

[Introduced in Sirius Mods 8.0]

The ClientCertificate function returns to a Janus server a Longstring that contains the binary content of a client SSL certificate.

%string = %(System):ClientCertificate[( [RequestCertificate= boolean])] Throws NotJanusConnection

%string	This `Longstring` contains a copy of the binary, ASN.1 encoded, content of the SSL certificate presented by this server's client. If no client certificate is provided (possibly because the port is not using SSL, or the certificate was already provided), `%string` is a null string.
`%(System)`	The class name in parentheses denotes a shared method. `ClientCertificate` can also be invoked via a `System` object variable, which may be `null`.
`RequestCertificate`	This name required argument is a `Boolean` enumeration. If `True`, a certificate is requested from the client at the time of the method call. If `False`, no certificate is requested.

This method can be used only on a Janus Web Server, Janus Telnet Server, or Janus Sockets Server thread. If used on any other kind of thread, it throws a NotJanusConnection exception.
Specifying RequestCertificate=True only has an effect on a Janus SSL port whose definition does not include SSLCLCERT or SSLCLCERTR. These parameters request a client certificate at connection-establishment time, and a client certificate may only be requested once for an SSL session (whether or not the request successfully gets a certificate in return).

System class: GeneratedPrivateKey
String class: DerToXmlDoc, X509CrlToXmlDoc, X509CertificateToXmlDoc, RSAPrivateKeyToXmlDoc, CertificateRequest, SignedCertificate and many cryptographic cipher methods
Socket class: Certificate
HttpRequest class: Get, Post, and Send
Stringlist class: AppendCertificateRequest, AppendPemData, PemToString and several more

Background information:

System class	List of System methods	System methods syntax
Notation conventions for methods

@@ Line 32: / Line 32: @@
 <li><var>System</var> class: <var>[[GeneratedPrivateKey (System function)|GeneratedPrivateKey]]</var> </li>
-<li><var>String</var> class: <var>[[DerToXmlDoc (String function)|DerToXmlDoc]]</var>, <var>[[X509CrlToXmlDoc (String function)|X509CrlToXmlDoc]]</var>, <var>[[X509CertificateToXmlDoc_(String_function)|X509CertificateToXmlDoc]]</var>, <var>[[RSAPrivateKeyToXmlDoc (String function)|RSAPrivateKeyToXmlDoc]]</var>, <var>[[CertificateRequest (String function)|CertificateRequest]]</var>, <var>[[SignedCertificate (String function)|SignedCertificate]]</var> </li>
+<li><var>String</var> class: <var>[[DerToXmlDoc (String function)|DerToXmlDoc]]</var>, <var>[[X509CrlToXmlDoc (String function)|X509CrlToXmlDoc]]</var>, <var>[[X509CertificateToXmlDoc (String function)|X509CertificateToXmlDoc]]</var>, <var>[[RSAPrivateKeyToXmlDoc (String function)|RSAPrivateKeyToXmlDoc]]</var>, <var>[[CertificateRequest (String function)|CertificateRequest]]</var>, <var>[[SignedCertificate (String function)|SignedCertificate]]</var> and many cryptographic cipher methods </li>
 <li><var>Socket</var> class: <var>[[Certificate (Socket function)|Certificate]]</var> </li>