TlsSettings interface

パッケージ:

@azure/core-rest-pipeline

TLS 認証の証明書を表します。

プロパティ

ca	必要に応じて、信頼された CA 証明書をオーバーライドします。 既定では、Mozilla によってキュレーションされた既知の CA を信頼します。 このオプションを使用して CA が明示的に指定されている場合、Mozilla の CA は完全に置き換えられます。
cert	PEM 形式の証明書チェーン。 秘密キーごとに 1 つの証明書チェーンを指定する必要があります。 各証明書チェーンは、提供された秘密キーの PEM 形式の証明書で構成され、その後に PEM 形式の中間証明書 (存在する場合) が順に構成され、ルート CA は含まれません (ルート CA はピアに事前に認識されている必要があります。ca を参照)。 複数の証明書チェーンを提供する場合、キー内の秘密キーと同じ順序にする必要はありません。 中間証明書が指定されていない場合、ピアは証明書を検証できず、ハンドシェイクは失敗します。
key	PEM 形式の秘密キー。 PEM では、暗号化される秘密キーのオプションを使用できます。 暗号化されたキーは options.パスフレーズで暗号化解除されます。 異なるアルゴリズムを使用する複数のキーは、暗号化されていないキー文字列またはバッファーの配列、または 形式 {pem: <string|buffer>[,passphrase: <string>]}のオブジェクトの配列として提供できます。 オブジェクト フォームは array.object.パスフレーズでのみ使用できます。省略可能です。 暗号化されたキーは、指定されている場合は object.パスフレーズで暗号化解除され、そうでない場合は options.パスフレーズで暗号化が解除されます。
passphrase	1 つの秘密キーまたは PFX に使用される共有パスフレーズ。
pfx	PFX または PKCS12 でエンコードされた秘密キーと証明書チェーン。 pfx は、キーと証明書を個別に提供する代わりに使用します。 通常、PFX は暗号化され、暗号化されている場合はパスフレーズを使用して暗号化を解除します。 複数の PFX は、暗号化されていない PFX バッファーの配列、または 形式 {buf: <string|buffer>[,passphrase: <string>]}の オブジェクトの配列として提供できます。 オブジェクト フォームは array.object.パスフレーズでのみ使用できます。省略可能です。 暗号化された PFX は、指定されている場合は object.パスフレーズ、そうでない場合は options.パスフレーズで暗号化解除されます。

プロパティの詳細

ca

必要に応じて、信頼された CA 証明書をオーバーライドします。 既定では、Mozilla によってキュレーションされた既知の CA を信頼します。 このオプションを使用して CA が明示的に指定されている場合、Mozilla の CA は完全に置き換えられます。

ca?: string | Buffer | (string | Buffer)[]

プロパティ値

string | Buffer | (string | Buffer)[]

cert

PEM 形式の証明書チェーン。 秘密キーごとに 1 つの証明書チェーンを指定する必要があります。 各証明書チェーンは、提供された秘密キーの PEM 形式の証明書で構成され、その後に PEM 形式の中間証明書 (存在する場合) が順に構成され、ルート CA は含まれません (ルート CA はピアに事前に認識されている必要があります。ca を参照)。 複数の証明書チェーンを提供する場合、キー内の秘密キーと同じ順序にする必要はありません。 中間証明書が指定されていない場合、ピアは証明書を検証できず、ハンドシェイクは失敗します。

cert?: string | Buffer | (string | Buffer)[]

プロパティ値

string | Buffer | (string | Buffer)[]

key

PEM 形式の秘密キー。 PEM では、暗号化される秘密キーのオプションを使用できます。 暗号化されたキーは options.パスフレーズで暗号化解除されます。 異なるアルゴリズムを使用する複数のキーは、暗号化されていないキー文字列またはバッファーの配列、または 形式 {pem: <string|buffer>[,passphrase: <string>]}のオブジェクトの配列として提供できます。 オブジェクト フォームは array.object.パスフレーズでのみ使用できます。省略可能です。 暗号化されたキーは、指定されている場合は object.パスフレーズで暗号化解除され、そうでない場合は options.パスフレーズで暗号化が解除されます。

key?: string | Buffer | (KeyObject | Buffer)[]

プロパティ値

string | Buffer | (KeyObject | Buffer)[]

passphrase

1 つの秘密キーまたは PFX に使用される共有パスフレーズ。

passphrase?: string

プロパティ値

string

pfx

PFX または PKCS12 でエンコードされた秘密キーと証明書チェーン。 pfx は、キーと証明書を個別に提供する代わりに使用します。 通常、PFX は暗号化され、暗号化されている場合はパスフレーズを使用して暗号化を解除します。 複数の PFX は、暗号化されていない PFX バッファーの配列、または 形式 {buf: <string|buffer>[,passphrase: <string>]}の オブジェクトの配列として提供できます。 オブジェクト フォームは array.object.パスフレーズでのみ使用できます。省略可能です。 暗号化された PFX は、指定されている場合は object.パスフレーズ、そうでない場合は options.パスフレーズで暗号化解除されます。

pfx?: string | Buffer | (string | Buffer | PxfObject)[]

プロパティ値

string | Buffer | (string | Buffer | PxfObject)[]