SteampipeとPowerpipeの役割分担

Powerpipe は、Steampipe と同じ Turbot 社のオープンソースのツールだ。以前は Steampipe 自体にベンチマークとダッシュボードの機能があったが、Steampipe v0.22 からはその役割が Powerpipe に移り、現在は次のように分担している。

SteampipePowerpipe
役割AWS の情報を SQL で取れるようにする(データの取得元)SQL を実行してチェックし、結果を表示・出力する
動かし方サービスとして常駐させる(PART 02)Steampipe のデータベースに接続して SQL を流す
中身プラグイン(テーブルの定義)mod(チェックとダッシュボードの定義)

Powerpipe で使う用語は4つだけ覚えておけばよい。

  • mod:チェックやダッシュボードをまとめたパッケージ。GitHub で公開されていて、powerpipe mod install で入れる
  • control(コントロール):1つのチェック項目。中身は SQL で、リソースごとに「ok」「alarm」などの判定を返す
  • benchmark(ベンチマーク):コントロールを章立てでまとめたもの。CIS などの基準1つが1つのベンチマークになる
  • dashboard(ダッシュボード):グラフや表をまとめた画面。ブラウザで見る

この回で使う AWS Compliance mod には、CIS AWS Foundations Benchmark、AWS Foundational Security Best Practices、PCI DSS、NIST などのベンチマークが含まれる。CIS は v1.2.0 から最新の v6.0.0 までそろっている(記事作成時点の mod は v1.13.1)。

Powerpipeを入れる

Powerpipe も Linux 用なので、Steampipe と同じ WSL2 の Ubuntu に入れる。インストールは公式のスクリプトで行う。

WSL(bash)
sudo /bin/sh -c "$(curl -fsSL https://powerpipe.io/install/powerpipe.sh)"
powerpipe --version
出力例
Powerpipe v1.5.6

次に、作業用のフォルダーを作り、mod を入れる。powerpipe mod init でフォルダーに mod.pp(このフォルダー自体の mod の定義)ができ、mod install で AWS Compliance mod が依存関係として追加される。mod の本体はフォルダー内の .powerpipe/mods に置かれる。

WSL(bash)
mkdir -p ~/powerpipe-aws && cd ~/powerpipe-aws
powerpipe mod init
powerpipe mod install github.com/turbot/steampipe-mod-aws-compliance

Powerpipe はデータの取得元として Steampipe のデータベースに接続するので、Steampipe をサービスとして起動しておく。複数アカウントを aggregator でまとめている場合は、PART 06 のとおり default.spc に search_path_prefix = "aws_all" を書いておくと、全アカウントがチェックの対象になる。

WSL(bash)
steampipe service start --database-listen local

⚠️ IAM のチェックの前に認証情報レポートを作っておく

CIS の IAM の章には、IAM の認証情報レポートを読むコントロール(未使用の認証情報・MFA の有無など)が含まれる。レポートがまだ作られていないと、これらのコントロールは error になる。事前に PowerShell で aws iam generate-credential-report --profile dev を実行しておく(レポートの作成には数秒〜数十秒かかる)。

CISベンチマークを実行する

入っているベンチマークは powerpipe benchmark list で確認できる。CIS だけを見たいなら grep で絞る。

WSL(bash)
cd ~/powerpipe-aws
powerpipe benchmark list | grep cis_v

最新の CIS v6.0.0 を実行する。対象のアカウントとリージョン、コントロールの数によるが、数分かかる。

WSL(bash)
powerpipe benchmark run aws_compliance.benchmark.cis_v600

全体を流す前に、まず1つの章だけで動作を確かめるのもよい。章や個々のコントロールにも名前が付いている。

実行したい範囲コマンド
CIS v6.0.0 全体powerpipe benchmark run aws_compliance.benchmark.cis_v600
2章(IAM)だけpowerpipe benchmark run aws_compliance.benchmark.cis_v600_2
2.13(アクセスキーを90日以内にローテーション)だけpowerpipe control run aws_compliance.control.cis_v600_2_13
レベル1の項目だけpowerpipe benchmark run aws_compliance.benchmark.cis_v600 --tag cis_level=1
実行せずに対象のコントロールを確認powerpipe benchmark run aws_compliance.benchmark.cis_v600 --dry-run

v6.0.0 の章立ては、2章 IAM、3章 ストレージ(S3・RDS・EFS)、4章 ログ、5章 モニタリング、6章 ネットワーク(EC2)となっている。

結果の読み方

実行すると、コントロールごとに判定の件数と、リソースごとの判定・理由が表示される。判定は次の5種類だ。

判定意味対応
ok基準を満たしているなし
alarm基準を満たしていない理由(reason)を見て是正するか、例外として扱うかを決める
skipチェックの対象外(無効化されたアクセスキーなど)なし
info判定せず情報だけ表示(root ユーザーなど自動で判定できないもの)人が確認する
errorSQL の実行に失敗した(権限不足・認証情報レポートがないなど)エラー内容を見て権限などを直す

まず見るべきは alarm と error だけ、という場合は --output brief を付けると、それ以外の行が省かれて読みやすい。

判定の中身は、ただの SQL だ。たとえば 2.13 のコントロールが実行している SQL は、次のような形になっている(mod のソースから抜粋し、一部を省略)。

AWS Compliance mod:iam_user_access_key_age_90 の SQL(抜粋)
select
  'arn:' || partition || ':iam::' || account_id || ':user/' || user_name
    || '/accesskey/' || access_key_id as resource,
  case
    when status <> 'Active' then 'skip'
    when create_date <= (current_date - interval '90' day) then 'alarm'
    else 'ok'
  end as status,
  user_name || ' ' || access_key_id || ' created '
    || to_char(create_date, 'DD-Mon-YYYY') as reason
from
  aws_iam_access_key;

resource(対象)・status(判定)・reason(理由)の3列を返す SELECT 文であることがわかる。つまり、判定に納得がいかないときは、この SQL を steampipe query でそのまま実行して確かめられる。PART 03〜05 で書いてきたクエリと地続きなのが、Powerpipe の分かりやすいところだ。

💡 alarm があると終了コードが 0 以外になる

powerpipe benchmark run は、alarm や error があると 0 以外の終了コードで終わる。定期実行のスクリプトで「問題があったときだけ通知する」といった分岐に使える。

結果をHTMLやCSVに出す

結果を共有するときは、--export でファイルに出力する。形式はファイルの拡張子で決まり、複数指定できる。Windows から開けるように、出力後に /mnt/c へコピーする。

WSL(bash)
cd ~/powerpipe-aws
d=$(date +%Y%m%d)
powerpipe benchmark run aws_compliance.benchmark.cis_v600 \
  --export "cis_v600_${d}.html" --export "cis_v600_${d}.csv" \
  --output none --progress=false

cp cis_v600_${d}.* /mnt/c/Users/taro/Documents/

--output none は、画面への表示を止めるオプションだ。出力できる主な形式を挙げておく。

形式(拡張子)中身・用途
html章ごとの集計と詳細を1ページにまとめたレポート。ブラウザで開いてそのまま共有できる
csv1行1判定の表。Excel で絞り込んだり、前回と比べたりするのに使う(日本語を含むなら PART 04 の BOM の扱いに注意)
mdMarkdown のレポート。Wiki などに貼る
json章立てを保った JSON。他のプログラムで処理する
asffAWS Security Hub の検出結果の形式(AWS のコントロールのみ)

ダッシュボードをWindowsのブラウザで見る

コマンドの出力ではなく画面で見たいときは、Powerpipe のサーバーを起動する。

WSL(bash)
cd ~/powerpipe-aws
powerpipe server

起動したら、Windows のブラウザで http://localhost:9033 を開く。WSL2 の localhost は Windows からそのまま使えるので、特別な設定はいらない。ベンチマークを選ぶと、章ごとの判定がグラフと表で表示され、各行から理由とリソースを確認できる。止めるときは WSL のターミナルで Ctrl+C を押す。

  • サーバーは既定で自分の PC からの接続だけを受け付ける(--listen local)。他の PC から見せたい場合は --listen network にするが、AWS の情報が見えることに注意する
  • ポートを変えるときは --port 9034 のように指定する
  • リソースの一覧や構成を見るダッシュボードが欲しい場合は、AWS Insights mod(powerpipe mod install github.com/turbot/steampipe-mod-aws-insights)も入れると、EC2・S3・IAM などのサービスごとのダッシュボードが追加される

独自のチェックを足す

社内のルール(「すべての EC2 に Owner タグを付ける」など)も、コントロールとして書けば同じ仕組みでチェックできる。~/powerpipe-aws に拡張子 .pp のファイルを置くだけだ。

~/powerpipe-aws/my_rules.pp
benchmark "my_rules" {
  title    = "社内ルール"
  children = [
    control.ec2_has_owner_tag,
    control.ebs_volume_attached
  ]
}

control "ec2_has_owner_tag" {
  title = "EC2インスタンスに Owner タグが付いている"
  sql   = <<-EOQ
    select
      arn as resource,
      case when tags ? 'Owner' then 'ok' else 'alarm' end as status,
      title || ' の Owner タグ: ' || coalesce(tags ->> 'Owner', '未設定') as reason,
      account_id,
      region
    from
      aws_ec2_instance
    where
      instance_state <> 'terminated'
  EOQ
}

control "ebs_volume_attached" {
  title = "EBSボリュームがEC2にアタッチされている"
  sql   = <<-EOQ
    select
      arn as resource,
      case when state = 'in-use' then 'ok' else 'alarm' end as status,
      volume_id || ' (' || size || 'GiB) の状態: ' || state as reason,
      account_id,
      region
    from
      aws_ebs_volume
  EOQ
}
WSL(bash)
cd ~/powerpipe-aws
powerpipe benchmark run my_rules

書き方のルールは、resource・status・reason の3列を返すこと、status は ok・alarm・skip・info・error のいずれかにすることの2つだけだ。それ以外の列(ここでは account_id と region)は、結果の補足情報(ディメンション)として表示される。powerpipe server を起動していれば、保存した時点でダッシュボードにも 社内ルール が現れる。

PART 04 の「タグ漏れを探すクエリ」や、PART 08 の逆引き SQL も、この形に書き直せばベンチマークに組み込める。毎回人が SQL を流して確認していたものを、判定付きのチェックとして残せるのが、Powerpipe を使う一番の利点だと思う。

✅ 次の記事では…

最終回の PART 08 では、AWS プラグインの主なテーブルを目的別に一覧にし、boto3 シリーズの付録と同じお題で逆引き SQL をまとめる。

→ PART 08 — 付録:Steampipeで取れる情報一覧と逆引きSQLへ