Software `/` code `/` prosody

Annotate

util/id.lua @ 12953:ebe3b2f96cad

mod_tokenauth: Switch to new token format (invalidates existing tokens!) The new format has the following properties: - 5 bytes longer than the previous format - The token now has separate 'id' and 'secret' parts - the token itself is no longer stored in the DB, and the secret part is hashed - The only variable length field (JID) has been moved to the end - The 'secret-token:' prefix (RFC 8959) is now included Compatibility with the old token format was not maintained, and all previously issued tokens are invalid after this commit (they will be removed from the DB if used).

author	Matthew Wild <mwild1@gmail.com>
date	Tue, 21 Mar 2023 14:33:29 +0000
parent	12111:f8d280215633
child	12975:d10957394a3c

rev	line source
8016 9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	1 -- Prosody IM
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	2 -- Copyright (C) 2008-2017 Matthew Wild
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	3 -- Copyright (C) 2008-2017 Waqas Hussain
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	4 -- Copyright (C) 2008-2017 Kim Alvefur
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	5 --
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	6 -- This project is MIT/X11 licensed. Please see the
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	7 -- COPYING file in the source package for more information.
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	8 --
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	9
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	10 local s_gsub = string.gsub;
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	11 local random_bytes = require "util.random".bytes;
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	12 local base64_encode = require "util.encodings".base64.encode;
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	13
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	14 local b64url = { ["+"] = "-", ["/"] = "_", ["="] = "" };
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	15 local function b64url_random(len)
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	16 return (s_gsub(base64_encode(random_bytes(len)), "[+/=]", b64url));
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	17 end
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	18
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	19 return {
12110 b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	20 -- sizes divisible by 3 fit nicely into base64 without padding==
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	21
12111 f8d280215633 util.id: Add a 'tiny' variant Kim Alvefur <zash@zash.se> parents: 12110 diff changeset	22 -- for short lived things with low risk of collisions
f8d280215633 util.id: Add a 'tiny' variant Kim Alvefur <zash@zash.se> parents: 12110 diff changeset	23 tiny = function() return b64url_random(3); end;
f8d280215633 util.id: Add a 'tiny' variant Kim Alvefur <zash@zash.se> parents: 12110 diff changeset	24
12110 b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	25 -- close to 8 bytes, should be good enough for relatively short lived or uses
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	26 -- scoped by host or users, half the size of an uuid
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	27 short = function() return b64url_random(9); end;
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	28
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	29 -- more entropy than uuid at 2/3 the size
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	30 -- should be okay for globally scoped ids or security token
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	31 medium = function() return b64url_random(18); end;
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	32
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	33 -- as long as an uuid but MOAR entropy
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	34 long = function() return b64url_random(27); end;
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	35
b5b799a2a10c util.id: Adjust entropy levels, with rationales Kim Alvefur <zash@zash.se> parents: 8016 diff changeset	36 -- pick your own adventure
8016 9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	37 custom = function (size)
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	38 return function () return b64url_random(size); end;
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	39 end;
9546c629289b util.id: New util for producing random identifiers of varying sizes Kim Alvefur <zash@zash.se> parents: diff changeset	40 }

prosody

ebe3b2f96cad

util/id.lua

Software / code / prosody

Annotate

util/id.lua @ 12953:ebe3b2f96cad

Software `/` code `/` prosody