本書で使用するコマンド

本書に記載しているコマンドとコマンドオプションの概要を説明します。

本書に記載しているコマンドの取り扱い

本書の執筆にあたっては本サービス のAPI を利用する上で複数のOSS コマンド を使用して動作確認を実施しておりますが、本書に記載したOSS コマンド自体をサポートするものではありません。

下記のOSS コマンド説明に記載しているオプション以外を利用する場合は、ユーザーの責任において調査の上、ご利用ください。

本書で記載しているコマンド例は「bash」で実行することを想定しています。

cURL コマンド

さまざまなプロトコルに対応したデータ通信を行うOSS コマンドです。本書ではHTTPS 通信によるAPI 実行のために使用しています。

本書で使用しているコマンドオプション

オプション 説明
-s 通信の進捗状況やコマンド構文エラーの表示を抑止する場合に指定します。
-S 「-s」オプションを利用する際、コマンド構文エラーを表示する場合に指定します。
-i レスポンスのHTTPヘッダーを表示する場合に指定します。
-H リクエストに使用するHTTPヘッダーを指定します。
-X リクエストメソッドを指定します。
-d リクエストボディとして送信するデータを指定します。
--cert クライアント認証で使用するクライアント証明書を指定します。
--key クライアント認証で使用するクライアント証明書に対応する秘密鍵を指定します。

jq コマンド

コマンドラインからJSON 形式のデータを操作するOSS コマンドです。本書ではレスポンスボディに含まれるJSON データに改行などを加え、整形して表示するために使用しています。

本書ではコマンドオプションを使用していません。

Openssl コマンド

暗号化に使用する証明書の作成や形式変換など、暗号化関連の操作が行えるOSS コマンドです。本書ではクライアント認証に使用する本サービスのクライアント証明書の形式変換に使用しています。

本書で使用しているコマンドオプション

オプション 説明
x509 X.509形式の証明書を操作するために指定します。X.509形式の証明書にはPEM,DERなどの形式が含まれます。
pkcs12 PKCS#12形式の証明書を操作するために指定します。
rsa 秘密鍵を操作するために指定します。
-in 操作対象の証明書を指定します。
-out 形式変換などを行う場合に出力ファイル名を指定します。
-clcerts PKCS#12形式のクライアント証明書からPEM形式のクライアント証明書に変換する場合に指定します。
-nokeys PKCS#12形式のクライアント証明書から秘密鍵のみ抽出する場合に指定します。
-nodes PKCS#12形式のクライアント証明書から秘密鍵を抽出する際、パスフレーズによる暗号化を実施しない場合に指定します。
-modulus 証明書と秘密鍵の整合性確認において必要な情報を表示するために指定します。
-noout 証明書や秘密鍵の操作においてファイルを出力しない場合に指定します。