AlinsRan commented on code in PR #13344: URL: https://github.com/apache/apisix/pull/13344#discussion_r3215974676
########## apisix/plugins/oas-validator.lua: ########## @@ -0,0 +1,298 @@ +-- +-- 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 secret = require("apisix.secret") +local plugin = require("apisix.plugin") +local ov = require("resty.openapi_validator") +local http = require("resty.http") +local ngx_req = ngx.req +local ngx_md5 = ngx.md5 +local pairs = pairs +local ipairs = ipairs +local tostring = tostring +local tab_sort = table.sort +local tab_concat = table.concat + +local plugin_name = "oas-validator" + +local DEFAULT_SPEC_URL_TTL = 3600 + +local schema = { + type = "object", + properties = { + spec = { + description = "schema against which the request/response will be validated", + type = "string", + minLength = 1 + }, + spec_url = { + description = "URL to fetch the OpenAPI spec from", + type = "string", + pattern = [[^https?://]], + }, + spec_url_request_headers = { + description = "custom HTTP headers to include when fetching spec_url", + type = "object", + additionalProperties = { + type = "string", + }, + }, + ssl_verify = { + description = "whether to verify SSL certificate when fetching spec_url", + type = "boolean", + default = false, + }, + timeout = { + description = "HTTP request timeout in milliseconds for fetching spec_url", + type = "integer", + minimum = 1000, + maximum = 60000, + default = 10000, + }, + verbose_errors = { + type = "boolean", + default = false + }, + skip_request_body_validation = { + type = "boolean", + default = false + }, + skip_request_header_validation = { + type = "boolean", + default = false + }, + skip_query_param_validation = { + type = "boolean", + default = false + }, + skip_path_params_validation = { + type = "boolean", + default = false + }, + reject_if_not_match = { + type = "boolean", + default = true + }, + rejection_status_code = { + description = "HTTP status code to return when request validation fails", + type = "integer", + minimum = 400, + maximum = 599, + default = 400 + } + }, + oneOf = { + {required = {"spec"}}, + {required = {"spec_url"}}, + }, +} + +local metadata_schema = { + type = "object", + properties = { + spec_url_ttl = { + description = "TTL in seconds for cached spec fetched from spec_url", + type = "integer", + minimum = 1, + default = DEFAULT_SPEC_URL_TTL, + }, + }, +} + +local spec_url_lrucache +local spec_url_lrucache_ttl + +local function get_spec_url_ttl() + local metadata = plugin.plugin_metadata(plugin_name) + if metadata and metadata.value and metadata.value.spec_url_ttl then + return metadata.value.spec_url_ttl + end + return DEFAULT_SPEC_URL_TTL +end + +local function get_spec_url_lrucache() + local ttl = get_spec_url_ttl() + if not spec_url_lrucache or spec_url_lrucache_ttl ~= ttl then + spec_url_lrucache = core.lrucache.new({ + ttl = ttl, + count = 512, + invalid_stale = true, + refresh_stale = true, + serial_creating = true, + }) + spec_url_lrucache_ttl = ttl + end + return spec_url_lrucache +end + +local function fetch_and_compile(conf) + local httpc = http.new() + httpc:set_timeout(conf.timeout or 10000) + + local params = { + method = "GET", + ssl_verify = conf.ssl_verify or false, + } + if conf.spec_url_request_headers then + params.headers = conf.spec_url_request_headers + end + + local res, err = httpc:request_uri(conf.spec_url, params) + if not res then + return nil, "failed to fetch spec from URL: " .. err + end + + if res.status ~= 200 then + return nil, "spec URL returned status " .. res.status + end + + local validator, err = ov.compile(res.body) + if not validator then + return nil, "failed to compile openapi spec fetched from URL: " .. err + end + + return validator +end + +local _M = { + version = 0.1, + priority = 512, + 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 not ok then + return false, err + end + + if conf.spec and not secret.is_secret_ref(conf.spec) then + local _, decode_err = core.json.decode(conf.spec) + if decode_err then + return false, "invalid JSON string provided, err: " .. decode_err + end + end + + return true +end + + +local function get_validator(conf) + if conf.spec then + if not conf._validator then Review Comment: Replace with`conf._meta`. We don't need an extra lrucache here. Storing the data directly in `conf` already acts as caching, and its lifecycle is naturally bound to the `conf` object. -- 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]
