config

package
v2.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const DefaultJWTSecret = "relaymesh-secret-key-change-in-production"

DefaultJWTSecret 是历史版本内置的 JWT 签名密钥默认值。

它随开源代码公开,任何人都能用它伪造管理员令牌,因此现在只作为「未配置」的哨兵值: 启动时若环境变量缺省或强度不足,会被自动生成并持久化的随机密钥取代,永远不会被用于签名。

View Source
const (
	// MinJWTSecretLength 是 JWT 签名密钥的最小字节数(HS256 至少应有 256 bit 熵的量级,README 亦要求不少于 32 字符)。
	MinJWTSecretLength = 32
)
View Source
const (
	// MinMCPTokenLength 是被授予「远程执行」权限的 MCP 令牌的最小长度。
	// 服务端自动生成的令牌(rm- + 64 位十六进制)远超此值;只有手工指定或来自环境变量的令牌才可能不合格。
	MinMCPTokenLength = 24
)

Variables

This section is empty.

Functions

func EnsureDataDir

func EnsureDataDir(dataDir string) error

EnsureDataDir creates the data directory and its certs subdirectory with secure permissions (0700).

func IsStrongJWTSecret

func IsStrongJWTSecret(secret string) bool

IsStrongJWTSecret 是 JWTSecretWeakness 的布尔形式,供终端硬门禁等需要「是/否」判断的场景使用。

func IsStrongMCPToken

func IsStrongMCPToken(token string) bool

IsStrongMCPToken 是 MCPTokenWeakness 的布尔形式。

func JWTSecretWeakness

func JWTSecretWeakness(secret string) string

JWTSecretWeakness 判断 JWT 签名密钥是否足够强。返回空字符串表示合格,否则返回不合格的原因(不含密钥内容,可安全写入日志)。

func MCPTokenWeakness

func MCPTokenWeakness(token string) string

MCPTokenWeakness 判断 MCP 令牌是否足够强(用于「令牌能代表远程执行」的场景)。 返回空字符串表示合格,否则返回不合格的原因(不含令牌内容,可安全写入日志与界面)。

func ResolveDataDir

func ResolveDataDir(mode string) string

ResolveDataDir resolves the base directory for database and certificates based on the runtime mode. For "stdio" mode, it defaults to the OS-standard user data directory to avoid polluting the workspace. For "serve" mode (or empty), it defaults to the relative "data" directory to preserve backward compatibility.

func SSHSecretKeyWeakness

func SSHSecretKeyWeakness(key string) string

SSHSecretKeyWeakness 判断 SSH 主机凭据的加密主密钥是否足够强,规则与 MCP 令牌一致(它保护的是同一类「可远程执行」的凭据)。 返回空字符串表示合格,否则返回原因(不含密钥内容,可安全写入日志与界面)。

Types

type Config

type Config struct {
	Mode                     string
	DataDir                  string
	Host                     string
	Port                     int
	HostName                 string
	DBPath                   string
	ProjectID                string
	MCPToken                 string
	ConfigureToken           string
	ExecutionToken           string
	WebUsername              string
	WebPassword              string
	JWTSecret                string
	TrustedProxies           string // RELAYMESH_TRUSTED_PROXIES,语义与校验见 api.ResolveTrustedProxies
	CSPMode                  string // RELAYMESH_CSP:off / report / enforce(默认 enforce),语义见 api.ResolveCSPMode
	AllowQueryToken          bool   // RELAYMESH_ALLOW_QUERY_TOKEN:SSE 端点是否仍接受 URL 上的 ?token=(兼容旧前端,默认开启;生产可关闭)
	TerminalMode             string // RELAYMESH_TERMINAL:auto(默认,满足安全前置条件才启用)/ off(强制关闭,只能关不能开),语义见 terminal.ResolveMode
	TerminalExec             string // RELAYMESH_TERMINAL_EXEC:off(默认)/ on(允许模型经 MCP 在已授权的主机上执行命令;仍需终端总闸开启),语义见 terminal.ResolveExec
	TerminalFiles            string // RELAYMESH_TERMINAL_FILES:off(默认)/ on(允许模型经 MCP 查看、拉取、写入已授权主机上令牌允许目录内的文件;还需要 RELAYMESH_TERMINAL_EXEC=on),语义见 terminal.ResolveFiles
	TerminalDiscovery        string // RELAYMESH_TERMINAL_DISCOVERY:window(默认,管理员手动开窗)/ always(常开,不建议公网),语义见 terminal.ResolveDiscovery
	TerminalRecord           string // RELAYMESH_TERMINAL_RECORD:auto(默认)/ off(服务端全局关闭终端记录,下发给每台主机的 Agent),语义见 terminal.ResolveRecord
	TerminalRecordDays       int    // RELAYMESH_TERMINAL_RECORD_DAYS:记录保留天数上限(0 表示不额外限制,主机本机默认 30 天;只能比主机本机配置更严格)
	TerminalRecordSessionMB  int    // RELAYMESH_TERMINAL_RECORD_SESSION_MB:单会话记录大小上限 MiB(0 表示不额外限制)
	TerminalRecordHostMB     int    // RELAYMESH_TERMINAL_RECORD_HOST_MB:单台主机记录总量上限 MiB(0 表示不额外限制)
	SSHSecretKey             string // RELAYMESH_SSH_SECRET_KEY:SSH 主机凭据的加密主密钥(独立于 JWT 密钥;未设置或过弱时 SSH 后端整块关闭)
	AllowedOrigins           string // RELAYMESH_ALLOWED_ORIGINS:终端浏览器 WebSocket 额外允许的 Origin(逗号分隔,含协议与端口)
	AgentDistDir             string // RELAYMESH_AGENT_DIST_DIR:Agent 各平台二进制的分发目录(Web 生成的安装命令从服务端下载);留空自动探测可执行文件旁 / 容器内 /app 下的 agent-dist
	WaitAfterMinutes         int
	MaxNoFeedbackChecks      int
	WaitInstruction          string
	WaitExhaustedInstruction string
	FeedbackTimeoutSeconds   int
	ASRAPIURL                string
	ASRAPIKey                string
	ASRModel                 string
	NtfyToken                string // RELAYMESH_NTFY_TOKEN:ntfy 访问令牌;设置后盖过界面里保存的令牌(令牌可以完全不进数据库)
	InboxOff                 bool   // RELAYMESH_INBOX=off:追加指令收件箱的总闸(只能关,不能靠它打开):不追加回执提示行、不让 hook 提醒、指引里不提收件箱;已排队的追加照旧在智能体下次发起交互时被带走
	OAuthOff                 bool   // RELAYMESH_OAUTH=off:关闭全部 OAuth 端点与元数据,/mcp 行为与未实现 OAuth 时一致
	PublicURL                string // RELAYMESH_PUBLIC_URL:授权服务器与资源元数据的公开根地址(缺省按代理头与 Host 推导)
	HTTPSPort                int
	TLSEnabled               bool
	TLSCertPath              string
	TLSKeyPath               string
	DevMode                  bool
	AutoOpenBrowser          bool
	Version                  string

	// 以下三项只供实验与端到端测试(不写进部署模板):把会话守护 / 自动续跑的检查间隔、自动续跑的退避与「续跑成功」的判定时长缩短到秒级,免得真等几分钟。生产不要设。
	TerminalGuardTickSec         int    // RELAYMESH_TERMINAL_GUARD_TICK_SEC:守护与自动续跑的检查间隔(秒,默认 60)
	TerminalAutoResumeBackoffSec string // RELAYMESH_TERMINAL_AUTORESUME_BACKOFF_SEC:自动续跑的退避(秒,逗号分隔,默认 300,1200,3600)
	TerminalAutoResumeOKSec      int    // RELAYMESH_TERMINAL_AUTORESUME_OK_SEC:自动续跑「成功」的判定时长(秒;默认按预设里的分钟数,10 分钟)
}

func Load

func Load() *Config

func LoadWithMode

func LoadWithMode(mode string) *Config

LoadWithMode loads configuration tailored for the given runtime mode ("serve" or "stdio").

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL