28f9a54ba9
把 Obsidian vault 通过 MCP 暴露给 Claude.ai,OAuth 走 nas-auth。 设计文档见 vault Coding/obsidian-mcp/obsidian-mcp 设计.md。 代码层落地参考 vault Coding/obsidian-mcp/MCP 实现指南.md。 V1+V2 同时实现(用户要求跳过分阶段直接全部): 读 Tools(需 scope=read:obsidian): - list_vault_tree(一次性 vault 地图,限制深度) - list_files / read_file(含 offset/limit 大文件分页) - search(子串匹配 + glob 过滤,最多 50 hits) - get_metadata(size / modified_at / has_frontmatter) 写 Tools(需 scope=write:obsidian): - write_file / append_file - 多重门禁:scope 校验 + 路径黑名单 + 写入白名单 + 永禁文件 - 永禁写:任意目录的 AGENTS.md / PROFILE.md / README.md / CLAUDE.md / 01-Secret/** - 白名单:02-ShengquGames/logs/ + Coding/ + NAS/NAS 待办清单.md - 写入审计日志按天 rotate(JSON line) 安全: - VaultPathResolver chroot:path traversal + symlink 双拒绝 - JwtBearer (HS256, Current+Previous fallback, MapInboundClaims=false) - aud=obsidian, iss=https://auth.zhengchentao.win - 黑名单:01-Secret / .obsidian / .trash / .git 技术栈: - .NET 10 + ModelContextProtocol SDK 1.0 - Streamable HTTP transport (POST /mcp) - JwtBearer 10.0 + IdentityModel.Tokens 8.x 部署: - Dockerfile multi-stage,runtime 装 ripgrep(V3 备用),non-root user - .gitea/workflows/build-image.yml:build + deploy 双 job,buildkit v0.13.2 - 容器内 :8080,宿主端口 9090 - 子域名 obs.zhengchentao.win - vault 挂载 /volume1/docker/webdav/data/Zhengchen:/vault:rw(V2 写入需要 rw) 测试:35/35 单测过(VaultPathResolver path traversal/blacklist/symlink + VaultWriteGuard whitelist/forbidden) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
121 lines
4.0 KiB
C#
121 lines
4.0 KiB
C#
using ObsidianMcp.Config;
|
|
using Microsoft.Extensions.Options;
|
|
|
|
namespace ObsidianMcp.Services;
|
|
|
|
/// <summary>
|
|
/// 写入门禁——在路径安全(VaultPathResolver)之上再加写入白名单控制。
|
|
///
|
|
/// 规则优先级(从高到低):
|
|
/// 1. 永禁写入:AGENTS.md / PROFILE.md / README.md / CLAUDE.md(任何路径下的同名文件)
|
|
/// 2. 永禁前缀:01-Secret/
|
|
/// 3. 必须命中写入白名单之一才允许
|
|
///
|
|
/// 白名单(hardcode):
|
|
/// - 前缀 02-ShengquGames/logs/
|
|
/// - 前缀 Coding/
|
|
/// - 精确匹配 NAS/NAS 待办清单.md
|
|
///
|
|
/// 白名单可通过 env Vault__WriteWhitelist__N 扩展。
|
|
/// </summary>
|
|
public class VaultWriteGuard
|
|
{
|
|
// 永禁写入的文件名(不含路径,任何目录下的同名文件都禁写)
|
|
private static readonly HashSet<string> ForbiddenFileNames =
|
|
new(StringComparer.OrdinalIgnoreCase)
|
|
{
|
|
"AGENTS.md",
|
|
"PROFILE.md",
|
|
"README.md",
|
|
"CLAUDE.md",
|
|
};
|
|
|
|
// 永禁写入的路径前缀(相对路径)
|
|
private static readonly string[] ForbiddenPrefixes =
|
|
[
|
|
"01-Secret/",
|
|
"01-Secret\\",
|
|
];
|
|
|
|
// hardcode 写入白名单
|
|
// 前缀匹配:以 / 或 \ 结尾表示前缀;精确匹配:其他
|
|
private static readonly string[] HardcodeWhitelist =
|
|
[
|
|
"02-ShengquGames/logs/",
|
|
"02-ShengquGames\\logs\\",
|
|
"Coding/",
|
|
"Coding\\",
|
|
"NAS/NAS 待办清单.md",
|
|
"NAS\\NAS 待办清单.md",
|
|
];
|
|
|
|
private readonly VaultPathResolver _resolver;
|
|
private readonly string[] _extraWhitelist;
|
|
|
|
public VaultWriteGuard(VaultPathResolver resolver, IOptions<VaultOptions> opts)
|
|
{
|
|
_resolver = resolver;
|
|
_extraWhitelist = opts.Value.WriteWhitelist ?? [];
|
|
}
|
|
|
|
/// <summary>
|
|
/// 校验相对路径是否允许写入。
|
|
/// 通过则返回规范化后的绝对路径;不通过则抛 UnauthorizedAccessException。
|
|
/// </summary>
|
|
public string EnsureWritable(string relativePath)
|
|
{
|
|
// 先过路径安全守卫(防穿越 + 黑名单)
|
|
var absPath = _resolver.Resolve(relativePath);
|
|
|
|
// 规范化相对路径(用于白名单匹配),统一用 /
|
|
var normalized = NormalizeRelative(relativePath);
|
|
|
|
// 1. 永禁文件名
|
|
var fileName = Path.GetFileName(absPath);
|
|
if (ForbiddenFileNames.Contains(fileName))
|
|
throw new UnauthorizedAccessException(
|
|
$"禁止写入保护文件:{relativePath}");
|
|
|
|
// 2. 永禁前缀
|
|
foreach (var prefix in ForbiddenPrefixes)
|
|
{
|
|
if (normalized.StartsWith(NormalizeRelative(prefix), StringComparison.OrdinalIgnoreCase))
|
|
throw new UnauthorizedAccessException(
|
|
$"禁止写入 01-Secret/ 目录:{relativePath}");
|
|
}
|
|
|
|
// 3. 白名单(hardcode + env 扩展)
|
|
if (!IsInWhitelist(normalized))
|
|
throw new UnauthorizedAccessException(
|
|
$"路径不在写入白名单内:{relativePath}");
|
|
|
|
return absPath;
|
|
}
|
|
|
|
private bool IsInWhitelist(string normalized)
|
|
{
|
|
var allWhitelist = HardcodeWhitelist.Concat(_extraWhitelist);
|
|
foreach (var entry in allWhitelist)
|
|
{
|
|
var normalizedEntry = NormalizeRelative(entry);
|
|
if (normalizedEntry.EndsWith('/'))
|
|
{
|
|
// 前缀匹配
|
|
if (normalized.StartsWith(normalizedEntry, StringComparison.OrdinalIgnoreCase))
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
// 精确匹配
|
|
if (string.Equals(normalized, normalizedEntry, StringComparison.OrdinalIgnoreCase))
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/// <summary>统一用 / 作分隔符,用于白名单匹配。</summary>
|
|
private static string NormalizeRelative(string path) =>
|
|
path.Replace('\\', '/');
|
|
}
|