API Module SSL generateCsrSslCertRequest
From Openprovider API documentation
(Difference between revisions)
(→Raw XML) |
(→Module SSL certificates > Decode CSR) |
||
| (8 intermediate revisions not shown) | |||
| Line 13: | Line 13: | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
| - | *'''bits''' | + | *'''bits''' (e.g. 1024 or 2048) |
| - | *'''commonName''' | + | *'''commonName''' (domain used as a common name) |
*'''country''' | *'''country''' | ||
| + | *'''organization''' | ||
| + | *'''email''' | ||
*state | *state | ||
*locality | *locality | ||
| - | |||
*unit | *unit | ||
| - | + | *subjectAlternativeName (additional domains) | |
| - | *subjectAlternativeName | + | *signatureHashAlgorithm (default: sha2) |
| - | *signatureHashAlgorithm | + | *withConfig (default: 1 - config file for OpenSSL command dumped out when subjectAlternativeName domains are included) |
| - | *withConfig | + | |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
| Line 29: | Line 29: | ||
| | | | ||
*csr | *csr | ||
| - | *key | + | *key (private key) |
| - | *command | + | *command (OpenSSL command used to generate CSR) |
|} | |} | ||
| Line 45: | Line 45: | ||
===Raw XML=== | ===Raw XML=== | ||
| - | ''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your | + | ''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider. |
| + | |||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<openXML> | <openXML> | ||
Current revision as of 12:50, 12 October 2016
Contents |
Module SSL certificates > Decode CSR
| Module | SSL certificates |
| Command name | generateCsrSslCertRequest |
| Use | Use this call to generate a CSR |
| Input |
|
| Output |
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('generateCsrSslCertRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'bits' => '2048',
'commonName' => 'test.com',
'country' => 'US',
));
Raw XML
Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<credentials>
<username>username</username>
<password>password</password>
</credentials>
<generateCsrSslCertRequest>
<bits>2048</bits>
<commonName>test.com</commonName>
<country>US</country>
</generateCsrSslCertRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
< code>0</code>
<desc />
<data>
<command>openssl req -new -newkey rsa:2048 -nodes -out your.csr -keyout your.private.key -subj "/C=US/ST=/L=/O=/OU=/CN=test.com/emailAddress=""</command>
<key>-----BEGIN PRIVATE KEY-----BASE64PRIVATEKEYHERE-----END PRIVATE KEY-----</key>
<csr>-----BEGIN CERTIFICATE REQUEST-----BASE64CSRHERE-----END CERTIFICATE REQUEST-----</csr>
</data>
</reply>
</openXML>