Mercurial > prosody-wiki
changeset 513:5812db271428
mod_privilege: better explanations of configuration, typos fixes
author | Goffi <goffi@goffi.org> |
---|---|
date | Thu, 07 May 2015 23:10:55 +0200 |
parents | cfef30b64777 |
children | 9427318ae72d |
files | mod_privilege.wiki |
diffstat | 1 files changed, 40 insertions(+), 19 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_privilege.wiki Thu Apr 09 12:05:58 2015 +0200 +++ b/mod_privilege.wiki Thu May 07 23:10:55 2015 +0200 @@ -3,11 +3,13 @@ = Introduction = -Privileged Entity is an extension which allows entity/component to have privileged access to server (set/get roster, send message on behalf of server, access presence informations). It can be used to build services independenlty of server (e.g.: PEP service). +Privileged Entity is an extension which allows entity/component to have privileged access to server (set/get roster, send message on behalf of server, access presence informations). It can be used to build services independently of server (e.g.: PEP service). = Details = -You can have all the details by reading the [http://xmpp.org/extensions/xep-0356.html XEP-0356]. If you use if with a component, you need to patch core/mod_component.lua to fire a new signal. To do it, copy the following patch in a, for example, /tmp/component.patch file: +You can have all the details by reading the [http://xmpp.org/extensions/xep-0356.html XEP-0356]. + +If you use it with a component, you need to patch core/mod_component.lua to fire a new signal. To do it, copy the following patch in a, for example, /tmp/component.patch file: {{{ diff --git a/plugins/mod_component.lua b/plugins/mod_component.lua --- a/plugins/mod_component.lua @@ -28,33 +30,51 @@ = Usage = -To use the module, like usual add *"privilege"* to your modules_enabled, then specify privileged entities like that: +To use the module, like usual add *"privilege"* to your modules_enabled. Note that if you use it with a local component, you also need to activate the module in your component section: {{{ -privileged_entities = { - ["romeo@montaigu.lit"] = { - roster = "get"; - presence = "managed_entity"; - }, - ["juliet@capulet.lit"] = { - roster = "both"; - message = "outgoing"; - presence = "roster"; - }, +modules_enabled = { + [...] + + "privilege"; } + +[...] + +Component "youcomponent.yourdomain.tld" + component_secret = "yourpassword" + modules_enabled = {"privilege"} }}} -Here _romeo@montaigu.lit_ can *get* roster of anybody on the server, and will *have presence for any user* of the server, while _juliet@capulet.lit_ can *get* and *set* a roster, *send messages* on the behalf of the server, and *access presence of anybody* (not only people on the server, but also people in rosters of users of the server). +then specify privileged entities *in your host section* like that: + +{{{ +VirtualHost "yourdomain.tld" + + privileged_entities = { + ["romeo@montaigu.lit"] = { + roster = "get"; + presence = "managed_entity"; + }, + ["juliet@capulet.lit"] = { + roster = "both"; + message = "outgoing"; + presence = "roster"; + }, + } +}}} + +Here _romeo@montaigu.lit_ can *get* roster of anybody on the host, and will *have presence for any user* of the host, while _juliet@capulet.lit_ can *get* and *set* a roster, *send messages* on the behalf of the server, and *access presence of anybody linked to the host* (not only people on the server, but also people in rosters of users of the server). */!\ Be extra careful when you give a permission to an entity/component, it's a powerful access, only do it if you absoly trust the component/entity, and you know where the software is coming from* = Configuration = -All the permissions give access to all accounts of the servers. +All the permissions give access to all accounts of the virtual host. == roster == ||none _(default)_||No access to rosters|| ||get||Allow *read* access to rosters|| ||set||Allow *write* access to rosters|| -||both||Allow "*read* and *write* access to rosters|| +||both||Allow *read* and *write* access to rosters|| == message == ||none _(default)_||Can't send message from server|| @@ -62,11 +82,12 @@ == presence == ||none _(default)_||Do not have extra presence information|| -||managed_entity||Receive presence stanzas (except subscriptions) from server users|| -||roster||Receive all presence stanzas (except subsciptions) from server users and people in their rosters|| +||managed_entity||Receive presence stanzas (except subscriptions) from host users|| +||roster||Receive all presence stanzas (except subsciptions) from host users and people in their rosters|| = Compatibility = +||dev||Need a patched core/mod_component.lua (see above)|| ||0.9||Need a patched core/mod_component.lua (see above)|| = Note = -This module is often used with (TODO) mod_delegation (c.f. XEP for more details) +This module is often used with mod_delegation (c.f. XEP for more details)