認証

サーバーとやり取りするには、CLI はベアラートークン認証を使用してリクエストを認証する必要があります。CLI は、ユーザーとして、アカウントとして、または OIDC トークンを使用して認証することをサポートしています。

ユーザーとして#

マシン上でローカルに CLI を使用する場合は、ユーザーとして認証することをお勧めします。ユーザーとして認証するには、次のコマンドを実行する必要があります。

bash

tuist auth login

このコマンドを実行すると、Web ベースの認証フローが進みます。認証が完了すると、CLI は長寿命のリフレッシュトークンと短命のアクセストークンを ~/.config/tuist/credentials に保存します。ディレクトリ内の各ファイルは、認証対象のドメインを表しており、デフォルトでは tuist.dev.json になります。このディレクトリに保存される情報は機密性が高いため、安全に保管してください。

CLI はサーバーへのリクエスト時に自動的に資格情報を参照します。アクセストークンの有効期限が切れている場合、CLI はリフレッシュトークンを使用して新しいアクセストークンを取得します。

Note

組織でシングルサインオンを使用している場合は、ブラウザでエンタープライズログインオプションを選択し、職場のメールアドレスを入力してください。Tuist は、既存の組織メンバーシップまたは検証済みのログインメールドメインからプロバイダーを検出できます。

OIDC トークン#

OpenID Connect (OIDC) をサポートする CI 環境の場合、Tuist は長寿命のシークレットを管理する必要なく自動的に認証できます。サポートされている CI 環境で実行されると、CLI は OIDC トークンプロバイダーを自動的に検出し、CI が提供するトークンを Tuist のアクセストークンと交換します。

サポートされているプロバイダー#

Tuist は以下の CI プロバイダーを認識し、リポジトリ接続を通じてそのトークンをプロジェクトにマッピングします。

GitHub Actions
CircleCI
Bitrise

OpenID Connect トークンを発行する他のあらゆるアイデンティティプロバイダーは、アカウント内の現在および将来のすべてのプロジェクトに対して一度設定するワークロードアイデンティティ信頼ポリシーを介して認証できます。例: Fly.io Machines。

OIDC 認証の設定#

GitHub Actions、CircleCI、および Bitrise の場合:

リポジトリを Tuist に接続: GitHub 統合ガイドに従って、GitHub リポジトリを Tuist プロジェクトに接続します。
tuist auth loginを実行: CI ワークフローで、認証が必要なコマンドの前に tuist auth login を実行します。CLI は CI 環境を自動的に検出し、OIDC を使用して認証します。

プロバイダー固有の設定例については、継続的インテグレーションガイドを参照してください。

ワークロードアイデンティティ信頼ポリシー#

信頼ポリシーを使用すると、デプロイメントプラットフォーム、Kubernetes クラスター、またはセルフマネージド CI システムなど、別のアイデンティティプロバイダーからのワークロードが、長寿命の Tuist シークレットなしでプロジェクトにアクセスできるようになります。プロバイダーは以下の条件を満たす必要があります。

パブリックアドレスで HTTPS 経由で到達可能であること。Tuist はリダイレクトを追跡せず、セルフホストされた Tuist サーバーからのものであっても、プライベートまたは内部ネットワークアドレスには接続しません。
非対称鍵（例: RS256 または ES256）で署名された JWT を発行すること。署名されていないトークンや共有シークレット（HS256 など）で署名されたトークンは拒否されます。
署名鍵を固定された HTTPS URL で JSON Web Key Set (JWKS) として公開すること。レスポンスは最大 64 KiB で、最大 20 個の鍵を含む必要があります。
すべてのトークンに有効期限 (exp) を含めること。

GitHub Actions、CircleCI、および Bitrise の発行者は、上記のリポジトリベースのフロー用に予約されており、信頼ポリシーでは使用できません。

Note

セルフホスト環境でのロールアウトを行う場合は、ワークロードアイデンティティを設定したりジョブを移行したりする前に、データベースマイグレーションを適用し、稼働中のすべての Tuist サーバーレプリカをアップグレードしてください。その後、CLI または Elixir 統合を TUIST_OIDC_TOKEN および TUIST_OIDC_ACCOUNT をサポートするバージョンにアップグレードします。既存の GitHub Actions、CircleCI、および Bitrise ジョブはリポジトリベースの認証を引き続き使用するため、アカウントハンドルは不要です。本番ジョブを切り替える前に、意図したワークロードで短命トークンの交換とキャッシュ操作を確認してください。新しい交換を停止するには、ポリシーを削除してください。すでに発行された Tuist アクセストークンの有効期限が切れるまで、最大 1 時間かかります。ポリシーを削除しても、これらのトークンは直ちに取り消されません。

ポリシーの作成#

Tuist ダッシュボードで、アカウントの設定 > 認証を開き、ワークロードアイデンティティ セクションを見つけます。アカウント管理者（または個人アカウントの所有者）である必要があります。各アカウントには最大 20 のポリシーを設定できます。アカウント全体の CI アクセスのためにアイデンティティを一度設定します。プロジェクトの選択は不要です。

ワークロードアイデンティティ の横にあるスイッチを使用して、ポリシーフォームを開きます。アカウントに保存されたアイデンティティがある場合、スイッチはオンになり、保存後もオンのままになります。アイデンティティがないアカウントの場合、スイッチはオフから始まります。組織の場合、このセクションは SCIM プロビジョニング の下に表示されます。フォームを非表示にしても下書きは保持され、ワークロード認証は無効になりません。保存されたアイデンティティカードとセットアップドキュメントへのリンクは表示されたままです。各カードには、アイデンティティの名前、発行者および JWKS URL、オーディエンス、正確な JSON クレーム、アカウント全体のスコープ、および作成時刻が表示されます。カード上のアクションを使用してアイデンティティを削除します。

以下のフィールドを入力するには カスタムプロバイダー を選択するか、組織のスラッグおよび数値の組織 ID とアプリケーション ID から生成するには Fly.io Machines を選択します。Fly テンプレートは、生成された発行者、JWKS URL、およびクレームを 詳細設定 で編集可能な状態に保ちます。テンプレートまたはヘルパー値を変更しても、手動で編集したフィールドは保持されます。発行者、JWKS URL、またはクレームがテンプレートを上書きする場合、Tuist は 詳細設定 を展開し、警告を表示して、保存されるポリシーを確認できるようにします。Fly ヘルパーを使用せずに続行するには、カスタムプロバイダー に戻ります。テンプレートは構成を入力するだけであり、Tuist がトークンを検証する方法を変更しません。

フィールド	説明
名前	ポリシーを識別するためのラベル。アカウント内で一意である必要があります。
発行者 URL	トークンの `iss` クレーム。末尾のスラッシュを含め、完全に一致する必要があります。
JWKS URL	プロバイダーの署名鍵の HTTPS URL。Tuist はこの URL を直接使用し、プロバイダーの OpenID Connect ディスカバリードキュメントを読み取らないため、`jwks_uri` をプロバイダーのドキュメントまたは `<issuer>/.well-known/openid-configuration` からコピーしてください。
オーディエンス	トークンが発行されるべきオーディエンス。デフォルトは `tuist` です。トークンの `aud` はこれと等しいか、`aud` がリストの場合はこれを含んでいる必要があります。他のサービス用に発行されたトークンがここで再利用されないよう、Tuist だけが受け入れる値を使用してください。
クレーム	トークンに含まれる必要がある 1〜10 個のクレームを持つ JSON オブジェクト。例: `{"sub": "system:serviceaccount:ci:builder"}`。JSON 入力は 8 KiB に制限されます。値は文字列、符号付き 64 ビット整数、またはブール値である必要があり、型を含めて完全に一致する必要があります。`"123"` は `123` と一致しません。ネストされたオブジェクト、リスト、および `iss`、`aud`、`exp`、`nbf`、`iat`、`jti` などの時間またはトークンに関するクレームは許可されません。

各ポリシーは、個別のプロジェクトを選択することなく、アカウントが所有する現在および将来のすべてのプロジェクト への CI アクセスを付与します。最初のプロジェクトを作成する前にアイデンティティを設定できます。これはアカウント管理や他のアカウントへのアクセスを付与するものではありません。

一致するクレームを持つトークンを取得できるすべてのワークロードは、それらのプロジェクトすべてにアクセスできるため、プロバイダーが保証し、誰も再利用できないクレームを選択してください。削除後に名前変更や再登録が可能な名前よりも、安定した数値 ID を優先してください。

Warning

共有アイデンティティプロバイダーでは、ポリシーを組織またはテナント および 対象のアプリケーション、プロジェクト、またはサービスアカウントにバインドしてください。main のようなブランチ名、production のような環境、または一般的なロールだけではアイデンティティの境界にはなりません。別のテナントが同じ値を持つトークンを取得する可能性があります。例えば、GitLab.com ポリシーには、ref だけでなく、対象プロジェクトの安定した project_id を含める必要があります。一致するトークンは、キャッシュ書き込みを含むアカウント全体の CI アクセスを付与するため、無関係なワークロードを信頼するポリシーはキャッシュポイズニングを許容する可能性があります。

Tuist は、発行者、オーディエンス、有効期限、not-before 時刻（最大 60 秒の時計ずれあり）、およびすべてのクレームを確認した後、トークンに署名した鍵を独自の JWKS URL が保持しているポリシーに対してのみアクセスを付与します。発行された 1 時間有効の CI トークンはアカウント全体を対象とし、プロジェクト ID のスナップショットではありません。発行後にアカウントで作成または転送されたプロジェクトも含まれます。プロジェクトの承認には依然として現在のアカウント所有権が必要であるため、プロジェクトを外部に転送すると、そのアカウントのトークンによるアクセスは削除されます。

ワークロードの認証#

ポリシーのオーディエンスを使用して、プロバイダーからアイデンティティトークンを要求します。
TUIST_OIDC_TOKEN をそのトークンに設定し、TUIST_OIDC_ACCOUNT をプロジェクトを所有する Tuist アカウントのハンドルに設定します。アカウントはすべてのトラストポリシー交換に必要です。これは検索先を選択するだけで、それ自体では何も付与しません。
tuist auth login を実行します。Elixir プロジェクトの場合、代わりに mix tuist.login を使用するか、TUIST_TOKEN または有効な保存済み資格情報がない場合に Elixir 統合が自動的にトークンを交換するようにします。

結果として得られる Tuist アクセストークンは ci スコープグループのみを持ち、選択したアカウントが所有する現在および将来のすべてのプロジェクトをカバーします。アカウント内の 20 を超えるポリシーが同じトークンに一致する場合、または 2 つを超える異なる JWKS URL を使用する場合、交換は失敗します。

Tuist はこれらのセッションを更新しません。アクセストークンは 1 時間後に失効し、更新トークンはありません。プロバイダーのアイデンティティトークンは多くの場合数分間しか有効ではないため、古い TUIST_OIDC_TOKEN を保持することは更新戦略ではありません。1 時間以上実行されるジョブの場合、Tuist セッションが失効する前に新しいアイデンティティトークンを要求し、再度ログインしてください。ポリシーを削除すると新しい交換は停止しますが、すでに発行されたアクセストークンは失効するまで有効です。

Tuist は、専用のサイズ制限付きキャッシュで正常にフェッチした後、最大 15 分間プロバイダーの署名鍵をキャッシュします。エントリはより早く追い出され、再度フェッチされる可能性があります。失敗したフェッチはキャッシュされません。プロバイダーが鍵をローテーションする場合、キャッシュされたセットにない鍵で署名されたトークンはキャッシュが失効するまで拒否されるため、その鍵でトークンに署名する少なくとも 15 分前に新しい鍵を JWKS で公開する必要があります。鍵 ID (kid) がないトークンは、JWKS に単一の適格な署名鍵が含まれている場合のみ受け入れられます。JWKS に鍵 ID が存在する場合、それは最大 256 バイトの文字列である必要があります。

Note

TUIST_OIDC_TOKEN は汎用的なトークン入力であり、サーバーの信頼を bypass する方法ではありません。これは CI プロバイダー検出よりも優先され、サーバーは引き続き組み込みプロバイダーと一致するトラストポリシーを持つアイデンティティのみを受け入れます。Tuist 資格情報を想定する TUIST_TOKEN にアイデンティティトークンを入れないでください。

交換が失敗した場合は、ポリシー内の発行者、オーディエンス、およびすべてのクレームがトークンと完全に一致すること、JWKS URL がトークンに署名した鍵を提供していること、ポリシーが削除されていないこと、そして TUIST_OIDC_ACCOUNT がプロジェクトを所有するアカウントを指していることを確認してください。どのアイデンティティが信頼されているかを露呈しないよう、Tuist はこれらのすべてのケースで同じエラーを返します。

Fly.io Machines#

Fly.io は OIDC ワークロードアイデンティティをサポートしています。Machine は、Fly API トークンや長寿命の Tuist シークレットなしで、ローカルの /.fly/api Unix ソケットから短命の署名付きアイデンティティトークンを要求できます。Fly トークンはソースリポジトリではなく組織とアプリケーションを識別するため、GitHub リポジトリを接続する代わりにトラストポリシーを使用してください。

Fly Machine 内で発行されたアイデンティティトークンから、発行者 (iss)、組織 ID (org_id)、およびアプリケーション ID (app_id) を取得します。発行者は https://oidc.fly.io/<organization-slug> です。組織名やアプリ名ではなく、数値 ID を使用してください。

Fly.io Machines テンプレートを使用してトラストポリシーを作成し、組織のスラッグと両方の数値 ID を入力します。これにより以下の値が入力され、ID は文字列として保持されます。カスタムプロバイダー を使用して手動で入力することもできます。クレーム内の ID の引用符はそのまま保持してください。

フィールド	値
発行者 URL	`https://oidc.fly.io/<organization-slug>`
JWKS URL	`https://oidc.fly.io/<organization-slug>/.well-known/jwks`
オーディエンス	`tuist`
クレーム	`{"org_id": "<organization-id>", "app_id": "<application-id>"}`

Machine 内で、TUIST_OIDC_ACCOUNT をプロジェクトを所有する Tuist アカウントのハンドル（Fly 組織のスラッグではない）に設定し、オーディエンス tuist でトークンを要求し、TUIST_OIDC_TOKEN を使用して tuist auth login に渡します。

bash

set -euo pipefail
export TUIST_OIDC_ACCOUNT="my-tuist-account"

TUIST_OIDC_TOKEN="$(curl --fail --silent --show-error \
  --unix-socket /.fly/api \
  -X POST http://localhost/v1/tokens/oidc \
  -H 'Content-Type: application/json' \
  --data '{"aud":"tuist"}')"
export TUIST_OIDC_TOKEN

tuist auth login
unset TUIST_OIDC_TOKEN

初期設定では、トークンをエクスポートした後でアンセットする前に、ローカルでアイデンティティフィールドのみを確認できます。これにより設定用のクレームをデコードします。Tuist は認証中に署名を別途検証します。

bash

python3 - <<'PY'
import base64, json, os
payload = os.environ["TUIST_OIDC_TOKEN"].split(".")[1]
claims = json.loads(base64.urlsafe_b64decode(payload + "=" * (-len(payload) % 4)))
print(json.dumps({key: claims[key] for key in ("iss", "org_id", "app_id")}, indent=2))
PY

トークン自体を出力したりコミットしたりしないでください。承認された Fly アプリ内のすべての Machine は、Tuist アカウントの現在および将来のすべてのプロジェクトに対して認証できます。追加のアプリごとに個別のポリシーを作成してください。Fly アイデンティティトークンは約10分で失効するため、長時間実行される Machine では、1時間の Tuist セッションが失効する前に新しいトークンを要求し、tuist auth login を再度実行してください。

OIDC トークンスコープ#

OIDC トークンには ci スコープグループが付与されます。GitHub Actions、CircleCI、Bitrise の場合、これによりリポジトリに接続されているすべてのプロジェクトへのアクセスが可能になります。ワークロードアイデンティティトラストポリシーの場合、これにより選択したアカウントが所有する現在および将来のすべてのプロジェクトへのアクセスが可能になりますが、プロジェクトの作成、プロジェクト管理、ランナー管理、またはアカウントメンバー管理は付与されません。ci スコープに含まれる内容の詳細については、スコープグループを参照してください。

セキュリティ上の利点

OIDC 認証は長寿命トークンよりも安全です。その理由は次のとおりです。

回転や管理が必要なシークレットがない
トークンは短命である
認証はリポジトリアイデンティティまたは明示的に承認されたワークロードアイデンティティに紐づけられている

Gradle プラグイン認証#

Gradle プラグインは Tuist CLI の認証状態を使用し、個別のログインフローを定義しません。CLI で一度認証すると、プラグインはその資格情報を再利用します。

project や url を含むプロジェクトおよびサーバーの設定には、標準的な tuist.toml リファレンスを使用してください。

ローカルで使用するには、次を実行します。

bash

tuist auth login

CI では、次のいずれかを使用します。

OIDC 認証（利用可能な場合は推奨）
アカウントトークン認証（TUIST_TOKEN 経由）

セルフホスト型 Tuist サーバーの場合、tuist.toml でサーバー URL を定義し（例：url = "https://tuist.your-company.com"）、標準のログインフローを実行します。URL はプラグインが使用する同じ設定ファイルから解決されます。

認証が構成された後、Gradle キャッシュコマンドとタスクを通常どおり実行します。

アカウントトークン#

OIDC をサポートしない CI 環境や、権限を細かく制御する必要がある場合は、アカウントトークンを使用できます。アカウントトークンを使用すると、トークンがアクセスできるスコープとプロジェクトを正確に指定できます。

アカウントトークンの作成#

アカウントトークンを作成する最も簡単な方法は、ダッシュボードから行うことです。

Tuist ダッシュボードで組織を開きます。
設定 > トークン に移動します。
トークンを生成 を選択します。
名前、任意の有効期限、プロジェクトアクセス、およびトークンに必要なスコープを選択します。
ダイアログを閉じる前に、生成されたトークン値をコピーしてください。トークン値は一度しか表示されません。

CLI からアカウントトークンを作成することもでき、スクリプトや自動化に役立ちます。

bash

tuist account tokens create account-handle \
  --scopes account:cache:write project:cache:read project:cache:write \
  --name ci-cache-token \
  --expires 1y

Important

account-handle を、トークンにアクセスさせたいプロジェクトを所有するアカウントのハンドルに置き換えてください。これは個人アカウントではなく、組織アカウント也可以是可能です。

コマンドは以下のオプションを受け付けます。

オプション	説明
`--scopes`	必須。トークンに付与するスコープのカンマ区切りリスト。
`--name`	必須。トークンの一意の識別子（1〜32文字、英数字、ハイフン、アンダースコアのみ）。
`--expires`	任意。トークンの有効期限。`30d`（日）、`6m`（月）、または `1y`（年）などの形式を使用します。指定しない場合、トークンは無期限になります。
`--projects`	トークンを特定のプロジェクトハンドルに制限します。指定しない場合、トークンはすべてのプロジェクトにアクセスできます。

利用可能なスコープ#

スコープ	説明
`account:cache:read`	アカウントスコープのキャッシュ済みバイナリをダウンロード
`account:cache:write`	アカウントスコープのキャッシュ済みバイナリをアップロード
`account:members:read`	アカウントメンバーを読み取る
`account:members:write`	アカウントメンバーを管理する
`account:registry:read`	Swift パッケージレジストリから読み取る
`account:registry:write`	Swift パッケージレジストリに公開する
`account:runners:read`	ランナージョブ、ワークフロー、プロファイル、およびボリュームを読み取る
`account:runners:write`	ランナープロファイルを管理し、ランナーボリュームをクリアする
`project:previews:read`	プレビューをダウンロード
`project:previews:write`	プレビューをアップロード
`project:admin:read`	プロジェクトとその設定を読み取る
`project:admin:write`	プロジェクトを作成、更新、削除する。プロジェクトを作成するには、すべてのプロジェクトにアクセスできるトークンが必要です
`project:cache:read`	キャッシュ済みバイナリをダウンロード
`project:cache:write`	キャッシュ済みバイナリをアップロード
`project:bundles:read`	バンドルを表示
`project:bundles:write`	バンドルをアップロード
`project:tests:read`	テスト結果を読み取る
`project:tests:write`	テスト結果をアップロード
`project:builds:read`	ビルド分析を読み取る
`project:builds:write`	ビルド分析をアップロード
`project:runs:read`	コマンド実行を読み取る
`project:runs:write`	コマンド実行を作成および更新

スコープグループ#

スコープグループは、単一の識別子で複数の関連するスコープを付与する便利な方法を提供します。スコープグループを使用すると、含まれる個々のスコープが自動的に展開されます。

スコープグループ	含まれるスコープ
`ci`	`account:cache:write`, `project:cache:write`, `project:previews:write`, `project:bundles:write`, `project:tests:write`, `project:builds:write`, `project:runs:write`
`mcp`	`project:cache:read`, `project:previews:read`, `project:bundles:read`, `project:tests:read`, `project:builds:read`, `project:runs:read`

継続的インテグレーション#

OIDC をサポートしない CI 環境では、ci スコープグループを使用してアカウントトークンを作成し、CI ワークフローを認証してください。ダッシュボードで、トークンを生成する際に CI プリセットを選択します。

CLI から同じトークンを作成することもできます。

bash

tuist account tokens create account-handle --scopes ci --name ci

これにより、一般的な CI 操作（キャッシュ、プレビュー、バンドル、テスト、ビルド、および実行）に必要なすべてのスコープを持つトークンが作成されます。生成されたトークンを CI 環境のシークレットとして保存し、TUIST_TOKEN 環境変数として設定します。

アカウントトークンの管理#

アカウントダッシュボードの設定 > トークン を開き、アカウントトークンを表示し、トークンのスコープとプロジェクトアクセスを確認し、ローテーション中にトークンを取り消します。

アカウントのすべてのトークンを一覧表示するには：

bash

tuist account tokens list account-handle

名前でトークンを取り消すには：

bash

tuist account tokens revoke account-handle ci-cache-token

アカウントトークンの使用#

アカウントトークンは、環境変数 TUIST_TOKEN として定義されることが想定されています。

bash

export TUIST_TOKEN=your-account-token

アカウントトークンを使用すべき場合

以下の場合にアカウントトークンを使用してください。

OIDC をサポートしない CI 環境での認証
トークンが実行できる操作に対する細かな制御
アカウント内の複数のプロジェクトにアクセスできるトークン
自動的に期限切れになる時間制限付きトークン