AppendCertificateRequest (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (→See also) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:AppendCertificateRequest subtitle}} | {{Template:Stringlist:AppendCertificateRequest subtitle}} | ||
This | This [[Notation conventions for methods#Callable functions|callable]] method generates an SSL client certificate from a given private key, and it adds the certificate lines to the end of a <var>Stringlist</var>. | ||
==Syntax== | ==Syntax== | ||
{{Template:Stringlist:AppendCertificateRequest syntax}} | {{Template:Stringlist:AppendCertificateRequest 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 [[#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. This value must be less than or equal to 2048 bits. </td></tr> | ||
<tr><th><var>Country</var></th> | <tr><th><var>Country</var></th> | ||
<td>string</td></tr> | <td>string</td></tr> | ||
| Line 24: | Line 27: | ||
<td>string</td></tr> | <td>string</td></tr> | ||
</table> | </table> | ||
===Return codes=== | |||
<table> | |||
<tr><th>0</th><td>All is well.</td></tr> | |||
<tr><th>3</th><td>Out of CCATEMP.</td></tr> | |||
<tr><th>5</th><td><var>Stringlist</var> identifier missing.</td></tr> | |||
<tr><th>6</th><td>Invalid <var>Stringlist</var> identifier.</td></tr> | |||
<tr><th>7</th><td>Insufficient storage.</td></tr> | |||
<tr><th>10</th><td>Private key <var>Stringlist</var> identifier missing.</td></tr> | |||
<tr><th>11</th><td>Invalid private key <var>Stringlist</var> identifier.</td></tr> | |||
<tr><th>12</th><td>Invalid private key.</td></tr> | |||
<tr><th>13</th><td>Challenge data mismatch.</td></tr> | |||
<tr><th>14</th><td>Bad private key/challenge signature.</td></tr> | |||
</table> | |||
==Usage notes== | ==Usage notes== | ||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li><var>[[AppendCertificateInfo (Stringlist function)|AppendCertificateInfo]]</var> | <li><var>[[AppendCertificateInfo (Stringlist function)|AppendCertificateInfo]]</var> | ||
<li><var>[[AppendCertificateRequestInfo (Stringlist function)|AppendCertificateRequestInfo]]</var> | <li><var>[[AppendCertificateRequestInfo (Stringlist function)|AppendCertificateRequestInfo]]</var> | ||
<li><var>[[AppendClientCertificateRequest (Stringlist function)|AppendClientCertificateRequest]]</var> | |||
<li><var>[[AppendPrivateKeyInfo (Stringlist function)|AppendPrivateKeyInfo]]</var> | |||
<li><var>[[AppendSignedCertificate (Stringlist function)|AppendSignedCertificate]]</var> | <li><var>[[AppendSignedCertificate (Stringlist function)|AppendSignedCertificate]]</var> | ||
<li><var>[[AppendSignedClientCertificate (Stringlist function)|AppendSignedClientCertificate]]</var> | <li><var>[[AppendSignedClientCertificate (Stringlist function)|AppendSignedClientCertificate]]</var> | ||
<li><var>[[CheckCertificate (Stringlist function)|CheckCertificate]]</var> | |||
<li><var>[[CheckCertificateRequest (Stringlist function)|CheckCertificateRequest]]</var> | |||
</ul> | </ul> | ||
{{Template:Stringlist:AppendCertificateRequest footer}} | {{Template:Stringlist:AppendCertificateRequest footer}} | ||
Revision as of 22:06, 11 May 2012
Add certificate request to a Stringlist (Stringlist class)
[Requires Janus Network Security]
This callable method generates an SSL client certificate from a given private key, and it adds the certificate lines to the end of a Stringlist.
Syntax
[%rc =] sl:AppendCertificateRequest( [PrivateKey=] string, - [[Country=] string], [[State=] string], - [[City=] string], - [[Organization=] string], - [[OrganizationalUnit=] string], - [[CommonName=] 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. This value must be less than or equal to 2048 bits. |
| Country | string |
| State | string |
| City | string |
| Organization | string |
| OrganizationalUnit | string |
| CommonName | string |
Return codes
| 0 | All is well. |
|---|---|
| 3 | Out of CCATEMP. |
| 5 | Stringlist identifier missing. |
| 6 | Invalid Stringlist identifier. |
| 7 | Insufficient storage. |
| 10 | Private key Stringlist identifier missing. |
| 11 | Invalid private key Stringlist identifier. |
| 12 | Invalid private key. |
| 13 | Challenge data mismatch. |
| 14 | Bad private key/challenge signature. |
Usage notes
Examples
See also
- AppendCertificateInfo
- AppendCertificateRequestInfo
- AppendClientCertificateRequest
- AppendPrivateKeyInfo
- AppendSignedCertificate
- AppendSignedClientCertificate
- CheckCertificate
- CheckCertificateRequest