ClientCertificateRequest (String function): Difference between revisions
No edit summary |
m (→See also: add method to list) |
||
(7 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Template:String:ClientCertificateRequest subtitle}} | {{Template:String:ClientCertificateRequest subtitle}} | ||
This page is [[under construction]]. | This page is [[under construction]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:String:ClientCertificateRequest syntax}} | {{Template:String:ClientCertificateRequest syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table | <table> | ||
<tr><th>%certRequest</th><td> | <tr><th>%certRequest</th> | ||
<td>A <var>String</var> or <var>Longstring</var> to contain the generated signed certificate request.</td></tr> | |||
<tr><th>string</th> | <tr><th>string</th> | ||
<td> | <td>A <var>String</var> or <var>Longstring</var> that contains an RSA-generated client public key. This value must be less than or equal to 4096 (as of version 7.7 of Model 204). The pre-7.7 maximum is 2048 bits.</td></tr> | ||
<tr><th><var>Country</var></th> | <tr><th><var>Country</var></th> | ||
<td | <td>This optional, [[Notation conventions for methods#Named parameters|name required]], string argument inserts a country value into the generated client certificate request. </td></tr> | ||
<tr><th><var>State</var></th> | <tr><th><var>State</var></th> | ||
<td>string | <td>This optional, name required, string argument inserts a state/province value into the generated client certificate request. </td></tr> | ||
<tr><th><var>City</var></th> | <tr><th><var>City</var></th> | ||
<td>string | <td>This optional, name required, string argument inserts a locality value into the generated client certificate request. </td></tr> | ||
<tr><th><var>Organization</var></th> | <tr><th><var>Organization</var></th> | ||
<td>string | <td>This optional, name required, string argument inserts an organization value into the generated client certificate request. </td></tr> | ||
<tr><th><var>OrganizationalUnit</var></th> | <tr><th><var>OrganizationalUnit</var></th> | ||
<td>string | <td>This optional, name required, string argument inserts an organization unit (OU) value into the generated client certificate request. </td></tr> | ||
<tr><th><var>CommonName</var></th> | <tr><th><var>CommonName</var></th> | ||
<td>string< | <td>This optional, name required, string argument inserts a common-name (CN) value into the generated client certificate request. | ||
<p></p></td></tr> | |||
<tr><th><var>Challenge</var></th> | <tr><th><var>Challenge</var></th> | ||
<td>string | <td>This optional, name required, string argument contains expected challenge data.</td></tr> | ||
<tr><th><var>SignatureAlgorithm</var></th> | <tr><th><var>SignatureAlgorithm</var></th> | ||
<td><var>DigestAlgorithm</var> value< | <td>This optional, name required, argument is a <var>[[DigestAlgorithm enumeration|DigestAlgorithm]]</var> enumeration value. Valid values are: <var>MD5</var>, <var>SHA1</var>, <var>SHA256</var>, <var>SHA384</var> (Model 204 7.7 and later), and <var>SHA512</var> (Model 204 7.7 and later). | ||
<p class="note"><b>Note:</b> Although supported and currently the default, most modern browsers are deprecating <var>SHA1</var>.</p></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
<p> | |||
<var>String</var> methods:</p> | |||
<ul> | |||
<li><var>[[CertificateRequest (String function)|CertificateRequest]]</var> </li> | |||
<li><var>[[ClientCertificateRequest (String function)|ClientCertificateRequest]]</var> </li> | |||
<li><var>[[SignedCertificate (String function)|SignedCertificate]]</var> </li> | |||
<li><var>[[SignedClientCertificate (String function)|SignedClientCertificate]]</var> </li> | |||
<li><var>[[DerToXmlDoc (String function)|DerToXmlDoc]]</var> </li> | |||
<li><var>[[RSAPrivateKeyToXmlDoc (String function)|RSAPrivateKeyToXmlDoc]]</var></li> | |||
<li><var>[[X509CertificateToXmlDoc (String function)|X509CertificateToXmlDoc]]</var> </li> | |||
<li><var>[[X509CrlToXmlDoc (String function)|X509CrlToXmlDoc]]</var> </li> | |||
<li>Multiple cryptographic cipher methods </li> | |||
</ul> | |||
<p> | |||
<var>Stringlist</var> methods: </p> | |||
{{Template:Stringlist crypto methods}} | |||
<p> | |||
<var>System</var> methods: </p> | |||
<ul> | |||
<li><var>[[ClientCertificate (System function)|ClientCertificate]]</var> </li> | |||
<li><var>[[GeneratedPrivateKey (System function)|GeneratedPrivateKey]]</var> </li> | |||
</ul> | |||
<p> | |||
<var>Socket</var> methods: </p> | |||
<ul> | |||
<li><var>[[Certificate (Socket function)|Certificate]]</var> </li> | |||
</ul> | |||
{{Template:String:ClientCertificateRequest footer}} | {{Template:String:ClientCertificateRequest footer}} |
Latest revision as of 15:05, 6 September 2018
Create a client certificate request from a public key (String class)
[Requires Janus Network Security]
This page is under construction.
Syntax
%certRequest = string:ClientCertificateRequest[( [Country= string], - [State= string], - [City= string], - [Organization= string], - [OrganizationalUnit= string], - [CommonName= string], - [Challenge= string], - [SignatureAlgorithm= digestAlgorithm])] Throws PKCSError
Syntax terms
%certRequest | A String or Longstring to contain the generated signed certificate request. |
---|---|
string | A String or Longstring that contains an RSA-generated client public key. This value must be less than or equal to 4096 (as of version 7.7 of Model 204). The pre-7.7 maximum is 2048 bits. |
Country | This optional, name required, string argument inserts a country value into the generated client certificate request. |
State | This optional, name required, string argument inserts a state/province value into the generated client certificate request. |
City | This optional, name required, string argument inserts a locality value into the generated client certificate request. |
Organization | This optional, name required, string argument inserts an organization value into the generated client certificate request. |
OrganizationalUnit | This optional, name required, string argument inserts an organization unit (OU) value into the generated client certificate request. |
CommonName | This optional, name required, string argument inserts a common-name (CN) value into the generated client certificate request. |
Challenge | This optional, name required, string argument contains expected challenge data. |
SignatureAlgorithm | This optional, name required, argument is a DigestAlgorithm enumeration value. Valid values are: MD5, SHA1, SHA256, SHA384 (Model 204 7.7 and later), and SHA512 (Model 204 7.7 and later).
Note: Although supported and currently the default, most modern browsers are deprecating SHA1. |
Usage notes
Examples
See also
String methods:
- CertificateRequest
- ClientCertificateRequest
- SignedCertificate
- SignedClientCertificate
- DerToXmlDoc
- RSAPrivateKeyToXmlDoc
- X509CertificateToXmlDoc
- X509CrlToXmlDoc
- Multiple cryptographic cipher methods
Stringlist methods:
- AppendCertificateInfo
- AppendCertificateRequest
- AppendCertificateRequestInfo
- AppendClientCertificateRequest
- AppendEncryptedSecurityData
- AppendGeneratedPrivateKey
- AppendPemData
- AppendPrivateKeyInfo
- AppendSignedCertificate
- AppendSignedClientCertificate
- CheckCertificate
- CheckCertificateRequest
- PemToString
System methods:
Socket methods: