AppendSignedCertificate (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (add link)
m (add link)
Line 34: Line 34:


<tr><th><var>SignatureAlgorithm</var></th>
<tr><th><var>SignatureAlgorithm</var></th>
<td>This optional, [[Notation conventions for methods#Named parameters|name required]], argument is a <var>DigestAlgorithm</var> enumeration value.  Valid options are: <var>MD5</var>, <var>SHA1</var>, <var>SHA256</var>.
<td>This optional, [[Notation conventions for methods#Named parameters|name required]], argument is a <var>[[DigestAlgorithm enumeration|DigestAlgorithm]]</var> enumeration value.  Valid options are: <var>MD5</var>, <var>SHA1</var>, <var>SHA256</var>.
<p class="note"><b>Note:</b> Although supported and currently the default, most modern browsers are deprecating <var>SHA1</var>.</p></td></tr>
<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>
Line 40: Line 40:
===Return codes===
===Return codes===
<table class="thJustBold">
<table class="thJustBold">
<tr><th>0</th><td>All is well.</td></tr>
<tr><th>0</th>
<tr><th>3</th><td>Out of CCATEMP.</td></tr>
<td>All is well.</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>3</th>
<tr><th>7</th><td>Insufficient storage.</td></tr>
<td>Out of CCATEMP.</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>5</th>
<tr><th>12</th><td>Invalid private key <var>Stringlist</var> data (not correctly base-64 encoded).</td></tr>
<td><var>Stringlist</var> identifier missing.</td></tr>
<tr><th>13</th><td>Certificate request <var>Stringlist</var> identifier missing.</td></tr>
 
<tr><th>14</th><td>Invalid certificate request <var>Stringlist</var> identifier.</td></tr>  
<tr><th>6</th>
<tr><th>15</th><td>Invalid certificate request.</td></tr>                 
<td>Invalid <var>Stringlist</var> identifier.</td></tr>
<tr><th>16</th><td>Invalid CA certificate <var>Stringlist</var> identifier.</td></tr>       
 
<tr><th>17</th><td>Invalid CA certificate.</td></tr>                    
<tr><th>7</th>
<tr><th>18</th><td>Invalid start date.</td></tr>                           
<td>Insufficient storage.</td></tr>
<tr><th>19</th><td>Invalid end date.</td></tr>                             
 
<tr><th>20</th><td>Invalid serial number.</td></tr>                      
<tr><th>10</th>
<tr><th>21</th><td>Private key does not match signer public key.</td></tr>
<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 <var>Stringlist</var> data (not correctly base-64 encoded).</td></tr>
 
<tr><th>13</th>
<td>Certificate request <var>Stringlist</var> identifier missing.</td></tr>
 
<tr><th>14</th>
<td>Invalid certificate request <var>Stringlist</var> identifier.</td></tr>  
 
<tr><th>15</th>
<td>Invalid certificate request.</td></tr>  
                
<tr><th>16</th>
<td>Invalid CA certificate <var>Stringlist</var> identifier.</td></tr>  
      
<tr><th>17</th>
<td>Invalid CA certificate.</td></tr>  
                 
<tr><th>18</th>
<td>Invalid start date.</td></tr>  
                          
<tr><th>19</th>
<td>Invalid end date.</td></tr>  
                            
<tr><th>20</th>
<td>Invalid serial number.</td></tr>  
                   
<tr><th>21</th>
<td>Private key does not match signer public key.</td></tr>
</table>
</table>


Revision as of 17:01, 28 August 2015

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

[Requires Janus Network Security]


This callable method signs an X.509 certificate request and adds the lines of the signed certificate to the end of a Stringlist.

Syntax

[%rc =] sl:AppendSignedCertificate( [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 below in Return codes.
sl A Stringlist object.
PrivateKey This name allowed argument is a Stringlist that contains the private key to be used for signing.
Request This name allowed argument is a Stringlist that contains the base-64 encoded X.509 certificate request.
Signer This optional, name allowed, argument is a Stringlist that contains the base-64 encoded CA (certifying authority) X.509 certificate. If not specified, the Request Stringlist 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.

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

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 Stringlist data (not correctly base-64 encoded).
13 Certificate request Stringlist identifier missing.
14 Invalid certificate request Stringlist identifier.
15 Invalid certificate request.
16 Invalid CA certificate Stringlist identifier.
17 Invalid CA certificate.
18 Invalid start date.
19 Invalid end date.
20 Invalid serial number.
21 Private key does not match signer public key.

Examples

See also

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