Files
ipass__ipass/rust/crates/plugin-domain/src/resolve.rs
T
admin 74aeefee58 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
2026-09-13 11:43:22 +08:00

189 lines
6.3 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.
//! 转发热路径:查共享内存取后端地址,供 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(),
}
}
}