AppendClientCertificateRequest (Stringlist function): Difference between revisions
m (Automatically generated page update) |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{Template:Stringlist:AppendClientCertificateRequest subtitle}} | {{Template:Stringlist:AppendClientCertificateRequest subtitle}} | ||
This | This [[Notation conventions for methods#Callable functions|callable]] method generates an SSL client certificate request from a given private key, and it adds the request lines to the end of a <var>Stringlist</var>. | ||
==Syntax== | ==Syntax== | ||
{{Template:Stringlist:AppendClientCertificateRequest syntax}} | {{Template:Stringlist:AppendClientCertificateRequest syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%rc</th><td> | <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 below in [[AppendCertificateRequest (Stringlist function)#Return codes|"Return codes"]].</td></tr> | |||
<tr><th>sl</th> | <tr><th>sl</th> | ||
<td>Stringlist object</td></tr> | <td>Stringlist object</td></tr> | ||
<tr><th><var>PrivateKey</var></th> | <tr><th><var>PrivateKey</var></th> | ||
<td><var>Stringlist</var> object</td></tr> | <td>This [[Notation conventions for methods#Named parameters|name allowed]] parameter is a <var>Stringlist</var> object that contains an RSA-generated private key.</td></tr> | ||
<tr><th><var>Country</var></th> | <tr><th><var>Country</var></th> | ||
<td>string</td></tr> | <td>string</td></tr> | ||
<tr><th><var>State</var></th> | <tr><th><var>State</var></th> | ||
<td>string</td></tr> | <td> A string that is the state or province name to be specified on the request.</td></tr> | ||
<tr><th><var>City</var></th> | <tr><th><var>City</var></th> | ||
<td>string</td></tr> | <td>A string that is the city name to be specified on the request.</td></tr> | ||
<tr><th><var>Organization</var></th> | <tr><th><var>Organization</var></th> | ||
<td>string</td></tr> | <td>string</td></tr> | ||
Line 24: | Line 27: | ||
<td>string</td></tr> | <td>string</td></tr> | ||
<tr><th><var>Challenge</var></th> | <tr><th><var>Challenge</var></th> | ||
<td>string</td></tr> | <td>A string that is the expected challenge data.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
<ul> | |||
<li><var>[[AppendCertificateInfo (Stringlist function)|AppendCertificateInfo]]</var> | |||
<li><var>[[AppendCertificateRequest (Stringlist function)|AppendCertificateRequest]]</var> | |||
<li><var>[[AppendCertificateRequestInfo (Stringlist function)|AppendCertificateRequestInfo]]</var> | |||
<li><var>[[AppendPrivateKeyInfo (Stringlist function)|AppendPrivateKeyInfo]]</var> | |||
<li><var>[[AppendSignedCertificate (Stringlist function)|AppendSignedCertificate]]</var> | |||
<li><var>[[AppendSignedClientCertificate (Stringlist function)|AppendSignedClientCertificate]]</var> | |||
<li><var>[[CheckCertificate (Stringlist function)|CheckCertificate]]</var> | |||
<li><var>[[CheckCertificateRequest (Stringlist function)|CheckCertificateRequest]]</var> | |||
</ul> | |||
{{Template:Stringlist:AppendClientCertificateRequest footer}} | {{Template:Stringlist:AppendClientCertificateRequest footer}} |
Revision as of 22:06, 11 May 2012
Add client certificate request to a Stringlist (Stringlist class)
[Requires Janus Network Security]
This callable method generates an SSL client certificate request from a given private key, and it adds the request lines to the end of a Stringlist.
Syntax
[%rc =] sl:AppendClientCertificateRequest( [PublicKey=] string, - [[Country=] string], - [[State=] string], - [[City=] string], - [[Organization=] string], - [[OrganizationalUnit=] string], - [[CommonName=] string], - [[Challenge=] string], - [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 below in "Return codes". |
---|---|
sl | Stringlist object |
PrivateKey | This name allowed parameter is a Stringlist object that contains an RSA-generated private key. |
Country | string |
State | A string that is the state or province name to be specified on the request. |
City | A string that is the city name to be specified on the request. |
Organization | string |
OrganizationalUnit | string |
CommonName | string |
Challenge | A string that is the expected challenge data. |
Usage notes
Examples
See also
- AppendCertificateInfo
- AppendCertificateRequest
- AppendCertificateRequestInfo
- AppendPrivateKeyInfo
- AppendSignedCertificate
- AppendSignedClientCertificate
- CheckCertificate
- CheckCertificateRequest