Repository navigation
Expand file tree
/
Copy pathauth.go
More file actions
549 lines (496 loc) · 18.6 KB
/
Copy pathauth.go
File metadata and controls
549 lines (496 loc) · 18.6 KB
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
// Copyright (c) 2026 Matthew Winter
//
// This source code is licensed under the MIT license found in the LICENSE file
// in the root directory of this source tree.
package sigma
import (
"context"
"errors"
"fmt"
"io"
"os"
"sort"
"strings"
"time"
"github.com/wintermi/sigma/internal/headerutil"
"github.com/wintermi/sigma/internal/redact"
)
// CredentialType identifies the kind of authentication material.
type CredentialType string
const (
// CredentialTypeAPIKey identifies a static API key.
CredentialTypeAPIKey CredentialType = "api-key"
// CredentialTypeOAuthToken identifies a bearer token from an OAuth provider.
CredentialTypeOAuthToken CredentialType = "oauth-token"
// CredentialTypeCloudCredential identifies cloud provider credential material.
CredentialTypeCloudCredential CredentialType = "cloud-credential"
)
const (
// MetadataAPIKeyEnvVar names one API-key environment variable in model metadata.
MetadataAPIKeyEnvVar = "apiKeyEnvVar"
// MetadataAPIKeyEnvVars names ordered API-key environment variables in model metadata.
MetadataAPIKeyEnvVars = "apiKeyEnvVars"
)
const (
defaultOpenAIAPIKeyEnv = "OPENAI_API_KEY"
defaultAzureOpenAIAPIKeyEnv = "AZURE_OPENAI_API_KEY"
defaultAnthropicAuthTokenEnv = "ANTHROPIC_AUTH_TOKEN"
defaultAnthropicOAuthTokenEnv = "ANTHROPIC_OAUTH_TOKEN"
defaultAnthropicAPIKeyEnv = "ANTHROPIC_API_KEY"
defaultGoogleAPIKeyEnv = "GOOGLE_API_KEY"
defaultGoogleCloudAPIKeyEnv = "GOOGLE_CLOUD_API_KEY"
defaultGeminiAPIKeyEnv = "GEMINI_API_KEY"
defaultMistralAPIKeyEnv = "MISTRAL_API_KEY"
defaultRadiusAPIKeyEnv = "RADIUS_API_KEY"
defaultOpenRouterAPIKeyEnv = "OPENROUTER_API_KEY"
defaultXAIAPIKeyEnv = "XAI_API_KEY"
defaultCloudflareAPIKeyEnv = "CLOUDFLARE_API_KEY"
defaultGroqAPIKeyEnv = "GROQ_API_KEY"
defaultTogetherAPIKeyEnv = "TOGETHER_API_KEY"
defaultBasetenAPIKeyEnv = "BASETEN_API_KEY"
defaultHuggingFaceTokenEnv = "HF_TOKEN"
defaultCopilotGitHubTokenEnv = "COPILOT_GITHUB_TOKEN"
defaultNVIDIAAPIKeyEnv = "NVIDIA_API_KEY"
defaultZAICodingCNAPIKeyEnv = "ZAI_CODING_CN_API_KEY"
defaultMoonshotAPIKeyEnv = "MOONSHOT_API_KEY"
defaultKimiAPIKeyEnv = "KIMI_API_KEY"
defaultFireworksAPIKeyEnv = "FIREWORKS_API_KEY"
defaultOpenCodeAPIKeyEnv = "OPENCODE_API_KEY"
defaultVercelAIGatewayKeyEnv = "AI_GATEWAY_API_KEY"
defaultQwenTokenPlanAPIKeyEnv = "QWEN_TOKEN_PLAN_API_KEY"
)
var defaultProviderEnvNames = map[ProviderID][]string{
ProviderOpenAI: {defaultOpenAIAPIKeyEnv},
ProviderAzureOpenAIResponses: {defaultAzureOpenAIAPIKeyEnv},
ProviderAnthropic: {defaultAnthropicAuthTokenEnv, defaultAnthropicOAuthTokenEnv, defaultAnthropicAPIKeyEnv},
ProviderGoogle: {defaultGoogleAPIKeyEnv, defaultGoogleCloudAPIKeyEnv, defaultGeminiAPIKeyEnv},
ProviderGoogleVertex: {defaultGoogleCloudAPIKeyEnv, defaultGoogleAPIKeyEnv},
ProviderGoogleVertexOpenAI: {defaultGoogleCloudAPIKeyEnv, defaultGoogleAPIKeyEnv},
ProviderGoogleVertexAnthropic: {defaultGoogleCloudAPIKeyEnv, defaultGoogleAPIKeyEnv},
ProviderMistral: {defaultMistralAPIKeyEnv},
ProviderRadius: {defaultRadiusAPIKeyEnv},
ProviderOpenRouter: {defaultOpenRouterAPIKeyEnv},
ProviderDeepSeek: {"DEEPSEEK_API_KEY"},
ProviderGroq: {defaultGroqAPIKeyEnv},
ProviderCerebras: {"CEREBRAS_API_KEY"},
ProviderXAI: {defaultXAIAPIKeyEnv},
ProviderTogether: {defaultTogetherAPIKeyEnv},
ProviderBaseten: {defaultBasetenAPIKeyEnv},
ProviderHuggingFace: {defaultHuggingFaceTokenEnv},
ProviderCloudflareAIGateway: {defaultCloudflareAPIKeyEnv},
ProviderCloudflareWorkersAI: {defaultCloudflareAPIKeyEnv},
ProviderGitHubCopilot: {defaultCopilotGitHubTokenEnv},
ProviderNVIDIA: {defaultNVIDIAAPIKeyEnv},
ProviderZAI: {"ZAI_API_KEY"},
ProviderZAICodingCN: {defaultZAICodingCNAPIKeyEnv},
ProviderAntLing: {"ANT_LING_API_KEY"},
ProviderMoonshotAI: {defaultMoonshotAPIKeyEnv},
ProviderMoonshotAICN: {defaultMoonshotAPIKeyEnv},
ProviderMiniMax: {"MINIMAX_API_KEY"},
ProviderMiniMaxCN: {"MINIMAX_CN_API_KEY"},
ProviderVercelAIGateway: {defaultVercelAIGatewayKeyEnv},
ProviderOpenCode: {defaultOpenCodeAPIKeyEnv},
ProviderOpenCodeGo: {defaultOpenCodeAPIKeyEnv},
ProviderFireworks: {defaultFireworksAPIKeyEnv},
ProviderFireworksAnthropic: {defaultFireworksAPIKeyEnv},
ProviderKimi: {defaultKimiAPIKeyEnv},
ProviderKimiCoding: {defaultKimiAPIKeyEnv},
ProviderXiaomi: {"XIAOMI_API_KEY"},
ProviderXiaomiTokenPlanCN: {"XIAOMI_TOKEN_PLAN_CN_API_KEY"},
ProviderXiaomiTokenPlanAMS: {"XIAOMI_TOKEN_PLAN_AMS_API_KEY"},
ProviderXiaomiTokenPlanSGP: {"XIAOMI_TOKEN_PLAN_SGP_API_KEY"},
ProviderQwenTokenPlan: {defaultQwenTokenPlanAPIKeyEnv},
ProviderQwenTokenPlanIndividual: {defaultQwenTokenPlanAPIKeyEnv},
ProviderQwenTokenPlanCN: {"QWEN_TOKEN_PLAN_CN_API_KEY"},
}
// Credential carries authentication material for a provider.
type Credential struct {
Type CredentialType
Value string
Expiry time.Time
Source string
Metadata map[string]any
}
// String returns a diagnostic-safe credential description.
func (c Credential) String() string {
return c.safeString()
}
// Format prevents fmt from printing Credential.Value with struct formatting verbs.
func (c Credential) Format(state fmt.State, verb rune) {
_, _ = io.WriteString(state, c.safeString())
}
func (c Credential) safeString() string {
parts := []string{"credential"}
if c.Type != "" {
parts = append(parts, "type="+string(c.Type))
}
if c.Source != "" {
parts = append(parts, "source="+redact.Source(c.Source))
}
if !c.Expiry.IsZero() {
parts = append(parts, "expiry="+c.Expiry.Format(time.RFC3339))
}
if len(c.Metadata) > 0 {
parts = append(parts, "metadata="+strings.Join(sortedAnyMapKeys(c.Metadata), ","))
}
if c.Value != "" {
parts = append(parts, "value="+redact.Secret(c.Value))
}
return strings.Join(parts, " ")
}
// AuthResolver resolves provider credentials for a request.
type AuthResolver interface {
Resolve(context.Context, Model, Options) (Credential, error)
}
// AuthResolutionResolver resolves provider credentials plus provider-scoped
// request configuration for a request.
type AuthResolutionResolver interface {
ResolveAuthResolution(context.Context, Model, Options) (AuthResolution, error)
}
// AuthResolverFunc adapts a function into an AuthResolver.
type AuthResolverFunc func(context.Context, Model, Options) (Credential, error)
// Resolve calls f.
func (f AuthResolverFunc) Resolve(ctx context.Context, model Model, opts Options) (Credential, error) {
if f == nil {
return Credential{}, unavailableCredential(model)
}
return f(ctx, model, opts)
}
// ResolveAuthForRequest resolves request auth and returns options augmented
// with descriptor-provided provider configuration. Caller-supplied headers and
// provider options keep precedence over auth-derived values.
func ResolveAuthForRequest(ctx context.Context, model Model, opts Options) (Options, Credential, error) {
resolution, err := ResolveAuthResolution(ctx, model, opts)
if err != nil {
return Options{}, Credential{}, err
}
return optionsWithAuthResolution(model.Provider, opts, resolution), resolution.Credential, nil
}
// ResolveAuthResolution resolves request auth through opts.AuthResolver.
func ResolveAuthResolution(ctx context.Context, model Model, opts Options) (AuthResolution, error) {
return resolveAuthResolution(ctx, model, opts, opts.AuthResolver)
}
func resolveAuthResolution(ctx context.Context, model Model, opts Options, resolver AuthResolver) (AuthResolution, error) {
if resolver == nil {
return AuthResolution{}, unavailableCredential(model, "auth-resolver")
}
if rich, ok := resolver.(AuthResolutionResolver); ok {
resolution, err := rich.ResolveAuthResolution(ctx, model, opts)
if err != nil {
return AuthResolution{}, fmt.Errorf("auth resolution: %w", err)
}
return normalizeAuthResolution(resolution), nil
}
credential, err := resolver.Resolve(ctx, model, opts)
if err != nil {
return AuthResolution{}, err
}
return normalizeAuthResolution(AuthResolution{Credential: credential, Source: credential.Source}), nil
}
func normalizeAuthResolution(resolution AuthResolution) AuthResolution {
if resolution.Source == "" {
resolution.Source = resolution.Credential.Source
}
return resolution
}
func optionsWithAuthResolution(provider ProviderID, opts Options, resolution AuthResolution) Options {
applied := cloneOptions(opts)
mergeAuthResolutionHeaders(&applied, resolution.Headers)
mergeAuthResolutionProviderOptions(&applied, provider, resolution.BaseURL, resolution.ProviderOptions)
return applied
}
func mergeAuthResolutionHeaders(opts *Options, headers map[string]string) {
if len(headers) == 0 {
return
}
opts.Headers = headerutil.Merge(headers, opts.Headers)
}
func mergeAuthResolutionProviderOptions(opts *Options, provider ProviderID, baseURL string, values map[string]any) {
const baseURLKey, baseURLCamelKey = "base_url", "baseURL"
if baseURL == "" && len(values) == 0 {
return
}
if opts.ProviderOptions == nil {
opts.ProviderOptions = make(map[ProviderID]map[string]any)
}
if opts.ProviderOptions[provider] == nil {
opts.ProviderOptions[provider] = make(map[string]any, len(values)+1)
}
providerOptions := opts.ProviderOptions[provider]
_, hasSnake := providerOptions[baseURLKey]
_, hasCamel := providerOptions[baseURLCamelKey]
hasExplicitBaseURL := hasSnake || hasCamel
if baseURL != "" && !hasExplicitBaseURL {
providerOptions[baseURLKey] = baseURL
}
for key, value := range values {
// Both supported spellings represent the caller's same routing choice.
if hasExplicitBaseURL && (key == baseURLKey || key == baseURLCamelKey) {
continue
}
if _, exists := providerOptions[key]; !exists {
providerOptions[key] = value
}
}
}
// OAuthTokenProvider provides OAuth tokens for a provider adapter.
type OAuthTokenProvider interface {
Token(context.Context, Model, Options) (Credential, error)
}
// OAuthTokenProviderFunc adapts a function into an OAuthTokenProvider.
type OAuthTokenProviderFunc func(context.Context, Model, Options) (Credential, error)
// Token calls f.
func (f OAuthTokenProviderFunc) Token(ctx context.Context, model Model, opts Options) (Credential, error) {
if f == nil {
return Credential{}, unavailableCredential(model, "oauth-token-provider")
}
return f(ctx, model, opts)
}
// CloudCredentialProvider provides cloud credential material for a provider adapter.
type CloudCredentialProvider interface {
Credential(context.Context, Model, Options) (Credential, error)
}
// CredentialUnavailableError reports a failed credential lookup without secrets.
type CredentialUnavailableError struct {
Provider ProviderID
Model ModelID
Sources []string
}
// Error returns diagnostic-safe source information.
func (e *CredentialUnavailableError) Error() string {
if e == nil {
return ""
}
message := "credential unavailable"
if e.Provider != "" || e.Model != "" {
message += fmt.Sprintf(" for %s/%s", e.Provider, e.Model)
}
if len(e.Sources) > 0 {
message += " after checking " + strings.Join(redactSources(e.Sources), ", ")
}
return message
}
// Is supports errors.Is(err, ErrCredentialUnavailable).
func (e *CredentialUnavailableError) Is(target error) bool {
return target == ErrCredentialUnavailable
}
// EnvironmentAuthResolver resolves static API keys from environment variables.
type EnvironmentAuthResolver struct {
LookupEnv func(string) (string, bool)
}
// EnvVars returns the ordered environment variable names that would be checked
// for model credentials. Model metadata takes precedence over provider
// defaults. Secret values are not returned.
func (r EnvironmentAuthResolver) EnvVars(model Model) []string {
return environmentCredentialSources(model)
}
// ConfiguredEnvVars returns the ordered environment variable names that are
// currently set to non-empty values for model credentials. Secret values are
// not returned.
func (r EnvironmentAuthResolver) ConfiguredEnvVars(model Model) []string {
lookup := r.LookupEnv
if lookup == nil {
lookup = os.LookupEnv
}
var configured []string
for _, source := range r.EnvVars(model) {
value, ok := lookup(source)
if ok && value != "" {
configured = append(configured, source)
}
}
return configured
}
// Resolve returns the first non-empty provider API key found in the environment.
func (r EnvironmentAuthResolver) Resolve(_ context.Context, model Model, _ Options) (Credential, error) {
lookup := r.LookupEnv
if lookup == nil {
lookup = os.LookupEnv
}
sources := r.EnvVars(model)
for _, source := range sources {
value, ok := lookup(source)
if ok && value != "" {
return Credential{
Type: CredentialTypeAPIKey,
Value: value,
Source: "env:" + source,
}, nil
}
}
return Credential{}, unavailableCredential(model, prefixSources("env:", sources)...)
}
// ChainAuthResolver resolves credentials through sigma's standard precedence.
//
// ProviderCallbacks holds request-scoped provider callbacks and takes
// precedence over the client resolver. DefaultProviderCallbacks holds
// callbacks installed as client or model defaults; they resolve after the
// client resolver and environment, preserving their pre-request-scoped
// position so an explicit client resolver keeps winning over ambient
// defaults.
type ChainAuthResolver struct {
Client AuthResolver
Environment AuthResolver
ProviderCallbacks map[ProviderID]AuthResolver
DefaultProviderCallbacks map[ProviderID]AuthResolver
}
// Resolve checks request overrides, request-scoped provider callbacks, the
// client resolver, environment, then default provider callbacks.
func (r ChainAuthResolver) Resolve(ctx context.Context, model Model, opts Options) (Credential, error) {
resolution, err := r.ResolveAuthResolution(ctx, model, opts)
if err != nil {
return Credential{}, err
}
return resolution.Credential, nil
}
// ResolveAuthResolution checks request overrides, request-scoped provider
// callbacks, the client resolver, environment, then default provider
// callbacks.
func (r ChainAuthResolver) ResolveAuthResolution(ctx context.Context, model Model, opts Options) (AuthResolution, error) {
if opts.APIKey != "" {
credential := Credential{
Type: CredentialTypeAPIKey,
Value: opts.APIKey,
Source: "request:api-key",
}
return AuthResolution{Credential: credential, Source: credential.Source}, nil
}
var sources []string
resolverOptions := opts
resolverOptions.AuthResolver = nil
if callback := r.ProviderCallbacks[model.Provider]; callback != nil {
resolution, err := resolveAuthResolution(ctx, model, resolverOptions, callback)
if err == nil {
return resolution, nil
}
if !chainCanContinue(err) {
return AuthResolution{}, err
}
sources = append(sources, credentialErrorSources(err)...)
}
if r.Client != nil {
resolution, err := resolveAuthResolution(ctx, model, resolverOptions, r.Client)
if err == nil {
return resolution, nil
}
if !chainCanContinue(err) {
return AuthResolution{}, err
}
sources = append(sources, credentialErrorSources(err)...)
}
environment := r.Environment
if environment == nil {
environment = EnvironmentAuthResolver{}
}
resolution, err := resolveAuthResolution(ctx, model, resolverOptions, environment)
if err == nil {
return resolution, nil
}
if !chainCanContinue(err) {
return AuthResolution{}, err
}
sources = append(sources, credentialErrorSources(err)...)
if callback := r.DefaultProviderCallbacks[model.Provider]; callback != nil {
resolution, err := resolveAuthResolution(ctx, model, resolverOptions, callback)
if err == nil {
return resolution, nil
}
if !chainCanContinue(err) {
return AuthResolution{}, err
}
sources = append(sources, credentialErrorSources(err)...)
}
return AuthResolution{}, unavailableCredential(model, sources...)
}
// chainCanContinue reports whether the chain may try its next source after
// err. A failed stored OAuth credential owns its provider, so it stops the
// chain even though it wraps ErrCredentialUnavailable.
func chainCanContinue(err error) bool {
var stored *storedOAuthError
return errors.Is(err, ErrCredentialUnavailable) && !errors.As(err, &stored)
}
func unavailableCredential(model Model, sources ...string) error {
return &CredentialUnavailableError{
Provider: model.Provider,
Model: model.ID,
Sources: uniqueStrings(sources),
}
}
func credentialErrorSources(err error) []string {
var unavailable *CredentialUnavailableError
if errors.As(err, &unavailable) {
return unavailable.Sources
}
return nil
}
func environmentCredentialSources(model Model) []string {
var sources []string
sources = appendMetadataEnvNames(sources, model.ProviderMetadata[MetadataAPIKeyEnvVar])
sources = appendMetadataEnvNames(sources, model.ProviderMetadata[MetadataAPIKeyEnvVars])
sources = append(sources, defaultEnvNames(model.Provider)...)
return uniqueStrings(sources)
}
func appendMetadataEnvNames(sources []string, value any) []string {
switch names := value.(type) {
case string:
if names != "" {
sources = append(sources, names)
}
case []string:
sources = append(sources, names...)
case []any:
for _, name := range names {
if text, ok := name.(string); ok && text != "" {
sources = append(sources, text)
}
}
}
return sources
}
func defaultEnvNames(provider ProviderID) []string {
names := defaultProviderEnvNames[provider]
if len(names) == 0 {
return nil
}
return append([]string(nil), names...)
}
func prefixSources(prefix string, sources []string) []string {
prefixed := make([]string, 0, len(sources))
for _, source := range sources {
prefixed = append(prefixed, prefix+source)
}
return prefixed
}
func redactSources(sources []string) []string {
redacted := make([]string, 0, len(sources))
for _, source := range sources {
redacted = append(redacted, redact.Source(source))
}
return redacted
}
func sortedAnyMapKeys(values map[string]any) []string {
keys := make([]string, 0, len(values))
for key := range values {
keys = append(keys, key)
}
sort.Strings(keys)
return keys
}
func uniqueStrings(values []string) []string {
if len(values) == 0 {
return nil
}
seen := make(map[string]struct{}, len(values))
unique := make([]string, 0, len(values))
for _, value := range values {
if value == "" {
continue
}
if _, ok := seen[value]; ok {
continue
}
seen[value] = struct{}{}
unique = append(unique, value)
}
return unique
}