CIからPubを使う
CIは、保存されたシークレットなしで、プライベートパッケージを読み取り、公開できます。各ジョブは、CIプロバイダー自身のIDトークンでどのリポジトリかを証明し、有効期間15分のPubトークンを受け取ります。
仕組み
- リポジトリをバインドする。Control Roomで「Organization」を開き、「CI access」を探します。「Bind a repository」で、どのリポジトリのCI実行がお客様の組織として動作するかを指定します。必要に応じて、特定のワークフロー、環境、ブランチからの実行だけに限定できます。バインドできるのはオーナーまたは管理者です。
- パッケージを付与する。各バインディングは、組織のCIメンバーになります。その「Packages」ボタンで、チームメンバーと同じように、読み取り、または読み取りと公開を許可するパッケージを付与します。付与がない場合は、グローバルパッケージと、組織にエンジンがあればそのエンジンを読み取るだけで、何も公開しません。バインディングを削除すると、そのメンバーと、付与されたすべての権限が削除されます。
- ジョブ内で交換する。ジョブは、オーディエンス
https://dartastic.ioのIDトークンを要求し、組織IDとともに交換エンドポイントに送信します。組織IDは同じ「Organization」画面にあります。 - Pubトークンを使う。
dart pub token addでPubトークンをdart pub getとdart pub publishに渡します(flutter pubも同様です)。
CIプロバイダー
| プロバイダー | バインドの前に |
|---|---|
| GitHub Actions | GitHub.comは最初から信頼されています。GitHub Enterprise Serverの場合は、オーナーがその発行者https://<your host>/_services/tokenを、この組織独自の発行者として追加します。 |
| GitLab CI/CD | GitLab.comは最初から信頼されています。セルフマネージドのGitLabの場合は、オーナーがそのアドレスhttps://<your host>を、この組織独自の発行者として追加します。 |
| Bitbucket Pipelines | Bitbucketのワークスペースはそれぞれ独自の発行者を持つため、まずオーナーが追加します。「CI access」の「This organization's own CI issuers」で「Bitbucket Pipelines」を選び、ワークスペースのURL名を入力します。 |
| CircleCI | CircleCIの組織はそれぞれ独自の発行者を持つため、まずオーナーが追加します。「CI access」の「This organization's own CI issuers」で「CircleCI」を選び、組織IDを入力します。 |
トークン交換
ジョブは、IDトークンをBearerトークンとして、組織IDをリクエスト本文として送信します:
shell
curl -sS --fail-with-body -X POST https://api.dartastic.io/v1/ci/exchange \
-H "Authorization: Bearer $CI_TOKEN" -H "Content-Type: application/json" \
-d '{"orgId":"<your organization id>"}'レスポンスとして、Pubトークンとその権限が返ります:
json
{
"token": "dtc_…", // the Pub token, valid for 15 minutes
"keyId": "…",
"organizationId": "<your organization id>",
"packages": ["my_package"], // what it may publish ([] when it only reads)
"packageAccess": { … }, // what it may read
"expiresAt": 1767225600 // seconds since 1970
}- 各IDトークンを交換できるのは1回だけです。交換はジョブの開始時に1回行い、Pubトークンをジョブの後続ステップのために保持してください。
- Pubトークンは、グローバルパッケージ、組織にエンジンがあればそのエンジン、CIメンバーに付与されたすべてのパッケージを読み取り、公開を許可されたパッケージを公開します。それ以外のことはできません。
- すべての交換は、リポジトリ、実行、コミットとともに、組織の「Audit Log」に記録されます。
交換が拒否された場合
拒否のレスポンスは最初に理由を示すため、ジョブのログにそのまま表示されます:
json
{"error": {"code": "permission-denied",
"message": "TRUSTED PUBLISHER REF MISMATCH: …",
"details": {"reason": "TRUSTED PUBLISHER REF MISMATCH"}}}| 理由 | 対処方法 |
|---|---|
CI EXCHANGE ORG MISSING | リクエストに組織が指定されていません。本文として{"orgId": "<your organization id>"}を送信してください。 |
CI OIDC TOKEN MISSING | リクエストにCIトークンが含まれていません。Authorization: Bearer <token>として送信してください。 |
CI OIDC AUDIENCE INVALID | トークンが別のオーディエンス向けに要求されています。スニペットと同じように、https://dartastic.io向けに要求してください。 |
CI OIDC ISSUER NOT TRUSTED | トークンの発行者は、この組織では信頼されていません。Bitbucket、CircleCI、GitHub Enterprise Server、セルフマネージドのGitLabの場合は、先にオーナーが発行者を追加します。 |
CI OIDC EXPIRED | 交換される前に、トークンの有効期限が切れました。ジョブがトークンを要求したら、すぐに交換してください。 |
CI OIDC TOKEN REPLAYED | このトークンはすでに交換されています。各トークンは1回しか交換できないため、交換はジョブごとに1回にしてください。 |
TRUSTED PUBLISHER NOT BOUND | この組織のバインディングに、ジョブのリポジトリを指定したものがありません。「CI access」でバインドし、ワークフローのorgIdを確認してください。 |
TRUSTED PUBLISHER REPOSITORY MISMATCH | バインディングが別のリポジトリまたはプロジェクトを指定しています。UUIDとIDは、そのジョブ自身のものである必要があります。 |
TRUSTED PUBLISHER WORKFLOW MISMATCH | ジョブが、バインディングで許可されたものとは別のワークフローまたはパイプラインファイルから実行されました。 |
TRUSTED PUBLISHER ENVIRONMENT MISMATCH | ジョブがバインディングの環境で実行されませんでした(CircleCIの場合は、そのコンテキストを使いませんでした)。 |
TRUSTED PUBLISHER REF MISMATCH | ジョブが、バインディングのrefパターンに一致しないブランチまたはタグで実行されました。 |
TRUSTED PUBLISHER REPOSITORY ID MISMATCH | リポジトリが削除され、同じ名前で作り直されています。バインディングを削除し、新しいリポジトリをバインドしてください。 |
TRUSTED PUBLISHER AMBIGUOUS | ジョブに一致するバインディングが複数あります。1つだけが一致するよう、ワークフロー、環境、refで絞り込んでください。 |
CI OIDC CLAIM MISSING | トークンに、プロバイダーが必ず送るクレームがありません。トークンがプロバイダー自身のCIトークンで、スニペットと同じように要求されたものか確認してください。 |
CI OIDC SSH RERUN | SSH付きで再実行されたCircleCIのジョブです。SSHなしで再実行してください。 |
CI EXCHANGE RATE LIMITED | このリポジトリまたは組織で、短時間に交換が多すぎます。交換はジョブごとに1回にし、時間をおいて再試行してください。 |
BOX STATE PUSH FAILED | レジストリが新しいトークンを受け取れませんでした。ジョブを再試行してください。 |