Files
sso/source/rust/crates/ipass-core/src/audit.rs
T
ssw a988cc3763 refactor: 网关拆分为 ipass-core 内核 + plugin-sso/plugin-domain 插件 + gateway
原 source/rust/src/ 单体 crate 拆为 Cargo workspace:

  crates/ipass-core/    内核:state(共享内存) / store(JSON 原子写) /
                        users(账号唯一写入口) / models(共性字段 + extra 透传) /
                        config(共性常量) / plugin(装配契约) / loc(开关) /
                        session / audit / http / util
  crates/plugin-sso/    身份插件:OAuth2 / OIDC / IAP / TOTP / RSA 等个性代码
  crates/plugin-domain/ 域名插件:企业域名「子域名 → 后端」转发 + 申请/审核
  gateway/              **唯一** cdylib,module 壳 + PLUGINS 装配数组

收窄原则:内核只留共性,个性代码下放插件。收窄后内核不再提供原单体的
bump_window / put_ukey / put_upstream / reload_shm 等,改由插件用 state 泛型
原语自行重建;OAuth 常量与前缀(如 OAUTH_SESSION_COOKIE=sso_sid、
IAP_TOKEN_AUDIENCE=sso-gateway)与历史取值严格一致。

插件一律 crate-type=["rlib"] 由 gateway 静态链入,产出单个
libsso_gateway.dylib —— 不各自出 .so(nginx 动态模块无稳定 ABI,
跨 .so 传 String 即双重 free)。

插件装配点集中在 gateway 5 处:use / PLUGINS 数组 / ModuleConfig 字段 /
Merge / loc_switch 分支,外加指令数组(长度 +1,新增 sso_domain 等开关)。
2026-09-13 10:23:34 +08:00

151 lines
5.4 KiB
Rust
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
//! 审计日志:append-only JSONL(对齐 MaxKey `mxk_history_login` / `mxk_history_event`
//! 的语义,但落点从数据库表改为本地文件——本项目无 DB)。
//!
//! ## 形状
//!
//! 一行一个 JSON 对象:
//!
//! ```json
//! {"ts":1760000000,"ts_text":"2026-09-12 22:00:00","action":"admin.login",
//! "actor":"alice","target":"alice","ok":true,"ip":"127.0.0.1","ua":"curl/8","detail":""}
//! ```
//!
//! ## 写入与轮转
//!
//! * 追加走共享内存里的全局文件写锁(与账号/客户端表同一把锁):审计事件都是
//! 低频登录/管理操作,串行化代价可忽略,换来多 worker 下不交错。
//! * 单条 `write(2)` 追加 + 行尾换行,POSIX 对 O_APPEND 的小块写保证不交织。
//! * 超过 `AUDIT_ROTATE_BYTES` 时轮转为 `audit.jsonl.1`(覆盖上一代)——
//! 防止无限增长,代价是只保留约两代历史,够排查用;要长期留存请外部归档。
//!
//! ## 读取
//!
//! `GET /api/admin/audit` 从文件尾部取最近 N 行,支持按 actor / action 过滤。
//! 读**不上锁**:读到写了一半的行(理论上有锁不会发生)解析失败即跳过。
use std::io::Write;
use serde_json::{Value, json};
use crate::store;
use crate::util;
/// 审计文件名(相对 `sso_data_dir`)
const FILE_NAME: &str = "audit.jsonl";
/// 轮转阈值(字节):超过即整体搬到 `audit.jsonl.1`
const ROTATE_BYTES: u64 = 5 * 1024 * 1024;
/// 读取接口默认返回的行数上限
pub const READ_LIMIT_DEFAULT: usize = 100;
/// 读取接口允许的最大行数
pub const READ_LIMIT_MAX: usize = 1000;
/// 记录一条审计事件。写失败只记 nginx 错误日志,**绝不影响业务响应**——
/// 审计是旁路,不能因为磁盘满把登录搞挂。
pub fn log(action: &str, actor: &str, target: &str, ok: bool, ip: &str, ua: &str, detail: &str) {
let now = util::now();
let entry = json!({
"ts": now,
"ts_text": util::fmt_time(now),
"action": action,
"actor": actor,
"target": target,
"ok": ok,
"ip": ip,
"ua": ua,
"detail": detail,
});
let path = std::path::PathBuf::from(store::data_dir()).join(FILE_NAME);
let result = (|| -> Result<(), String> {
// 与账号/客户端表共用同一把文件写锁(store 层的 state::file_lock):
// 轮转判断 + 追加必须原子,且低频事件串行化代价可忽略
let _guard = crate::state::file_lock().ok_or("内部错误:状态锁不可用")?;
if let Ok(meta) = std::fs::metadata(&path) {
if meta.len() > ROTATE_BYTES {
let rotated = path.with_extension("jsonl.1");
let _ = std::fs::rename(&path, &rotated);
}
}
let mut f = std::fs::OpenOptions::new()
.create(true)
.append(true)
.open(&path)
.map_err(|e| format!("打开审计文件失败:{e}"))?;
f.write_all(entry.to_string().as_bytes())
.and_then(|_| f.write_all(b"\n"))
.map_err(|e| format!("写审计文件失败:{e}"))?;
Ok(())
})();
if let Err(e) = result {
util::log_err(&format!("[audit] {e}"));
}
}
/// 便捷版:调用方只有 actor/target 等基础信息,无 IP/UA(如初始化路径)。
pub fn log_simple(action: &str, actor: &str, target: &str, ok: bool, detail: &str) {
log(action, actor, target, ok, "-", "", detail);
}
/// 读取最近事件(新的事件在前)。
///
/// `filter_actor` / `filter_action` 精确匹配;`limit` 超界收口到
/// `READ_LIMIT_MAX`。文件不存在(尚无事件)返回空表。
pub fn read(limit: usize, filter_actor: &str, filter_action: &str) -> Vec<Value> {
let limit = limit.clamp(1, READ_LIMIT_MAX);
let path = std::path::PathBuf::from(store::data_dir()).join(FILE_NAME);
let Ok(text) = std::fs::read_to_string(&path) else {
return Vec::new();
};
let mut out: Vec<Value> = Vec::new();
for line in text.lines().rev() {
if out.len() >= limit {
break;
}
let Ok(v) = serde_json::from_str::<Value>(line) else {
continue; // 跳过损坏行,不让单行问题挡住整页
};
if !filter_actor.is_empty() && v.get("actor").and_then(|x| x.as_str()) != Some(filter_actor)
{
continue;
}
if !filter_action.is_empty()
&& v.get("action").and_then(|x| x.as_str()) != Some(filter_action)
{
continue;
}
out.push(v);
}
out
}
/// 统计概要(管理台卡片):文件行数与占用字节。
pub fn stats() -> Value {
let path = std::path::PathBuf::from(store::data_dir()).join(FILE_NAME);
match std::fs::metadata(&path) {
Ok(meta) => json!({ "bytes": meta.len(), "rotated": path.with_extension("jsonl.1").exists() }),
Err(_) => json!({ "bytes": 0, "rotated": false }),
}
}
/// 供 e2e / 管理台展示的 action 清单(前端筛选下拉用)。
pub const KNOWN_ACTIONS: &[&str] = &[
"admin.login",
"admin.logout",
"admin.user.create",
"admin.user.delete",
"admin.user.password",
"admin.user.key",
"admin.user.role",
"admin.user.profile",
"admin.user.unlock",
"admin.user.batch",
"admin.client.save",
"admin.client.rotate",
"admin.client.delete",
"admin.session.kick",
"sso.login",
"oauth.token",
];