設定ファイル
Awnexa は、データディレクトリ(既定は ./.awnexa。はじめにを参照)の
config.json から設定を読み込みます。ファイルは awnexa init が作成し、手で編集できます。
コマンドラインのオプションはファイルより優先されます。書き間違いに気づけるように、未知のキーはエラーになります。
{ "version": 1, "profile": "readonly", "regions": ["us-east-1", "ap-northeast-1"], "network": { "proxy": "http://proxy.example.com:8080", "noProxy": [".internal.example.com"], "caBundle": "corp-ca.pem" }}AWS の認証情報はここに保存しません。Awnexa は常に AWS SDK の標準の認証情報チェーン(AWS CLI と同じプロファイル、SSO セッション、環境変数)を使います。
| キー | 既定値 | 説明 |
|---|---|---|
version |
1 |
ファイルの形式 |
profile |
— | AWS プロファイル名(名前のみ) |
sample |
— | awnexa init --sample が設定する。そのディレクトリが合成したサンプルデータであることを示す。自分では設定しない |
regions |
— | スキャンするリージョン |
reportLang |
en |
--lang を指定しないときの report と snapshot diff --as markdown の言語(en か ja) |
concurrency |
4 |
API の一覧取得を並列に実行する最大数(1〜32) |
maxAttempts |
5 |
AWS API 呼び出し 1 回あたりの試行回数(1〜10) |
connectionTimeoutMs |
10000 |
接続のタイムアウト(ミリ秒) |
requestTimeoutMs |
60000 |
リクエストのタイムアウト(ミリ秒) |
detailCallLimit |
20000 |
コレクタ・リージョンごとの、リソース単位の詳細取得の上限 |
evidence.enabled |
true |
API の生のレスポンス(機密値はマスキング済み)を保存する |
evidence.maxBytes |
5242880 |
取得根拠のファイル 1 つの最大サイズ |
network.proxy |
— | HTTP(S) プロキシの URL。HTTPS_PROXY / HTTP_PROXY より優先 |
network.noProxy |
— | プロキシを通さずに接続するホスト。NO_PROXY より優先 |
network.caBundle |
— | 追加で信頼する CA 証明書の PEM ファイル。相対パスはデータディレクトリ基準 |
プロキシ環境で使う
Section titled “プロキシ環境で使う”Awnexa の通信はすべて HTTPS です。プロキシ環境では network.proxy を設定するか、AWS CLI と同じ環境変数を使います。
| 設定(先に見つかったものを使う) | 用途 |
|---|---|
network.proxy → HTTPS_PROXY → HTTP_PROXY |
プロキシ |
network.noProxy → NO_PROXY |
直接接続するホスト |
network.caBundle → AWS_CA_BUNDLE |
追加で信頼する証明書 |
小文字の変数名(https_proxy、no_proxy)も使えます。環境変数でスキームを省略した場合(proxy.example.com:8080)は http:// とみなします。プロキシを通る通信は次のとおりです。
awnexa scanの AWS API 呼び出し。AWS SDK が行うサインインの呼び出し(STS AssumeRole、IAM Identity Center / SSO)も含みます- Awnexa のバックエンドへの利用統計の送信(送信するデータ)
接続先は公式の AWS エンドポイントのままです。プロキシは通信を中継するだけで(HTTP CONNECT)、TLS は AWS まで張られます。
EC2 のインスタンスメタデータサービスと ECS の認証情報エンドポイントには常に直接接続します。
プロキシの URL
Section titled “プロキシの URL”http://proxy.example.com:8080http://user:password@proxy.example.com:8080https://proxy.example.com:8443多くの社内プロキシは http:// で指定します(AWS との通信は TLS のままです)。https:// はプロキシ自体が TLS
で接続を受け付ける場合だけ使います。認証は Basic 認証に対応しています。NTLM、Kerberos、SOCKS、PAC ファイルには対応していません。
ユーザー名やパスワードに @・:・/・%・# が含まれる場合は、その文字をパーセントエンコードします(@ → %40、
: → %3A、/ → %2F、% → %25、# → %23)。たとえばパスワード p@ss:1 は
http://alice:p%40ss%3A1@proxy.example.com:8080 になります。
noProxy
Section titled “noProxy”各要素には次のいずれかを書きます。
| 要素 | 一致するもの |
|---|---|
* |
すべてのホスト(プロキシを使わない) |
example.com、.example.com |
example.com とその配下のすべてのホスト |
10.0.0.1 |
その IP アドレス |
vpce.example.com:8443 |
そのホストのそのポートだけ |
アドレス範囲(CIDR)には対応していません。一部の AWS エンドポイントにプロキシではなく VPC
インターフェイスエンドポイント経由で接続する場合に noProxy を使います。
TLS を復号するプロキシ
Section titled “TLS を復号するプロキシ”プロキシが独自の証明書で HTTPS を復号して検査する場合は、Awnexa がその証明書を信頼する必要があります。信頼していないと、
すべての呼び出しが証明書のエラー(self-signed certificate in certificate chain など)で失敗します。
network.caBundle(または AWS_CA_BUNDLE)に、プロキシの CA 証明書を含む PEM ファイルを指定してください。
標準の信頼する証明書に追加され、置き換えはしません。Awnexa を起動する前に NODE_EXTRA_CA_CERTS を設定しても同じことができます。
うまくいかないとき
Section titled “うまくいかないとき”| 症状 | 確認すること |
|---|---|
AWS_AUTH_FAILED に (via proxy …) とタイムアウトや ECONNREFUSED |
プロキシのホスト名とポート |
ProxyAuthenticationRequired(HTTP 407) |
プロキシのユーザー名・パスワードと、そのパーセントエンコード |
| 証明書のエラー | TLS を復号するプロキシなら network.caBundle |
INVALID_PROXY |
URL が http:// か https:// で始まっているか |
INVALID_CA_BUNDLE |
ファイルが存在し、-----BEGIN CERTIFICATE----- を含むか |
プロキシが一部の AWS エンドポイントを拒否することもあります。その場合、そのサービスは awnexa coverage でコード
NonAwsResponse の failed(AWS 以外が返した HTTP エラー。IAM による拒否ではない)になります。
ネットワーク管理者に *.amazonaws.com と *.api.aws の許可を依頼してください。