View source for CertLevels (Socket function)

{{Template:Socket:CertLevels subtitle}}

This method retrieves the number of
levels of the SSL certificate provided on a socket by the remote partner.
The <var>CertLevels</var> function has an effect similar to
its equivalent $function, <var>[[$Sock_Cert_Levels]]</var>.
==Syntax==
{{Template:Socket:CertLevels syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th>
<td>Return string, which contains the value of the number of levels of the certificate provided by the remote partner on a socket.
If no such certificate was provided, the null string is returned. Otherwise, level 0 corresponds to the client or the "subject" of the certificate; level 1 to the "signer" of the certificate; level 2 to the "signer" of the level 1 signer's certificate; and so on.

Since all certificates accepted by <var class="product">Janus Network Security</var> must be signed, <var class="term">%number</var> will always be greater than or equal to 2 if non-zero. Level 3 would indicate a certificate that includes an intermediate certificate.

For information on the data that can be retrieved for each certificate level see <var>[[CertInfo (Socket function)|CertInfo]]</var>. To learn more about client certificates, see the <i>[http://www.sirius-software.com/maint/download/jansslr.pdf Janus Network Security Reference Manual]</i>.
</td></tr>
<tr><th>socket</th>
<td>A variable or an expression that is a reference to a <var>Socket</var> object.

</td></tr></table>

==Usage notes==
<ul>
<li><var>CertLevels</var> returns the value <code>-1</code> if the socket is not open
and <code>ONRESET CONTINUE</code> is in effect for the socket.
<li>A <var>CertLevels</var> call may cause an [[CertInfo (Socket function)#reneg|SSL renegotiation]] in order to
request a digital certificate from the client.
</ul>

==Example==

The following statement
returns the number of levels of the certificate received from the remote partner
using the <code>%sok</code> socket:
<p class="code">%count = %sok:Certlevels
</p>

{{Template:Socket:CertLevels footer}}