Network Options

NetworkOptions.ca_roots — Function
ca_roots() :: Union{Nothing, String}

ca_roots() 関数は、PEM 形式でエンコードされた認証局ルート証明書を含むファイルまたはディレクトリがある場合、その場所を呼び出し元に返します。Windows や macOS のように、組み込みの TLS エンジンがシステム標準の証明書検証機構を使ってホストを検証できるシステムでは、デフォルトでこの関数は nothing を返します。macOS を除く従来の UNIX システムでは、ルート証明書は通常 /etc 内のファイルに保存されています。現在の UNIX システムで一般的な場所を検索し、そのいずれかのパスが存在すれば、そのパスを返します。一般的なルート証明書のパスがどれも存在しない場合は、Julia に同梱されているルート証明書一式のパスを返します。

ca_roots() が返すデフォルト値は、環境変数 JULIA_SSL_CA_ROOTS_PATH、SSL_CERT_DIR、または SSL_CERT_FILE を設定することで上書きできます。この場合、この関数は、設定されている変数のうち最初のものの値を常に返します(パスが存在するかどうかは問いません)。JULIA_SSL_CA_ROOTS_PATH が空文字列に設定されている場合、ほかの変数は(未設定の場合と同様に)無視されます。ほかの変数が空文字列に設定されている場合は、未設定として扱われます。

source
NetworkOptions.ca_roots_path — Function
ca_roots_path() :: String

ca_roots_path() 関数は ca_roots() 関数と似ていますが、PEM 形式でエンコードされた認証局のルート証明書を含むファイルまたはディレクトリのパスを常に返します。Windows や macOS のように、システムのルート証明書がファイルシステムに保存されていない環境で呼び出すと、現時点では Julia に同梱されているルート証明書一式へのパスを返します。(将来的には、この関数がシステムからルート証明書を取得してファイルに保存し、そのファイルのパスを返すようになる可能性があります。)

TLS を使用するライブラリをシステム証明書で設定できる場合は、通常その方法が望ましいです。つまり、システム証明書を使用することを示す nothing を返す ca_roots() を使うほうが適切です。ca_roots_path() 関数は、ルート証明書を含むファイルまたはディレクトリのパスを必須とするライブラリを設定する場合にのみ使用してください。

ca_roots_path() が返すデフォルト値は、環境変数 JULIA_SSL_CA_ROOTS_PATH、SSL_CERT_DIR、または SSL_CERT_FILE を設定することで上書きできます。この場合、この関数は設定されている変数のうち最初のものの値を常に返します(パスが存在するかどうかは問いません)。JULIA_SSL_CA_ROOTS_PATH が空文字列に設定されている場合、ほかの変数は未設定の場合と同様に無視されます。ほかの変数が空文字列に設定されている場合は、未設定の場合と同様に扱われます。

source
NetworkOptions.ssh_dir — Function
ssh_dir() :: String

ssh_dir() 関数は、ssh プログラムが設定ファイルを保存する、または検索するディレクトリの場所を返します。デフォルトでは ~/.ssh ですが、環境変数 SSH_DIR を設定すると変更できます。

source
NetworkOptions.ssh_key_pass — Function
ssh_key_pass() :: String

ssh_key_pass() 関数は、環境変数 SSH_KEY_PASS が設定されていればその値を、設定されていなければ nothing を返します。将来的には、安全なシステムストレージなど、別の方法でパスワードを取得できるようになる可能性があります。そのため、SSH 秘密鍵の復号にパスワードを必要とするパッケージは、環境変数を直接確認するのではなく、この API を使用してください。そうすれば、こうした機能が追加された際に、自動的にその恩恵を受けられます。

source
NetworkOptions.ssh_key_name — Function
ssh_key_name() :: String

ssh_key_name() 関数は、SSH が接続時に使用する主要なファイルのベース名を返します。通常、この関数を直接呼び出す必要はありません。ライブラリでは一般に、フルパスを取得するために ssh_key_path 関数と ssh_pub_key_path 関数を使用してください。環境変数 SSH_KEY_NAME が設定されている場合、この関数はその値を返します。設定されていない場合は、デフォルトで id_rsa を返します。

source
NetworkOptions.ssh_key_path — Function
ssh_key_path() :: String

ssh_key_path() 関数は、SSH 接続に使用する SSH 秘密鍵ファイルのパスを返します。SSH_KEY_PATH 環境変数が設定されている場合は、その値を返します。設定されていない場合は、既定で次の値を返します。

joinpath(ssh_dir(), ssh_key_name())

この既定値は、SSH_DIR 環境変数と SSH_KEY_NAME 環境変数によって決まります。

source
NetworkOptions.ssh_pub_key_path — Function
ssh_pub_key_path() :: String

ssh_pub_key_path() 関数は、SSH 接続に使用する SSH 公開鍵ファイルのパスを返します。SSH_PUB_KEY_PATH 環境変数が設定されている場合は、その値を返します。設定されておらず、SSH_KEY_PATH が設定されている場合は、そのパスに .pub サフィックスを付けて返します。どちらも設定されていない場合は、次の値を返します。

joinpath(ssh_dir(), ssh_key_name() * ".pub")

このデフォルト値は、SSH_DIR 環境変数と SSH_KEY_NAME 環境変数にも依存します。

source
NetworkOptions.ssh_known_hosts_files — Function
ssh_known_hosts_files() :: Vector{String}

ssh_known_hosts_files() 関数は、SSH 接続時にリモートサーバーの身元を確認するために使用する SSH known hosts ファイルのパスをベクターで返します。デフォルトでは、この関数は次を返します。

[joinpath(ssh_dir(), "known_hosts"), bundled_known_hosts]

ここで、bundled_known_hosts は、このパッケージに同梱されている known hosts ファイルのコピーのパスです(github.com および gitlab.com の known hosts キーが含まれています)。ただし、環境変数 SSH_KNOWN_HOSTS_FILES が設定されている場合は、その値を : 文字(Windows では ;)で分割したパスのベクターを代わりに返します。このベクターの要素が空の場合は、デフォルトの known hosts パスに展開されます。

ssh_known_hosts_files() を使用するパッケージでは、ホスト名とキーの種類を照合して一致するエントリーを探し、いずれかのファイルで最初に一致したエントリーを、そのホストの確定的な身元情報として扱うのが理想的です。呼び出し元がキーの種類を照合できない場合(たとえば、キーの種類がハッシュ化されている場合)は、各ファイル内でそのホストに一致するエントリーをすべて調べることで、上記のアルゴリズムを近似しなければなりません。あるファイルに対象ホストのエントリーが存在する場合は、そのうちのいずれかが一致する必要があります。対象ホストのエントリーがそれ以前のファイルに存在しない場合に限り、呼び出し元は後続の known hosts ファイルの検索を続けるべきです。

source
NetworkOptions.ssh_known_hosts_file — Function
ssh_known_hosts_file() :: String

ssh_known_hosts_file() 関数は、SSH 接続時にリモートサーバーの識別に使用する SSH known hosts ファイルのパスを 1 つ返します。ssh_known_hosts_files が返すパスのうち、実際に存在する最初のパスを返します。複数の known hosts ファイルを参照できる呼び出し元は、代わりに ssh_known_hosts_files を使用し、その関数のドキュメントに記載されているとおり、返されたすべてのファイルからホストの一致を探してください。

source
NetworkOptions.verify_host — Function
verify_host(url::AbstractString, [transport::AbstractString]) :: Bool

verify_host 関数は、TLS や SSH などのセキュアなトランスポートで通信する際に、ホストの識別情報を検証するかどうかを呼び出し元に伝えます。url 引数には、次のいずれかを指定できます。

  1. proto:// で始まる正しい URL
  2. ssh 形式のホスト名単体、または user@ を前置したホスト名
  3. 上記の scp 形式のホスト名に、: とパスを続けたもの

いずれの場合もホスト名部分が取り出され、検証するかどうかはホスト名だけに基づいて決定されます。入力 URL のその他の情報は判断に影響しません。特に、URL のプロトコルは関係ありません(詳細は後述)。

transport 引数は、問い合わせの対象となるトランスポートの種類を示します。現在、認識される値は SSL/ssl(別名 TLS/tls)と SSH/ssh です。トランスポートを省略した場合、どのトランスポートでもホスト名を検証すべきでないときに限り、問い合わせは true を返します。

ホスト名は、transport が指定されているかどうか、およびその値に応じて、該当する環境変数内のホストパターンと照合されます。

  • JULIA_NO_VERIFY_HOSTS — すべてのトランスポートで検証しないホスト
  • JULIA_SSL_NO_VERIFY_HOSTS — SSL/TLS で検証しないホスト
  • JULIA_SSH_NO_VERIFY_HOSTS — SSH で検証しないホスト
  • JULIA_ALWAYS_VERIFY_HOSTS — 常に検証するホスト

これらの各変数の値は、ホスト名パターンをカンマで区切ったリストです。パターンの構文は次のとおりです。各パターンは . で分割され、各部分は次のいずれかでなければなりません。

  1. ASCII の英字、数字、ハイフン、アンダースコアのいずれか1文字以上からなるドメイン名のリテラル要素(厳密には正規のホスト名の構成要素ではありませんが、使われることがあります)。リテラル要素は、それ自体にのみ一致します。
  2. 0個以上のドメイン名要素に一致する **
  3. 任意の1つのドメイン名要素に一致する *

これらの変数に含まれるパターンリストとホスト名を照合する際、ホスト名は . で分割され、その要素の並びがパターンと照合されます。リテラルパターンは、値が完全に一致するホスト名要素1つに一致します。* パターンは、値を問わずホスト名要素1つに一致します。** パターンは、任意の数のホスト名要素に一致します。たとえば、次のようになります。

  • ** は、すべてのホスト名に一致します。
  • **.org は、.org トップレベルドメイン内のすべてのホスト名に一致します。
  • example.com は、ホスト名が example.com と完全に一致する場合にのみ一致します。
  • *.example.com は api.example.com に一致しますが、example.com や v1.api.example.com には一致しません。
  • **.example.com は、example.com 配下のすべてのドメインに一致します。example.com 自体に加え、api.example.com や v1.api.example.com も含まれます。
source