Files
2026-07-13 12:58:18 +08:00

121 lines
5.0 KiB
C#

using Microsoft.Extensions.Configuration;
/// <summary>
/// Resolves the OpenAI-compatible API key for outbound LLM calls.
/// Single source of truth shared by <c>Program.cs</c> (primary OpenAI client)
/// and <see cref="A2uiSecondaryToolCaller"/> (secondary tool-calling HTTP client).
/// </summary>
internal static class ApiKeyResolver
{
internal const string MockApiKey = "sk-mock-local";
internal const string DefaultOpenAiEndpoint = "https://models.inference.ai.azure.com";
/// <summary>
/// Resolves the API key using (in order): <c>OPENAI_API_KEY</c> env var,
/// <c>configuration["OPENAI_API_KEY"]</c>, then <c>configuration["GitHubToken"]</c>.
///
/// If none of those are set, behavior depends on the upstream endpoint
/// (<c>OPENAI_BASE_URL</c> env / config): when it looks like aimock or
/// localhost, the mock key is returned silently (intended dev path); for
/// any other endpoint we fail-fast with an <see cref="InvalidOperationException"/>
/// so misconfigured prod deployments do not silently send a bogus key.
/// </summary>
internal static string ResolveApiKey(IConfiguration configuration, ILogger? logger = null)
{
ArgumentNullException.ThrowIfNull(configuration);
var apiKey = FirstNonBlank(
Environment.GetEnvironmentVariable("OPENAI_API_KEY"),
configuration["OPENAI_API_KEY"],
configuration["GitHubToken"]);
if (apiKey is not null)
{
return apiKey;
}
var endpoint = ResolveEndpoint(configuration);
if (IsMockEndpoint(endpoint))
{
// Silent fallback in dev — aimock/localhost ignores the key.
return MockApiKey;
}
var message =
"No API key found (checked OPENAI_API_KEY env, configuration[OPENAI_API_KEY], configuration[GitHubToken]) " +
$"and OPENAI_BASE_URL ('{endpoint}') is not an aimock/localhost endpoint. " +
"Refusing to fall back to the mock key for a non-mock endpoint.";
logger?.LogCritical("[api-key-resolver] {Message}", message);
throw new InvalidOperationException(message);
}
/// <summary>
/// Returns the configured OpenAI endpoint, preferring env var then config,
/// then falling back to the public Azure-hosted models endpoint.
/// </summary>
internal static string ResolveEndpoint(IConfiguration configuration)
{
ArgumentNullException.ThrowIfNull(configuration);
return FirstNonBlank(
Environment.GetEnvironmentVariable("OPENAI_BASE_URL"),
configuration["OPENAI_BASE_URL"]) ?? DefaultOpenAiEndpoint;
}
/// <summary>
/// Returns the first candidate that is neither null nor whitespace-only.
/// Used in place of the <c>??</c> operator when cascading through env var
/// → configuration sources, since <c>??</c> only short-circuits on null
/// and would otherwise let an empty-string env var mask a configured
/// fallback.
/// </summary>
private static string? FirstNonBlank(params string?[] candidates)
{
foreach (var candidate in candidates)
{
if (!string.IsNullOrWhiteSpace(candidate))
{
return candidate;
}
}
return null;
}
private static bool IsMockEndpoint(string endpoint)
{
// Parse and inspect ONLY the host component. Substring matching against
// the full URL is exploitable: an attacker-controlled endpoint like
// https://attacker.example.com/aimock-decoy or
// https://api.openai.com/?env=localhost would otherwise be classified
// as a mock and bypass the fail-fast guard, silently returning the
// mock key.
//
// Subdomain matching (e.g. host.StartsWith("aimock.")) is also rejected
// as attack surface: an attacker-registered domain like
// "aimock.attacker.example.com" would otherwise be classified as a
// mock endpoint. Only exact, well-known mock hosts and loopback
// addresses are accepted.
//
// Loopback detection delegates to <see cref="Uri.IsLoopback"/> because
// Uri.Host's formatting is not stable across loopback variants:
// <c>new Uri("http://[::1]:8000/").Host</c> returns <c>"[::1]"</c>
// (with brackets), so a naive <c>host == "::1"</c> check silently
// fails. <c>Uri.IsLoopback</c> covers <c>localhost</c>, the entire
// <c>127.0.0.0/8</c> range, <c>::1</c> in any bracketed form, and
// IPv4-mapped IPv6 loopback (<c>::ffff:127.0.0.1</c>).
if (!Uri.TryCreate(endpoint, UriKind.Absolute, out var uri))
{
return false;
}
if (uri.IsLoopback)
{
return true;
}
var host = uri.Host;
return host == "0.0.0.0" // unspecified address; OS-dependent, kept for back-compat
|| host.Equals("aimock", StringComparison.OrdinalIgnoreCase); // Docker-compose service name
}
}