File

Switch to a new role-based authorization framework, removing is_admin() We began moving away from simple "is this user an admin?" permission checks before 0.12, with the introduction of mod_authz_internal and the ability to dynamically change the roles of individual users. The approach in 0.12 still had various limitations however, and apart from the introduction of roles other than "admin" and the ability to pull that info from storage, not much actually changed. This new framework shakes things up a lot, though aims to maintain the same functionality and behaviour on the surface for a default Prosody configuration. That is, if you don't take advantage of any of the new features, you shouldn't notice any change. The biggest change visible to developers is that usermanager.is_admin() (and the auth provider is_admin() method) have been removed. Gone. Completely. Permission checks should now be performed using a new module API method: module:may(action_name, context) This method accepts an action name, followed by either a JID (string) or (preferably) a table containing 'origin'/'session' and 'stanza' fields (e.g. the standard object passed to most events). It will return true if the action should be permitted, or false/nil otherwise. Modules should no longer perform permission checks based on the role name. E.g. a lot of code previously checked if the user's role was prosody:admin before permitting some action. Since many roles might now exist with similar permissions, and the permissions of prosody:admin may be redefined dynamically, it is no longer suitable to use this method for permission checks. Use module:may(). If you start an action name with ':' (recommended) then the current module's name will automatically be used as a prefix. To define a new permission, use the new module API: module:default_permission(role_name, action_name) module:default_permissions(role_name, { action_name[, action_name...] }) This grants the specified role permission to execute the named action(s) by default. This may be overridden via other mechanisms external to your module. The built-in roles that developers should use are: - prosody:user (normal user) - prosody:admin (host admin) - prosody:operator (global admin) The new prosody:operator role is intended for server-wide actions (such as shutting down Prosody). Finally, all usage of is_admin() in modules has been fixed by this commit. Some of these changes were trickier than others, but no change is expected to break existing deployments. EXCEPT: mod_auth_ldap no longer supports the ldap_admin_filter option. It's very possible nobody is using this, but if someone is then we can later update it to pull roles from LDAP somehow.

-- Storage local record API Description
--
-- This is written as a TypedLua description

-- Key-Value stores (the default)

local stanza = require"util.stanza".stanza_t

local record keyval_store
	get : function ( keyval_store, string ) : any , string
	set : function ( keyval_store, string, any ) : boolean, string
end

-- Map stores (key-key-value stores)

local record map_store
	get : function ( map_store, string, any ) : any, string
	set : function ( map_store, string, any, any ) : boolean, string
	set_keys : function ( map_store, string, { any : any }) : boolean, string
	remove : table
end

-- Archive stores

local record archive_query
	start  : number -- timestamp
	["end"]: number -- timestamp
	with   : string
	after  : string -- archive id
	before : string -- archive id
	total  : boolean
end

local record archive_store
	-- Optional set of capabilities
	caps   : {
		-- Optional total count of matching items returned as second return value from :find()
		string : any
	}

	-- Add to the archive
	append : function ( archive_store, string, string, any, number, string ) : string, string

	-- Iterate over archive
	type iterator = function () : string, any, number, string
	find   : function ( archive_store, string, archive_query ) : iterator, integer

	-- Removal of items. API like find. Optional
	delete : function ( archive_store, string, archive_query ) : boolean | number, string

	-- Array of dates which do have messages (Optional)
	dates  : function ( archive_store, string ) : { string }, string

	-- Map of counts per "with" field
	summary : function ( archive_store, string, archive_query ) : { string : integer }, string

	-- Map-store API
	get    : function ( archive_store, string, string ) : stanza, number, string
	get    : function ( archive_store, string, string ) : nil, string
	set    : function ( archive_store, string, string, stanza, number, string ) : boolean, string
end

-- This represents moduleapi
local record coremodule
	-- If the first string is omitted then the name of the module is used
	-- The second string is one of "keyval" (default), "map" or "archive"
	open_store : function (archive_store, string, string) : keyval_store, string
	open_store : function (archive_store, string, string) : map_store, string
	open_store : function (archive_store, string, string) : archive_store, string

	-- Other module methods omitted
end

return coremodule