├── assets ├── image-20190418174610816.png └── image-20190418175944799.png ├── .gitignore ├── GNode └── plugin.lua ├── README.md └── LICENSE /assets/image-20190418174610816.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gtbotsonar/analyse-plugin-lua/HEAD/assets/image-20190418174610816.png -------------------------------------------------------------------------------- /assets/image-20190418175944799.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gtbotsonar/analyse-plugin-lua/HEAD/assets/image-20190418175944799.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Lua sources 2 | luac.out 3 | 4 | # luarocks build files 5 | *.src.rock 6 | *.zip 7 | *.tar.gz 8 | 9 | # Object files 10 | *.o 11 | *.os 12 | *.ko 13 | *.obj 14 | *.elf 15 | 16 | # Precompiled Headers 17 | *.gch 18 | *.pch 19 | 20 | # Libraries 21 | *.lib 22 | *.a 23 | *.la 24 | *.lo 25 | *.def 26 | *.exp 27 | 28 | # Shared objects (inc. Windows DLLs) 29 | *.dll 30 | *.so 31 | *.so.* 32 | *.dylib 33 | 34 | # Executables 35 | *.exe 36 | *.out 37 | *.app 38 | *.i*86 39 | *.x86_64 40 | *.hex 41 | 42 | .DS_Store 43 | -------------------------------------------------------------------------------- /GNode/plugin.lua: -------------------------------------------------------------------------------- 1 | --- 2 | --- Created by lhertz. 3 | --- DateTime: 2019-04-18 11:49 4 | --- 5 | 6 | local cjson = require "cjson" 7 | local ngx = ngx 8 | local ngx_req_get_headers = ngx.req.get_headers 9 | local ngx_req_get_method = ngx.req.get_method 10 | local ngx_req_raw_header = ngx.req.raw_header 11 | local ngx_req_set_header = ngx.req.set_header 12 | local ngx_encode_base64 = ngx.encode_base64 13 | local ngx_log = ngx.log 14 | local ngx_ERR = ngx.ERR 15 | local ngx_now = ngx.now 16 | 17 | local DEFAULT_METHOD = "GNodeMethod" 18 | local DEFAULT_URL = "GNodeURL" 19 | 20 | local HTTP_HEADER_KEY = "X-Botsonar-Information" 21 | 22 | local _M = { 23 | _VERSION = "0.01" 24 | } 25 | 26 | local function get_client_ip(headers) 27 | 28 | if headers['x-real-ip'] then 29 | return headers['x-real-ip'] 30 | end 31 | 32 | if headers['x-forwarded-for'] and headers['x-forwarded-for'] ~= '' then 33 | local lastcomma = string.find(headers['x-forwarded-for'], ',', 1) 34 | if lastcomma then 35 | return string.sub(headers['x-forwarded-for'], 0, lastcomma - 1) 36 | else 37 | return headers['x-forwarded-for'] 38 | end 39 | end 40 | 41 | return ngx.var.remote_addr 42 | end 43 | 44 | local function collectInfo() 45 | local headers = ngx_req_get_headers() 46 | local info = { 47 | type = 0, 48 | web = { 49 | rawHeaders = ngx_req_raw_header(true), 50 | requestMethod = ngx_req_get_method() or DEFAULT_METHOD, 51 | requestURL = ngx.var.request_uri or DEFAULT_URL, 52 | requestTime = ngx_now(), 53 | clientAddress = get_client_ip(headers) 54 | } 55 | } 56 | local tmp = cjson.encode(info) 57 | local result = ngx_encode_base64(tmp) 58 | ngx_req_set_header(HTTP_HEADER_KEY, result) 59 | end 60 | 61 | function _M.run() 62 | local ok, err = pcall(collectInfo) 63 | if not ok then 64 | ngx_log(ngx_ERR, "GNode Plugin collect web information failed! Error: ", err) 65 | end 66 | return 67 | end 68 | 69 | return _M -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## BotSonar OpenResty 插件使用说明 2 | 3 | - 简介 4 | 5 | - 该插件用于整合在 OpenResty 或者安装了 [lua 模块](https://github.com/openresty/lua-nginx-module) 的 Nginx 反向代理中，用于收集流量的 Web 端信息以提供给 GCloud 组件进行智能判断。 6 | 7 | - 目录结构 8 | 9 | - GNodePlugin 10 | - GNode 11 | - plugin.lua 12 | - README.md 13 | 14 | - 安装、整合及使用 15 | 16 | - 依赖： 17 | 18 | - [lua-cjson](https://github.com/openresty/lua-cjson/)，(OpenResty 内置) 19 | - [ngx_http_lua_module](https://github.com/openresty/lua-nginx-module)，(OpenResty 内置) 20 | 21 | - 安装： 22 | 23 | - 把 GNode 目录完整的拷贝到`/usr/local/openresty/lualib`目录下，即 `plugin.lua`的绝对路径为`/usr/local/openresty/lualib/GNode/plugin.lua`。(如果自定义了 OpenResty 的安装目录，则需根据情况调整为`(OpenResty 安装路径)/lualib/GNode`) 24 | 25 | - 整合： 26 | 27 | - 修改 OpenResty 的配置文件，在需要防护的 location 块中添加如下代码以调用该插件： 28 | 29 | ```nginx 30 | access_by_lua_block { 31 | local plugin = require "GNode.plugin" 32 | plugin.run() 33 | } 34 | ``` 35 | 36 | 示例： 37 | 38 | ```nginx 39 | server { 40 | listen 80; 41 | listen 443 ssl; 42 | ssl_certificate Crt/GNodeCA.crt; 43 | ssl_certificate_key Crt/GNodeCA.key; 44 | 45 | server_name test.com; 46 | 47 | error_log logs/error.log info; 48 | 49 | default_type text/html; 50 | client_body_buffer_size 256k; 51 | 52 | location / { 53 | access_by_lua_block { 54 | local plugin = require "GNode.plugin" 55 | plugin.run() 56 | } 57 | proxy_pass http://upstream1; 58 | } 59 | } 60 | ``` 61 | 62 | - 使用： 63 | 64 | - 整合完插件之后重启 OpenResty 即可。插件正常工作的情况下，反代之后的请求(即 Web 服务器实际收到的请求)头部会携带`X-Botsonar-Information`字段，其值即为需要发送给 GCloud 判断接口的数据，字符串类型。如： 65 | 66 | ![image-20190418174610816](assets/image-20190418174610816.png) 67 | 68 | 此时可以在服务端取出此字段发送到指定接口并获取判断结果。 69 | 70 | - 错误提示：如果由于某些原因插件运行出错，反代的原始功能不会受到任何影响，但是反代之后的请求头部中不会出现`X-Botsonar-Information`字段，同时OpenResty 的 `error.log`(或者用户指定的错误日志输出)中会记录错误消息及原因，如： 71 | 72 | ![image-20190418175944799](assets/image-20190418175944799.png) 73 | 74 | - 注意事项： 75 | 76 | - 注意涉及到的 OpenResty 的安装目录要根据实际情况进行修改 77 | - 本插件暂不支持 HTTP/2 协议 -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------