Software /
code /
prosody
File
util/jwt.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 | 12975:d10957394a3c |
line wrap: on
line source
local s_gsub = string.gsub; local crypto = require "prosody.util.crypto"; local json = require "prosody.util.json"; local hashes = require "prosody.util.hashes"; local base64_encode = require "prosody.util.encodings".base64.encode; local base64_decode = require "prosody.util.encodings".base64.decode; local secure_equals = require "prosody.util.hashes".equals; local b64url_rep = { ["+"] = "-", ["/"] = "_", ["="] = "", ["-"] = "+", ["_"] = "/" }; local function b64url(data) return (s_gsub(base64_encode(data), "[+/=]", b64url_rep)); end local function unb64url(data) return base64_decode(s_gsub(data, "[-_]", b64url_rep).."=="); end local jwt_pattern = "^(([A-Za-z0-9-_]+)%.([A-Za-z0-9-_]+))%.([A-Za-z0-9-_]+)$" local function decode_jwt(blob, expected_alg) local signed, bheader, bpayload, signature = string.match(blob, jwt_pattern); if not signed then return nil, "invalid-encoding"; end local header = json.decode(unb64url(bheader)); if not header or type(header) ~= "table" then return nil, "invalid-header"; elseif header.alg ~= expected_alg then return nil, "unsupported-algorithm"; end return signed, signature, bpayload; end local function new_static_header(algorithm_name) return b64url('{"alg":"'..algorithm_name..'","typ":"JWT"}') .. '.'; end local function decode_raw_payload(raw_payload) local payload, err = json.decode(unb64url(raw_payload)); if err ~= nil then return nil, "json-decode-error"; elseif type(payload) ~= "table" then return nil, "invalid-payload-type"; end return true, payload; end -- HS*** family local function new_hmac_algorithm(name) local static_header = new_static_header(name); local hmac = hashes["hmac_sha"..name:sub(-3)]; local function sign(key, payload) local encoded_payload = json.encode(payload); local signed = static_header .. b64url(encoded_payload); local signature = hmac(key, signed); return signed .. "." .. b64url(signature); end local function verify(key, blob) local signed, signature, raw_payload = decode_jwt(blob, name); if not signed then return nil, signature; end -- nil, err if not secure_equals(b64url(hmac(key, signed)), signature) then return false, "signature-mismatch"; end return decode_raw_payload(raw_payload); end local function load_key(key) assert(type(key) == "string", "key must be string (long, random, secure)"); return key; end return { sign = sign, verify = verify, load_key = load_key }; end local function new_crypto_algorithm(name, key_type, c_sign, c_verify, sig_encode, sig_decode) local static_header = new_static_header(name); return { sign = function (private_key, payload) local encoded_payload = json.encode(payload); local signed = static_header .. b64url(encoded_payload); local signature = c_sign(private_key, signed); if sig_encode then signature = sig_encode(signature); end return signed.."."..b64url(signature); end; verify = function (public_key, blob) local signed, signature, raw_payload = decode_jwt(blob, name); if not signed then return nil, signature; end -- nil, err signature = unb64url(signature); if sig_decode and signature then signature = sig_decode(signature); end if not signature then return false, "signature-mismatch"; end local verify_ok = c_verify(public_key, signed, signature); if not verify_ok then return false, "signature-mismatch"; end return decode_raw_payload(raw_payload); end; load_public_key = function (public_key_pem) local key = assert(crypto.import_public_pem(public_key_pem)); assert(key:get_type() == key_type, "incorrect key type"); return key; end; load_private_key = function (private_key_pem) local key = assert(crypto.import_private_pem(private_key_pem)); assert(key:get_type() == key_type, "incorrect key type"); return key; end; }; end -- RS***, PS*** local rsa_sign_algos = { RS = "rsassa_pkcs1", PS = "rsassa_pss" }; local function new_rsa_algorithm(name) local family, digest_bits = name:match("^(..)(...)$"); local c_sign = crypto[rsa_sign_algos[family].."_sha"..digest_bits.."_sign"]; local c_verify = crypto[rsa_sign_algos[family].."_sha"..digest_bits.."_verify"]; return new_crypto_algorithm(name, "rsaEncryption", c_sign, c_verify); end -- ES*** local function new_ecdsa_algorithm(name, c_sign, c_verify, sig_bytes) local function encode_ecdsa_sig(der_sig) local r, s = crypto.parse_ecdsa_signature(der_sig, sig_bytes); return r..s; end local expected_sig_length = sig_bytes*2; local function decode_ecdsa_sig(jwk_sig) if #jwk_sig ~= expected_sig_length then return nil; end return crypto.build_ecdsa_signature(jwk_sig:sub(1, sig_bytes), jwk_sig:sub(sig_bytes+1)); end return new_crypto_algorithm(name, "id-ecPublicKey", c_sign, c_verify, encode_ecdsa_sig, decode_ecdsa_sig); end local algorithms = { HS256 = new_hmac_algorithm("HS256"), HS384 = new_hmac_algorithm("HS384"), HS512 = new_hmac_algorithm("HS512"); ES256 = new_ecdsa_algorithm("ES256", crypto.ecdsa_sha256_sign, crypto.ecdsa_sha256_verify, 32); ES512 = new_ecdsa_algorithm("ES512", crypto.ecdsa_sha512_sign, crypto.ecdsa_sha512_verify, 66); RS256 = new_rsa_algorithm("RS256"), RS384 = new_rsa_algorithm("RS384"), RS512 = new_rsa_algorithm("RS512"); PS256 = new_rsa_algorithm("PS256"), PS384 = new_rsa_algorithm("PS384"), PS512 = new_rsa_algorithm("PS512"); }; local function new_signer(algorithm, key_input, options) local impl = assert(algorithms[algorithm], "Unknown JWT algorithm: "..algorithm); local key = (impl.load_private_key or impl.load_key)(key_input); local sign = impl.sign; local default_ttl = (options and options.default_ttl) or 3600; return function (payload) local issued_at; if not payload.iat then issued_at = os.time(); payload.iat = issued_at; end if not payload.exp then payload.exp = (issued_at or os.time()) + default_ttl; end return sign(key, payload); end end local function new_verifier(algorithm, key_input, options) local impl = assert(algorithms[algorithm], "Unknown JWT algorithm: "..algorithm); local key = (impl.load_public_key or impl.load_key)(key_input); local verify = impl.verify; local check_expiry = not (options and options.accept_expired); local claim_verifier = options and options.claim_verifier; return function (token) local ok, payload = verify(key, token); if ok then local expires_at = check_expiry and payload.exp; if expires_at then if type(expires_at) ~= "number" then return nil, "invalid-expiry"; elseif expires_at < os.time() then return nil, "token-expired"; end end if claim_verifier and not claim_verifier(payload) then return nil, "incorrect-claims"; end end return ok, payload; end end local function init(algorithm, private_key, public_key, options) return new_signer(algorithm, private_key, options), new_verifier(algorithm, public_key or private_key, options); end return { init = init; new_signer = new_signer; new_verifier = new_verifier; -- Exported mainly for tests _algorithms = algorithms; -- Deprecated sign = algorithms.HS256.sign; verify = algorithms.HS256.verify; };