ClientCertificate (System function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Usage notes) |
||
| Line 18: | Line 18: | ||
<li>This method can be used only on a <var class="product">Janus Web Server</var>, <var class="product">Janus Telnet Server</var>, or <var class="product">Janus Sockets</var> Server thread. If used on any other kind of thread, it throws a | <li>This method can be used only on a <var class="product">Janus Web Server</var>, <var class="product">Janus Telnet Server</var>, or <var class="product">Janus Sockets</var> Server thread. If used on any other kind of thread, it throws a | ||
<var>[[NotJanusConnection class|NotJanusConnection]]</var> exception. | <var>[[NotJanusConnection class|NotJanusConnection]]</var> exception. | ||
<li>Specifying <code>RequestCertificate=True</code> only has an effect on a | <li>Specifying <code>RequestCertificate=True</code> only has an effect on a Janus <var>[[SSL]]</var> port whose definition does ''not'' include <var>[[SSLCLCERT and SSLCLCERTR|SSLCLCERT]]</var> or <var>[[SSLCLCERT and SSLCLCERTR|SSLCLCERTR]]</var>. 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). | may only be requested once for an SSL session (whether or not the request successfully gets a certificate in return). | ||
</ul> | </ul> | ||
Revision as of 20:11, 5 November 2011
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.
Syntax
%string = %(System):ClientCertificate[( [RequestCertificate= boolean])] Throws NotJanusConnection
Syntax terms
| %string | This Longstring contains the binary 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. |
Usage notes
- 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=Trueonly 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).