spacewander commented on a change in pull request #4710: URL: https://github.com/apache/apisix/pull/4710#discussion_r680822076
########## File path: apisix/plugins/authz-casbin.lua ########## @@ -0,0 +1,118 @@ +-- +-- 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. +-- + +local casbin = require("casbin") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ngx = ngx +local get_headers = ngx.req.get_headers +local lrucache = core.lrucache.new({ + ttl = 300, count = 32 +}) + +local plugin_name = "authz-casbin" + +local schema = { + type = "object", + properties = { + model_path = { type = "string" }, + policy_path = { type = "string" }, + username = { type = "string"} + }, + required = {"model_path", "policy_path", "username"}, + additionalProperties = false +} + +local metadata_schema = { + type = "object", + properties = { + model = {type = "string"}, + policy = {type = "string"}, + }, + required = {"model", "policy"}, + additionalProperties = false +} + +local _M = { + version = 0.1, + priority = 2560, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + +function _M.check_schema(conf, schema_type) + if schema_type == core.schema.TYPE_METADATA then + return core.schema.check(metadata_schema, conf) + end + local ok, err = core.schema.check(schema, conf) + if ok then + return true + else + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value and conf.username then + return true + end + end + return false, err +end + + +local function new_enforcer(conf, modifiedIndex) + local model_path = conf.model_path + local policy_path = conf.policy_path + + local e + + if model_path and policy_path then + e = casbin:new(model_path, policy_path) + conf.type = "file" + end + + local metadata = plugin.plugin_metadata(plugin_name) Review comment: IMHO, it surprises me that the enforcer from metadata can override the one from the route. Normally, the route level configuration can override the global one. ########## File path: apisix/plugins/authz-casbin.lua ########## @@ -0,0 +1,118 @@ +-- +-- 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. +-- + +local casbin = require("casbin") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ngx = ngx +local get_headers = ngx.req.get_headers +local lrucache = core.lrucache.new({ + ttl = 300, count = 32 +}) + +local plugin_name = "authz-casbin" + +local schema = { + type = "object", + properties = { + model_path = { type = "string" }, + policy_path = { type = "string" }, + username = { type = "string"} + }, + required = {"model_path", "policy_path", "username"}, + additionalProperties = false +} + +local metadata_schema = { + type = "object", + properties = { + model = {type = "string"}, + policy = {type = "string"}, + }, + required = {"model", "policy"}, + additionalProperties = false +} + +local _M = { + version = 0.1, + priority = 2560, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + +function _M.check_schema(conf, schema_type) + if schema_type == core.schema.TYPE_METADATA then + return core.schema.check(metadata_schema, conf) + end + local ok, err = core.schema.check(schema, conf) + if ok then + return true + else + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value and conf.username then + return true + end + end + return false, err +end + + +local function new_enforcer(conf, modifiedIndex) + local model_path = conf.model_path + local policy_path = conf.policy_path + + local e + + if model_path and policy_path then + e = casbin:new(model_path, policy_path) + conf.type = "file" + end + + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value.model and metadata.value.policy and not e then + local model = metadata.value.model + local policy = metadata.value.policy + e = casbin:newEnforcerFromText(model, policy) + conf.type = "metadata" Review comment: We don't need to bind the enforcer from metadata with the route configuration as it is global. Recreating the global enforcer when the request hits another route is not a good idea. ########## File path: apisix/plugins/authz-casbin.lua ########## @@ -0,0 +1,118 @@ +-- +-- 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. +-- + +local casbin = require("casbin") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ngx = ngx +local get_headers = ngx.req.get_headers +local lrucache = core.lrucache.new({ + ttl = 300, count = 32 +}) + +local plugin_name = "authz-casbin" + +local schema = { + type = "object", + properties = { + model_path = { type = "string" }, + policy_path = { type = "string" }, + username = { type = "string"} + }, + required = {"model_path", "policy_path", "username"}, + additionalProperties = false +} + +local metadata_schema = { + type = "object", + properties = { + model = {type = "string"}, + policy = {type = "string"}, + }, + required = {"model", "policy"}, + additionalProperties = false +} + +local _M = { + version = 0.1, + priority = 2560, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + +function _M.check_schema(conf, schema_type) + if schema_type == core.schema.TYPE_METADATA then + return core.schema.check(metadata_schema, conf) + end + local ok, err = core.schema.check(schema, conf) + if ok then + return true + else + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value and conf.username then + return true + end + end + return false, err +end + + +local function new_enforcer(conf, modifiedIndex) + local model_path = conf.model_path + local policy_path = conf.policy_path + + local e + + if model_path and policy_path then + e = casbin:new(model_path, policy_path) + conf.type = "file" + end + + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value.model and metadata.value.policy and not e then + local model = metadata.value.model + local policy = metadata.value.policy + e = casbin:newEnforcerFromText(model, policy) + conf.type = "metadata" + conf.modifiedIndex = modifiedIndex + end + + conf.casbin_enforcer = e +end + + +function _M.rewrite(conf) Review comment: ```suggestion function _M.rewrite(conf, ctx) ``` ########## File path: apisix/plugins/authz-casbin.lua ########## @@ -0,0 +1,118 @@ +-- +-- 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. +-- + +local casbin = require("casbin") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ngx = ngx +local get_headers = ngx.req.get_headers +local lrucache = core.lrucache.new({ + ttl = 300, count = 32 +}) + +local plugin_name = "authz-casbin" + +local schema = { + type = "object", + properties = { + model_path = { type = "string" }, + policy_path = { type = "string" }, + username = { type = "string"} + }, + required = {"model_path", "policy_path", "username"}, + additionalProperties = false +} + +local metadata_schema = { + type = "object", + properties = { + model = {type = "string"}, + policy = {type = "string"}, + }, + required = {"model", "policy"}, + additionalProperties = false +} + +local _M = { + version = 0.1, + priority = 2560, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + +function _M.check_schema(conf, schema_type) + if schema_type == core.schema.TYPE_METADATA then + return core.schema.check(metadata_schema, conf) + end + local ok, err = core.schema.check(schema, conf) + if ok then + return true + else + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value and conf.username then + return true + end + end + return false, err +end + + +local function new_enforcer(conf, modifiedIndex) + local model_path = conf.model_path + local policy_path = conf.policy_path + + local e + + if model_path and policy_path then + e = casbin:new(model_path, policy_path) + conf.type = "file" + end + + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value.model and metadata.value.policy and not e then + local model = metadata.value.model + local policy = metadata.value.policy + e = casbin:newEnforcerFromText(model, policy) + conf.type = "metadata" + conf.modifiedIndex = modifiedIndex + end + + conf.casbin_enforcer = e +end + + +function _M.rewrite(conf) + -- creates an enforcer when request sent for the first time + local metadata = plugin.plugin_metadata(plugin_name) + if (not conf.casbin_enforcer) or + (conf.type == "metadata" and conf.modifiedIndex ~= metadata.modifiedIndex) then + new_enforcer(conf, metadata.modifiedIndex) + end + + local path = ngx.var.request_uri Review comment: ```suggestion local path = ctx.var.uri ``` It is more suitable to use the normalized one? See http://nginx.org/en/docs/http/ngx_http_core_module.html#var_uri ########## File path: apisix/plugins/authz-casbin.lua ########## @@ -0,0 +1,118 @@ +-- +-- 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. +-- + +local casbin = require("casbin") +local core = require("apisix.core") +local plugin = require("apisix.plugin") +local ngx = ngx +local get_headers = ngx.req.get_headers +local lrucache = core.lrucache.new({ + ttl = 300, count = 32 +}) + +local plugin_name = "authz-casbin" + +local schema = { + type = "object", + properties = { + model_path = { type = "string" }, + policy_path = { type = "string" }, + username = { type = "string"} + }, + required = {"model_path", "policy_path", "username"}, + additionalProperties = false +} + +local metadata_schema = { + type = "object", + properties = { + model = {type = "string"}, + policy = {type = "string"}, + }, + required = {"model", "policy"}, + additionalProperties = false +} + +local _M = { + version = 0.1, + priority = 2560, + name = plugin_name, + schema = schema, + metadata_schema = metadata_schema +} + +function _M.check_schema(conf, schema_type) + if schema_type == core.schema.TYPE_METADATA then + return core.schema.check(metadata_schema, conf) + end + local ok, err = core.schema.check(schema, conf) + if ok then + return true + else + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value and conf.username then + return true + end + end + return false, err +end + + +local function new_enforcer(conf, modifiedIndex) + local model_path = conf.model_path + local policy_path = conf.policy_path + + local e + + if model_path and policy_path then + e = casbin:new(model_path, policy_path) + conf.type = "file" + end + + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value.model and metadata.value.policy and not e then + local model = metadata.value.model + local policy = metadata.value.policy + e = casbin:newEnforcerFromText(model, policy) + conf.type = "metadata" + conf.modifiedIndex = modifiedIndex + end + + conf.casbin_enforcer = e +end + + +function _M.rewrite(conf) + -- creates an enforcer when request sent for the first time + local metadata = plugin.plugin_metadata(plugin_name) + if (not conf.casbin_enforcer) or + (conf.type == "metadata" and conf.modifiedIndex ~= metadata.modifiedIndex) then + new_enforcer(conf, metadata.modifiedIndex) + end + + local path = ngx.var.request_uri + local method = ngx.var.request_method Review comment: ```suggestion local method = ctx.var.method ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
