Mercurial > prosody-wiki

comparison mod_auth_external.wiki @ 396:5720e3f68061

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update docs for lpty-based version
author MWild1@gmail.com
date Tue, 13 Aug 2013 17:47:14 +0000
parents 35702f67785f
children 0045196dc6b9
comparison
equal deleted inserted replaced
395:af771646760b 396:5720e3f68061
2 #labels Stage-Alpha,Type-Auth 2 #labels Stage-Alpha,Type-Auth
3 3
4 = Introduction = 4 = Introduction =
5 5
6 Allow client authentication to be handled by an external script/process. 6 Allow client authentication to be handled by an external script/process.
7
8 = Installation =
9
10 mod_auth_external depends on a Lua module called [http://www.tset.de/lpty/ lpty]. You can install it on many platforms using [http://luarocks.org/ LuaRocks], for example:
11
12 {{{
13 sudo luarocks install lpty
14 }}}
15
16 Note: Earlier versions of the module did not depend on lpty. While using the newer version is strongly recommended, you can find the [https://prosody-modules.googlecode.com/hg-history/50ee38e95e754bf1034d980364f93564028b2f34/mod_auth_external/mod_auth_external.lua older version here] if you need it (revision 50ee38e95e75 of the repository).
7 17
8 = Configuration = 18 = Configuration =
9 19
10 As with all auth modules, there is no need to add this to modules_enabled. Simply add in the global section, or for the relevant hosts: 20 As with all auth modules, there is no need to add this to modules_enabled. Simply add in the global section, or for the relevant hosts:
11 21
15 25
16 These options are specific to mod_auth_external: 26 These options are specific to mod_auth_external:
17 27
18 ||external_auth_protocol||May be "generic" or "ejabberd" (the latter for compatibility with ejabberd external auth scripts. Default is "generic".|| 28 ||external_auth_protocol||May be "generic" or "ejabberd" (the latter for compatibility with ejabberd external auth scripts. Default is "generic".||
19 ||external_auth_command||The command/script to execute.|| 29 ||external_auth_command||The command/script to execute.||
30 ||external_auth_timeout||The number of seconds to wait for a response from the auth process. Default is 5.||
20 31
21 = Protocol = 32 = Protocol =
22 33
23 Prosody executes the given command/script, and sends it queries. 34 Prosody executes the given command/script, and sends it queries.
24 35
58 external_auth_protocol = "ejabberd" 69 external_auth_protocol = "ejabberd"
59 }}} 70 }}}
60 71
61 = Compatibility = 72 = Compatibility =
62 ||0.8||Works|| 73 ||0.8||Works||
74 ||0.9||Works||