# バッチ設計書 40-generate-sbom-prep.sh

## 概要

本ドキュメントは、SBOM生成準備バッチ `generate-sbom-prep.sh` の設計仕様を記載したものです。このバッチは、Software Bill of Materials（SBOM）生成のための準備処理を行い、Azure DevOpsパイプラインで使用するアーティファクト名を設定します。

### 本バッチの処理概要

このバッチは、CI/CDパイプラインでSBOM（ソフトウェア部品表）を生成する前の準備処理として、成果物ディレクトリの作成とアーティファクト名の正規化を行います。

**業務上の目的・背景**：現代のソフトウェアサプライチェーンセキュリティでは、SBOMの生成が重要視されています。SBOMは、ソフトウェアに含まれる全てのコンポーネント（依存関係、ライブラリ等）を一覧化したもので、脆弱性管理やライセンスコンプライアンスに活用されます。本バッチは、1ES（One Engineering System）テンプレートと統合するために、適切なディレクトリ構造とアーティファクト名を準備します。

**バッチの実行タイミング**：Azure DevOps CI/CDパイプラインのSBOM生成フェーズの前に実行されます。

**主要な処理内容**：
1. pipeline-logging-functions.shの読み込み
2. 環境変数からステージ名とジョブ名を取得してアーティファクト名を生成
3. 特殊文字を安全な文字（アンダースコア）に置換
4. SBOM生成用ディレクトリの作成
5. ARTIFACT_NAME環境変数の設定とAzure DevOpsへの通知

**前後の処理との関連**：SBOM生成ツール（1ESテンプレート）の前処理として実行され、生成されたディレクトリとアーティファクト名がSBOMツールで使用されます。

**影響範囲**：ファイルシステム（ディレクトリ作成）、環境変数（ARTIFACT_NAME）、Azure DevOps変数。

## バッチ種別

CI/CD / SBOM準備処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | CI/CDパイプライン実行時 |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | Azure DevOpsパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| SYSTEM_STAGENAME | Azure DevOpsのステージ名が設定されていること |
| AGENT_JOBNAME | Azure DevOpsのジョブ名が設定されていること |
| pipeline-logging-functions.sh | 同一ディレクトリにスクリプトが存在すること |

### 実行可否判定

Azure DevOpsパイプライン環境で実行されることを前提としています。必要な環境変数が設定されていない場合は動作が不定になります。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| $1 (manifest_dir) | string | Yes | - | SBOMマニフェストの出力先ディレクトリ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| SYSTEM_STAGENAME | 環境変数 | Azure DevOpsステージ名 |
| AGENT_JOBNAME | 環境変数 | Azure DevOpsジョブ名 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ARTIFACT_NAME | 環境変数 | 正規化されたアーティファクト名 |
| Azure DevOps変数 | パイプライン変数 | ARTIFACT_NAME変数 |
| SBOMディレクトリ | ディレクトリ | $manifest_dir/$safe_artifact_name |
| 終了コード | 数値 | 0: 成功 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ディレクトリパス | $manifest_dir/{STAGENAME}_{JOBNAME}_SBOM |
| 特殊文字置換 | `/:<>\|?@*$ ` → `_` |

## 処理フロー

### 処理シーケンス

```
1. スクリプトパス解決
   └─ シンボリックリンクを解決して実際のスクリプトパスを取得

2. pipeline-logging-functions.sh読み込み
   └─ パイプラインログ関数をインポート

3. アーティファクト名生成
   ├─ artifact_name = SYSTEM_STAGENAME + "_" + AGENT_JOBNAME + "_SBOM"
   └─ 特殊文字を "_" に置換してsafe_artifact_name生成

4. マニフェストディレクトリ取得
   └─ 引数$1をmanifest_dirとして使用

5. SBOMディレクトリ作成
   └─ $manifest_dir/$safe_artifact_name を作成
      ├─ 存在しない場合: mkdir -p で作成
      └─ 存在する場合: エラー出力

6. 環境変数設定
   ├─ ARTIFACT_NAME環境変数をexport
   └─ Azure DevOpsパイプライン変数として設定（##vso[task.setvariable]）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[スクリプトパス解決]
    B --> C[pipeline-logging-functions.sh読込]
    C --> D[artifact_name生成]
    D --> E[特殊文字置換]
    E --> F[manifest_dir取得]
    F --> G[sbom_generation_dir設定]
    G --> H{ディレクトリ存在?}
    H -->|No| I[mkdir -p]
    I --> J[成功メッセージ]
    H -->|Yes| K[エラー出力]
    J --> L[ARTIFACT_NAME表示]
    K --> L
    L --> M[環境変数export]
    M --> N[Azure DevOps変数設定]
    N --> O[exit 0]
```

## データベース操作仕様

### 操作別データベース影響一覧

本バッチはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 警告 | SBOMディレクトリが既に存在する | 既存ディレクトリの削除または別のパスを指定 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

ディレクトリ作成に失敗した場合は、Write-PipelineTelemetryErrorでAzure DevOpsパイプラインにエラーが通知されます。ディスク容量や権限を確認してください。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回 |
| 目標処理時間 | 1秒以内 |
| メモリ使用量上限 | 最小限 |

## 排他制御

なし。CI/CDパイプラインでは通常、ジョブごとに異なるディレクトリが使用されます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | ディレクトリ作成成功時 | "Sbom directory created." + パス |
| 情報ログ | アーティファクト名処理時 | "Artifact name before : " + 変換前名 |
| 情報ログ | アーティファクト名処理時 | "Artifact name after : " + 変換後名 |
| エラーログ | ディレクトリ作成失敗時 | "Unable to create sbom folder." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| Write-PipelineTelemetryError | 発生時 | Azure DevOpsパイプライン |

## 備考

### 特殊文字置換パターン
以下の文字がアンダースコア（_）に置換されます：
- `/` (スラッシュ)
- `:` (コロン)
- `<` (小なり)
- `>` (大なり)
- `\` (バックスラッシュ)
- `|` (パイプ)
- `?` (クエスチョン)
- `@` (アットマーク)
- `*` (アスタリスク)
- `$` (ドルマーク)
- ` ` (スペース)
- `"` (ダブルクォート)

### Azure DevOpsパイプライン統合
- `##vso[task.setvariable variable=ARTIFACT_NAME]` コマンドでパイプライン変数を設定
- 後続のタスクでARTIFACT_NAME変数を参照可能

### 1ESテンプレートとの統合
- 1ESテンプレートは独自のSBOMを生成する可能性があるため、サブディレクトリを使用
- $manifest_dir直下ではなく$manifest_dir/$safe_artifact_nameに出力
