您可以将 SPIFFE 用作工作负载身份提供方,用 SPIFFE JWT-SVID 换取短期 OpenAI 访问令牌。这样,通过 SPIRE 或其他兼容 SPIFFE 的身份提供方认证的工作负载就能调用 OpenAI API,无需存储长期有效的 API 密钥。
如果您使用 Idira Secure Workload Access,请按照 Idira 设置指南配置代理程序和令牌交付方式。
OpenAI 支持将 SPIFFE JWT-SVID 作为 JWT 主体令牌进行验证。这类令牌必须包含签发方、受众、过期时间和签发时间戳,并带有可通过 JWKS 验证的签名。OpenAI 不支持将 SPIFFE X.509-SVID 用作工作负载身份联合的主体令牌。
JWT-SVID 规范要求令牌包含 sub、aud 和 exp 声明。要在 OpenAI 中使用 JWT-SVID,令牌还必须包含 iss 和 iat 声明,并在标头中包含 kid 字段,以便 OpenAI 根据工作负载身份提供方的配置验证令牌。
JWT-SVID 不是 OpenID Connect ID 令牌。SPIRE OIDC Discovery Provider 提供发现元数据和 JWKS 密钥,供 OpenAI 验证 JWT-SVID。它不会改变令牌的 SPIFFE 语义,也不要求使用 OIDC 登录流程。
有关 SPIFFE 术语和令牌要求,请参阅 SPIFFE 的 JWT-SVID 规范和 Workload API 规范。
配置 SPIFFE 提供方,使其为需要调用 OpenAI API 的工作负载签发 JWT-SVID。以下说明使用 SPIRE 术语。对于其他兼容 SPIFFE 的提供方,只要其签发的 JWT-SVID 包含 OpenAI 可验证的签发方信息,且提供可供 OpenAI 验证签名的 JWKS 密钥,OpenAI 端的配置方式就相同。
您的 SPIFFE 配置必须提供以下内容:
- 工作负载的稳定 SPIFFE ID,例如
spiffe://example.org/ns/production/sa/openai-wif。
- 一个专用于访问 OpenAI 的 JWT-SVID 受众,例如
https://api.openai.com/v1,也可以是您自行选择的其他不透明标识符。
- JWT 签发方 URL。该 URL 必须出现在 JWT-SVID 的
iss 声明中,供 OpenAI 验证。
- 包含 JWT-SVID 签名密钥对应公钥的 JWKS,可通过 OIDC 发现机制提供,也可上传。
- 工作负载从 SPIFFE Workload API 获取新 JWT-SVID 的方式。
受众是一个必须精确匹配的标识符,不一定是接收 JWT-SVID 的端点。您可以使用 https://api.openai.com/v1 或其他服务专用值,只要 SPIFFE Workload API 请求中的受众与 OpenAI 提供方配置中的受众一致即可。
条件允许时,请通过 SPIRE OIDC Discovery Provider 发布 SPIFFE 签发方信息。将 SPIRE Server 的 jwt_issuer 和 OIDC Discovery Provider 的 jwt_issuer 设为同一个 HTTPS 签发方 URL,并在 OpenAI 中配置相同的 URL。
在 SPIRE Server 配置中:
1234server {
trust_domain = "example.org"
jwt_issuer = "https://spire-oidc.example.org"
}
在单独的 SPIRE OIDC Discovery Provider 配置中:
123# Relevant issuer fields only
domains = ["spire-oidc.example.org"]
jwt_issuer = "https://spire-oidc.example.org"
配置 OIDC Discovery Provider 时,还需要指定密钥材料来源,例如 server_api、workload_api 或 file,以及提供服务的方式,例如 ACME、TLS 证书或 Unix 套接字。完整的配置选项请参阅 SPIRE OIDC Discovery Provider 文档。
SPIFFE 信任域与 JWT 签发方是两个不同的概念。在本例中,JWT-SVID 的主体是 example.org 信任域中的一个 SPIFFE ID,而签发方由 HTTPS 签发方 URL 标识:
1234{
"sub": "spiffe://example.org/ns/production/sa/openai-wif",
"iss": "https://spire-oidc.example.org"
}
SPIRE OIDC Discovery Provider 提供 OIDC 发现文档和 JWKS 端点。关闭使用上传的 JWKS 验证令牌时,OpenAI 可以使用该文档和端点。
如果 OpenAI 无法访问您的签发方发现端点,请改用上传 JWKS 的模式。在此模式下,OpenAI 仍会检查工作负载身份提供方配置中的签发方是否与 JWT-SVID 的 iss 声明一致,但会使用您在工作负载身份提供方配置中保存的 JWKS JSON 验证签名。
注意: SPIFFE JWT-SVID 规范将 JWT 标头中的 kid 字段列为可选字段,但 OpenAI 要求 JWT 主体令牌的标头包含 kid,以便从配置的 JWKS 中选择签名密钥。如果您的 SPIFFE 提供方可能省略 kid,请将其配置为在用于 OpenAI 工作负载身份联合的令牌中包含该字段。
要在能够调用 SPIFFE Workload API 的工作负载中检查 JWT-SVID,请使用您将在 OpenAI 中配置的受众请求令牌。请在应用程序所在的工作负载上下文中运行以下命令,因为 Workload API 根据调用进程的身份进行授权。
1234TOKEN=$(spire-agent api fetch jwt \
-socketPath /run/spire/sockets/agent.sock \
-audience "https://api.openai.com/v1" | sed -n '2p')
export TOKEN
如果您的工作负载有多个 SPIFFE ID,请在请求中指定所需的身份:
12345TOKEN=$(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
在配置工作负载身份联合之前,请将 JWT-SVID 导出为环境变量 TOKEN,然后在本地运行以下任一示例,检查令牌的标头和声明:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25const parts = process.env.TOKEN?.split(".") ?? [];
if (parts.length !== 3) {
throw new Error("Expected a compact JWT with three segments");
}
const decode = (segment: string) => {
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]));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33import base64
import json
import os
import re
def reject_non_json_constant(value):
raise ValueError(f"JWT segment contains non-JSON constant: {value}")
parts = os.environ.get("TOKEN", "").split(".")
if len(parts) != 3:
raise ValueError("Expected a compact JWT with three segments")
def decode(segment):
if re.fullmatch(r"[A-Za-z0-9_-]+", segment) is None or len(segment) % 4 == 1:
raise ValueError("JWT segment is not valid Base64URL")
padded_segment = segment + "=" * (-len(segment) % 4)
decoded = base64.b64decode(padded_segment, altchars=b"-_", validate=True)
if base64.urlsafe_b64encode(decoded).rstrip(b"=").decode("ascii") != segment:
raise ValueError("JWT segment is not valid Base64URL")
decoded_text = decoded.decode("utf-8")
value = json.loads(decoded_text, parse_constant=reject_non_json_constant)
if not isinstance(value, dict):
raise ValueError("JWT segment is not a JSON object")
return decoded_text
print("Header:")
print(decode(parts[0]))
print("\nPayload:")
print(decode(parts[1]))
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84package main
import (
"bytes"
"encoding/base64"
"encoding/json"
"fmt"
"os"
"strings"
"unicode/utf8"
)
func decodeSegment(segment string) (json.RawMessage, error) {
if !isBase64URLSegment(segment) {
return nil, fmt.Errorf("JWT segment is not valid Base64URL")
}
decoded, err := base64.RawURLEncoding.DecodeString(segment)
if err != nil {
return nil, err
}
if base64.RawURLEncoding.EncodeToString(decoded) != segment {
return nil, fmt.Errorf("JWT segment is not valid Base64URL")
}
if !utf8.Valid(decoded) {
return nil, fmt.Errorf("JWT segment is not valid UTF-8")
}
var value json.RawMessage
if err := json.Unmarshal(decoded, &value); err != nil {
return nil, err
}
if trimmed := bytes.TrimSpace(value); len(trimmed) == 0 || trimmed[0] != '{' {
return nil, fmt.Errorf("JWT segment is not a JSON object")
}
return value, nil
}
func isBase64URLSegment(segment string) bool {
if segment == "" || len(segment)%4 == 1 {
return false
}
for _, character := range segment {
if !('A' <= character && character <= 'Z') &&
!('a' <= character && character <= 'z') &&
!('0' <= character && character <= '9') &&
character != '-' &&
character != '_' {
return false
}
}
return true
}
func printJSON(label string, value json.RawMessage) error {
formatted, err := json.MarshalIndent(value, "", " ")
if err != nil {
return err
}
fmt.Printf("%s:\n%s\n", label, formatted)
return nil
}
func main() {
parts := strings.Split(os.Getenv("TOKEN"), ".")
if len(parts) != 3 {
panic("Expected a compact JWT with three segments")
}
header, err := decodeSegment(parts[0])
if err != nil {
panic(err)
}
payload, err := decodeSegment(parts[1])
if err != nil {
panic(err)
}
if err := printJSON("Header", header); err != nil {
panic(err)
}
fmt.Println()
if err := printJSON("Payload", payload); err != nil {
panic(err)
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80// Add Jackson (com.fasterxml.jackson.core:jackson-databind) to your project.
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.charset.CharacterCodingException;
import java.nio.charset.CodingErrorAction;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
public final class DecodeJwtExample {
private static final ObjectMapper JSON =
new ObjectMapper().enable(DeserializationFeature.FAIL_ON_TRAILING_TOKENS);
private DecodeJwtExample() {}
static String decodeUtf8(byte[] bytes) throws IOException {
try {
return StandardCharsets.UTF_8
.newDecoder()
.onMalformedInput(CodingErrorAction.REPORT)
.onUnmappableCharacter(CodingErrorAction.REPORT)
.decode(ByteBuffer.wrap(bytes))
.toString();
} catch (CharacterCodingException exception) {
throw new IOException("JWT segment is not valid UTF-8", exception);
}
}
static String decodeSegment(String segment) throws IOException {
if (!isBase64UrlSegment(segment)) {
throw new IllegalArgumentException("JWT segment is not valid Base64URL");
}
byte[] bytes = Base64.getUrlDecoder().decode(segment);
if (!Base64.getUrlEncoder().withoutPadding().encodeToString(bytes).equals(segment)) {
throw new IllegalArgumentException("JWT segment is not valid Base64URL");
}
String decoded = decodeUtf8(bytes);
JsonNode value = JSON.readTree(decoded);
if (value == null || value.isMissingNode() || !value.isObject()) {
throw new IOException("JWT segment is not a JSON object");
}
return decoded;
}
static boolean isBase64UrlSegment(String segment) {
if (segment.isEmpty() || segment.length() % 4 == 1) {
return false;
}
return segment
.chars()
.allMatch(
character ->
character >= 'A' && character <= 'Z'
|| character >= 'a' && character <= 'z'
|| character >= '0' && character <= '9'
|| character == '-'
|| character == '_');
}
static String[] requireCompactJwt(String token) {
if (token == null) {
throw new IllegalArgumentException("Expected a compact JWT with three segments");
}
String[] parts = token.split("\\.", -1);
if (parts.length != 3) {
throw new IllegalArgumentException("Expected a compact JWT with three segments");
}
return parts;
}
public static void main(String[] args) throws IOException {
String[] parts = requireCompactJwt(System.getenv("TOKEN"));
System.out.println("Header:");
System.out.println(decodeSegment(parts[0]));
System.out.println("\nPayload:");
System.out.println(decodeSegment(parts[1]));
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62using System.Text;
using System.Text.Json;
static string DecodeSegment(string segment)
{
if (
segment.Length % 4 == 1 ||
segment.Any(
character =>
!(
character is >= 'A' and <= 'Z' ||
character is >= 'a' and <= 'z' ||
character is >= '0' and <= '9' ||
character is '-' or '_'
)
)
)
{
throw new FormatException("JWT segment is not valid Base64URL");
}
byte[] decoded = Convert.FromBase64String(
segment.Replace('-', '+').Replace('_', '/') +
new string('=', (4 - segment.Length % 4) % 4)
);
string canonicalSegment = Convert
.ToBase64String(decoded)
.TrimEnd('=')
.Replace('+', '-')
.Replace('/', '_');
if (canonicalSegment != segment)
{
throw new FormatException("JWT segment is not valid Base64URL");
}
string decodedJson = new UTF8Encoding(false, true).GetString(decoded);
using JsonDocument document = JsonDocument.Parse(decodedJson);
if (document.RootElement.ValueKind is not JsonValueKind.Object)
{
throw new FormatException("JWT segment is not a JSON object");
}
return decodedJson;
}
string? token = Environment.GetEnvironmentVariable("TOKEN");
if (token is null)
{
throw new InvalidOperationException(
"Expected a compact JWT with three segments"
);
}
string[] parts = token.Split('.');
if (parts.Length != 3)
{
throw new InvalidOperationException(
"Expected a compact JWT with three segments"
);
}
Console.WriteLine("Header:");
Console.WriteLine(DecodeSegment(parts[0]));
Console.WriteLine("\nPayload:");
Console.WriteLine(DecodeSegment(parts[1]));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34require "base64"
require "json"
parts = ENV.fetch("TOKEN", "").split(".", -1)
raise "Expected a compact JWT with three segments" unless parts.length == 3
decode = lambda do |segment|
unless segment.match?(/\A[A-Za-z0-9_-]+\z/) && segment.length % 4 != 1
raise "JWT segment is not valid Base64URL"
end
padded = segment.ljust((segment.length + 3) & ~3, "=")
begin
decoded = Base64.urlsafe_decode64(padded)
rescue ArgumentError
raise "JWT segment is not valid Base64URL"
end
unless Base64.urlsafe_encode64(decoded, padding: false) == segment
raise "JWT segment is not valid Base64URL"
end
decoded.force_encoding(Encoding::UTF_8)
raise "JWT segment is not valid UTF-8" unless decoded.valid_encoding?
value = JSON.parse(decoded)
raise "JWT segment is not a JSON object" unless value.is_a?(Hash)
decoded
end
puts("Header:")
puts(decode.call(parts[0]))
puts("\nPayload:")
puts(decode.call(parts[1]))
这些示例只解码 JWT,不验证令牌签名。请使用本地解码器处理生产环境的令牌,避免将其粘贴到第三方工具中。
解码后的 SPIFFE JWT-SVID 类似于以下示例:
1234{
"alg": "ES256",
"kid": "jwt-svid-key-1"
}
1234567{
"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 配置进行核对。检查标头中的 alg 和 kid,以及载荷中的 iss、aud、sub、iat 和 exp。alg 的具体值取决于 SPIRE Server 的 JWT 签名密钥配置。
在 OpenAI 中为 SPIFFE JWT-SVID 签发方创建工作负载身份提供方,然后添加与您信任的 SPIFFE ID 匹配的服务账号映射。
-
创建工作负载身份提供方。 将名称设为唯一值,例如 spiffe-prod。填写描述,例如 Production SPIFFE workloads,以便管理员识别该提供方。
-
设置签发方和受众。 将 OIDC 签发方 URL 设为与 JWT-SVID 的 iss 声明完全一致的值,例如 https://spire-oidc.example.org。将受众设为向 SPIFFE Workload API 请求令牌时指定的受众值。本例中使用 https://api.openai.com/v1。
-
选择 JWKS 来源。 如果 OpenAI 可以访问您的 SPIRE OIDC Discovery Provider,请保持使用上传的 JWKS 验证令牌选项关闭。OpenAI 会通过 OIDC 发现机制获取 JWKS,并用它验证 JWT-SVID 签名。
如果 OpenAI 无法访问签发方,请启用使用上传的 JWKS 验证令牌,然后将 JWKS JSON 设为 JWT-SVID 签名密钥对应的公钥集。请上传完整的公开 JWKS 对象,包括容纳各公钥条目的 keys 数组。请勿包含私钥材料。
-
仅在需要派生映射属性时添加属性转换。 如果直接使用 sub 进行映射,则无需转换属性。只有在需要从一个或多个令牌声明派生映射值时,才使用属性转换。有关转换机制,请参阅工作负载身份联合主指南。
-
创建服务账号映射。 将名称设为在该工作负载身份提供方内唯一的值,例如 production-openai-wif。填写描述,例如 Production SPIFFE workload for OpenAI API access,说明哪个工作负载可以使用该映射。
-
匹配 SPIFFE ID。 将键设为 sub,将值设为工作负载的 SPIFFE ID,例如 spiffe://example.org/ns/production/sa/openai-wif。
对于具有高权限的工作负载,请优先使用精确匹配的 SPIFFE ID。只有在该前缀下的每个 SPIFFE ID 都应能获取 OpenAI 访问令牌时,才在末尾使用通配符。例如,spiffe://example.org/ns/production/sa/* 允许任何路径与之匹配的生产环境服务账号获取令牌。
-
选择目标 OpenAI 服务账号。 将项目设为目标服务账号所属的 OpenAI 项目。将服务账号设为 SPIFFE 工作负载可以使用的 OpenAI 服务账号,例如 spiffe-prod-openai-wif。如果您希望为此映射创建新的服务账号,而不复用现有账号,请勾选 Create a new service account in this project。
-
按需缩小 API 权限范围。 选择适当的权限,例如 api.model.request 和 api.vector_store.read,以进一步限制通过此映射签发的访问令牌的权限。如果您无需针对工作负载身份联合额外限制权限范围,请将权限留空。令牌仍以映射到的服务账号身份获得授权。
配置 OpenAI SDK 客户端,使其用新获取的 SPIFFE JWT-SVID 换取 OpenAI 签发的访问令牌。
以下 SDK 示例假设您的 SPIFFE 集成会刷新 JWT-SVID 并将其写入 /var/run/spiffe/openai.jwt。请将文件权限设置为仅允许该工作负载读取。由于 JWT-SVID 的有效期很短,请在令牌过期前更新文件。如果条件允许,您也可以在主体令牌提供方中使用所用编程语言的 SPIFFE 库,直接从 SPIFFE Workload API 获取 JWT-SVID,以免读到文件中的过期令牌。
在工作负载环境中设置 OPENAI_IDENTITY_PROVIDER_ID 和 OPENAI_SERVICE_ACCOUNT_ID。令牌文件包含外部主体令牌。OPENAI_IDENTITY_PROVIDER_ID 标识 OpenAI 工作负载身份提供方,OPENAI_SERVICE_ACCOUNT_ID 标识目标 OpenAI 服务账号。随后,OpenAI 会根据令牌声明查找与该提供方和服务账号匹配的映射。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40import { 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: string) {
return {
tokenType: "jwt" as const,
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-6.1-terra",
input: "Say hello from SPIFFE workload identity federation.",
});
console.log(response.output_text);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33import os
from pathlib import Path
from openai import OpenAI
from openai.auth import SubjectTokenProvider
TOKEN_PATH = "/var/run/spiffe/openai.jwt"
def spiffe_jwt_svid_provider(token_path: str) -> SubjectTokenProvider:
def get_token() -> str:
token = Path(token_path).read_text().strip()
if not token:
raise RuntimeError("The SPIFFE JWT-SVID file is empty.")
return token
return {"token_type": "jwt", "get_token": get_token}
client = OpenAI(
workload_identity={
"identity_provider_id": os.environ["OPENAI_IDENTITY_PROVIDER_ID"],
"service_account_id": os.environ["OPENAI_SERVICE_ACCOUNT_ID"],
"provider": spiffe_jwt_svid_provider(TOKEN_PATH),
},
)
response = client.responses.create(
model="gpt-6.1-terra",
input="Say hello from SPIFFE workload identity federation.",
)
print(response.output_text)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69package main
import (
"context"
"fmt"
"log"
"os"
"strings"
"github.com/openai/openai-go/v3"
"github.com/openai/openai-go/v3/auth"
"github.com/openai/openai-go/v3/option"
"github.com/openai/openai-go/v3/responses"
)
const tokenPath = "/var/run/spiffe/openai.jwt"
type spiffeJWTSVIDProvider struct {
path string
}
func (p spiffeJWTSVIDProvider) TokenType() auth.SubjectTokenType {
return auth.SubjectTokenTypeJWT
}
func (p spiffeJWTSVIDProvider) GetToken(ctx context.Context, _ auth.HTTPDoer) (string, error) {
data, err := os.ReadFile(p.path)
if err != nil {
return "", &auth.SubjectTokenProviderError{
Provider: "spiffe",
Message: "failed to read SPIFFE JWT-SVID",
Cause: err,
}
}
token := strings.TrimSpace(string(data))
if token == "" {
return "", &auth.SubjectTokenProviderError{
Provider: "spiffe",
Message: "SPIFFE JWT-SVID file is empty",
}
}
return token, nil
}
func main() {
client := openai.NewClient(
option.WithWorkloadIdentity(auth.WorkloadIdentity{
IdentityProviderID: os.Getenv("OPENAI_IDENTITY_PROVIDER_ID"),
ServiceAccountID: os.Getenv("OPENAI_SERVICE_ACCOUNT_ID"),
Provider: spiffeJWTSVIDProvider{
path: tokenPath,
},
}),
)
response, err := client.Responses.New(context.Background(), responses.ResponseNewParams{
Model: openai.ChatModelGPT4_1Mini,
Input: responses.ResponseNewParamsInputUnion{
OfString: openai.String("Say hello from SPIFFE workload identity federation."),
},
})
if err != nil {
log.Fatal(err)
}
fmt.Println(response.OutputText())
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75import com.fasterxml.jackson.databind.json.JsonMapper;
import com.openai.auth.SubjectTokenProvider;
import com.openai.auth.SubjectTokenType;
import com.openai.auth.WorkloadIdentity;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.core.http.HttpClient;
import com.openai.errors.SubjectTokenProviderException;
import com.openai.models.responses.ResponseCreateParams;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.concurrent.CompletableFuture;
public final class SpiffeWorkloadIdentityExample {
private static final String TOKEN_PATH = "/var/run/spiffe/openai.jwt";
private SpiffeWorkloadIdentityExample() {}
static final class SpiffeJwtSvidProvider implements SubjectTokenProvider {
private final Path tokenPath;
SpiffeJwtSvidProvider(String tokenPath) {
this.tokenPath = Path.of(tokenPath);
}
@Override
public SubjectTokenType tokenType() {
return SubjectTokenType.JWT;
}
@Override
public String getToken(HttpClient httpClient, JsonMapper jsonMapper) {
String token;
try {
token = Files.readString(tokenPath).trim();
} catch (Exception e) {
throw new SubjectTokenProviderException("spiffe", "failed to read SPIFFE JWT-SVID", e);
}
if (token.isEmpty()) {
throw new SubjectTokenProviderException("spiffe", "SPIFFE JWT-SVID file is empty", null);
}
return token;
}
@Override
public CompletableFuture<String> getTokenAsync(HttpClient httpClient, JsonMapper jsonMapper) {
return CompletableFuture.supplyAsync(() -> getToken(httpClient, jsonMapper));
}
}
public static void main(String[] args) {
WorkloadIdentity workloadIdentity =
WorkloadIdentity.builder()
.identityProviderId(System.getenv("OPENAI_IDENTITY_PROVIDER_ID"))
.serviceAccountId(System.getenv("OPENAI_SERVICE_ACCOUNT_ID"))
.provider(new SpiffeJwtSvidProvider(TOKEN_PATH))
.build();
OpenAIClient client = OpenAIOkHttpClient.builder().workloadIdentity(workloadIdentity).build();
ResponseCreateParams params =
ResponseCreateParams.builder()
.model("gpt-6.1-terra")
.input("Say hello from SPIFFE workload identity federation.")
.build();
client.responses().create(params).output().stream()
.flatMap(item -> item.message().stream())
.flatMap(message -> message.content().stream())
.flatMap(content -> content.outputText().stream())
.forEach(outputText -> System.out.println(outputText.text()));
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49require "openai"
TOKEN_PATH = "/var/run/spiffe/openai.jwt"
class SpiffeJWTSVIDProvider
include OpenAI::Auth::SubjectTokenProvider
def initialize(token_path:)
@token_path = token_path
end
def token_type
OpenAI::Auth::TokenType::JWT
end
def get_token
token = File.read(@token_path).strip
if token.empty?
raise OpenAI::Errors::SubjectTokenProviderError.new(
message: "SPIFFE JWT-SVID file is empty",
provider: "spiffe"
)
end
token
rescue SystemCallError => e
raise OpenAI::Errors::SubjectTokenProviderError.new(
message: "Failed to read SPIFFE JWT-SVID: #{e.message}",
provider: "spiffe",
cause: e
)
end
end
provider = SpiffeJWTSVIDProvider.new(token_path: TOKEN_PATH)
workload_identity = OpenAI::Auth::WorkloadIdentity.new(
identity_provider_id: ENV.fetch("OPENAI_IDENTITY_PROVIDER_ID"),
service_account_id: ENV.fetch("OPENAI_SERVICE_ACCOUNT_ID"),
provider: provider
)
client = OpenAI::Client.new(workload_identity: workload_identity)
response = client.responses.create(
model: "gpt-6.1-terra",
input: "Say hello from SPIFFE workload identity federation."
)
puts(response.output_text)
- 使用 JWT-SVID 进行 OpenAI 工作负载身份联合。X.509-SVID 可用于双向 TLS 认证,但 OpenAI 令牌交换端点不接受 X.509-SVID。
- 为访问 OpenAI 指定单一的专用受众。避免使用范围过大的受众,例如整个信任域或环境名称。
- 尽可能精确匹配 SPIFFE ID。仅在明确需要共享信任边界时使用通配符映射。
- 为 JWT-SVID 设置较短的有效期,以降低持有者令牌遭受重放攻击的风险。OpenAI 访问令牌的过期时间不会晚于交换时使用的外部主体令牌。
- 谨慎轮换签名密钥。在轮换期间通过 OIDC 发现机制同时发布新旧公钥,或在使用新的
kid 签发 JWT-SVID 之前更新已上传的公开 JWKS。
- 保持 SPIRE Server 与工作负载的时钟同步。时钟偏差过大时,原本有效的 JWT-SVID 可能因被判定为尚未生效、签发时间过早或已过期而遭到拒绝。
- 保护 SPIFFE Workload API 套接字。能够获取工作负载 JWT-SVID 的进程可以尝试用它换取 OpenAI 访问令牌。
- 确保 OpenAI 服务账号的权限边界与应用程序和环境的权限边界一致。不要让不相关的 SPIFFE 工作负载共用高权限服务账号。
- 监控令牌交换失败的情况,检查签发方、受众、签名密钥或映射是否匹配。