refactor(plugin): P0-P2 插件化落地 —— workspace 化 + ipass-core + plugin-domain

- P0: rust/ 改 workspace(ipass-core 内核 + gateway 唯一 cdylib),
  [profile.release] 上移根、依赖收敛 workspace.dependencies;
  users::delete 的 stats::forget 依赖改为 on_delete 钩子注册表
- P1: 契约层 core/plugin.rs(Plugin trait)+ core/loc.rs(Switch 并集 +
  set_switch_fn,未实现变体保守 false);gateway PLUGINS 分发循环,
  不认领统一 404(插件绝不自行 404)
- P2: 身份端点下沉 core/api.rs(CorePlugin + CoreExt 扩展注册表,
  gateway 作装配根回填域名数/用量/连带回收/白名单校验);
  plugin-domain crate(domains + DomainEntry + sub: 前缀 + ResolveHandler
  + $proxy_backend_addr + 域名类端点含 purge)
- 行为等价:conf/nginx.conf、Dockerfile、tests 零改动,262 回归全绿
- 方案文档 docs/plugin/PLUGINIZATION_PLAN.md
This commit is contained in:
admin committed 2026-09-13 11:43:22 +08:00
1 parent 1fb83e4dda
commit 74aeefee58
35 files changed
+2513 -1360

No files matched your search

+191
View File
@@ -0,0 +1,191 @@
//! 域名类端点:管理员审核/创建/删除/清理 + 账号态申请/查询/删除。
//!
//! 路由表只认领**本插件**的路径;不认领的返回 `None` 交给下一个插件。
//! `/api/admin/purge` 清理的是过期域名与陈旧驳回记录,属域名职责。
use ngx::core::Status;
use ngx::ffi::ngx_http_request_t;
use ngx::http::HTTPStatus;
use serde_json::json;
use ipass_core::api::{Actor, Guard, run_guarded, user_or_401};
use ipass_core::http;
use ipass_core::util;
use crate::config;
use crate::domains;
// ===========================================================================
// 路由
// ===========================================================================
type Handler = fn(*mut ngx_http_request_t, Actor) -> Status;
fn route(method: &str, uri: &str) -> Option<(Guard, Handler)> {
let entry: (Guard, Handler) = match (method, uri) {
("GET", "/api/admin/domains") => (Guard::Admin, h_admin_domains),
("POST", "/api/admin/domains/review") => (Guard::Admin, h_admin_domain_review),
("POST", "/api/admin/domains/create") => (Guard::Admin, h_admin_domain_create),
("POST", "/api/admin/domains/delete") => (Guard::Admin, h_admin_domain_delete),
("POST", "/api/admin/purge") => (Guard::Admin, h_admin_purge),
("GET", "/api/v1/domains") => (Guard::User, h_my_domains),
("POST", "/api/v1/domains/apply") => (Guard::User, h_apply),
("POST", "/api/v1/domains/delete") => (Guard::User, h_my_delete),
_ => return None,
};
Some(entry)
}
/// 本表分发:认领则返回响应状态,不认领返回 `None`。
pub fn dispatch(r: *mut ngx_http_request_t) -> Option<Status> {
let method = http::method_str(r);
let uri = http::uri(r);
let Some((guard, handler)) = route(&method, &uri) else {
return None;
};
Some(run_guarded(r, guard, handler))
}
// ===========================================================================
// 管理员:域名审核
// ===========================================================================
fn h_admin_domains(r: *mut ngx_http_request_t, _actor: Actor) -> Status {
http::ok(
r,
json!({
"items": domains::view_all(&domains::all()),
"pending": domains::count_pending(),
// 子域名命名规则:前端据此渲染「i + 8位数字 + dm」输入框,
// 避免前后端各写一份前缀/后缀/zone 而漂移(真源 = 本插件 config.rs)
"subdomain_rule": {
"zone": config::ENTERPRISE_ZONE,
"prefix": config::SUBDOMAIN_PREFIX,
"suffix": config::SUBDOMAIN_SUFFIX,
"digits": config::SUBDOMAIN_RAND_DIGITS,
},
}),
"ok",
)
}
fn h_admin_domain_review(r: *mut ngx_http_request_t, actor: Actor) -> Status {
let p = http::params(r);
let id = p.get("id").map(String::as_str).unwrap_or("");
let action = p.get("action").map(String::as_str).unwrap_or("");
match domains::review(id, action, actor.admin_name()) {
Ok(entry) => {
let msg = if action == "approve" { "已通过审核" } else { "已驳回" };
http::ok(r, domains::view(&entry), msg)
}
Err(e) => http::fail(r, HTTPStatus::BAD_REQUEST, &e),
}
}
fn h_admin_domain_create(r: *mut ngx_http_request_t, actor: Actor) -> Status {
let p = http::params(r);
// subdomain 缺省(或空串)= 由网关按规则自动生成 `i<8位随机数字>dm`,
// 与面板上「i + 8位随机数 + dm」是同一套规则(见 domains::gen_subdomain)。
match domains::create_by_admin(
p.get("subdomain").map(String::as_str).unwrap_or(""),
p.get("backend").map(String::as_str).unwrap_or(""),
p.get("type"),
p.get("owner"),
actor.admin_name(),
) {
Ok(entry) => http::ok(r, domains::view(&entry), "已创建并直接放行"),
Err(e) => http::fail(r, HTTPStatus::BAD_REQUEST, &e),
}
}
fn h_admin_domain_delete(r: *mut ngx_http_request_t, _actor: Actor) -> Status {
let p = http::params(r);
let id = p.get("id").map(String::as_str).unwrap_or("");
match domains::remove(id) {
Ok(sub) => http::ok(r, json!({ "subdomain": sub }), "已删除"),
Err(e) => http::fail(r, HTTPStatus::BAD_REQUEST, &e),
}
}
fn h_admin_purge(r: *mut ngx_http_request_t, _actor: Actor) -> Status {
match domains::purge() {
Ok(removed) => http::ok(
r,
json!({ "removed": removed }),
&format!("已清理 {removed} 条过期/陈旧记录"),
),
Err(e) => http::fail(r, HTTPStatus::BAD_REQUEST, &e),
}
}
// ===========================================================================
// 账号态
// ===========================================================================
fn h_my_domains(r: *mut ngx_http_request_t, actor: Actor) -> Status {
let user = match user_or_401(r, actor) {
Ok(u) => u,
Err(e) => return e,
};
http::ok(
r,
json!({ "items": domains::view_all(&domains::by_owner(&user.username)) }),
"ok",
)
}
fn h_apply(r: *mut ngx_http_request_t, actor: Actor) -> Status {
let user = match user_or_401(r, actor) {
Ok(u) => u,
Err(e) => return e,
};
let p = http::params(r);
let entry = match domains::apply(
&user.username,
p.get("subdomain").map(String::as_str).unwrap_or(""),
p.get("backend").map(String::as_str).unwrap_or(""),
p.get("type"),
) {
Ok(e) => e,
Err(e) => return http::fail(r, HTTPStatus::BAD_REQUEST, &e),
};
let view = domains::view(&entry);
util::log_notice(&format!(
"[api] {} 申请 {} type={} status={}",
user.username,
entry.subdomain,
entry.dtype,
entry.effective_status(util::now())
));
let msg = if entry.status == "approved" {
format!(
"已直接放行(临时授权权限生效),{} 小时后自动失效",
config::TEMP_DOMAIN_TTL / 3600
)
} else {
"已提交申请,等待管理员审核".to_owned()
};
http::ok(r, view, &msg)
}
fn h_my_delete(r: *mut ngx_http_request_t, actor: Actor) -> Status {
let user = match user_or_401(r, actor) {
Ok(u) => u,
Err(e) => return e,
};
let p = http::params(r);
let id = p.get("id").map(String::as_str).unwrap_or("");
match domains::remove_own(id, &user.username) {
Ok(sub) => http::ok(r, json!({ "subdomain": sub }), "已删除"),
Err(e) => http::fail(r, HTTPStatus::BAD_REQUEST, &e),
}
}
+35
View File
@@ -0,0 +1,35 @@
//! 域名插件策略常量(自内核 config.rs 迁入;改策略只改这里)。
/// 临时域名审批通过后的有效期(秒)。到期仅停止转发,记录保留供查阅。
pub const TEMP_DOMAIN_TTL: i64 = 6 * 3600;
/// 子域名总长上限:首字符 + 最多 61 个后续字符
pub const SUBDOMAIN_MAX_LEN: usize = 62;
/// 系统保留名:不允许用户申请,避免抢占管理入口
pub const RESERVED_SUBDOMAINS: [&str; 4] = ["proxy-api", "admin", "www", "api"];
/// 驳回记录保留时长,超期由 purge 清理(秒)
pub const REJECTED_PURGE_TTL: i64 = 7 * 86400;
/// 键前缀:子域名 → 后端映射
pub const KEY_SUB_PREFIX: &[u8] = b"sub:";
/// 企业域名(业务域名)的 zone:**子域名 + `.` + 此后缀 = 完整对外域名**。
///
/// ⚠️ 与 `conf/nginx.conf` 的「企业域名 server」严格耦合:
/// `server_name ~^(?<subdomain>.+dm)\.mayishangshu\.cn$;`
/// 改这里必须同步改那条正则(反之亦然)。
pub const ENTERPRISE_ZONE: &str = "mayishangshu.cn";
/// 自动生成子域名的形状:`<前缀><N 位随机数字><后缀>` —— 例如 `i12345678dm`。
///
/// 后缀**必须是 `dm`**:企业域名 server 的正则要求捕获组以 `dm` 结尾
/// (`^(.+dm)\.mayishangshu\.cn$`),否则域名建出来也转发不到。
/// 这是「规则」的实质约束,不是命名偏好。
pub const SUBDOMAIN_PREFIX: &str = "i";
pub const SUBDOMAIN_SUFFIX: &str = "dm";
/// 随机数字位数。10^8 的空间,撞车概率极低
pub const SUBDOMAIN_RAND_DIGITS: usize = 8;
/// 自动生成子域名时的最大重试次数(真撞上已占用的就换一个再试)
pub const SUBDOMAIN_GEN_ATTEMPTS: usize = 5;
+488
View File
@@ -0,0 +1,488 @@
//! 域名(子域名映射)与申请审核。
//!
//! 数据结构见 `models::DomainEntry`。
//!
//! ## 状态机
//!
//! ```text
//! temp + 有临时授权权限 → 直接 approved(reviewed_by=auto,到时自动 expired)
//! temp + 无临时授权权限 → pending,等管理员审核
//! long + 任意 → pending,等管理员审核
//! ```
//!
//! 到期不等于删除:临时域名过期后仅「不再转发」,记录保留供查阅。
//!
//! ## 写穿
//!
//! 热路径**永不回源**(未命中即 404),所以每个写操作都必须
//! **同时更新共享内存与文件**——这就是 `sync_shm` 的存在理由。
//! 漏掉一处,就会出现「审核通过了但立刻 404」。
use serde_json::{Value, json};
use ipass_core::{state, users, util};
use crate::config::{
ENTERPRISE_ZONE, KEY_SUB_PREFIX, REJECTED_PURGE_TTL, RESERVED_SUBDOMAINS, SUBDOMAIN_GEN_ATTEMPTS,
SUBDOMAIN_MAX_LEN, SUBDOMAIN_PREFIX, SUBDOMAIN_RAND_DIGITS, SUBDOMAIN_SUFFIX, TEMP_DOMAIN_TTL,
};
use crate::models::DomainEntry;
// ===========================================================================
// 校验
// ===========================================================================
/// 子域名:小写字母/数字开头,其后可含短横线,总长 ≤ 62,且不在保留名单内。
/// 返回规范化(小写)后的值。
pub fn validate_subdomain(raw: &str) -> Result<String, String> {
if raw.is_empty() {
return Err("缺少 subdomain 参数".to_owned());
}
let s = raw.to_ascii_lowercase();
let bytes = s.as_bytes();
if bytes.len() > SUBDOMAIN_MAX_LEN {
return Err("子域名长度不能超过 62 个字符".to_owned());
}
let head_ok = matches!(bytes[0], b'a'..=b'z' | b'0'..=b'9');
let tail_ok = bytes[1..].iter().all(|&b| matches!(b, b'a'..=b'z' | b'0'..=b'9' | b'-'));
if !head_ok || !tail_ok {
return Err("子域名只能是小写字母、数字、短横线,且不能以短横线开头".to_owned());
}
if RESERVED_SUBDOMAINS.contains(&s.as_str()) {
return Err(format!("子域名 {s} 为系统保留名,不可使用"));
}
Ok(s)
}
/// 后端地址:`host:port`,host 允许字母/数字/`.`/`_`/`-`,端口 1-65535
pub fn validate_backend(raw: &str) -> Result<String, String> {
let s = util::trim(raw);
if s.is_empty() {
return Err("缺少 backend 参数".to_owned());
}
let Some(colon) = s.rfind(':') else {
return Err("backend 格式应为 host:port,例如 192.168.1.7:89".to_owned());
};
let (host, port) = (&s[..colon], &s[colon + 1..]);
let host_ok = !host.is_empty()
&& host.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-'));
let port_ok = !port.is_empty()
&& port.chars().all(|c| c.is_ascii_digit())
&& port.parse::<u32>().map(|p| (1..=65535).contains(&p)).unwrap_or(false);
if !host_ok || !port_ok {
return Err("backend 格式应为 host:port,且端口在 1-65535 之间".to_owned());
}
Ok(s.to_owned())
}
// ===========================================================================
// 子域名命名规则(唯一真源,前端/API 共用)
// ===========================================================================
/// 生成一个符合企业域名规则的子域名:`i` + 8 位随机数字 + `dm`(如 `i48291376dm`)。
///
/// **后缀 `dm` 不是装饰**:企业域名 server 的正则是
/// `^(.+dm)\.mayishangshu\.cn$`,捕获组必须以 `dm` 结尾,否则该域名根本不会
/// 被转发 server 匹配到。所以「i+8位+dm」是硬约束,别改后缀。
pub fn gen_subdomain() -> String {
format!(
"{SUBDOMAIN_PREFIX}{}{SUBDOMAIN_SUFFIX}",
util::rand_digits(SUBDOMAIN_RAND_DIGITS)
)
}
/// 子域名 → 完整对外域名(**不含端口**)。
///
/// 端口刻意不在这里拼:网关用宿主 88 承载三个域名,但端口应当**跟随调用方**
/// (见 readme §15),由前端按 `location.port` 拼,写死任何一种都会在另一种
/// 部署下给出「看着对、打不通」的地址。
pub fn full_host(subdomain: &str) -> String {
format!("{subdomain}.{ENTERPRISE_ZONE}")
}
pub fn validate_type(raw: Option<&String>) -> String {
match raw.map(|s| s.as_str()) {
Some("long") => "long".to_owned(),
_ => "temp".to_owned(),
}
}
// ===========================================================================
// 共享内存同步(写穿 / 装载)
// ===========================================================================
/// 把一条记录同步进共享内存。**所有写操作之后必须调用它**。
///
/// 写失败 = 热路径查不到 = 该域名立刻 404,所以失败必须出声
/// (`state::put` 返回 false:共享内存 zone 满或分配失败)。
pub fn sync_shm(entry: &DomainEntry) {
let now = util::now();
if entry.is_forwardable(now) {
// long 用 0 表示永不过期;temp 用真实到期时刻,热路径读到即知是否还能用
let exp = if entry.dtype == "temp" { entry.expires_at } else { 0 };
if !state::put(
KEY_SUB_PREFIX,
entry.subdomain.as_bytes(),
entry.backend.as_bytes(),
exp,
) {
util::log_err(&format!(
"[domains] 转发映射写共享内存失败 sub={} —— 该域名会 404(共享内存可能已满)",
entry.subdomain
));
}
} else {
state::remove(KEY_SUB_PREFIX, entry.subdomain.as_bytes());
}
}
/// 全量重载转发映射(启动装载 / purge / 连带回收后调用)。返回装载条数。
///
/// 只清 `sub:` 前缀的键,**不会误伤正在登录的管理员会话**。
pub fn reload_shm() -> usize {
state::clear_prefix(KEY_SUB_PREFIX);
let now = util::now();
let mut expected = 0;
let mut loaded = 0;
for entry in crate::store::read_domains() {
if entry.is_forwardable(now) {
expected += 1;
let exp = if entry.dtype == "temp" { entry.expires_at } else { 0 };
if state::put(KEY_SUB_PREFIX, entry.subdomain.as_bytes(), entry.backend.as_bytes(), exp) {
loaded += 1;
}
}
}
if loaded != expected {
util::log_err(&format!(
"[domains] 转发映射装载不全:{loaded}/{expected} —— 有域名会 404"
));
}
loaded
}
// ===========================================================================
// 查询
// ===========================================================================
/// 全部记录,按创建时间倒序
pub fn all() -> Vec<DomainEntry> {
let mut list = crate::store::read_domains();
list.sort_by(|a, b| b.created_at.cmp(&a.created_at));
list
}
pub fn by_owner(owner: &str) -> Vec<DomainEntry> {
let mut list: Vec<DomainEntry> =
crate::store::read_domains().into_iter().filter(|e| e.owner == owner).collect();
list.sort_by(|a, b| b.created_at.cmp(&a.created_at));
list
}
/// 按 id 取单条记录(当前无调用方,保留为对外查询接口)
#[allow(dead_code)]
pub fn by_id(id: &str) -> Option<DomainEntry> {
crate::store::read_domains().into_iter().find(|e| e.id == id)
}
pub fn count_pending() -> usize {
crate::store::read_domains().iter().filter(|e| e.status == "pending").count()
}
// ===========================================================================
// 用户申请
// ===========================================================================
/// 用户提交申请。有临时授权权限的 temp 申请直接放行。
///
/// 返回的 entry 若 `status == approved && reviewed_by == auto`,即免审通过。
pub fn apply(
username: &str,
subdomain: &str,
backend: &str,
dtype: Option<&String>,
) -> Result<DomainEntry, String> {
let user = users::get(username).ok_or("账号不存在")?;
let subdomain = validate_subdomain(subdomain)?;
let backend = validate_backend(backend)?;
let dtype = validate_type(dtype);
let now = util::now();
let auto = dtype == "temp" && user.has_temp_permission(now);
let chosen = subdomain.clone();
let entry = crate::store::update_domains(move |list| {
if let Some(idx) = list.iter().position(|e| e.subdomain == chosen) {
let existing = &list[idx];
let mine_pending = existing.owner == username && existing.status == "pending";
let its_expired =
existing.dtype == "temp" && existing.effective_status(now) == "expired";
// 自己的待审申请可以改写;已失效的临时域名视为空闲可复用
if !(mine_pending || its_expired) {
return Err(format!("子域名 {chosen} 已被占用"));
}
list.remove(idx);
}
let entry = DomainEntry {
id: util::gen_id(),
subdomain: chosen,
backend,
dtype,
owner: username.to_owned(),
status: if auto { "approved".to_owned() } else { "pending".to_owned() },
created_at: now,
expires_at: if auto { now + TEMP_DOMAIN_TTL } else { 0 },
reviewed_by: if auto { "auto".to_owned() } else { String::new() },
reviewed_at: if auto { now } else { 0 },
};
list.push(entry.clone());
Ok(entry)
})?;
sync_shm(&entry);
Ok(entry)
}
// ===========================================================================
// 管理员操作
// ===========================================================================
/// 审核:approve / reject。只允许处理 pending 状态。
pub fn review(id: &str, action: &str, admin: &str) -> Result<DomainEntry, String> {
if action != "approve" && action != "reject" {
return Err("action 只能是 approve 或 reject".to_owned());
}
let now = util::now();
let id = id.to_owned();
let action = action.to_owned();
let admin = admin.to_owned();
let updated = crate::store::update_domains(move |list| {
let item = list.iter_mut().find(|e| e.id == id).ok_or("记录不存在")?;
if item.status != "pending" {
return Err(format!("该申请已处理(当前状态:{})", item.status));
}
if action == "approve" {
item.status = "approved".to_owned();
item.expires_at = if item.dtype == "temp" { now + TEMP_DOMAIN_TTL } else { 0 };
} else {
item.status = "rejected".to_owned();
}
item.reviewed_by = admin;
item.reviewed_at = now;
Ok(item.clone())
})?;
sync_shm(&updated);
Ok(updated)
}
/// 管理员直接创建并放行(等价于「我替你建好并批准」)。
///
/// `subdomain` **留空即自动生成** `i<8位随机数字>dm`(见 `gen_subdomain`),
/// 撞上已占用就换一个重试(最多 `SUBDOMAIN_GEN_ATTEMPTS` 次)。管理台与
/// `/api/admin/domains/create` 走同一条路径,规则不会两处漂移。
pub fn create_by_admin(
subdomain: &str,
backend: &str,
dtype: Option<&String>,
owner: Option<&String>,
admin: &str,
) -> Result<DomainEntry, String> {
let backend = validate_backend(backend)?;
let owner = match owner {
Some(o) if !o.is_empty() => o.clone(),
_ => admin.to_owned(),
};
if users::get(&owner).is_none() {
return Err(format!("归属账号不存在:{owner}"));
}
let dtype = validate_type(dtype);
let manual = !util::trim(subdomain).is_empty();
let attempts = if manual { 1 } else { SUBDOMAIN_GEN_ATTEMPTS };
let mut last_err = "子域名生成失败".to_owned();
for _ in 0..attempts {
let sub = if manual { validate_subdomain(subdomain)? } else { gen_subdomain() };
// 自动生成的也过一遍校验:常量被误改时立刻报错,而不是建出个用不了的域名
let sub = validate_subdomain(&sub)?;
match insert_approved(&sub, &backend, &dtype, &owner, admin) {
Ok(entry) => {
sync_shm(&entry);
return Ok(entry);
}
Err(e) => {
// 手填的子域名撞车是用户要解决的问题;自动生成的直接换一个重试
if manual {
return Err(e);
}
last_err = e;
}
}
}
Err(last_err)
}
/// 落盘一条 approved 记录(占用检查在这里);调用方负责 `sync_shm`。
fn insert_approved(
subdomain: &str,
backend: &str,
dtype: &str,
owner: &str,
admin: &str,
) -> Result<DomainEntry, String> {
let now = util::now();
let chosen = subdomain.to_owned();
let backend = backend.to_owned();
let dtype = dtype.to_owned();
let owner = owner.to_owned();
let admin = admin.to_owned();
crate::store::update_domains(move |list| {
if let Some(idx) = list.iter().position(|e| e.subdomain == chosen) {
let existing = &list[idx];
let its_expired =
existing.dtype == "temp" && existing.effective_status(now) == "expired";
if !its_expired {
return Err(format!("子域名 {chosen} 已被占用"));
}
list.remove(idx);
}
let entry = DomainEntry {
id: util::gen_id(),
subdomain: chosen,
backend,
dtype: dtype.clone(),
owner,
status: "approved".to_owned(),
created_at: now,
expires_at: if dtype == "temp" { now + TEMP_DOMAIN_TTL } else { 0 },
reviewed_by: admin,
reviewed_at: now,
};
list.push(entry.clone());
Ok(entry)
})
}
/// 用户删除自己的域名。成功返回被删的子域名(供转发侧失效)。
pub fn remove_own(id: &str, username: &str) -> Result<String, String> {
let id = id.to_owned();
let username = username.to_owned();
crate::store::update_domains(move |list| {
let idx = list.iter().position(|e| e.id == id).ok_or("记录不存在")?;
if list[idx].owner != username {
return Err("只能删除自己的域名".to_owned());
}
let sub = list.remove(idx).subdomain;
Ok(sub)
})
.map(|sub| {
state::remove(KEY_SUB_PREFIX, sub.as_bytes());
sub
})
}
/// 管理员删除任意域名
pub fn remove(id: &str) -> Result<String, String> {
let id = id.to_owned();
crate::store::update_domains(move |list| {
let idx = list.iter().position(|e| e.id == id).ok_or("记录不存在")?;
Ok(list.remove(idx).subdomain)
})
.map(|sub| {
state::remove(KEY_SUB_PREFIX, sub.as_bytes());
sub
})
}
/// 连带回收某账号名下的全部域名(删除账号时用)。返回回收条数。
pub fn remove_by_owner(owner: &str) -> usize {
let mut removed = 0usize;
let result = crate::store::update_domains(|list| {
list.retain(|e| {
if e.owner == owner {
removed += 1;
false
} else {
true
}
});
Ok(())
});
if result.is_ok() && removed > 0 {
// 被回收的可能包含正在转发的域名,必须全量重载
reload_shm();
}
removed
}
/// 清理:已过期的临时域名 + 超过保留期的驳回记录。返回清理条数。
pub fn purge() -> Result<usize, String> {
let now = util::now();
let mut removed = 0usize;
crate::store::update_domains(|list| {
list.retain(|e| {
let status = e.effective_status(now);
let stale_rejected =
status == "rejected" && (now - e.reviewed_at) > REJECTED_PURGE_TTL;
if status == "expired" || stale_rejected {
removed += 1;
false
} else {
true
}
});
Ok(())
})?;
if removed > 0 {
reload_shm();
}
Ok(removed)
}
// ===========================================================================
// 对外投影
// ===========================================================================
pub fn view(entry: &DomainEntry) -> Value {
let now = util::now();
let status = entry.effective_status(now);
let exp = entry.expires_at;
let live_temp = status == "approved" && entry.dtype == "temp" && exp > now;
json!({
"id": entry.id,
"subdomain": entry.subdomain,
"host": full_host(&entry.subdomain),
"backend": entry.backend,
"type": entry.dtype,
"owner": entry.owner,
"status": status,
"created_at": entry.created_at,
"created_at_text": util::fmt_time(entry.created_at),
"expires_at": exp,
"expires_at_text": if entry.dtype == "temp" && exp > 0 { util::fmt_time(exp) } else { "-".to_owned() },
"expires_left": if live_temp { exp - now } else { 0 },
"expires_left_text": if live_temp { util::fmt_left(exp - now) } else { String::new() },
"reviewed_by": entry.reviewed_by,
"reviewed_at": entry.reviewed_at,
"auto_approved": entry.reviewed_by == "auto",
})
}
pub fn view_all(list: &[DomainEntry]) -> Vec<Value> {
list.iter().map(view).collect()
}
+54
View File
@@ -0,0 +1,54 @@
//! plugin-domain —— 动态域名插件。
//!
//! 职责:子域名 → 后端映射(`sub:` 键空间)、申请与审批、转发决策
//! (access 阶段查共享内存)。数据文件 `data/domains.json`。
//!
//! ## 与旧版最大的差异:写穿
//!
//! 热路径**永不回源**(未命中即 404),所以每个写操作都必须
//! **同时更新共享内存与文件**——这就是 `domains::sync_shm` 的存在理由。
//! 漏掉一处,就会出现「审核通过了但立刻 404」。
//!
//! ## 装配点(gateway)
//!
//! * `preconfig` —— 注册 `$proxy_backend_addr` 变量(`proxy_pass` 依赖)
//! * `postconfig` —— 注册 `ResolveHandler`(access 阶段)
//! * `zone_load` —— 全量装载 `sub:` 映射
//! * `dispatch_api` —— 认领域名类管理/账号端点
pub mod api;
pub mod config;
pub mod domains;
pub mod models;
pub mod resolve;
pub mod store;
use ngx::core::Status;
use ngx::ffi::{ngx_conf_t, ngx_http_request_t};
use ipass_core::plugin::Plugin;
pub struct DomainPlugin;
impl Plugin for DomainPlugin {
fn name(&self) -> &'static str {
"domain"
}
fn preconfig(&self, cf: *mut ngx_conf_t) -> bool {
resolve::preconfig(cf)
}
fn postconfig(&self, cf: *mut ngx_conf_t) -> bool {
// SAFETY: cf 由 nginx 传入且有效
ngx::http::add_phase_handler::<resolve::ResolveHandler>(unsafe { &mut *cf }).is_ok()
}
fn dispatch_api(&self, r: *mut ngx_http_request_t) -> Option<Status> {
api::dispatch(r)
}
fn zone_load(&self) -> usize {
domains::reload_shm()
}
}
+61
View File
@@ -0,0 +1,61 @@
//! 域名持久化模型(`domains.json`:一条记录 = 一个子域名)。
use serde::{Deserialize, Serialize};
/// 单条域名记录。
///
/// 字段名与旧版 `data/domains.json` **逐字对应**,以便新版直接接管旧数据文件。
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DomainEntry {
pub id: String,
pub subdomain: String,
/// `host:port`
pub backend: String,
/// `temp`(临时,到时自动停止转发) | `long`(长期)
#[serde(rename = "type")]
pub dtype: String,
/// 归属账号
pub owner: String,
/// `pending` | `approved` | `rejected`
pub status: String,
#[serde(default)]
pub created_at: i64,
/// 仅 temp 有意义;long 恒为 0
#[serde(default)]
pub expires_at: i64,
/// `auto` 表示凭临时授权权限免审放行
#[serde(default)]
pub reviewed_by: String,
#[serde(default)]
pub reviewed_at: i64,
}
impl DomainEntry {
/// 实际状态:approved 的临时域名过期后视为 `expired`。
///
/// 这是「到期不等于删除」语义的落点——记录保留,只是不再转发。
pub fn effective_status(&self, now: i64) -> &'static str {
if self.status == "approved" && self.dtype == "temp" {
if self.expires_at > 0 && self.expires_at <= now {
return "expired";
}
}
match self.status.as_str() {
"approved" => "approved",
"rejected" => "rejected",
_ => "pending",
}
}
/// 转发侧判定:返回该域名当前是否可转发(已放行且未过期)
pub fn is_forwardable(&self, now: i64) -> bool {
if self.status != "approved" {
return false;
}
if self.dtype == "temp" {
// 临时域名必须有明确的、尚未到达的到期时刻
return self.expires_at > now;
}
true
}
}
+188
View File
@@ -0,0 +1,188 @@
//! 转发热路径:查共享内存取后端地址,供 nginx 的 `proxy_pass` 使用。
//!
//! **热路径唯一入口**——只读内存,未命中不产生任何 I/O。
//! 旧版这里在 miss 时会去读 `domains.json` 并全量 JSON 解码,
//! 那正是「随便发一堆随机子域名就能打穿磁盘」的入口。
use core::ptr;
use core::sync::atomic::{AtomicUsize, Ordering};
use ngx::core::{Pool, Status};
use ngx::ffi::{
NGX_HTTP_VAR_CHANGEABLE, NGX_HTTP_VAR_NOCACHEABLE, ngx_conf_t, ngx_http_add_variable,
ngx_http_get_variable_index, ngx_http_request_t, ngx_http_variable_value_t, ngx_int_t,
ngx_uint_t,
};
use ngx::http::{HTTPStatus, HttpPhase, HttpRequestHandler};
use ngx::ngx_string;
use crate::config;
use ipass_core::loc::{self, Switch};
use ipass_core::state;
use ipass_core::util;
/// `$proxy_backend_addr` 在 `r->variables` 里的下标
static BACKEND_VAR_INDEX: AtomicUsize = AtomicUsize::new(usize::MAX);
/// 查共享内存取后端地址;已过期的条目视为不存在。
fn resolve_backend(subdomain: &[u8]) -> Option<String> {
let (backend, expires_at) = state::get(config::KEY_SUB_PREFIX, subdomain)?;
if expires_at > 0 && expires_at <= util::now() {
return None;
}
Some(backend)
}
/// 取 Host 头里第一个点之前的部分作为子域名。
///
/// 刻意不走 nginx 的 server_name 正则捕获变量(那需要再算一次变量 hash),
/// 热路径上手工切更省。
pub fn subdomain_of(r: *mut ngx_http_request_t) -> Option<Vec<u8>> {
// SAFETY: r 有效;迭代器只在本函数存续期内使用
let request = unsafe { ngx::http::Request::from_ngx_http_request(r) };
for (key, value) in request.headers_in_iterator() {
if key.as_bytes().eq_ignore_ascii_case(b"host") {
let host = value.as_bytes();
// 去掉端口
let host = match host.iter().position(|&b| b == b':') {
Some(i) => &host[..i],
None => host,
};
// 取第一段标签
let label = match host.iter().position(|&b| b == b'.') {
Some(i) => &host[..i],
None => host,
};
if label.is_empty() {
return None;
}
return Some(label.to_ascii_lowercase());
}
}
None
}
/// 把后端地址写进 `r->variables[$proxy_backend_addr]`,供 `proxy_pass` 使用
fn set_backend_var(r: *mut ngx_http_request_t, backend: &str) {
let idx = BACKEND_VAR_INDEX.load(Ordering::SeqCst);
if idx == usize::MAX {
return;
}
// SAFETY: idx 由 ngx_http_get_variable_index 分配且落在 r->variables 内;
// 值分配在请求池里,随请求回收
unsafe {
let pool = Pool::from_ngx_pool((*r).pool);
let bytes = backend.as_bytes();
let data = pool.alloc(bytes.len()) as *mut u8;
if data.is_null() {
return;
}
ptr::copy_nonoverlapping(bytes.as_ptr(), data, bytes.len());
let vv: *mut ngx_http_variable_value_t = (*r).variables.add(idx);
(*vv).data = data;
(*vv).set_len(bytes.len() as _);
(*vv).set_valid(1);
(*vv).set_not_found(0);
(*vv).set_no_cacheable(1);
}
}
/// 变量 get_handler:`proxy_pass` 求值 `$proxy_backend_addr` 时被调用。
///
/// 与 access 阶段互补——这里保证「即使 access 未赋值也能取到」,
/// access 阶段则负责决定命中不了时返回 404。
extern "C" fn backend_get(
r: *mut ngx_http_request_t,
v: *mut ngx_http_variable_value_t,
_data: usize,
) -> ngx_int_t {
// SAFETY: nginx 传入的 r/v 必然有效
unsafe {
let resolved = subdomain_of(r).as_deref().and_then(resolve_backend);
let Some(backend) = resolved else {
(*v).set_not_found(1);
return Status::NGX_ERROR.into();
};
let pool = Pool::from_ngx_pool((*r).pool);
let bytes = backend.as_bytes();
let data = pool.alloc(bytes.len()) as *mut u8;
if data.is_null() {
(*v).set_not_found(1);
return Status::NGX_ERROR.into();
}
ptr::copy_nonoverlapping(bytes.as_ptr(), data, bytes.len());
(*v).data = data;
(*v).set_len(bytes.len() as _);
(*v).set_valid(1);
(*v).set_no_cacheable(1);
(*v).set_not_found(0);
Status::NGX_OK.into()
}
}
/// 配置解析前注册 `$proxy_backend_addr`。
///
/// 必须在 preconfiguration 阶段调用,否则配置里的
/// `proxy_pass http://$proxy_backend_addr` 无法解析。
pub fn preconfig(cf: *mut ngx_conf_t) -> bool {
let mut name = ngx_string!("proxy_backend_addr");
let idx = unsafe { ngx_http_get_variable_index(cf, &raw mut name) };
if idx == -1 {
return false;
}
BACKEND_VAR_INDEX.store(idx as usize, Ordering::SeqCst);
let var = unsafe {
ngx_http_add_variable(
cf,
&raw mut name,
(NGX_HTTP_VAR_CHANGEABLE | NGX_HTTP_VAR_NOCACHEABLE) as ngx_uint_t,
)
};
if var.is_null() {
return false;
}
// SAFETY: var 非空且由本函数独占初始化
unsafe {
(*var).get_handler = Some(backend_get);
(*var).set_handler = None;
(*var).data = 0;
}
true
}
/// 转发热路径:命中则放行(`proxy_pass` 会去取 `$proxy_backend_addr`),未命中直接 404。
pub struct ResolveHandler;
impl HttpRequestHandler for ResolveHandler {
const PHASE: HttpPhase = HttpPhase::Access;
type Output = Status;
fn handler(request: &mut ngx::http::Request) -> Self::Output {
// 未开启该开关的 location 一律放行(管理台/API 走这里)
let r: *mut ngx_http_request_t = request.as_mut() as *mut ngx_http_request_t;
if !loc::enabled(r, Switch::Proxy) {
return Status::NGX_DECLINED;
}
let Some(host) = subdomain_of(r) else {
return HTTPStatus::NOT_FOUND.into();
};
match resolve_backend(&host) {
Some(backend) => {
set_backend_var(r, &backend);
Status::NGX_DECLINED
}
// 与旧版语义一致:查不到 = 未配置 / 已过期 / 已删除 / 尚未审核通过
None => HTTPStatus::NOT_FOUND.into(),
}
}
}
+33
View File
@@ -0,0 +1,33 @@
//! 域名表的文件读写(复用内核 store 的原子写 + 全局文件写锁)。
use std::path::PathBuf;
use ipass_core::{state, store};
use crate::models::DomainEntry;
fn domains_path() -> PathBuf {
store::path_in_data("domains.json")
}
pub fn read_domains() -> Vec<DomainEntry> {
store::read_json(&domains_path(), Vec::new())
}
pub fn write_domains(data: &[DomainEntry]) -> Result<(), String> {
store::write_json(&domains_path(), &data.to_vec())
}
/// 加锁「读-改-写」域名表。
///
/// 闭包返回 `Ok(T)` 表示提交,`Err(msg)` 表示放弃(不写盘)。
pub fn update_domains<T, F>(f: F) -> Result<T, String>
where
F: FnOnce(&mut Vec<DomainEntry>) -> Result<T, String>,
{
let _guard = state::file_lock().ok_or("内部错误:状态锁不可用")?;
let mut data = read_domains();
let out = f(&mut data)?;
write_domains(&data)?;
Ok(out)
}