spacewander commented on a change in pull request #3894: URL: https://github.com/apache/apisix/pull/3894#discussion_r600106994
########## File path: apisix/plugins/ldap-auth.lua ########## @@ -0,0 +1,171 @@ +-- +-- 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 core = require("apisix.core") +local ngx = ngx +local ngx_re = require("ngx.re") +local ipairs = ipairs +local consumer_mod = require("apisix.consumer") +local lualdap = require "lualdap" + +local lrucache = core.lrucache.new({ + ttl = 300, count = 512 +}) +local consumers_lrucache = core.lrucache.new({ + type = "plugin", +}) + +local schema = { + type = "object", + title = "work with route or service object", + properties = { + basedn = { type = "string" }, + ldapuri = { type = "string" }, + usetls = { type = "boolean" }, + uid = { type = "string" }, + auto_create_consumer = {type ="boolean"} + }, + required = {"basedn","ldapuri"}, + additionalProperties = true, +} + +local consumer_schema = { + type = "object", + title = "work with consumer object", + properties = { + userdn = { type = "string" }, + }, + required = {"userdn"}, + additionalProperties = false, +} + +local plugin_name = "ldap-auth" + +local _M = { + version = 0.1, + priority = 2520, + type = 'auth', + name = plugin_name, + schema = schema, + consumer_schema = consumer_schema +} + +function _M.check_schema(conf, schema_type) + local ok, err + if schema_type == core.schema.TYPE_CONSUMER then + ok, err = core.schema.check(consumer_schema, conf) + else + ok, err = core.schema.check(schema, conf) + end + + if not ok then Review comment: return `ok, err` is enough. ########## File path: docs/en/latest/plugins/ldap-auth.md ########## @@ -0,0 +1,152 @@ +--- +title: ldap-auth +--- + +<!-- +# +# 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. +# +--> + +## Summary + +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) + +## Name + +`ldap-auth` is an authentication plugin that can works with `consumer`. Add Ldap Authentication to a `service` or `route`. + +The `consumer` then authenticate against the Ldap server using Basic authentication. Review comment: "authenticates"? ########## File path: docs/en/latest/plugins/ldap-auth.md ########## @@ -0,0 +1,152 @@ +--- +title: ldap-auth +--- + +<!-- +# +# 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. +# +--> + +## Summary + +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) + +## Name + +`ldap-auth` is an authentication plugin that can works with `consumer`. Add Ldap Authentication to a `service` or `route`. + +The `consumer` then authenticate against the Ldap server using Basic authentication. + +For more information on Basic authentication, refer to [Wiki](https://en.wikipedia.org/wiki/Basic_access_authentication) for more information. + +This authentication plugin use [lualdap](https://lualdap.github.io/lualdap/) plugin to connect against the ldap server + +## Attributes + +| Name | Type | Requirement | Default | Valid | Description | +| -------- | ------ | ----------- | ------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| basedn | string | required | | | the base dn of the `ldap` server (example : `ou=users,dc=example,dc=org`) | +| ldapuri | string | required | | | the uri of the ldap server | +| usetls | boolean | optional | `true` | | Boolean flag indicating if Transport Layer Security (TLS) should be used. | +| uid | string | optional | `cn` | | the user's password | Review comment: Is it the password? ########## File path: apisix/plugins/ldap-auth.lua ########## @@ -0,0 +1,171 @@ +-- +-- 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 core = require("apisix.core") +local ngx = ngx +local ngx_re = require("ngx.re") +local ipairs = ipairs +local consumer_mod = require("apisix.consumer") +local lualdap = require "lualdap" + +local lrucache = core.lrucache.new({ + ttl = 300, count = 512 +}) +local consumers_lrucache = core.lrucache.new({ + type = "plugin", +}) + +local schema = { + type = "object", + title = "work with route or service object", + properties = { + basedn = { type = "string" }, + ldapuri = { type = "string" }, + usetls = { type = "boolean" }, Review comment: Would you use a snake case for the field name, like `base_dn` / `ldap_uri`? ########## File path: apisix/plugins/ldap-auth.lua ########## @@ -0,0 +1,171 @@ +-- +-- 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 core = require("apisix.core") +local ngx = ngx +local ngx_re = require("ngx.re") +local ipairs = ipairs +local consumer_mod = require("apisix.consumer") +local lualdap = require "lualdap" + +local lrucache = core.lrucache.new({ + ttl = 300, count = 512 +}) +local consumers_lrucache = core.lrucache.new({ + type = "plugin", +}) + +local schema = { + type = "object", + title = "work with route or service object", + properties = { + basedn = { type = "string" }, + ldapuri = { type = "string" }, + usetls = { type = "boolean" }, + uid = { type = "string" }, + auto_create_consumer = {type ="boolean"} + }, + required = {"basedn","ldapuri"}, + additionalProperties = true, +} + +local consumer_schema = { + type = "object", + title = "work with consumer object", + properties = { + userdn = { type = "string" }, + }, + required = {"userdn"}, + additionalProperties = false, +} + +local plugin_name = "ldap-auth" + +local _M = { + version = 0.1, + priority = 2520, + type = 'auth', + name = plugin_name, + schema = schema, + consumer_schema = consumer_schema +} + +function _M.check_schema(conf, schema_type) + local ok, err + if schema_type == core.schema.TYPE_CONSUMER then + ok, err = core.schema.check(consumer_schema, conf) + else + ok, err = core.schema.check(schema, conf) + end + + if not ok then + return false, err + end + + return true +end + +local create_consume_cache +do + local consumer_names = {} + + function create_consume_cache(consumers) + core.table.clear(consumer_names) + + for _, consumer in ipairs(consumers.nodes) do + core.log.info("consumer node: ", core.json.delay_encode(consumer)) + consumer_names[consumer.auth_conf.userdn] = consumer + end + + return consumer_names + end + +end -- do + +local function extract_auth_header(authorization) + local obj = { username = "", password = "" } + + local m, err = ngx.re.match(authorization, "Basic\\s(.+)", "jo") + if err then + -- error authorization + return nil, err + end + + local decoded = ngx.decode_base64(m[1]) + + local res + res, err = ngx_re.split(decoded, ":") + if err then + return nil, "split authorization err:" .. err + end + + obj.username = ngx.re.gsub(res[1], "\\s+", "", "jo") + obj.password = ngx.re.gsub(res[2], "\\s+", "", "jo") + + return obj, nil +end + +function _M.rewrite(conf, ctx) + core.log.info("plugin access phase, conf: ", core.json.delay_encode(conf)) + + -- 1. extract authorization from header + local auth_header = core.request.header(ctx, "Authorization") + if not auth_header then + core.response.set_header("WWW-Authenticate", "Basic realm='.'") + return 401, { message = "Missing authorization in request" } + end + + local user, err = extract_auth_header(auth_header) + if err then + return 401, { message = err } + end + + -- 2. try authenticate the user against the ldap server + local uid = "cn" + if conf.uid then + uid = conf.uid + end + local userdn = uid .. "=" .. user.username .. "," .. conf.basedn + local ld = lualdap.open_simple (conf.ldapuri, userdn, user.password, conf.usetls) + if not ld then + return 401, { message = "Invalid user authorization" } + end + + -- 3. Retreive consumer for authorization plugin + if conf.auto_create_consumer then Review comment: Better to avoid creating temporary consumers. The temporary consumer may be broken somewhere else. -- 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. For queries about this service, please contact Infrastructure at: [email protected]
