Nginx - 整合lua 实现对POST请求的参数拦截校验(不使用Openresty)

文章目录

  • 概述
  • 步骤 1: 安装 Nginx 和 Lua 模块
  • 步骤 2: 创建 Lua 脚本用于参数校验
  • 步骤 3: 配置 Nginx 使用 Lua 脚本
    • 写法二: 状态码
    • 写法三 : 返回自定义JSON
    • 复杂的正则校验
  • 步骤 4: 测试和验证
  • ngx.HTTP_* 枚举值

在这里插入图片描述


概述

一个不使用 OpenResty 的 Nginx 集成 Lua 脚本的方案,用于对 POST 请求参数进行校验。

在这里插入图片描述

指令所处处理阶段使用范围解释
init_by_lua / init_by_lua_fileloading-confighttpNginx Master进程加载配置时执行;通常用于初始化全局配置/预加载Lua模块
init_worker_by_lua / init_worker_by_lua_filestarting-workerhttp每个Nginx Worker进程启动时调用的计时器,如果Master进程不允许则只会在init_by_lua之后调用;通常用于定时拉取配置/数据,或者后端服务的健康检查
set_by_lua / set_by_lua_filerewriteserver, server if, location, location if设置Nginx变量,可以实现复杂的赋值逻辑;此处是阻塞的,Lua代码要做到非常快。
rewrite_by_lua / rewrite_by_lua_filerewritehttp, server, location, location ifrewrite阶段处理,可以实现复杂的转发/重定向逻辑。
access_by_lua / access_by_lua_fileaccesshttp, server, location, location if请求访问阶段处理,用于访问控制。
content_by_lua / content_by_lua_filecontentlocation, location if内容处理器,接收请求处理并输出响应。
header_filter_by_lua / header_filter_by_lua_fileoutput-header-filterhttp, server, location, location if设置header和cookie。
body_filter_by_lua / body_filter_by_lua_fileoutput-body-filterhttp, server, location, location if对响应数据进行过滤,比如截断、替换。
log_by_lua / log_by_lua_fileloghttp, server, location, location iflog阶段处理,比如记录访问量/统计平均响应时间。

步骤 1: 安装 Nginx 和 Lua 模块

玩转 Nginx 之:使用 Lua 扩展 Nginx 功能

在这里插入图片描述


步骤 2: 创建 Lua 脚本用于参数校验

创建一个 Lua 脚本,位于 /opt/nginx/lib/lua/validate_params.lua(路径根据nginx.conf中的位置调整):

 -- validate_params.lua
local function validate_post_params()
    ngx.req.read_body()
    local args = ngx.req.get_post_args()

    if not args.username or #args.username < 3 then
        ngx.status = ngx.HTTP_BAD_REQUEST
        ngx.say("Username must be at least 3 characters long")
        return false
    end

    if not args.password or #args.password < 6 then
        ngx.status = ngx.HTTP_BAD_REQUEST
        ngx.say("Password must be at least 6 characters long")
        return false
    end

    return true
end

return {
    validate_post_params = validate_post_params
}


步骤 3: 配置 Nginx 使用 Lua 脚本

在 Nginx 配置文件中,使用 Lua 脚本来校验 POST 请求参数。修改 nginx.conf` ,增加 Lua 配置:

 
user  root;
worker_processes  1;

#error_log  logs/error.log;
#error_log  logs/error.log  notice;
#error_log  logs/error.log  info;

#pid        logs/nginx.pid;


events {
    worker_connections  1024;
}


http {
    include       mime.types;
    default_type  application/octet-stream;
    
    lua_package_path "/opt/nginx/lib/lua/?.lua;;";

    lua_need_request_body on;  # 启用请求体读取
    
    

    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';

    access_log  logs/access.log  main;
    error_log  logs/error.log ;
    
    
    sendfile        on;

    keepalive_timeout  65;

    
    server {
        listen       28443;
        server_name  localhost;

        access_log  logs/host.access.log  main;

        location / {
            root   html;
            index  index.html index.htm;
        }
 
        
   location /api {
    content_by_lua_block {
        local validator = require("validate_params")
        if validator.validate_post_params() then
            ngx.say("Validation passed")
        end
        }
      }
   }
}


写法二: 状态码

lua

-- validate_params.lua
local function validate_post_params()
    ngx.req.read_body()
    local args = ngx.req.get_post_args()

    -- 验证用户名
    if not args.username or #args.username < 3 then
        return ngx.HTTP_BAD_REQUEST, "Invalid username"
    end

    -- 验证密码
    if not args.password or #args.password < 6 then
        return ngx.HTTP_BAD_REQUEST, "Invalid password"
    end

    -- 验证通过
    return ngx.HTTP_OK, "Validation successful"
end

return {
    validate = validate_post_params
}

nginx.conf location config

  location /api {
    content_by_lua_block {
        local validator = require("validate_params")
        local status, message = validator.validate()
        
        ngx.status = status
        ngx.say(status)
        ngx.say(message)
        
        if status ~= ngx.HTTP_OK then
            ngx.exit(status)
        end
        
        -- 继续后续业务逻辑
    }
  }

在这里插入图片描述


写法三 : 返回自定义JSON

如果不使用 cjson 库,我们可以手动构造 JSON 字符串。这种方法虽然不如使用专门的 JSON 库灵活,但对于简单的情况来说是足够的。

 -- validate_params.lua
local function validate_post_params()
    ngx.req.read_body()
    local args = ngx.req.get_post_args()

    if not args.username or #args.username < 3 then
        ngx.status = ngx.HTTP_BAD_REQUEST
        ngx.say("Username must be at least 3 characters long")
        return false
    end

    if not args.password or #args.password < 6 then
        ngx.status = ngx.HTTP_BAD_REQUEST
        -- 创建 JSON 字符串
        local json_response = string.format('{"status":"%s","message":"%s"}',ngx.status,  "Password must be at least 6 characters long")

        -- 设置响应头为 JSON
        ngx.header.content_type = "application/json"
        
        -- 输出 JSON 响应
        ngx.say(json_response)

        return false
    end

    return true
end

return {
    validate_post_params = validate_post_params
}

这段代码会返回相同格式的 JSON:

{
    "status": "400",
    "message": "Password must be at least 6 characters long"
}

在这里插入图片描述

几点说明:

  1. 使用 Lua 的 string.format() 函数来构造 JSON 字符串。这种方法适用于简单的 JSON 结构。

  2. 注意要正确处理字符串中的特殊字符,特别是引号。在这个例子中,我们的消息没有特殊字符,但在实际应用中可能需要进行转义。

  3. 仍然设置响应头的 content-type 为 “application/json”。

  4. 使用 ngx.say() 输出构造的 JSON 字符串。

这种方法的优点是不依赖额外的库,缺点是对于复杂的 JSON 结构可能会变得难以维护。如果需要处理更复杂的 JSON 数据,或者需要频繁地进行 JSON 操作,最好还是使用专门的 JSON 库(如 cjson 或 dkjson)。


 location /api {
    content_by_lua_block {
        local validator = require("validate_params")
        if validator.validate_post_params() then
            ngx.say("Validation passed")
        end
        }
      }

复杂的正则校验

-- validate_params.lua

-- 用户名验证函数
local function validate_username(username)
    -- 基础检查
    if not username or username == "" then
        return false, "Username cannot be empty"
    end

    -- 长度检查
    local length = string.len(username)
    if length < 3 then
        return false, "Username is too short (minimum 3 characters)"
    end
    if length > 20 then
        return false, "Username is too long (maximum 20 characters)"
    end

    -- 检查是否包含空格
    if string.find(username, "%s") then
        return false, "Username cannot contain spaces"
    end

    -- 正则表达式检查(只允许字母、数字、下划线,必须以字母开头)
    local pattern = "^[A-Za-z][A-Za-z0-9_]*$"
    if not ngx.re.match(username, pattern) then
        return false, "Username must start with a letter and can only contain letters, numbers and underscore"
    end

    -- 检查保留字
    local reserved_words = {
        "admin", "root", "system", "user",
        "moderator", "administrator"
    }
    
    local username_lower = string.lower(username)
    for _, word in ipairs(reserved_words) do
        if username_lower == word then
            return false, "This username is reserved"
        end
    end

    return true, nil
end

-- JSON响应函数
local function send_json_response(status, message)
    ngx.status = status
    ngx.header.content_type = "application/json"
    local json_response = string.format('{"status":"%s","message":"%s"}', status, message)
    ngx.say(json_response)
end

-- 主验证函数
local function validate_post_params()
    ngx.req.read_body()
    local args = ngx.req.get_post_args()

    -- 验证用户名
    if not args.username then
        send_json_response(ngx.HTTP_BAD_REQUEST, "Username is required")
        return false
    end

    local is_valid, error_message = validate_username(args.username)
    if not is_valid then
        send_json_response(ngx.HTTP_BAD_REQUEST, error_message)
        return false
    end

    -- 验证密码
    if not args.password or #args.password < 6 then
        send_json_response(ngx.HTTP_BAD_REQUEST, "Password must be at least 6 characters long")
        return false
    end

    return true
end

-- 导出模块
return {
    validate_post_params = validate_post_params
}


    location /api {
    content_by_lua_block {
        local validator = require("validate_params")
        if validator.validate_post_params() then
            ngx.say("Validation passed")
        end
        }
      }

在这里插入图片描述

  1. 有效的用户名和密码:
curl -X POST http://localhost:28443/api -d "username=validuser&password=validpass123"

预期结果:成功(具体响应取决于你的成功处理逻辑)

  1. 用户名太短:
curl -X POST http://localhost:28443/api -d "username=ab&password=validpass123"

预期结果:

{"status":"400","message":"Username is too short (minimum 3 characters)"}
  1. 用户名太长:
curl -X POST http://localhost:28443/api -d "username=thisusernameiswaytoolong&password=validpass123"

预期结果:

{"status":"400","message":"Username is too long (maximum 20 characters)"}
  1. 用户名包含空格:
curl -X POST http://localhost:28443/api -d "username=invalid user&password=validpass123"

预期结果:

{"status":"400","message":"Username cannot contain spaces"}
  1. 用户名不以字母开头:
curl -X POST http://localhost:28443/api -d "username=1invaliduser&password=validpass123"

预期结果:

{"status":"400","message":"Username must start with a letter and can only contain letters, numbers and underscore"}
  1. 用户名包含非法字符:
curl -X POST http://localhost:28443/api -d "username=invalid@user&password=validpass123"

预期结果:

{"status":"400","message":"Username must start with a letter and can only contain letters, numbers and underscore"}
  1. 用户名是保留字:
curl -X POST http://localhost:28443/api -d "username=admin&password=validpass123"

预期结果:

{"status":"400","message":"This username is reserved"}
  1. 密码太短:
curl -X POST http://localhost:28443/api -d "username=validuser&password=short"

预期结果:

{"status":"400","message":"Password must be at least 6 characters long"}
  1. 缺少用户名:
curl -X POST http://localhost:28443/api -d "password=validpass123"

预期结果:

{"status":"400","message":"Username is required"}
  1. 缺少密码:
curl -X POST http://localhost:28443/api -d "username=validuser"

预期结果:

{"status":"400","message":"Password must be at least 6 characters long"}

步骤 4: 测试和验证

  1. 重启 Nginx

    sudo systemctl restart nginx
    
  2. 发送 POST 请求
    可以使用 curl 或 Postman 测试:

[root@hcss-ecs-917b sbin]#    curl -X POST http://localhost:28443/api -d "username=test&password=123456"
Validation passed
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#    curl -X POST http://localhost:28443/api -d "username=test&password=1"
Password must be at least 6 characters long
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#    curl -X POST http://localhost:28443/api -d "username=t&password=1"
Username must be at least 3 characters long
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#    curl -X POST http://localhost:28443/api
Username must be at least 3 characters long
[root@hcss-ecs-917b sbin]#
[root@hcss-ecs-917b sbin]#

在这里插入图片描述


ngx.HTTP_* 枚举值

在 OpenResty/Nginx 中,ngx.HTTP_* 常用的状态码枚举值如下:

  1. 成功类状态码:
ngx.HTTP_OK                 -- 200 成功
ngx.HTTP_CREATED            -- 201 已创建
ngx.HTTP_NO_CONTENT         -- 204 无内容
  1. 重定向类:
ngx.HTTP_MOVED_TEMPORARILY  -- 302 临时重定向
ngx.HTTP_MOVED_PERMANENTLY  -- 301 永久重定向
ngx.HTTP_SEE_OTHER          -- 303 其他位置
ngx.HTTP_NOT_MODIFIED       -- 304 未修改
  1. 客户端错误类:
ngx.HTTP_BAD_REQUEST        -- 400 错误请求
ngx.HTTP_UNAUTHORIZED       -- 401 未授权
ngx.HTTP_FORBIDDEN          -- 403 禁止访问
ngx.HTTP_NOT_FOUND          -- 404 未找到
ngx.HTTP_METHOD_NOT_ALLOWED -- 405 方法不允许
ngx.HTTP_REQUEST_TIMEOUT    -- 408 请求超时
ngx.HTTP_CONFLICT           -- 409 冲突
ngx.HTTP_GONE               -- 410 资源已不存在
  1. 服务器错误类:
ngx.HTTP_INTERNAL_SERVER_ERROR  -- 500 内部服务器错误
ngx.HTTP_NOT_IMPLEMENTED        -- 501 未实现
ngx.HTTP_BAD_GATEWAY            -- 502 网关错误
ngx.HTTP_SERVICE_UNAVAILABLE    -- 503 服务不可用
ngx.HTTP_GATEWAY_TIMEOUT        -- 504 网关超时

常用示例:

-- 成功响应
ngx.status = ngx.HTTP_OK
ngx.say("Success")

-- 参数错误
ngx.status = ngx.HTTP_BAD_REQUEST
ngx.say("Invalid parameters")

-- 未授权
ngx.status = ngx.HTTP_UNAUTHORIZED
ngx.say("Authentication required")

-- 服务器错误
ngx.status = ngx.HTTP_INTERNAL_SERVER_ERROR
ngx.say("Server error occurred")

推荐使用场景:

  1. 验证类:使用 400-409
  2. 身份认证:使用 401-403
  3. 资源相关:使用 404-410
  4. 服务器错误:使用 500-504

建议根据具体业务场景选择最精准的状态码。

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/948643.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

医院机房运维:所有IT资源运行状态同一平台实时呈现

在当今数字化医疗高速发展的时代&#xff0c;医院的信息化系统已然成为保障医疗服务顺畅开展、守护患者生命健康的关键基础设施。以郑州人民医院为例&#xff0c;随着医疗业务不断拓展&#xff0c;其背后支撑的机房运维面临着诸多棘手难题。 传统的分散式人工维护模式&#xff…

AcWing练习题:油耗

给定一个汽车行驶的总路程&#xff08;km&#xff09;和消耗的油量&#xff08;l&#xff09;&#xff0c;请你求出汽车每消耗 1 升汽油可行驶多少公里路程。 输入格式 输入共两行&#xff0c;第一行包含整数 X&#xff0c;表示行驶总路程。 第二行包含保留一位小数的浮点数…

前后端规约

文章目录 引言I 【强制】前后端交互的 API请求内容响应体响应码II 【推荐】MVC响应体III【参考】IV 其他引言 服务器内部重定向必须使用 forward;外部重定向地址必须使用 URL 统一代理模块生成,否则会因线上采用 HTTPS 协议而导致浏览器提示“不安全”,并且还会带来 URL 维护…

Redis(二)value 的五种常见数据类型简述

目录 一、string&#xff08;字符串&#xff09; 1、raw 2、int 3、embstr 二、hash&#xff08;哈希表&#xff09; 1、hashtable 2、ziplist 三、list&#xff08;列表&#xff09; ​编辑 1、linkedlist 2、ziplist 3、quicklist&#xff08;redis 3.2后的列表内…

RabbitMQ 客户端 连接、发送、接收处理消息

RabbitMQ 客户端 连接、发送、接收处理消息 一. RabbitMQ 的机制跟 Tcp、Udp、Http 这种还不太一样 RabbitMQ 服务&#xff0c;不是像其他服务器一样&#xff0c;负责逻辑处理&#xff0c;然后转发给客户端 而是所有客户端想要向 RabbitMQ服务发送消息&#xff0c; 第一步&a…

仿生的群体智能算法总结之二(十种)

群体智能算法是一类通过模拟自然界中的群体行为来解决复杂优化问题的方法。以下是10种常见的群体智能算法,接上文https://blog.csdn.net/lzm12278828/article/details/144933367仿生的群体智能算法总结之一(十种)-CSDN博客https://blog.csdn.net/lzm12278828/article/detail…

Jenkins(持续集成与自动化部署)

Jenkins 是一个开源软件项目&#xff0c;是基于Java开发的一种持续集成工具。 官网&#xff1a;https://www.jenkins.io/ GitLab安装使用 安装前提&#xff1a;内存至少需要4G 官方网站&#xff1a;https://about.gitlab.com/ 安装文档&#xff1a;https://docs.gitlab.c…

Luma AI 简单几步生成视频

简单几步生成视频 登录我们的 AceDataPlatform 网站&#xff0c;按照下图所示即可生成高质量的视频&#xff0c;同时&#xff0c;我们也提供了简单易用的 API 方便集成调用&#xff0c;可以查看 Luma API了解详情 技术介绍 我们使用了 Luma 的技术&#xff0c;实现了上面的图…

Day17补代码随想录 654.最大二叉树|617.合并二叉树|700.二叉搜索树中的搜索|98.验证二叉搜索树

654.最大二叉树 题目 【体会为什么构造二叉树都是前序遍历】 给定一个不重复的整数数组 nums 。 最大二叉树 可以用下面的算法从 nums 递归地构建: 创建一个根节点&#xff0c;其值为 nums 中的最大值。递归地在最大值 左边 的 子数组前缀上 构建左子树。递归地在最大值 右…

vue代理问题

vue代理问题 场景:前后端分离项目问题,在前端中请求接口,返回数据这个过程,但是在这个过程中,前端会有两个环境,一个是开发环境,一个是生产环境. 在开发环境中请求接口可能会遇到跨域问题,比如请求的端口是3000,当前端口是8080,这时候就会遇到跨域问题,或者ip不同,也会存在跨…

学英语学压测:02jmeter组件-测试计划和线程组ramp-up参数的作用

&#x1f4e2;&#x1f4e2;&#x1f4e2;&#xff1a;先看关键单词&#xff0c;再看英文&#xff0c;最后看中文总结&#xff0c;再回头看一遍英文原文&#xff0c;效果更佳&#xff01;&#xff01; 关键词 Functional Testing功能测试[ˈfʌŋkʃənəl ˈtɛstɪŋ]Sample样…

phpIPAM容器化部署场景下从1.5.x更新到1.7.0提示禁用安装脚本配置的处理

phpIPAM容器化部署场景下从1.5.x更新到1.7.0&#xff0c;在系统登录页面出现“Please disable installaion scripts....”提示&#xff0c;本文件记录处理过程。 一、问题描述 phpIPAM从1.5.x更新到1.7.0&#xff0c;在系统登录页面出现提示&#xff1a; “Please disable in…

第三届图像处理、计算机视觉与机器学习国际学术会议(ICICML 2024)

目录 重要信息 大会简介 组织单位 大会成员 征稿主题 会议日程 参会方式 重要信息 大会官网&#xff1a;www.icicml.org 大会时间&#xff1a;2024年11月22日-24日 大会地点&#xff1a;中国 深圳 大会简介 第三届图像处理、计算机视觉与机器学…

技术人做Youtuber第一次实战

2025年第一篇&#xff0c;新年好~ 大概2012年还是大三时&#xff0c;不记得从哪里搞到了youtube注册方法&#xff0c;注册了youtube, facebook等被"walled"的网站&#xff0c;当时沉迷海贼王&#xff0c;上传了类似"六分钟看海贼王多热血"的视频&#xff0…

仓颉笔记——windows11安装启用cangjie语言,并使用vscode编写“你好,世界”

2025年1月1日第一篇日记&#xff0c;大家新年好。 去年就大致看了一下&#xff0c;感觉还不错&#xff0c;但一直没上手&#xff0c;这次借着元旦的晚上安装了一下&#xff0c;今年正式开动&#xff0c;公司众多的应用国产化正等着~~ 第一步&#xff1a;准备 官网&#xff1a;…

大模型数据采集和预处理:把所有数据格式,word、excel、ppt、jpg、pdf、表格等转为数据

大模型数据采集和预处理&#xff1a;把所有数据格式&#xff0c;word、excel、ppt、jpg、pdf、表格等转为数据 文本/图片/表格&#xff0c;分别提取处理工具选择不同格式文件&#xff0c;使用不同工具处理1. 确认目标2. 分析过程(目标-手段分析法)3. 实现步骤4. 代码封装效果展…

使用函数求e的近似值(PTA)C语言

自然常数e可以用级数11/1!1/2!⋯1/n!来近似计算。本题要求实现一个计算阶乘的简单函数&#xff0c;使得可以利用该函数&#xff0c;对给定的非负整数n&#xff0c;求该级数的前n1项和。 函数接口定义&#xff1a; double fact( int n ); 其中n是用户传入的参数&#xff0c;函…

9.系统学习-卷积神经网络

9.系统学习-卷积神经网络 简介输入层卷积层感受野池化层全连接层代码实现 简介 卷积神经网络是一种用来处理局部和整体相关性的计算网络结构&#xff0c;被应用在图像识别、自然语言处理甚至是语音识别领域&#xff0c;因为图像数据具有显著的局部与整体关系&#xff0c;其在图…

循环冗余校验CRC的介绍

一、简介 循环冗余校验CRC&#xff08;Cyclic Redundancy Check&#xff09;是数据通信领域中最常用的一种差错校验码。该校验方法中&#xff0c;使用多项式出发&#xff08;模2除法&#xff09;运算后的余数为校验字段。CRC只能实现检错&#xff0c;不能实现纠错&#xff0c;使…

C语言 数组名

1.数组名 数组名是数组首元素的地址。 数组名确实能表示首元素的地址 但是有两个例外&#xff1a; 1.sizeof(数组名&#xff09;,这里的数组名表示整个数组&#xff0c;计算的是整个数组的大小&#xff0c;单位是字节 2.&数组名&#xff0c;这里的数组名表示整个数组&…