McpHelper.SQLite 1.0.9

McpHelper.SQLite

McpHelper SQLite 数据库认证扩展，提供基于 SQLite 数据库的 API Key 认证功能。

功能特性

• 数据库认证 - 从 SQLite 数据库验证 API Key
• 认证缓存 - 内置缓存机制，减少数据库查询
• 认证日志 - 可选的认证日志记录功能
• 健康检查 - 支持数据库连接健康检查

安装

dotnet add package McpHelper.SQLite

依赖

目标框架

• .NET 10.0

快速开始

1. 基础使用

using McpHelper.Extensions;

var builder = WebApplication.CreateBuilder(args);

// 注册核心中间件
builder.Services.AddMcpHelper();

// 添加 SQLite 认证
builder.Services.AddSqliteAuthentication(options =>
{
    options.ConnectionString = "Data Source=api_keys.db";
    options.TableName = "api_keys";
    options.KeyColumnName = "key";
});

var app = builder.Build();
app.MapMcpHelper();
app.Run();

2. 完整配置

builder.Services.AddSqliteAuthentication(options =>
{
    // 数据库连接字符串
    options.ConnectionString = "Data Source=api_keys.db";

    // 表和列配置
    options.TableName = "api_keys";
    options.KeyColumnName = "key";

    // 可选：缓存配置
    options.EnableCache = true;
    options.CacheExpirationMinutes = 30;

    // 可选：认证日志
    options.EnableAuthLog = true;
    options.LogTableName = "auth_logs";
});

配置选项

DatabaseOptions

数据库表结构

API Key 表

CREATE TABLE api_keys (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    key TEXT NOT NULL UNIQUE,
    created_at TEXT DEFAULT CURRENT_TIMESTAMP,
    is_active INTEGER DEFAULT 1,
    description TEXT
);

-- 创建索引
CREATE INDEX idx_api_keys_key ON api_keys(key);

认证日志表（可选）

CREATE TABLE auth_logs (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    key TEXT NOT NULL,
    success INTEGER NOT NULL,
    ip_address TEXT,
    user_agent TEXT,
    timestamp TEXT DEFAULT CURRENT_TIMESTAMP
);

-- 创建索引
CREATE INDEX idx_auth_logs_timestamp ON auth_logs(timestamp);

使用示例

创建 API Key

using Microsoft.Data.Sqlite;

// 插入新的 API Key
using var connection = new SqliteConnection("Data Source=api_keys.db");
await connection.OpenAsync();

using var command = connection.CreateCommand();
command.CommandText = @"
    INSERT INTO api_keys (key, description)
    VALUES (@key, @description)";

command.Parameters.AddWithValue("@key", Guid.NewGuid().ToString("N"));
command.Parameters.AddWithValue("@description", "My API Key");

await command.ExecuteNonQueryAsync();

验证 API Key

认证由中间件自动处理，只需在请求头中添加：

X-Api-Key: your-api-key

完整示例项目

参见 McpHelper.Example.SqliteAuth。

认证缓存

启用缓存后，验证通过的 API Key 会被缓存，减少数据库查询：

• 缓存时间：默认 30 分钟
• 自动刷新：缓存过期后自动重新查询
• 内存存储：使用内存缓存，重启后清空

认证日志

启用日志后，每次认证尝试都会记录：

健康检查

SQLite 认证扩展会自动注册数据库连接工厂，支持健康检查：

builder.Services.AddHealthChecks()
    .AddSqlite("Data Source=api_keys.db", name: "sqlite-auth");

与其他认证方式对比

相关项目

• McpHelper.Core - 核心库
• McpHelper.PostgreSQL - PostgreSQL 数据库认证扩展

许可证

MIT License