APIs in Category: ssl |
API version 6.1 |
ssl-server-cert-generate |
These apis allow for operations related to TLS/SSL communication, such as: generating the certificate used by the HTTPS server port, viewing the certificate, or creating certificate signing requests. |
ssl-server-cert-generate | [top] |
Generates the self-signed certificate to be used by the HTTPS port. The newly generated certificate will become active after a reboot.
The certificate will be generated with the following parameters:
- Public Key Algorithm: RSA
- Key Length: 2048
- Signature Algorithm: SHA-256 with RSA Encryption
- Validity: 5 years
Output Name Range Type Description certificate certificate
The generated certificate in Privacy Enhanced Mail (PEM) format.
ssl-server-cert-get | [top] |
Retrieves the certificate chain used by the HTTPS port. The certificate chain can be retrieved by anybody.
Output Name Range Type Description certificate-chain certificate-chain
The certificate chain in Privacy Enhanced Mail (PEM) format.
ssl-server-cert-request | [top] |
Creates a PKCS#10 Certification Request from the HTTPS port's certificate that can be submitted to a Certificate Authority for signing. The signed certificate received from a CA can then be imported via ssl-server-cert-set.
Output Name Range Type Description certificate-request string
The generated PKCS#10 Certification Request in Privacy Enhanced Mail (PEM) format.
ssl-server-cert-set | [top] |
Sets the certificate to be used by the HTTPS port. The certificate must be a CA-signed certificate generated from the Certification Request created via ssl-server-cert-request. The newly set certificate will become active after a reboot.
Input Name Range Type Description certificate-chain certificate-chain
The certificate chain in Privacy Enhanced Mail (PEM) format. Each certificate in the chain from the new certificate to the Certificate Authority must be included.
Errno Description EINVALIDINPUT
Element definition: certificate | [top] |
An X.509 certificate in Privacy Enhanced Mail (PEM) format.
[none]
Element definition: certificate-chain | [top] |
A chain of X.509 certificates in Privacy Enhanced Mail (PEM) format.
[none]