├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── INDIVIDUAL_CONTRIBUTOR_LICENSE.md ├── LICENSE ├── NOTICE.txt ├── README.md ├── kong-oidc-auth-0.3-0.rockspec ├── kong-oidc-auth-0.3-0.src.rock └── src ├── access.lua ├── handler.lua └── schema.lua /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project email 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at [opensource@optum.com][email]. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [http://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: http://contributor-covenant.org 74 | [version]: http://contributor-covenant.org/version/1/4/ 75 | [email]: mailto:opensource@optum.com 76 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. Please also review our [Contributor License Agreement ("CLA")](INDIVIDUAL_CONTRIBUTOR_LICENSE.md) prior to submitting changes to the project. You will need to attest to this agreement following the instructions in the [Paperwork for Pull Requests](#paperwork-for-pull-requests) section below. 4 | 5 | --- 6 | 7 | # How to Contribute 8 | 9 | Now that we have the disclaimer out of the way, let's get into how you can be a part of our project. There are many different ways to contribute. 10 | 11 | ## Issues 12 | 13 | We track our work using Issues in GitHub. Feel free to open up your own issue to point out areas for improvement or to suggest your own new experiment. If you are comfortable with signing the waiver linked above and contributing code or documentation, grab your own issue and start working. 14 | 15 | ## Coding Standards 16 | 17 | We have some general guidelines towards contributing to this project. 18 | 19 | ### Languages 20 | 21 | *Lua* 22 | 23 | ## Pull Requests 24 | 25 | If you've gotten as far as reading this section, then thank you for your suggestions. 26 | 27 | ### Paperwork for Pull Requests 28 | 29 | * Please read this guide and make sure you agree with our [Contributor License Agreement ("CLA")](INDIVIDUAL_CONTRIBUTOR_LICENSE.md). 30 | * Make sure git knows your name and email address: 31 | ``` 32 | $ git config user.name "J. Random User" 33 | $ git config user.email "j.random.user@example.com" 34 | ``` 35 | >The name and email address must be valid as we cannot accept anonymous contributions. 36 | * Write good commit messages. 37 | > Concise commit messages that describe your changes help us better understand your contributions. 38 | * The first time you open a pull request in this repository, you will see a comment on your PR with a link that will allow you to sign our Contributor License Agreement (CLA) if necessary. 39 | > The link will take you to a page that allows you to view our CLA. You will need to click the `Sign in with GitHub to agree button` and authorize the cla-assistant application to access the email addresses associated with your GitHub account. Agreeing to the CLA is also considered to be an attestation that you either wrote or have the rights to contribute the code. All committers to the PR branch will be required to sign the CLA, but you will only need to sign once. This CLA applies to all repositories in the Optum org. 40 | 41 | ## General Guidelines 42 | 43 | Ensure your pull request (PR) adheres to the following guidelines: 44 | 45 | * Try to make the name concise and descriptive. 46 | * Give a good description of the change being made. Since this is very subjective, see the [Updating Your Pull Request (PR)](#updating-your-pull-request-pr) section below for further details. 47 | * Every pull request should be associated with one or more issues. If no issue exists yet, please create your own. 48 | * Make sure that all applicable issues are mentioned somewhere in the PR description. This can be done by typing # to bring up a list of issues. 49 | 50 | ### Updating Your Pull Request (PR) 51 | 52 | A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. This applies to both the content documented in the PR and the changed contained within the branch being merged. There's no need to open a new PR. Just edit the existing one. 53 | 54 | [email]: mailto:opensource@optum.com 55 | -------------------------------------------------------------------------------- /INDIVIDUAL_CONTRIBUTOR_LICENSE.md: -------------------------------------------------------------------------------- 1 | # Individual Contributor License Agreement ("Agreement") V2.0 2 | 3 | Thank you for your interest in this Optum project (the "PROJECT"). In order to clarify the intellectual property license granted with Contributions from any person or entity, the PROJECT must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of the PROJECT and its users; it does not change your rights to use your own Contributions for any other purpose. 4 | 5 | You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the PROJECT. In return, the PROJECT shall not use Your Contributions in a way that is inconsistent with stated project goals in effect at the time of the Contribution. Except for the license granted herein to the PROJECT and recipients of software distributed by the PROJECT, You reserve all right, title, and interest in and to Your Contributions. 6 | 1. Definitions. 7 | 8 | "You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with the PROJECT. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. 9 | 10 | "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the PROJECT for inclusion in, or documentation of, any of the products owned or managed by the PROJECT (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the PROJECT or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the PROJECT for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." 11 | 12 | 2. Grant of Copyright License. 13 | 14 | Subject to the terms and conditions of this Agreement, You hereby grant to the PROJECT and to recipients of software distributed by the PROJECT a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. 15 | 16 | 3. Grant of Patent License. 17 | 18 | Subject to the terms and conditions of this Agreement, You hereby grant to the PROJECT and to recipients of software distributed by the PROJECT a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. 19 | 20 | 4. Representations. 21 | 22 | (a) You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to the PROJECT, or that your employer has executed a separate Corporate CLA with the PROJECT. 23 | 24 | (b) You represent that each of Your Contributions is Your original creation (see section 6 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions. 25 | 26 | 5. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. 27 | 28 | 6. Should You wish to submit work that is not Your original creation, You may submit it to the PROJECT separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". 29 | 30 | 7. You agree to notify the PROJECT of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect. 31 | -------------------------------------------------------------------------------- /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 2021 Optum 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 | -------------------------------------------------------------------------------- /NOTICE.txt: -------------------------------------------------------------------------------- 1 | Kong OIDC Auth Plugin 2 | Copyright 2018 Optum 3 | 4 | Project Description: 5 | ==================== 6 | 7 | The Kong OIDC Auth Plugin is a small, lua-based, OpenResty Nginx module which provides external authentication on Kong’s proxy requests. The purpose of this OIDC plugin is to provide authentication against Optum’s Ping Federate service. OpenID Connect enabled login is a common and popular pattern across many companies. 8 | 9 | Authors: 10 | Jeremy Justus, ©Optum 2018 11 | Ross Sbriscia, ©Optum 2018 12 | Niko Usai, 2016 13 | 14 | Added Files: 15 | ============ 16 | 17 | 18 | Modified Files: 19 | =============== 20 | access.lua 21 | schema.lua 22 | handler.lua 23 | 24 | 6/1/2018: 25 | This plugin is originally based on the logic from the "Kong External OAUTH 2.0" developed by Niko Usai. It is highly modified and extended for our needs and updated to be compatible with the modern Kong TLS libaries. We have enhanced features to be Ping federate specific, Proxy Wildcard definition tolerant, "/logout" fucntionality, userInfo caching functionality, as well as proper redirection implemented for Single Page Apps(SPA) to achieve a proper user experience. 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kong OIDC Auth 2 | OpenID Connect authentication integration with the Kong Gateway 3 | 4 | ## Configuration 5 | You can add the plugin with the following request: 6 | 7 | ```bash 8 | $ curl -X POST http://kong:8001/apis/{api}/plugins \ 9 | --data "name=kong-oidc-auth" \ 10 | --data "config.authorize_url=https://oauth.something.net/openid-connect/authorize" \ 11 | --data "config.scope=openid+profile+email" \ 12 | --data "config.pfidpadapterid=CompanyIdOIDCStage" \ 13 | --data "config.token_url=https://oauth.something.net/openid-connect/token" \ 14 | --data "config.client_id=SOME_CLEINT_ID" \ 15 | --data "config.client_secret=SOME_SECRET_KEY" \ 16 | --data "config.user_url=https://oauth.something.net/openid-connect/userinfo" \ 17 | --data "config.user_keys=email,name,sub" \ 18 | --data "config.hosted_domain=mycompany.com" \ 19 | --data "config.email_key=email" \ 20 | --data "config.salt=b3253141ce67204b" \ 21 | --data "config.app_login_redirect_url=https://yourapplication.com/loggedin/dashboard" \ 22 | --data "config.cookie_domain=.company.com" \ 23 | --data "config.user_info_cache_enabled=false" 24 | ``` 25 | 26 | | Form Parameter | default | description | 27 | | --- | --- | --- | 28 | | `name` | | plugin name `kong-oidc-auth` | 29 | | `config.authorize_url` | | authorization url of the OAUTH provider (the one to which you will be redirected when not authenticated) | 30 | | `config.scope` | | OAUTH scope of the authorization request | 31 | | `config.pfidpadapterid`
Optional | | OAUTH PingFederate Adaptor ID of the authorization request ex: CompanyIdOIDCStage, essentially points to the idp environment, ping federate specific only | 32 | | `config.token_url` | | url of the Oauth provider to request the access token | 33 | | `config.client_id` | | OAUTH Client Id | 34 | | `config.client_secret` | | OAUTH Client Secret | 35 | | `config.user_url` | | url of the oauth provider used to retrieve user information and also check the validity of the access token | 36 | | `config.user_keys`
Optional | `username,email` | keys to extract from the `user_url` endpoint returned json, they will also be added to the headers of the upstream server as `X-OAUTH-XXX` | 37 | | `config.hosted_domain` | | domain whose users must belong to in order to get logged in. Ignored if empty | 38 | | `config.email_key` | | key to be checked for hosted domain, taken from userinfo endpoint | 39 | | `config.user_info_periodic_check` | 60 | time in seconds between token checks | 40 | | `config.salt` | b3253141ce67204b | salt for the user session token, must be 16 char alphanumeric | 41 | | `config.app_login_redirect_url` | | Needed for Single Page Applications to redirect after initial authentication successful, otherwise a proxy request following initial authentication would redirect data directly to a users browser! | 42 | | `config.cookie_domain` | | Specify the domain in which this cookie is valid for, realistically will need to match the gateway | 43 | | `config.user_info_cache_enabled` | | This enables storing the userInfo in Kong local cache which enables sending the entire requested user information to the backend service upon every request, otherwise user info only comes back occasionally and backend api service providers are required to validate the EOAuth Cookie Session with cached user information within their logic | 44 | 45 | In addition to the `user_keys` will be added a `X-OAUTH-TOKEN` header with the access token of the provider. 46 | 47 | NOTES: 48 | Ping Federate requires you to authorize a callback URL, all proxies have a standard call back route of: 49 | https://api-gateway.company.com/your/proxy/path/oauth2/callback 50 | 51 | ## Supported Kong Releases 52 | Kong >= 3.0 53 | 54 | ## Installation 55 | Recommended: 56 | ``` 57 | $ luarocks install kong-oidc-auth 58 | ``` 59 | Other: 60 | ``` 61 | $ git clone https://github.com/Optum/kong-oidc-auth.git /path/to/kong/plugins/kong-oidc-auth 62 | $ cd /path/to/kong/plugins/kong-oidc-auth 63 | $ luarocks make *.rockspec 64 | ``` 65 | 66 | ## Maintainers 67 | [jeremyjpj0916](https://github.com/jeremyjpj0916) 68 | [rsbrisci](https://github.com/rsbrisci) 69 | 70 | Feel free to open issues, or refer to our [Contribution Guidelines](https://github.com/Optum/kong-oidc-auth/blob/master/CONTRIBUTING.md) if you have any questions. 71 | -------------------------------------------------------------------------------- /kong-oidc-auth-0.3-0.rockspec: -------------------------------------------------------------------------------- 1 | package = "kong-oidc-auth" 2 | version = "0.3-0" 3 | source = { 4 | url = "git+https://github.com/Optum/kong-oidc-auth.git" 5 | } 6 | description = { 7 | summary = "OpenID Connect authentication with Kong gateway", 8 | detailed = [[Please refer to the documentation associated here: https://github.com/Optum/kong-oidc-auth ]], 9 | homepage = "https://github.com/Optum/kong-oidc-auth", 10 | license = "Apache 2.0" 11 | } 12 | dependencies = { 13 | "luaossl == 20220711-0", 14 | } 15 | build = { 16 | type = "builtin", 17 | modules = { 18 | ["kong.plugins.kong-oidc-auth.access"] = "src/access.lua", 19 | ["kong.plugins.kong-oidc-auth.handler"] = "src/handler.lua", 20 | ["kong.plugins.kong-oidc-auth.schema"]= "src/schema.lua" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /kong-oidc-auth-0.3-0.src.rock: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Optum/kong-oidc-auth/3c09ed8991b4bb1f0831fbfc41e4d21ff9cd20fd/kong-oidc-auth-0.3-0.src.rock -------------------------------------------------------------------------------- /src/access.lua: -------------------------------------------------------------------------------- 1 | local _M = {} 2 | local cjson = require "cjson.safe" 3 | local pl_stringx = require "pl.stringx" 4 | local http = require "resty.http" 5 | local str = require "resty.string" 6 | local openssl_digest = require "openssl.digest" 7 | local cipher = require "openssl.cipher" 8 | local aes = cipher.new("AES-128-CBC") 9 | local oidc_error = nil 10 | local salt = nil --16 char alphanumeric 11 | local cookieDomain = nil 12 | local kong = kong 13 | 14 | local function getUserInfo(access_token, callback_url, conf) 15 | local httpc = http:new() 16 | local res, err = httpc:request_uri(conf.user_url, { 17 | method = "GET", 18 | ssl_verify = false, 19 | headers = { 20 | ["Authorization"] = "Bearer " .. access_token, 21 | } 22 | }) 23 | 24 | -- redirect to auth if user result is invalid not 200 25 | if res.status ~= 200 then 26 | return redirect_to_auth(conf, callback_url) 27 | end 28 | 29 | local userJson = cjson.decode(res.body) 30 | return userJson 31 | end 32 | 33 | local function getKongKey(eoauth_token, access_token, callback_url, conf) 34 | -- This will add a 28800 second (8 hour) expiring TTL on this cached value 35 | -- https://github.com/thibaultcha/lua-resty-mlcache/blob/master/README.md 36 | local userInfo, err = kong.cache:get(eoauth_token, { ttl = 28800 }, getUserInfo, access_token, callback_url, conf) 37 | 38 | if err then 39 | ngx.log(ngx.ERR, "Could not retrieve UserInfo: ", err) 40 | return 41 | end 42 | 43 | return userInfo 44 | end 45 | 46 | function redirect_to_auth( conf, callback_url ) 47 | -- Track the endpoint they wanted access to so we can transparently redirect them back 48 | if type(ngx.header["Set-Cookie"]) == "table" then 49 | ngx.header["Set-Cookie"] = { "EOAuthRedirectBack=" .. ngx.var.request_uri .. ";Path=/;Expires=" .. ngx.cookie_time(ngx.time() + 120) .. ";Max-Age=120;HttpOnly", unpack(ngx.header["Set-Cookie"]) } 50 | else 51 | ngx.header["Set-Cookie"] = { "EOAuthRedirectBack=" .. ngx.var.request_uri .. ";Path=/;Expires=" .. ngx.cookie_time(ngx.time() + 120) .. ";Max-Age=120;HttpOnly", ngx.header["Set-Cookie"] } 52 | end 53 | 54 | -- Redirect to the /oauth endpoint 55 | local oauth_authorize = nil 56 | if(conf.pf_idp_adapter_id == "") then --Standard Auth URL(Something other than ping) 57 | oauth_authorize = conf.authorize_url .. "?response_type=code&client_id=" .. conf.client_id .. "&redirect_uri=" .. callback_url .. "&scope=" .. conf.scope 58 | else --Ping Federate Auth URL 59 | oauth_authorize = conf.authorize_url .. "?pfidpadapterid=" .. conf.pf_idp_adapter_id .. "&response_type=code&client_id=" .. conf.client_id .. "&redirect_uri=" .. callback_url .. "&scope=" .. conf.scope 60 | --oauth_authorize = conf.authorize_url .. "?pfidpadapterid=" .. conf.pf_idp_adapter_id .. "&response_type=code&client_id=" .. conf.client_id .. "&redirect_uri=" .. callback_url .. "&scope=" .. conf.scope .. "&prompt=none" 61 | end 62 | 63 | return ngx.redirect(oauth_authorize) 64 | end 65 | 66 | function encode_token(token, conf) 67 | return ngx.encode_base64(aes:encrypt(openssl_digest.new("md5"):final(conf.client_secret), salt, true):final(token)) 68 | end 69 | 70 | function decode_token(token, conf) 71 | local status, token = pcall(function () return aes:decrypt(openssl_digest.new("md5"):final(conf.client_secret), salt, true):final(ngx.decode_base64(token)) end) 72 | 73 | if status then 74 | return token 75 | else 76 | return nil 77 | end 78 | end 79 | 80 | -- Logout Handling 81 | function handle_logout(encrypted_token, conf) 82 | --Terminate the Cookie 83 | if type(ngx.header["Set-Cookie"]) == "table" then 84 | ngx.header["Set-Cookie"] = { "EOAuthToken=;Path=/;Expires=Thu, Jan 01 1970 00:00:00 UTC;Max-Age=0;HttpOnly" .. cookieDomain, unpack(ngx.header["Set-Cookie"]) } 85 | else 86 | ngx.header["Set-Cookie"] = { "EOAuthToken=;Path=/;Expires=Thu, Jan 01 1970 00:00:00 UTC;Max-Age=0;HttpOnly" .. cookieDomain, ngx.header["Set-Cookie"] } 87 | end 88 | 89 | if conf.user_info_cache_enabled then 90 | kong.cache:invalidate(encrypted_token) 91 | end 92 | 93 | return kong.response.exit(200) 94 | end 95 | 96 | -- Callback Handling 97 | function handle_callback( conf, callback_url ) 98 | local args = ngx.req.get_uri_args() 99 | local code = args.code 100 | local redirect_url 101 | 102 | if args.redirect_url == nil then 103 | redirect_url = callback_url 104 | else 105 | redirect_url = args.redirect_url 106 | end 107 | 108 | if code then 109 | local httpc = http:new() 110 | local res, err = httpc:request_uri(conf.token_url, { 111 | method = "POST", 112 | ssl_verify = false, 113 | body = "grant_type=authorization_code&client_id=" .. conf.client_id .. "&client_secret=" .. conf.client_secret .. "&code=" .. code .. "&redirect_uri=" .. redirect_url, 114 | headers = { 115 | ["Content-Type"] = "application/x-www-form-urlencoded", 116 | } 117 | }) 118 | 119 | if not res then 120 | oidc_error = {status = ngx.HTTP_INTERNAL_SERVER_ERROR, message = "Failed to request: " .. err} 121 | return kong.response.exit(oidc_error.status, { message = oidc_error.message }) 122 | end 123 | 124 | local json = cjson.decode(res.body) 125 | local access_token = json.access_token 126 | if not access_token then 127 | oidc_error = {status = ngx.HTTP_BAD_REQUEST, message = json.error_description} 128 | return kong.response.exit(oidc_error.status, { message = oidc_error.message }) 129 | end 130 | 131 | if type(ngx.header["Set-Cookie"]) == "table" then 132 | ngx.header["Set-Cookie"] = { "EOAuthToken=" .. encode_token(access_token, conf) .. ";Path=/;Expires=" .. ngx.cookie_time(ngx.time() + 1800) .. ";Max-Age=1800;HttpOnly" .. cookieDomain, unpack(ngx.header["Set-Cookie"]) } 133 | else 134 | ngx.header["Set-Cookie"] = { "EOAuthToken=" .. encode_token(access_token, conf) .. ";Path=/;Expires=" .. ngx.cookie_time(ngx.time() + 1800) .. ";Max-Age=1800;HttpOnly" .. cookieDomain, ngx.header["Set-Cookie"] } 135 | end 136 | 137 | --Support redirection back to Application Loggedin Dashboard for subsequent transactions 138 | if conf.app_login_redirect_url ~= "" then 139 | return ngx.redirect(conf.app_login_redirect_url) 140 | end 141 | 142 | -- Support redirection back to Kong if necessary 143 | local redirect_back = ngx.var.cookie_EOAuthRedirectBack 144 | 145 | if redirect_back then 146 | return ngx.redirect(redirect_back) --Should always land here if no custom Loggedin page defined! 147 | else 148 | --return redirect_to_auth(conf, callback_url) 149 | return 150 | end 151 | else 152 | oidc_error = {status = ngx.HTTP_UNAUTHORIZED, message = "User has denied access to the resources"} 153 | return kong.response.exit(oidc_error.status, { message = oidc_error.message }) 154 | end 155 | end 156 | 157 | function _M.run(conf) 158 | local path_prefix = "" 159 | local callback_url = "" 160 | cookieDomain = ";Domain=" .. conf.cookie_domain 161 | salt = conf.salt 162 | 163 | --Fix for /api/team/POC/oidc/v1/service/oauth2/callback?code=******* 164 | if ngx.var.request_uri:find('?') then 165 | path_prefix = ngx.var.request_uri:sub(1, ngx.var.request_uri:find('?') -1) 166 | else 167 | path_prefix = ngx.var.request_uri 168 | end 169 | 170 | if pl_stringx.endswith(path_prefix, "/") then 171 | path_prefix = path_prefix:sub(1, path_prefix:len() - 1) 172 | callback_url = ngx.var.scheme .. "://" .. ngx.var.host .. path_prefix .. "/oauth2/callback" 173 | elseif pl_stringx.endswith(path_prefix, "/oauth2/callback") then --We are in the callback of our proxy 174 | callback_url = ngx.var.scheme .. "://" .. ngx.var.host .. path_prefix 175 | handle_callback(conf, callback_url) 176 | else 177 | callback_url = ngx.var.scheme .. "://" .. ngx.var.host .. path_prefix .. "/oauth2/callback" 178 | end 179 | 180 | local encrypted_token = ngx.var.cookie_EOAuthToken 181 | 182 | -- check if we are authenticated already 183 | if encrypted_token then 184 | local access_token = decode_token(encrypted_token, conf) 185 | if not access_token then 186 | -- broken access token 187 | return redirect_to_auth( conf, callback_url ) 188 | end 189 | 190 | --They had a valid EOAuthToken so its safe to process a proper logout now. 191 | if pl_stringx.endswith(path_prefix, "/logout") then 192 | return handle_logout(encrypted_token, conf) 193 | end 194 | 195 | --Update the Cookie to increase longevity for 30 more minutes if active proxying 196 | if type(ngx.header["Set-Cookie"]) == "table" then 197 | ngx.header["Set-Cookie"] = { "EOAuthToken=" .. encode_token(access_token, conf) .. ";Path=/;Expires=" .. ngx.cookie_time(ngx.time() + 1800) .. ";Max-Age=1800;HttpOnly" .. cookieDomain, unpack(ngx.header["Set-Cookie"]) } 198 | else 199 | ngx.header["Set-Cookie"] = { "EOAuthToken=" .. encode_token(access_token, conf) .. ";Path=/;Expires=" .. ngx.cookie_time(ngx.time() + 1800) .. ";Max-Age=1800;HttpOnly" .. cookieDomain, ngx.header["Set-Cookie"] } 200 | end 201 | 202 | --CACHE LOGIC - Check boolean and then if EOAUTH has existing key -> userInfo value 203 | if conf.user_info_cache_enabled then 204 | local userInfo = getKongKey(encrypted_token, access_token, callback_url, conf) 205 | if userInfo then 206 | for i, key in ipairs(conf.user_keys) do 207 | ngx.header["X-Oauth-".. key] = userInfo[key] 208 | ngx.req.set_header("X-Oauth-".. key, userInfo[key]) 209 | end 210 | ngx.header["X-Oauth-Token"] = access_token 211 | return 212 | end 213 | end 214 | -- END OF NEW CACHE LOGIC -- 215 | 216 | -- Get user info 217 | if not ngx.var.cookie_EOAuthUserInfo then 218 | local json = getUserInfo(access_token, callback_url, conf) 219 | 220 | if json then 221 | if conf.hosted_domain ~= "" and conf.email_key ~= "" then 222 | if not pl_stringx.endswith(json[conf.email_key], conf.hosted_domain) then 223 | oidc_error = {status = ngx.HTTP_UNAUTHORIZED, message = "Hosted domain is not matching"} 224 | return kong.response.exit(oidc_error.status, { message = oidc_error.message }) 225 | end 226 | end 227 | 228 | for i, key in ipairs(conf.user_keys) do 229 | ngx.header["X-Oauth-".. key] = json[key] 230 | ngx.req.set_header("X-Oauth-".. key, json[key]) 231 | end 232 | ngx.header["X-Oauth-Token"] = access_token 233 | 234 | if type(ngx.header["Set-Cookie"]) == "table" then 235 | ngx.header["Set-Cookie"] = { "EOAuthUserInfo=0;Path=/;Expires=" .. ngx.cookie_time(ngx.time() + conf.user_info_periodic_check) .. ";Max-Age=" .. conf.user_info_periodic_check .. ";HttpOnly", unpack(ngx.header["Set-Cookie"]) } 236 | else 237 | ngx.header["Set-Cookie"] = { "EOAuthUserInfo=0;Path=/;Expires=" .. ngx.cookie_time(ngx.time() + conf.user_info_periodic_check) .. ";Max-Age=" .. conf.user_info_periodic_check .. ";HttpOnly", ngx.header["Set-Cookie"] } 238 | end 239 | 240 | else 241 | return kong.response.exit(500, { message = err }) 242 | end 243 | end 244 | 245 | else 246 | return redirect_to_auth(conf, callback_url) 247 | end 248 | end 249 | 250 | return _M 251 | -------------------------------------------------------------------------------- /src/handler.lua: -------------------------------------------------------------------------------- 1 | local access = require "kong.plugins.kong-oidc-auth.access" 2 | 3 | local KongOidcAuth = {} 4 | 5 | function KongOidcAuth:access(conf) 6 | access.run(conf) 7 | end 8 | 9 | return KongOidcAuth 10 | -------------------------------------------------------------------------------- /src/schema.lua: -------------------------------------------------------------------------------- 1 | local typedefs = require "kong.db.schema.typedefs" 2 | local url = require "socket.url" 3 | 4 | --Added a app_login_redirect_url for Single Page Apps that need redirection to their dashboard after auth prior to transacting against backend API services 5 | --Added a new pf_idp_adapter_id tag as optional since we uses ping federate for OIDC 6 | --Added a cookie_domain for valid domain the cookie can be used across 7 | 8 | local function validate_url(value) 9 | local parsed_url = url.parse(value) 10 | if parsed_url.scheme and parsed_url.host then 11 | parsed_url.scheme = parsed_url.scheme:lower() 12 | if not (parsed_url.scheme == "http" or parsed_url.scheme == "https") then 13 | return false, "Supported protocols are HTTP and HTTPS" 14 | end 15 | end 16 | 17 | return true 18 | end 19 | 20 | return { 21 | name = "kong-oidc-auth", 22 | fields = { 23 | { protocols = typedefs.protocols_http }, 24 | { config = { 25 | type = "record", 26 | fields = { 27 | { authorize_url = { type = "string", required = true, custom_validator = validate_url }, }, 28 | { app_login_redirect_url = { type = "string", required = false }, }, 29 | { token_url = { type = "string", required = true, custom_validator = validate_url }, }, 30 | { user_url = {type = "string", required = true, custom_validator = validate_url}, }, 31 | { client_secret = { type = "string", required = true}, }, 32 | { scope = { type = "string" }, }, 33 | { salt = { type = "string", required = true, default = "b3253141ce67204b"}, }, 34 | { pf_idp_adapter_id = { type = "string" }, }, 35 | { user_keys = { type = "array", default = {"username", "email"}}, }, 36 | { cookie_domain = { type = "string", default = ".company.com"}, }, 37 | { user_info_periodic_check = { type = "number", required = true, default = 60}, }, 38 | { hosted_domain = { type = "string" }, }, 39 | { email_key = { type = "string" }, }, 40 | { user_info_cache_enabled = { type = "boolean", default = false}, }, 41 | }, }, }, 42 | }, 43 | } 44 | --------------------------------------------------------------------------------