Software / code / prosody
File
util/jsonschema.lua @ 13652:a08065207ef0
net.server_epoll: Call :shutdown() on TLS sockets when supported
Comment from Matthew:
This fixes a potential issue where the Prosody process gets blocked on sockets
waiting for them to close. Unlike non-TLS sockets, closing a TLS socket sends
layer 7 data, and this can cause problems for sockets which are in the process
of being cleaned up.
This depends on LuaSec changes which are not yet upstream.
From Martijn's original email:
So first my analysis of luasec. in ssl.c the socket is put into blocking
mode right before calling SSL_shutdown() inside meth_destroy(). My best
guess to why this is is because meth_destroy is linked to the __close
and __gc methods, which can't exactly be called multiple times and
luasec does want to make sure that a tls session is shutdown as clean
as possible.
I can't say I disagree with this reasoning and don't want to change this
behaviour. My solution to this without changing the current behaviour is
to introduce a shutdown() method. I am aware that this overlaps in a
conflicting way with tcp's shutdown method, but it stays close to the
OpenSSL name. This method calls SSL_shutdown() in the current
(non)blocking mode of the underlying socket and returns a boolean
whether or not the shutdown is completed (matching SSL_shutdown()'s 0
or 1 return values), and returns the familiar ssl_ioerror() strings on
error with a false for completion. This error can then be used to
determine if we have wantread/wantwrite to finalize things. Once
meth_shutdown() has been called once a shutdown flag will be set, which
indicates to meth_destroy() that the SSL_shutdown() has been handled
by the application and it shouldn't be needed to set the socket to
blocking mode. I've left the SSL_shutdown() call in the
LSEC_STATE_CONNECTED to prevent TOCTOU if the application reaches a
timeout for the shutdown code, which might allow SSL_shutdown() to
clean up anyway at the last possible moment.
Another thing I've changed to luasec is the call to socket_setblocking()
right before calling close(2) in socket_destroy() in usocket.c.
According to the latest POSIX[0]:
Note that the requirement for close() on a socket to block for up to
the current linger interval is not conditional on the O_NONBLOCK
setting.
Which I read to mean that removing O_NONBLOCK on the socket before close
doesn't impact the behaviour and only causes noise in system call
tracers. I didn't touch the windows bits of this, since I don't do
windows.
For the prosody side of things I've made the TLS shutdown bits resemble
interface:onwritable(), and put it under a combined guard of self._tls
and self.conn.shutdown. The self._tls bit is there to prevent getting
stuck on this condition, and self.conn.shutdown is there to prevent the
code being called by instances where the patched luasec isn't deployed.
The destroy() method can be called from various places and is read by
me as the "we give up" error path. To accommodate for these unexpected
entrypoints I've added a single call to self.conn:shutdown() to prevent
the socket being put into blocking mode. I have no expectations that
there is any other use here. Same as previous, the self.conn.shutdown
check is there to make sure it's not called on unpatched luasec
deployments and self._tls is there to make sure we don't call shutdown()
on tcp sockets.
I wouldn't recommend logging of the conn:shutdown() error inside
close(), since a lot of clients simply close the connection before
SSL_shutdown() is done.
| author | Martijn van Duren <martijn@openbsd.org> |
|---|---|
| date | Thu, 06 Feb 2025 15:04:38 +0000 |
| parent | 13385:72d7830505f0 |
| child | 13867:eabd38507c1d |
| child | 13866:7f6916088278 |
line wrap: on
line source
-- This file is generated from teal-src/util/jsonschema.lua if not math.type then require("prosody.util.mathcompat") end local utf8_enc = rawget(_G, "utf8") or require("prosody.util.encodings").utf8; local utf8_len = utf8_enc.len or function(s) local _, count = s:gsub("[%z\001-\127\194-\253][\128-\191]*", ""); return count end; local json = require("prosody.util.json") local null = json.null; local pointer = require("prosody.util.jsonpointer") local json_schema_object = { xml_t = {} } local function simple_validate(schema, data) if schema == nil then return true elseif schema == "object" and type(data) == "table" then return type(data) == "table" and (next(data) == nil or type((next(data, nil))) == "string") elseif schema == "array" and type(data) == "table" then return type(data) == "table" and (next(data) == nil or type((next(data, nil))) == "number") elseif schema == "integer" then return math.type(data) == schema elseif schema == "null" then return data == null elseif type(schema) == "table" then for _, one in ipairs(schema) do if simple_validate(one, data) then return true end end return false else return type(data) == schema end end local function mkerr(sloc, iloc, err) return { schemaLocation = sloc; instanceLocation = iloc; error = err } end local function validate(schema, data, root, sloc, iloc, errs) if type(schema) == "boolean" then return schema end if root == nil then root = schema iloc = "" sloc = "" errs = {}; end if schema["$ref"] and schema["$ref"]:sub(1, 1) == "#" then local referenced = pointer.resolve(root, schema["$ref"]:sub(2)) if referenced ~= nil and referenced ~= root and referenced ~= schema then if not validate(referenced, data, root, schema["$ref"], iloc, errs) then table.insert(errs, mkerr(sloc .. "/$ref", iloc, "Subschema failed validation")) return false, errs end end end if not simple_validate(schema.type, data) then table.insert(errs, mkerr(sloc .. "/type", iloc, "unexpected type")); return false, errs end if schema.type == "object" then if type(data) == "table" then for k in pairs(data) do if not (type(k) == "string") then table.insert(errs, mkerr(sloc .. "/type", iloc, "'object' had non-string keys")); return false, errs end end end end if schema.type == "array" then if type(data) == "table" then for i in pairs(data) do if not (math.type(i) == "integer") then table.insert(errs, mkerr(sloc .. "/type", iloc, "'array' had non-integer keys")); return false, errs end end end end if schema["enum"] ~= nil then local match = false for _, v in ipairs(schema["enum"]) do if v == data then match = true break end end if not match then table.insert(errs, mkerr(sloc .. "/enum", iloc, "not one of the enumerated values")); return false, errs end end if type(data) == "string" then if schema.maxLength and utf8_len(data) > schema.maxLength then table.insert(errs, mkerr(sloc .. "/maxLength", iloc, "string too long")) return false, errs end if schema.minLength and utf8_len(data) < schema.minLength then table.insert(errs, mkerr(sloc .. "/maxLength", iloc, "string too short")) return false, errs end if schema.luaPattern and not data:match(schema.luaPattern) then table.insert(errs, mkerr(sloc .. "/luaPattern", iloc, "string does not match pattern")) return false, errs end end if type(data) == "number" then if schema.multipleOf and (data == 0 or data % schema.multipleOf ~= 0) then table.insert(errs, mkerr(sloc .. "/luaPattern", iloc, "not a multiple")) return false, errs end if schema.maximum and not (data <= schema.maximum) then table.insert(errs, mkerr(sloc .. "/maximum", iloc, "number exceeds maximum")) return false, errs end if schema.exclusiveMaximum and not (data < schema.exclusiveMaximum) then table.insert(errs, mkerr(sloc .. "/exclusiveMaximum", iloc, "number exceeds exclusive maximum")) return false, errs end if schema.minimum and not (data >= schema.minimum) then table.insert(errs, mkerr(sloc .. "/minimum", iloc, "number below minimum")) return false, errs end if schema.exclusiveMinimum and not (data > schema.exclusiveMinimum) then table.insert(errs, mkerr(sloc .. "/exclusiveMinimum", iloc, "number below exclusive minimum")) return false, errs end end if schema.allOf then for i, sub in ipairs(schema.allOf) do if not validate(sub, data, root, sloc .. "/allOf/" .. i, iloc, errs) then table.insert(errs, mkerr(sloc .. "/allOf", iloc, "did not match all subschemas")) return false, errs end end end if schema.oneOf then local valid = 0 for i, sub in ipairs(schema.oneOf) do if validate(sub, data, root, sloc .. "/oneOf" .. i, iloc, errs) then valid = valid + 1 end end if valid ~= 1 then table.insert(errs, mkerr(sloc .. "/oneOf", iloc, "did not match exactly one subschema")) return false, errs end end if schema.anyOf then local match = false for i, sub in ipairs(schema.anyOf) do if validate(sub, data, root, sloc .. "/anyOf/" .. i, iloc, errs) then match = true break end end if not match then table.insert(errs, mkerr(sloc .. "/anyOf", iloc, "did not match any subschema")) return false, errs end end if schema["not"] then if validate(schema["not"], data, root, sloc .. "/not", iloc, errs) then table.insert(errs, mkerr(sloc .. "/not", iloc, "did match subschema")) return false, errs end end if schema["if"] ~= nil then if validate(schema["if"], data, root, sloc .. "/if", iloc, errs) then if schema["then"] then if not validate(schema["then"], data, root, sloc .. "/then", iloc, errs) then table.insert(errs, mkerr(sloc .. "/then", iloc, "did not match subschema")) return false, errs end end else if schema["else"] then if not validate(schema["else"], data, root, sloc .. "/else", iloc, errs) then table.insert(errs, mkerr(sloc .. "/else", iloc, "did not match subschema")) return false, errs end end end end if schema.const ~= nil and schema.const ~= data then table.insert(errs, mkerr(sloc .. "/const", iloc, "did not match constant value")) return false, errs end if type(data) == "table" then if schema.maxItems and #(data) > schema.maxItems then table.insert(errs, mkerr(sloc .. "/maxItems", iloc, "too many items")) return false, errs end if schema.minItems and #(data) < schema.minItems then table.insert(errs, mkerr(sloc .. "/minItems", iloc, "too few items")) return false, errs end if schema.required then for _, k in ipairs(schema.required) do if data[k] == nil then table.insert(errs, mkerr(sloc .. "/required", iloc .. "/" .. tostring(k), "missing required property")) return false, errs end end end if schema.dependentRequired then for k, reqs in pairs(schema.dependentRequired) do if data[k] ~= nil then for _, req in ipairs(reqs) do if data[req] == nil then table.insert(errs, mkerr(sloc .. "/dependentRequired", iloc, "missing dependent required property")) return false, errs end end end end end if schema.propertyNames ~= nil then for k in pairs(data) do if not validate(schema.propertyNames, k, root, sloc .. "/propertyNames", iloc .. "/" .. tostring(k), errs) then table.insert(errs, mkerr(sloc .. "/propertyNames", iloc .. "/" .. tostring(k), "a property name did not match subschema")) return false, errs end end end local seen_properties = {} if schema.properties then for k, sub in pairs(schema.properties) do if data[k] ~= nil and not validate(sub, data[k], root, sloc .. "/" .. tostring(k), iloc .. "/" .. tostring(k), errs) then table.insert(errs, mkerr(sloc .. "/" .. tostring(k), iloc .. "/" .. tostring(k), "a property did not match subschema")) return false, errs end seen_properties[k] = true end end if schema.luaPatternProperties then for pattern, sub in pairs(schema.luaPatternProperties) do for k in pairs(data) do if type(k) == "string" and k:match(pattern) then if not validate(sub, data[k], root, sloc .. "/luaPatternProperties", iloc, errs) then table.insert(errs, mkerr(sloc .. "/luaPatternProperties/" .. pattern, iloc .. "/" .. tostring(k), "a property did not match subschema")) return false, errs end seen_properties[k] = true end end end end if schema.additionalProperties ~= nil then for k, v in pairs(data) do if not seen_properties[k] then if not validate(schema.additionalProperties, v, root, sloc .. "/additionalProperties", iloc .. "/" .. tostring(k), errs) then table.insert(errs, mkerr(sloc .. "/additionalProperties", iloc .. "/" .. tostring(k), "additional property did not match subschema")) return false, errs end end end end if schema.dependentSchemas then for k, sub in pairs(schema.dependentSchemas) do if data[k] ~= nil and not validate(sub, data, root, sloc .. "/dependentSchemas/" .. k, iloc, errs) then table.insert(errs, mkerr(sloc .. "/dependentSchemas", iloc .. "/" .. tostring(k), "did not match dependent subschema")) return false, errs end end end if schema.uniqueItems then local values = {} for _, v in pairs(data) do if values[v] then table.insert(errs, mkerr(sloc .. "/uniqueItems", iloc, "had duplicate items")) return false, errs end values[v] = true end end local p = 0 if schema.prefixItems ~= nil then for i, s in ipairs(schema.prefixItems) do if data[i] == nil then break elseif validate(s, data[i], root, sloc .. "/prefixItems/" .. i, iloc .. "/" .. i, errs) then p = i else table.insert(errs, mkerr(sloc .. "/prefixItems/" .. i, iloc .. "/" .. tostring(i), "did not match subschema")) return false, errs end end end if schema.items ~= nil then for i = p + 1, #(data) do if not validate(schema.items, data[i], root, sloc, iloc .. "/" .. i, errs) then table.insert(errs, mkerr(sloc .. "/prefixItems/" .. i, iloc .. "/" .. i, "did not match subschema")) return false, errs end end end if schema.contains ~= nil then local found = 0 for i = 1, #(data) do if validate(schema.contains, data[i], root, sloc .. "/contains", iloc .. "/" .. i, errs) then found = found + 1 else table.insert(errs, mkerr(sloc .. "/contains", iloc .. "/" .. i, "did not match subschema")) end end if found < (schema.minContains or 1) then table.insert(errs, mkerr(sloc .. "/minContains", iloc, "too few matches")) return false, errs elseif found > (schema.maxContains or math.huge) then table.insert(errs, mkerr(sloc .. "/maxContains", iloc, "too many matches")) return false, errs end end end return true end json_schema_object.validate = validate; return json_schema_object