Annotate

misc/sasl/example.lua @ 6112:4c0e3fe57e92

mod_compliance_latest: Gracefull error logging on missing dependency. diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md --- a/mod_compliance_latest/README.md +++ b/mod_compliance_latest/README.md @@ -9,13 +9,15 @@ rockspec: # Introduction -This module will always require and load to the lastest compliance tester we have in the community modules. -Currently this is [mod_compliance_2023]. +This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules. +Currently this is [mod_compliance_2023]. See the linked module for further details. + +If you do not use the *Prosody plugin installer* this module will likely have limited value to you. +You can also just install the current compliance tester manually. # Configuration -Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer. -See the linked module for further details. +Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*. # Compatibility diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua --- a/mod_compliance_latest/mod_compliance_latest.lua +++ b/mod_compliance_latest/mod_compliance_latest.lua @@ -1,1 +1,6 @@ -module:depends("compliance_2023"); +local success, err = pcall(function() module:depends("compliance_2023") end) + +if not success then + module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?") + return 1, "Error: Couldn't load dependency mod_compliance_2023." +end
author Menel <menel@snikket.de>
date Mon, 23 Dec 2024 12:58:03 +0100
parent 2354:7d2fcc7a15f7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2354
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 local method = {}
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 local method_mt = { __index = method }
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 -- This should return a set of supported mechanisms
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 function method:mechanisms()
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 return {
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 ["OAUTH-SOMETHING"] = true;
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 }
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 end
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 -- Called when a mechanism is selecetd
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 function method:select(mechanism)
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 return mechanism == "OAUTH-SOMETHING";
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 end
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 -- Called for each message received
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 function method:process(message)
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 -- parse the message
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 if false then
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 -- To send a SASL challenge:
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 return "challenge", "respond-to-this";
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 end
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 if false then
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 -- To fail, send:
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 return "failure", "not-authorized", "Helpful error message here";
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 end
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 self.username = "someone";
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 return "success";
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 end
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 local function new_sasl()
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 return setmetatable({}, method_mt);
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 end
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 function method:clean_clone()
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 return setmetatable({}, method_mt);
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 end
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 local provider = {}
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
42
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43 function provider.get_sasl_handler()
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 return new_sasl();
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
45 end
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46
7d2fcc7a15f7 Example SASL mechanism implementation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47 module:provides("auth", provider);