証明書ベースのセキュリティを必要とする API にリクエストを送信する際に認証を有効にするため、Apidog で証明書を追加および管理できます。これは、相互 TLS(mTLS)またはカスタム認証局を使用する API に接続するために不可欠です。証明書認証について#
相互 TLS(mTLS) は、クライアントとサーバーの両方が証明書で自身の身元を確認する必要がある認証方法です。双方の身元が確認されると、暗号化された 接続が確立されます。これにより、従来の一方向 TLS よりも強力なセキュリティが提供されます。カスタム CA 証明書 を使用すると、内部証明書レジストリに登録された証明書を使用するエンドポイントに接続できます。CA 証明書を追加しない場合、Apidog から送信されたリクエストは「SSL Error: Self signed certificate」で失敗します。証明書の管理#
Apidog の設定では、インストール済みの証明書の表示、新しい証明書の追加、または証明書の削除を行えます。CA 証明書の追加#
カスタム認証局を使用する API にリクエストを送信する際の「self signed certificate」エラーを回避するには、CA 証明書を Apidog に追加します。1
CA Certificates の横にあるトグルをオンにします。
PEM ファイルには複数の CA 証明書を含めることができます。Apidog はファイル内のすべての証明書を読み込みます。
クライアント証明書の追加#
相互 TLS 認証を使用する API にリクエストを送信するには、クライアント証明書を Apidog に追加します。2
証明書の
Host ドメインを入力します(プロトコルは含めないでください)。
Host フィールドはパターンマッチングをサポートしています。*.example.com と入力すると、すべての example.com サブドメインに同じクライアント証明書が使用されます。
3
(任意)ドメインに関連付けるカスタムポート番号を入力します。ポートを指定しない場合、Apidog はデフォルトの HTTPS ポート(443)を使用します。
4
証明書ファイルを選択します。
オプション 1: 証明書の CRT ファイル と Key ファイル を選択します
オプション 2: 証明書の PFX ファイル を選択します
5
クライアント証明書の生成時にパスフレーズを使用した場合は、ボックスに入力します。それ以外の場合は、ボックスを空のままにします。
各クライアント証明書はドメインに固有です。同じドメインに複数の証明書を追加しないでください。ドメインに複数の証明書を追加した場合、Apidog は最後に追加された証明書を使用するため、予期しない動作が発生する可能性があります。
証明書の編集#
証明書は追加後に編集できません。変更するには、次の手順を実行します。証明書の削除#
Apidog からリクエストを送信するために証明書が不要になった場合は、証明書を削除します。| 証明書タイプ | 削除方法 |
|---|
| CA 証明書 | 証明書の横にある削除アイコン(Close icon)を選択します |
| クライアント証明書 | 証明書の横にある削除アイコン(Delete icon)を選択します |
証明書の使用#
クライアント証明書を追加した後、Apidog でその証明書を使用するために追加の手順を実行する必要はありません。設定済みのドメインに HTTPS リクエストを行うと、Apidog はリクエストとともにクライアント証明書を自動的に送信します
証明書は OpenSSL の処理を使用して送信されます
HTTP リクエストを行った場合、Apidog は証明書を送信しません。証明書は HTTPS 接続でのみ送信されます。