Commands used in this manual
This section explains an overview of the commands and the command options indicated in this manual.
Handling of the commands indicated in this manual
When writing this manual, the operation of multiple OSS commands when using the K5 APIs has been confirmed, but this does not mean that the OSS commands in this manual themselves are supported.
When using options other than those indicated in the OSS command explanations below, please be aware that you do so at your own risk.
The command examples given in this manual assume that "bash" is being used for execution.
cURL command
An OSS command for performing data communication that is compatible with various protocols. In this manual it is used for executing K5 IaaS APIs using HTTPS communication
Command options used in this manual
| Options | Explanation |
|---|---|
| -s | Specify this to prevent display of the progress of communication or command syntax errors. |
| -S | Specify this to display command syntax errors when the "-s" option is specified. |
| -i | Specify this to display the HTTP headers of responses. |
| -H | Specify this to use HTTP headers in requests. |
| -X | Specify the request method. |
| -d | Specify the data to send as the request body. |
| --cert | Specify the client certificate to use for client authentication. |
| --key | Specify the private key corresponding to the client certificate used for client authentication. |
jq command
An OSS command used to operate JSON format data from the command line. In this manual it is used to add line feeds to the JSON data contained in response bodies and display the data clearly.
No command options are used in this manual.
Openssl command
An OSS command for encryption related operations, such as the creation and format conversion of the client certificates used in encryption. In this manual it is used to convert the format of the K5 client certificate used in client authentication.
Command options used in this manual
| Options | Explanation |
|---|---|
| x509 | Specify this to operate X.509 format client certificates. Formats such as PEM and DER are included in the X.509 format. |
| pkcs12 | Specify this to operate PKCS#12 format client certificates. |
| rsa | Specify this to operate private keys. |
| -in | Specify this to indicate the client certificate that is the target of operation |
| -out | Specify the name of the output file when performing format conversion, etc. |
| -clcerts | Specify this when converting a PKCS#12 format client certificate to a PEM format client certificate. |
| -nokeys | Specify this when extracting a private key from a PKCS#12 client certificate. |
| -nodes | Specify this when not performing encryption using a passphrase when extracting a private key from a PKCS#12 format client certificate. |
| -modulus | Specify this to display the information necessary to confirm the consistency of a client certificate and a private key. |
| -noout | Specify this when not outputting a file during operation of a client certificate or private key. |