├── .gitignore ├── kong └── plugins │ └── http301https │ ├── schema.lua │ └── handler.lua ├── .luacheckrc ├── README.md ├── kong-plugin-http301https-0.1.0-1.rockspec └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | **/.DS_Store 2 | -------------------------------------------------------------------------------- /kong/plugins/http301https/schema.lua: -------------------------------------------------------------------------------- 1 | return { 2 | no_consumer = false, -- this plugin is available on APIs as well as on Consumers, 3 | fields = { 4 | -- Describe your plugin's configuration's schema here. 5 | 6 | }, 7 | self_check = function(schema, plugin_t, dao, is_updating) 8 | -- perform any custom verification 9 | return true 10 | end 11 | } 12 | -------------------------------------------------------------------------------- /.luacheckrc: -------------------------------------------------------------------------------- 1 | -- Configuration file for LuaCheck 2 | -- see: https://luacheck.readthedocs.io/en/stable/ 3 | -- 4 | -- To run do: `luacheck .` from the repo 5 | 6 | std = "ngx_lua" 7 | unused_args = false 8 | redefined = false 9 | max_line_length = false 10 | 11 | 12 | globals = { 13 | "_KONG", 14 | "kong", 15 | "ngx.IS_CLI", 16 | } 17 | 18 | 19 | not_globals = { 20 | "string.len", 21 | "table.getn", 22 | } 23 | 24 | 25 | ignore = { 26 | "6.", -- ignore whitespace warnings 27 | } 28 | 29 | 30 | exclude_files = { 31 | --"spec/fixtures/invalid-module.lua", 32 | --"spec-old-api/fixtures/invalid-module.lua", 33 | } 34 | 35 | 36 | files["spec/**/*.lua"] = { 37 | std = "ngx_lua+busted", 38 | } 39 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Kong plugin http301https 2 | ==================== 3 | 4 | A simple kong plugin that 301 redirect http request to https version, for example: 5 | 6 | if your user visit your site with http: 7 | 8 | ``` 9 | http://www.example.com/xxx.php?a=b 10 | ``` 11 | 12 | this plugin will redirect to: 13 | 14 | ``` 15 | https://www.example.com/xxx.php?a=b 16 | ``` 17 | 18 | ### How to use 19 | 20 | 1. clone the code: 21 | 22 | ``` 23 | git clone git@github.com:pocketdigi/kong-plugin-http301https.git 24 | ``` 25 | 26 | 2. install 27 | 28 | ``` 29 | cd kong-plugin-http301https 30 | luarocks make 31 | ``` 32 | 3. Edit /etc/kong/kong.conf, uncomment`plugins = bundled` add http301https 33 | 34 | ``` 35 | plugins = bundled,http301https 36 | ``` 37 | 4. Restart kong 38 | 39 | 5. Add plugin to your service 40 | 41 | 42 | -------------------------------------------------------------------------------- /kong-plugin-http301https-0.1.0-1.rockspec: -------------------------------------------------------------------------------- 1 | package = "kong-plugin-http301https" -- TODO: rename, must match the info in the filename of this rockspec! 2 | -- as a convention; stick to the prefix: `kong-plugin-` 3 | version = "0.1.0-1" -- TODO: renumber, must match the info in the filename of this rockspec! 4 | -- The version '0.1.0' is the source code version, the trailing '1' is the version of this rockspec. 5 | -- whenever the source version changes, the rockspec should be reset to 1. The rockspec version is only 6 | -- updated (incremented) when this file changes, but the source remains the same. 7 | 8 | -- TODO: This is the name to set in the Kong configuration `plugins` setting. 9 | -- Here we extract it from the package name. 10 | local pluginName = package:match("^kong%-plugin%-(.+)$") -- "myPlugin" 11 | 12 | supported_platforms = {"linux", "macosx"} 13 | source = { 14 | url = "https://github.com/pocketdigi/kong-plugin-http301https.git", 15 | tag = "0.1.0" 16 | } 17 | 18 | description = { 19 | summary = "A Kong plugin that redirect http request to https with 301 status code.", 20 | homepage = "https://www.pocketdigi.com", 21 | license = "Apache 2.0" 22 | } 23 | 24 | dependencies = { 25 | } 26 | 27 | build = { 28 | type = "builtin", 29 | modules = { 30 | -- TODO: add any additional files that the plugin consists of 31 | ["kong.plugins."..pluginName..".handler"] = "kong/plugins/"..pluginName.."/handler.lua", 32 | ["kong.plugins."..pluginName..".schema"] = "kong/plugins/"..pluginName.."/schema.lua", 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /kong/plugins/http301https/handler.lua: -------------------------------------------------------------------------------- 1 | -- If you're not sure your plugin is executing, uncomment the line below and restart Kong 2 | -- then it will throw an error which indicates the plugin is being loaded at least. 3 | 4 | --assert(ngx.get_phase() == "timer", "The world is coming to an end!") 5 | 6 | 7 | -- Grab pluginname from module name 8 | local plugin_name = ({...})[1]:match("^kong%.plugins%.([^%.]+)") 9 | 10 | -- load the base plugin object and create a subclass 11 | local plugin = require("kong.plugins.base_plugin"):extend() 12 | 13 | -- constructor 14 | function plugin:new() 15 | plugin.super.new(self, plugin_name) 16 | 17 | -- do initialization here, runs in the 'init_by_lua_block', before worker processes are forked 18 | 19 | end 20 | 21 | --------------------------------------------------------------------------------------------- 22 | -- In the code below, just remove the opening brackets; `[[` to enable a specific handler 23 | -- 24 | -- The handlers are based on the OpenResty handlers, see the OpenResty docs for details 25 | -- on when exactly they are invoked and what limitations each handler has. 26 | -- 27 | -- The call to `.super.xxx(self)` is a call to the base_plugin, which does nothing, except logging 28 | -- that the specific handler was executed. 29 | --------------------------------------------------------------------------------------------- 30 | 31 | 32 | --[[ handles more initialization, but AFTER the worker process has been forked/created. 33 | -- It runs in the 'init_worker_by_lua_block' 34 | function plugin:init_worker() 35 | plugin.super.init_worker(self) 36 | 37 | -- your custom code here 38 | 39 | end --]] 40 | 41 | --[[ runs in the ssl_certificate_by_lua_block handler 42 | function plugin:certificate(plugin_conf) 43 | plugin.super.certificate(self) 44 | 45 | -- your custom code here 46 | 47 | end --]] 48 | 49 | --[[ runs in the 'rewrite_by_lua_block' (from version 0.10.2+) 50 | -- IMPORTANT: during the `rewrite` phase neither the `api` nor the `consumer` will have 51 | -- been identified, hence this handler will only be executed if the plugin is 52 | -- configured as a global plugin! 53 | function plugin:rewrite(plugin_conf) 54 | plugin.super.rewrite(self) 55 | 56 | -- your custom code here 57 | 58 | end --]] 59 | 60 | ---[[ runs in the 'access_by_lua_block' 61 | function plugin:access(plugin_conf) 62 | plugin.super.access(self) 63 | schema=kong.request.get_scheme() 64 | test=kong.request.get_header("test") 65 | if ( schema == "http" ) 66 | then 67 | path_with_query = kong.request.get_path_with_query() 68 | host = kong.request.get_host() 69 | 70 | https_url = "https://" .. host .. path_with_query 71 | 72 | kong.response.exit(301,"Redirect to https",{["Location"] = https_url }); 73 | end 74 | 75 | end --]] 76 | 77 | ---[[ runs in the 'header_filter_by_lua_block' 78 | function plugin:header_filter(plugin_conf) 79 | plugin.super.header_filter(self) 80 | 81 | 82 | end --]] 83 | 84 | --[[ runs in the 'body_filter_by_lua_block' 85 | function plugin:body_filter(plugin_conf) 86 | plugin.super.body_filter(self) 87 | 88 | -- your custom code here 89 | 90 | end --]] 91 | 92 | --[[ runs in the 'log_by_lua_block' 93 | function plugin:log(plugin_conf) 94 | plugin.super.log(self) 95 | 96 | -- your custom code here 97 | 98 | end --]] 99 | 100 | 101 | -- set the plugin priority, which determines plugin execution order 102 | plugin.PRIORITY = 1000 103 | 104 | -- return our plugin object 105 | return plugin 106 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------