AppendClientCertificateRequest (Stringlist function): Difference between revisions
| mNo edit summary | |||
| Line 9: | Line 9: | ||
| <table class="syntaxTable"> | <table class="syntaxTable"> | ||
| <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 [[ | <td>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|"Return codes"]].</td></tr> | ||
| <tr><th>sl</th> | <tr><th>sl</th> | ||
| <td>Stringlist object</td></tr> | <td>Stringlist object</td></tr> | ||
| Line 34: | Line 34: | ||
| <tr><th><var>Challenge</var></th> | <tr><th><var>Challenge</var></th> | ||
| <td>This name allowed, optional, string argument inserts the expected authentication challenge data/password. You might need to identify the type of authentication, for example, certificate-based authentication.</td></tr> | <td>This name allowed, optional, string argument inserts the expected authentication challenge data/password. You might need to identify the type of authentication, for example, certificate-based authentication.</td></tr> | ||
| </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>Public key <var>Stringlist</var> identifier missing.</td></tr> | |||
| <tr><th>11</th><td>Invalid public key <var>Stringlist</var> identifier.</td></tr> | |||
| <tr><th>12</th><td>Invalid public key.</td></tr> | |||
| <tr><th>13</th><td>Challenge data mismatch.</td></tr> | |||
| <tr><th>14</th><td>Bad public key/challenge signature.</td></tr> | |||
| </table> | </table> | ||
Revision as of 23:53, 4 June 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 client public 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 elsewhere in "Return codes". | 
|---|---|
| sl | Stringlist object | 
| PublicKey | This name allowed parameter is a Stringlist object that contains an RSA-generated client public key. | 
| Country | This name allowed, optional, string argument inserts a country value into the generated certificate request. | 
| State | This name allowed, optional, string argument inserts a state/province value into the generated certificate request. | 
| City | This name allowed, optional, string argument inserts a locality value into the generated certificate request. | 
| Organization | This name allowed, optional, string argument inserts an organization value (for example, a company name) into the generated certificate request. | 
| OrganizationalUnit | This name allowed, optional, string argument inserts an organization unit (OU) value into the generated certificate request. For example, a department within a company. | 
| CommonName | This name allowed, optional, string argument inserts a common-name (CN) value into the generated certificate request. For example, a host name like "www.sirius-software.com". | 
| Challenge | This name allowed, optional, string argument inserts the expected authentication challenge data/password. You might need to identify the type of authentication, for example, certificate-based authentication. | 
Return codes
| 0 | All is well. | 
|---|---|
| 3 | Out of CCATEMP. | 
| 5 | Stringlist identifier missing. | 
| 6 | Invalid Stringlist identifier. | 
| 7 | Insufficient storage. | 
| 10 | Public key Stringlist identifier missing. | 
| 11 | Invalid public key Stringlist identifier. | 
| 12 | Invalid public key. | 
| 13 | Challenge data mismatch. | 
| 14 | Bad public key/challenge signature. | 
Examples
For a closely related example, see the AppendCertificateRequest "Examples" section.
See also
- AppendCertificateInfo
- AppendCertificateRequest
- AppendCertificateRequestInfo
- AppendEncryptedSecurityData
- AppendGeneratedPrivateKey
- AppendPrivateKeyInfo
- AppendSignedCertificate
- AppendSignedClientCertificate
- CheckCertificate
- CheckCertificateRequest
- DER-to-XmlDoc String methods