For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
メインナビゲーション

SPIFFE のワークロード ID フェデレーションの構成

SPIFFE JWT-SVID を有効期間の短い OpenAI アクセストークンと交換することで、SPIFFE をワークロード ID プロバイダーとして使用できます。これにより、SPIRE または別の SPIFFE 互換 ID プロバイダーで認証されたワークロードは、有効期間の長い API キーを保存せずに OpenAI API を呼び出せます。

Codex で使用する場合は、このページの手順で JWT-SVID を取得し、内容を確認します。次に、Codex のワークロード ID を構成して、そのトークンをファイルに書き込み、Codex がそのファイルを参照するようにします。このページのサービスアカウントマッピングと SDK の例は、OpenAI API 向けです。

OpenAI は、発行者、オーディエンス、有効期限、発行時刻、および JWKS で検証できる署名を備え、JWT サブジェクトトークンとして検証可能な SPIFFE JWT-SVID をサポートしています。SPIFFE X.509-SVID は、ワークロード ID フェデレーションのサブジェクトトークンとしてサポートしていません。

JWT-SVID 仕様では、subaudexp クレームが必須です。OpenAI で JWT-SVID を使用するには、OpenAI がワークロード ID プロバイダーの構成に照らしてトークンを検証できるように、issiat クレーム、および kid ヘッダーも含める必要があります。

JWT-SVID は OpenID Connect ID トークンではありません。SPIRE OIDC Discovery Provider は、OpenAI が JWT-SVID を検証できるように、ディスカバリメタデータと JWKS の鍵を提供します。トークンの SPIFFE としての意味を変えたり、OIDC ログインフローを必要としたりするものではありません。

SPIFFE の用語とトークンの要件については、SPIFFE の JWT-SVID 仕様Workload API 仕様を参照してください。

SPIFFE のセットアップ

OpenAI API を呼び出す必要があるワークロードに JWT-SVID を発行するように、SPIFFE プロバイダーを構成します。この手順では SPIRE の用語を使用していますが、OpenAI が検証できる発行者情報と JWKS の署名鍵情報を備えた JWT-SVID を発行する SPIFFE 互換プロバイダーであれば、同じ OpenAI 構成を適用できます。

SPIFFE の環境には、次のものが必要です。

  • spiffe://example.org/ns/production/sa/openai-wif など、ワークロードを継続して識別できる SPIFFE ID
  • https://api.openai.com/v1 または任意に選んだ別の不透明な値など、OpenAI へのアクセス専用の単一の JWT-SVID オーディエンス
  • OpenAI による検証のために JWT-SVID の iss クレームに含める JWT 発行者 URL
  • OIDC ディスカバリまたは JWKS のアップロードによって提供する、JWT-SVID 署名鍵の公開 JWKS
  • SPIFFE Workload API から新しい JWT-SVID を取得するためのワークロード側の仕組み

オーディエンスは完全一致で照合する識別子であり、JWT-SVID を受け取るエンドポイントである必要はありません。SPIFFE Workload API のリクエストと OpenAI のプロバイダー構成が一致していれば、https://api.openai.com/v1 または別のサービス固有の値を使用できます。

可能であれば、SPIRE OIDC Discovery Provider を通じて SPIFFE の発行者情報を公開します。SPIRE Server の jwt_issuer と OIDC Discovery Provider の jwt_issuer には、OpenAI に設定するものと同じ HTTPS 発行者 URL を設定します。

SPIRE Server の構成では、次のように設定します。

server {
  trust_domain = "example.org"
  jwt_issuer   = "https://spire-oidc.example.org"
}

別途、SPIRE OIDC Discovery Provider の構成では、次のように設定します。

# Relevant issuer fields only
domains    = ["spire-oidc.example.org"]
jwt_issuer = "https://spire-oidc.example.org"

OIDC Discovery Provider の構成には、server_apiworkload_apifile などの鍵情報の取得元と、ACME、TLS 証明書、Unix ソケットなどの配信の仕組みも必要です。構成オプションの全一覧は、SPIRE OIDC Discovery Provider のドキュメントを参照してください。

SPIFFE のトラストドメインと JWT の発行者は異なる概念です。この例では、JWT-SVID のサブジェクトは example.org トラストドメイン内の SPIFFE ID であり、発行者は次の HTTPS 発行者 URL です。

{
  "sub": "spiffe://example.org/ns/production/sa/openai-wif",
  "iss": "https://spire-oidc.example.org"
}

SPIRE OIDC Discovery Provider は、 アップロードした JWKS をトークン検証に使用 が無効の場合に OpenAI が利用できる OIDC ディスカバリドキュメントと JWKS エンドポイントを提供します。

OpenAI から発行者のディスカバリエンドポイントにアクセスできない場合は、代わりにアップロードした JWKS を使用するモードを選びます。このモードでも、OpenAI はワークロード ID プロバイダーの発行者を JWT-SVID の iss クレームと照合しますが、署名の検証にはワークロード ID プロバイダーに保存した JWKS JSON を使用します。

注: SPIFFE JWT-SVID 仕様では JWT ヘッダーの kid は任意ですが、OpenAI では、構成された JWKS から署名鍵を選択できるよう、JWT サブジェクトトークンに kid ヘッダーを含める必要があります。SPIFFE プロバイダーで kid を省略できる場合は、OpenAI のワークロード ID フェデレーション用に必ず含めるように構成してください。

SPIFFE Workload API を呼び出せるワークロードから JWT-SVID を取得して内容を確認するには、OpenAI に設定するものと同じオーディエンスを指定してリクエストします。Workload API の認可は呼び出し元プロセスの ID に依存するため、このコマンドはアプリケーションと同じワークロードコンテキストで実行してください。

TOKEN=$(spire-agent api fetch jwt \
  -socketPath /run/spire/sockets/agent.sock \
  -audience "https://api.openai.com/v1" | sed -n '2p')
export TOKEN

ワークロードに複数の SPIFFE ID がある場合は、使用する ID を指定してリクエストします。

TOKEN=$(spire-agent api fetch jwt \
  -socketPath /run/spire/sockets/agent.sock \
  -spiffeID "spiffe://example.org/ns/production/sa/openai-wif" \
  -audience "https://api.openai.com/v1" | sed -n '2p')
export TOKEN

トークンの検証

ワークロード ID フェデレーションを構成する前に、JWT-SVID を TOKEN としてエクスポートし、次の例のいずれかをローカルで実行してヘッダーとクレームを確認します。

const parts = process.env.TOKEN?.split(".") ?? [];
if (parts.length !== 3) {
  throw new Error("Expected a compact JWT with three segments");
}

const decode = (segment) => {
  if (!/^[A-Za-z0-9_-]+$/.test(segment) || segment.length % 4 === 1) {
    throw new Error("JWT segment is not valid Base64URL");
  }
  const bytes = Buffer.from(segment, "base64url");
  if (bytes.toString("base64url") !== segment) {
    throw new Error("JWT segment is not valid Base64URL");
  }
  const decoded = new TextDecoder("utf-8", { fatal: true }).decode(bytes);
  const value = JSON.parse(decoded);
  if (value === null || Array.isArray(value) || typeof value !== "object") {
    throw new Error("JWT segment is not a JSON object");
  }
  return decoded;
};

console.log("Header:");
console.log(decode(parts[0]));
console.log("\nPayload:");
console.log(decode(parts[1]));

いずれの例も、トークンの署名を検証せずに JWT をデコードします。本番環境のトークンにはローカルのデコーダーを使用し、本番環境のトークンをサードパーティ製ツールに貼り付けることは避けてください。

デコードした SPIFFE JWT-SVID は、次のような形式になります。

{
  "alg": "ES256",
  "kid": "jwt-svid-key-1"
}
{
  "iss": "https://spire-oidc.example.org",
  "aud": ["https://api.openai.com/v1"],
  "sub": "spiffe://example.org/ns/production/sa/openai-wif",
  "iat": 1716235422,
  "exp": 1716235722
}

受け取ったトークンを交換する前に、デコードした内容を OpenAI の構成と照合します。ヘッダーの algkid、ペイロードの issaudsubiatexp を確認してください。実際の alg の値は、SPIRE Server の JWT 署名鍵の構成によって異なります。

ワークロード ID フェデレーションのセットアップ

SPIFFE JWT-SVID の発行者に対応するワークロード ID プロバイダーを OpenAI で作成し、信頼する SPIFFE ID に一致するサービスアカウントマッピングを追加します。

ワークロード ID プロバイダーのセットアップ

  1. ワークロード ID プロバイダーを作成します。 名前 には、spiffe-prod などの一意の値を設定します。管理者がプロバイダーを識別しやすいように、 説明には Production SPIFFE workloads などを入力します。

  2. 発行者とオーディエンスを設定します。 OIDC 発行者 URL には、https://spire-oidc.example.org など、JWT-SVID の iss クレームと完全に一致する値を設定します。 オーディエンス には、SPIFFE Workload API へのリクエストで指定したオーディエンスの値を設定します。この例では https://api.openai.com/v1 です。

  3. JWKS の取得元を選択します。 OpenAI から SPIRE OIDC Discovery Provider にアクセスできる場合は、 アップロードした JWKS をトークン検証に使用 を無効のままにします。OpenAI は OIDC ディスカバリと、そこから取得した JWKS を使用して JWT-SVID の署名を検証します。

    OpenAI から発行者にアクセスできない場合は、 アップロードした JWKS をトークン検証に使用を有効にし、 JWKS JSON に JWT-SVID 署名鍵の公開鍵セットを設定します。鍵を格納する keys 配列も含め、公開 JWKS オブジェクト全体をアップロードしてください。秘密鍵の情報は含めないでください。

  4. マッピング用の属性を導出する必要がある場合にのみ、属性変換を追加します。 sub から直接マッピングする場合、属性変換は不要です。1 つ以上のトークンクレームからマッピング値を導出する必要がある場合にのみ使用してください。変換の動作については、ワークロード ID フェデレーションのメインガイドを参照してください。

サービスアカウントマッピングのセットアップ

  1. サービスアカウントマッピングを作成します。 名前 には、production-openai-wif など、ワークロード ID プロバイダー内で一意の値を設定します。 説明には Production SPIFFE workload for OpenAI API access などを入力し、このマッピングを使用できるワークロードを示します。

  2. SPIFFE ID を照合条件に設定します。 キー には sub を、 には spiffe://example.org/ns/production/sa/openai-wif などのワークロードの SPIFFE ID を設定します。

    特権を持つワークロードには、SPIFFE ID の完全一致による照合を推奨します。末尾のワイルドカードは、そのプレフィックス配下のすべての SPIFFE ID に OpenAI アクセストークンの発行を許可する場合にのみ使用してください。たとえば、spiffe://example.org/ns/production/sa/* は、一致する本番環境のすべてのサービスアカウントパスを許可します。

  3. OpenAI 側の対象を選択します。 プロジェクト には、対象のサービスアカウントを所有する OpenAI プロジェクトを設定します。 サービスアカウント には、spiffe-prod-openai-wif など、SPIFFE ワークロードが使用できる OpenAI サービスアカウントを設定します。既存のサービスアカウントを再利用せず、このマッピング用に新しく作成する場合は、Create a new service account in this project にチェックを入れます。

  4. 必要に応じて API 権限を絞り込みます。 api.model.requestapi.vector_store.read など、適切な 権限 を選択し、このマッピングから発行されるアクセストークンの権限をさらに絞り込みます。WIF 固有のスコープ制限を追加しない場合は、権限を空欄のままにします。その場合も、トークンはマッピング先のサービスアカウントとして認可されます。

コードでのトークンの使用

新しい SPIFFE JWT-SVID を OpenAI 発行のアクセストークンと交換するように、OpenAI SDK クライアントを構成します。

以下の SDK サンプルは、SPIFFE 連携によって JWT-SVID が更新され、/var/run/spiffe/openai.jwt に書き込まれることを前提としています。このファイルはワークロードだけが読み取れるようにしてください。JWT-SVID は有効期間が短いため、トークンの有効期限が切れる前にファイルを更新します。また、古いトークンファイルの使用を避けるため、可能であれば、言語別の SPIFFE ライブラリを使い、サブジェクトトークンプロバイダー内で SPIFFE Workload API から JWT-SVID を直接取得する方法もあります。

ワークロード環境に OPENAI_IDENTITY_PROVIDER_IDOPENAI_SERVICE_ACCOUNT_ID を設定します。トークンファイルには外部サブジェクトトークンが格納されています。OPENAI_IDENTITY_PROVIDER_ID は OpenAI のワークロード ID プロバイダーを、OPENAI_SERVICE_ACCOUNT_ID は対象の OpenAI サービスアカウントを識別します。OpenAI はトークンのクレームに基づいて、そのプロバイダーとサービスアカウントに一致するマッピングを検索します。

SPIFFE JWT-SVID を使用した認証
import { readFile } from "node:fs/promises";
import OpenAI from "openai";

const tokenPath = "/var/run/spiffe/openai.jwt";
const identityProviderId = process.env.OPENAI_IDENTITY_PROVIDER_ID;
const serviceAccountId = process.env.OPENAI_SERVICE_ACCOUNT_ID;

if (!identityProviderId || !serviceAccountId) {
  throw new Error(
    "Set OPENAI_IDENTITY_PROVIDER_ID and OPENAI_SERVICE_ACCOUNT_ID"
  );
}

function spiffeJwtSvidProvider(path) {
  return {
    tokenType: "jwt",
    getToken: async () => {
      const token = (await readFile(path, "utf8")).trim();
      if (!token) {
        throw new Error("The SPIFFE JWT-SVID file is empty.");
      }
      return token;
    },
  };
}

const client = new OpenAI({
  workloadIdentity: {
    identityProviderId,
    serviceAccountId,
    provider: spiffeJwtSvidProvider(tokenPath),
  },
});

const response = await client.responses.create({
  model: "gpt-5.6-terra",
  input: "Say hello from SPIFFE workload identity federation.",
});

console.log(response.output_text);

SPIFFE のベストプラクティス

  • OpenAI のワークロード ID フェデレーションには JWT-SVID を使用してください。X.509-SVID は相互 TLS に役立ちますが、OpenAI のトークン交換エンドポイントでは受け付けられません。
  • OpenAI へのアクセスには、専用のオーディエンスを 1 つ使用してください。トラストドメイン全体や環境名など、対象範囲の広いオーディエンスは避けてください。
  • 可能な限り、SPIFFE ID を完全一致で照合してください。ワイルドカードによるマッピングは、意図的に共有する信頼境界に対してのみ使用してください。
  • ベアラートークンのリプレイリスクを軽減するため、JWT-SVID の有効期間は短くしてください。OpenAI アクセストークンの有効期限が、交換に使用した外部サブジェクトトークンの有効期限を超えることはありません。
  • 署名鍵は慎重にローテーションしてください。ローテーション期間中は OIDC ディスカバリを通じて新旧両方の公開鍵を公開するか、新しい kid を含む JWT-SVID を発行する前に、アップロード済みの公開 JWKS を更新してください。
  • SPIRE Server とワークロードの時計を同期してください。時刻に大きなずれがあると、本来有効な JWT-SVID が、まだ有効ではない、古すぎる、または有効期限切れであるとして拒否されることがあります。
  • SPIFFE Workload API のソケットを保護してください。ワークロードの JWT-SVID を取得できるプロセスは、それを交換して OpenAI へのアクセスを得ようとすることができます。
  • OpenAI サービスアカウントの境界を、アプリケーションと環境の権限境界に合わせてください。互いに無関係な SPIFFE ワークロード間で、高い権限を持つサービスアカウントを共有しないでください。
  • 発行者、オーディエンス、署名鍵、マッピングの不一致によるトークン交換の失敗を監視します。