AppendSignedClientCertificate (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (privateKey may be string or stringlist)
m (add detail)
Line 1: Line 1:
{{Template:Stringlist:AppendSignedClientCertificate subtitle}}
{{Template:Stringlist:AppendSignedClientCertificate subtitle}}
This [[Notation conventions for methods#Callable functions|callable]] method signs an X.509 client certificate request and adds the lines of the signed certificate to the end of a <var>Stringlist</var>.
This [[Notation conventions for methods#Callable functions|callable]] method signs an X.509 client certificate request and adds the lines of the signed certificate to the end of a <var>Stringlist</var>. It requires a valid private key, certificate request, and signer.  


==Syntax==
==Syntax==
Line 6: Line 6:


===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table>
<tr><th>%rc</th>
<tr><th>%rc</th>
<td>An, optional, numeric variable that is set to zero if the function is a success. The possible return codes are described elsewhere in [[AppendSignedCertificate (Stringlist function)#Return codes|Return codes]]. </td></tr>
<td>An, optional, numeric variable that is set to zero if the function is a success. The possible return codes are described elsewhere in [[AppendSignedCertificate (Stringlist function)#Return codes|Return codes]]. </td></tr>
Line 17: Line 17:


<tr><th><var>Request</var></th>
<tr><th><var>Request</var></th>
<td>This name allowed argument is a string or <var>Stringlist</var> that contains the base-64 encoded X.509 certificate request.</td></tr>
<td>This name allowed argument is a string or <var>Stringlist</var> that contains the base64 encoded X.509 certificate request.</td></tr>


<tr><th><var>Signer</var></th>
<tr><th><var>Signer</var></th>
<td>This name allowed argument is a string or <var>Stringlist</var> that contains the base-64 encoded CA (certifying authority) X.509 certificate. If not specified, the <var>Request</var> <var>Stringlist</var> is used: that is, the certificate will be self-signed. </td></tr>
<td>This name allowed argument is a string or <var>Stringlist</var> that contains a base64 encoded CA (certifying authority) X.509 certificate. If not specified, the <var>Request</var> value is used: that is, the certificate will be self-signed. </td></tr>


<tr><th><var>StartDate</var></th>
<tr><th><var>StartDate</var></th>
Line 36: Line 36:
</table>
</table>


==Examples==
==Example==


==See also==
==See also==

Revision as of 23:27, 30 March 2016

Add base64 encoded signed client certificate to a Stringlist (Stringlist class)

[Requires Janus Network Security]

This callable method signs an X.509 client certificate request and adds the lines of the signed certificate to the end of a Stringlist. It requires a valid private key, certificate request, and signer.

Syntax

[%rc =] sl:AppendSignedClientCertificate( [PrivateKey=] string, - [Request=] string, - [Signer=] string, - [[StartDate=] string], - [[EndDate=] string], - [[SerialNumber=] number], - [SignatureAlgorithm= digestAlgorithm])

Syntax terms

%rc An, optional, numeric variable that is set to zero if the function is a success. The possible return codes are described elsewhere in Return codes.
sl A Stringlist object.
PrivateKey This name allowed argument is a string or Stringlist that contains the private key to be used for signing.
Request This name allowed argument is a string or Stringlist that contains the base64 encoded X.509 certificate request.
Signer This name allowed argument is a string or Stringlist that contains a base64 encoded CA (certifying authority) X.509 certificate. If not specified, the Request value is used: that is, the certificate will be self-signed.
StartDate This optional, name allowed, argument is a string that contains the Start date for the signed certificate (in YYMMDDHHMISS format). The default is today's date.
EndDate This optional, name allowed, argument is a string that contains the End date for the signed certificate (in YYMMDDHHMISS format). The default is 24 hours from StartDate.
SerialNumber This optional, name allowed, argument is a numeric value that is the Serial number for the signed certificate. The default is a number guaranteed to increase by 1 for every call and guaranteed to increase from run to run, unless there is an extreme amount of signing occurrences.
SignatureAlgorithm This optional, name required, argument is a DigestAlgorithm enumeration value. Valid options are: MD5, SHA1, SHA256. The default value is SHA256 as of Model 204 7.7 (and zap maintenance for versions 7.6 and 7.5).

Note: Although supported and formerly the default, most modern browsers are deprecating SHA1.

Example

See also

Stringlist methods:

String methods:

System methods:

Socket methods:

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=AppendSignedClientCertificate_(Stringlist_function)&oldid=83582"