| # |
| # Licensed to the Apache Software Foundation (ASF) under one or more |
| # contributor license agreements. See the NOTICE file distributed with |
| # this work for additional information regarding copyright ownership. |
| # The ASF licenses this file to You under the Apache License, Version 2.0 |
| # (the "License"); you may not use this file except in compliance with |
| # the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| # |
| use t::APISIX 'no_plan'; |
| |
| log_level('debug'); |
| repeat_each(1); |
| no_long_string(); |
| no_root_location(); |
| # no_shuffle(); |
| |
| add_block_preprocessor(sub { |
| my ($block) = @_; |
| |
| if ((!defined $block->error_log) && (!defined $block->no_error_log)) { |
| $block->set_value("no_error_log", "[error]"); |
| } |
| |
| if (!defined $block->request) { |
| $block->set_value("request", "GET /t"); |
| } |
| }); |
| |
| run_tests(); |
| |
| __DATA__ |
| |
| === TEST 1: Set up new route with wrong valid_issuers |
| --- config |
| location /t { |
| content_by_lua_block { |
| local t = require("lib.test_admin").test |
| local code, body = t('/apisix/admin/routes/1', |
| ngx.HTTP_PUT, |
| [[{ |
| "plugins": { |
| "openid-connect": { |
| "client_id": "dummy", |
| "client_secret": "dummy", |
| "discovery": "http://127.0.0.1:8080/realms/University/.well-known/openid-configuration", |
| "ssl_verify": true, |
| "timeout": 10, |
| "bearer_only": true, |
| "use_jwks": true, |
| "claim_validator": { |
| "issuer": { |
| "valid_issuers": 123 |
| } |
| } |
| } |
| }, |
| "upstream": { |
| "nodes": { |
| "127.0.0.1:1980": 1 |
| }, |
| "type": "roundrobin" |
| }, |
| "uri": "/*" |
| }]] |
| ) |
| |
| if code >= 300 then |
| ngx.status = code |
| end |
| ngx.say(body) |
| } |
| } |
| --- error_code: 400 |
| --- response_body eval |
| qr/\{"error_msg":"failed to check the configuration of plugin openid-connect err: property \\"claim_validator\\" validation failed.*"\}/ |
| |
| |
| |
| === TEST 2: Set up new route with valid valid_issuers |
| --- config |
| location /t { |
| content_by_lua_block { |
| local t = require("lib.test_admin").test |
| local code, body = t('/apisix/admin/routes/1', |
| ngx.HTTP_PUT, |
| [[{ |
| "plugins": { |
| "openid-connect": { |
| "client_id": "dummy", |
| "client_secret": "dummy", |
| "discovery": "http://127.0.0.1:8080/realms/University/.well-known/openid-configuration", |
| "ssl_verify": true, |
| "timeout": 10, |
| "bearer_only": true, |
| "use_jwks": true, |
| "claim_validator": { |
| "issuer": { |
| "valid_issuers": ["https://securetoken.google.com/test-firebase-project"] |
| } |
| } |
| } |
| }, |
| "upstream": { |
| "nodes": { |
| "127.0.0.1:1980": 1 |
| }, |
| "type": "roundrobin" |
| }, |
| "uri": "/*" |
| }]] |
| ) |
| |
| if code >= 300 then |
| ngx.status = code |
| end |
| ngx.say(body) |
| } |
| } |
| --- response_body |
| passed |
| |
| |
| |
| === TEST 3: Update plugin with ID provider jwks endpoint for token verification with invalid issuer. |
| --- config |
| location /t { |
| content_by_lua_block { |
| local t = require("lib.test_admin").test |
| local code, body = t('/apisix/admin/routes/1', |
| ngx.HTTP_PUT, |
| [[{ |
| "plugins": { |
| "openid-connect": { |
| "client_id": "not required", |
| "client_secret": "not required", |
| "discovery": "http://127.0.0.1:8080/realms/University/.well-known/openid-configuration", |
| "redirect_uri": "http://localhost:3000", |
| "ssl_verify": false, |
| "timeout": 10, |
| "bearer_only": true, |
| "use_jwks": true, |
| "realm": "University", |
| "claim_validator": { |
| "issuer": { |
| "valid_issuers": ["https://securetoken.google.com/test-firebase-project"] |
| } |
| } |
| } |
| }, |
| "upstream": { |
| "nodes": { |
| "127.0.0.1:1980": 1 |
| }, |
| "type": "roundrobin" |
| }, |
| "uri": "/hello" |
| }]] |
| ) |
| |
| if code >= 300 then |
| ngx.status = code |
| end |
| ngx.say(body) |
| } |
| } |
| --- response_body |
| passed |
| |
| |
| |
| === TEST 4: verification fails because issuer not in valid_issuer |
| --- config |
| location /t { |
| content_by_lua_block { |
| -- Obtain valid access token from Keycloak using known username and password. |
| local json_decode = require("toolkit.json").decode |
| local http = require "resty.http" |
| local httpc = http.new() |
| local uri = "http://127.0.0.1:8080/realms/University/protocol/openid-connect/token" |
| local res, err = httpc:request_uri(uri, { |
| method = "POST", |
| body = "grant_type=password&client_id=course_management&client_secret=d1ec69e9-55d2-4109-a3ea-befa071579d5&username=teacher@gmail.com&password=123456", |
| headers = { |
| ["Content-Type"] = "application/x-www-form-urlencoded" |
| } |
| }) |
| |
| -- Check response from keycloak and fail quickly if there's no response. |
| if not res then |
| ngx.say(err) |
| return |
| end |
| |
| -- Check if response code was ok. |
| if res.status == 200 then |
| -- Get access token from JSON response body. |
| local body = json_decode(res.body) |
| local accessToken = body["access_token"] |
| |
| -- Access route using access token. Should work. |
| uri = "http://127.0.0.1:" .. ngx.var.server_port .. "/hello" |
| local res, err = httpc:request_uri(uri, { |
| method = "GET", |
| headers = { |
| ["Authorization"] = "Bearer " .. body["access_token"] |
| } |
| }) |
| |
| if res.status == 200 then |
| -- Route accessed successfully. |
| ngx.say(true) |
| else |
| -- Couldn't access route. |
| ngx.say(false) |
| end |
| else |
| -- Response from Keycloak not ok. |
| ngx.say(false) |
| end |
| } |
| } |
| --- response_body |
| false |
| --- error_log |
| OIDC introspection failed: jwt signature verification failed: Claim 'iss' ('http://127.0.0.1:8080/realms/University') returned failure |
| |
| |
| |
| === TEST 5: Update plugin with ID provider jwks endpoint for token verification with valid issuer. |
| --- config |
| location /t { |
| content_by_lua_block { |
| local t = require("lib.test_admin").test |
| local code, body = t('/apisix/admin/routes/1', |
| ngx.HTTP_PUT, |
| [[{ |
| "plugins": { |
| "openid-connect": { |
| "client_id": "dummy", |
| "client_secret": "dummy", |
| "discovery": "http://127.0.0.1:8080/realms/University/.well-known/openid-configuration", |
| "redirect_uri": "http://localhost:3000", |
| "ssl_verify": false, |
| "timeout": 10, |
| "bearer_only": true, |
| "use_jwks": true, |
| "realm": "University", |
| "claim_validator": { |
| "issuer": { |
| "valid_issuers": ["http://127.0.0.1:8080/realms/University"] |
| } |
| } |
| } |
| }, |
| "upstream": { |
| "nodes": { |
| "127.0.0.1:1980": 1 |
| }, |
| "type": "roundrobin" |
| }, |
| "uri": "/hello" |
| }]] |
| ) |
| |
| if code >= 300 then |
| ngx.status = code |
| end |
| ngx.say(body) |
| } |
| } |
| --- response_body |
| passed |
| |
| |
| |
| === TEST 6: Obtain valid token and access route with it. |
| --- config |
| location /t { |
| content_by_lua_block { |
| -- Obtain valid access token from Keycloak using known username and password. |
| local json_decode = require("toolkit.json").decode |
| local http = require "resty.http" |
| local httpc = http.new() |
| local uri = "http://127.0.0.1:8080/realms/University/protocol/openid-connect/token" |
| local res, err = httpc:request_uri(uri, { |
| method = "POST", |
| body = "grant_type=password&client_id=course_management&client_secret=d1ec69e9-55d2-4109-a3ea-befa071579d5&username=teacher@gmail.com&password=123456", |
| headers = { |
| ["Content-Type"] = "application/x-www-form-urlencoded" |
| } |
| }) |
| |
| -- Check response from keycloak and fail quickly if there's no response. |
| if not res then |
| ngx.say(err) |
| return |
| end |
| |
| -- Check if response code was ok. |
| if res.status == 200 then |
| -- Get access token from JSON response body. |
| local body = json_decode(res.body) |
| local accessToken = body["access_token"] |
| |
| -- Access route using access token. Should work. |
| uri = "http://127.0.0.1:" .. ngx.var.server_port .. "/hello" |
| local res, err = httpc:request_uri(uri, { |
| method = "GET", |
| headers = { |
| ["Authorization"] = "Bearer " .. body["access_token"] |
| } |
| }) |
| |
| if res.status == 200 then |
| -- Route accessed successfully. |
| ngx.say(true) |
| else |
| -- Couldn't access route. |
| ngx.say(false) |
| end |
| else |
| -- Response from Keycloak not ok. |
| ngx.say(false) |
| end |
| } |
| } |
| --- response_body |
| true |
| --- grep_error_log eval |
| qr/token validate successfully by \w+/ |
| --- grep_error_log_out |
| token validate successfully by jwks |
| |
| |
| |
| === TEST 7: Update plugin with ID provider jwks endpoint for token verification with valid issuer in discovery endpoint. |
| --- config |
| location /t { |
| content_by_lua_block { |
| local t = require("lib.test_admin").test |
| local code, body = t('/apisix/admin/routes/1', |
| ngx.HTTP_PUT, |
| [[{ |
| "plugins": { |
| "openid-connect": { |
| "client_id": "dummy", |
| "client_secret": "dummy", |
| "discovery": "http://127.0.0.1:8080/realms/University/.well-known/openid-configuration", |
| "redirect_uri": "http://localhost:3000", |
| "ssl_verify": false, |
| "timeout": 10, |
| "bearer_only": true, |
| "use_jwks": true, |
| "realm": "University" |
| } |
| }, |
| "upstream": { |
| "nodes": { |
| "127.0.0.1:1980": 1 |
| }, |
| "type": "roundrobin" |
| }, |
| "uri": "/hello" |
| }]] |
| ) |
| |
| if code >= 300 then |
| ngx.status = code |
| end |
| ngx.say(body) |
| } |
| } |
| --- response_body |
| passed |
| |
| |
| |
| === TEST 8: Obtain valid token and access route with it. Use valid_issuer from discovery endpoint. |
| --- config |
| location /t { |
| content_by_lua_block { |
| -- Obtain valid access token from Keycloak using known username and password. |
| local json_decode = require("toolkit.json").decode |
| local http = require "resty.http" |
| local httpc = http.new() |
| local uri = "http://127.0.0.1:8080/realms/University/protocol/openid-connect/token" |
| local res, err = httpc:request_uri(uri, { |
| method = "POST", |
| body = "grant_type=password&client_id=course_management&client_secret=d1ec69e9-55d2-4109-a3ea-befa071579d5&username=teacher@gmail.com&password=123456", |
| headers = { |
| ["Content-Type"] = "application/x-www-form-urlencoded" |
| } |
| }) |
| |
| -- Check response from keycloak and fail quickly if there's no response. |
| if not res then |
| ngx.say(err) |
| return |
| end |
| |
| -- Check if response code was ok. |
| if res.status == 200 then |
| -- Get access token from JSON response body. |
| local body = json_decode(res.body) |
| local accessToken = body["access_token"] |
| |
| -- Access route using access token. Should work. |
| uri = "http://127.0.0.1:" .. ngx.var.server_port .. "/hello" |
| local res, err = httpc:request_uri(uri, { |
| method = "GET", |
| headers = { |
| ["Authorization"] = "Bearer " .. body["access_token"] |
| } |
| }) |
| |
| if res.status == 200 then |
| -- Route accessed successfully. |
| ngx.say(true) |
| else |
| -- Couldn't access route. |
| ngx.say(false) |
| end |
| else |
| -- Response from Keycloak not ok. |
| ngx.say(false) |
| end |
| } |
| } |
| --- response_body |
| true |
| --- grep_error_log eval |
| qr/token validate successfully by \w+/ |
| --- grep_error_log_out |
| token validate successfully by jwks |
| --- error_log |
| valid_issuers not provided explicitly, using issuer from discovery doc: http://127.0.0.1:8080/realms/University |
