aboutsummaryrefslogtreecommitdiffstats
path: root/util/sasl
diff options
context:
space:
mode:
authorTobias Markmann <tm@ayena.de>2010-02-28 22:32:12 +0100
committerTobias Markmann <tm@ayena.de>2010-02-28 22:32:12 +0100
commitcb3a0cad21e9598fb4e9ed69a4294135da755aa6 (patch)
tree3c3e5c7f31bb6b48691668709b947bf61e4c3afb /util/sasl
parentb4ba73c8b61d4af5282dd88216a71323c967e0e6 (diff)
downloadprosody-cb3a0cad21e9598fb4e9ed69a4294135da755aa6.tar.gz
prosody-cb3a0cad21e9598fb4e9ed69a4294135da755aa6.zip
util.sasl: Moving SASL authentication backends documentation to the mechanism files.
Diffstat (limited to 'util/sasl')
-rw-r--r--util/sasl/digest-md5.lua15
-rw-r--r--util/sasl/plain.lua15
2 files changed, 30 insertions, 0 deletions
diff --git a/util/sasl/digest-md5.lua b/util/sasl/digest-md5.lua
index 5b8f5c8a..3d6a3e1e 100644
--- a/util/sasl/digest-md5.lua
+++ b/util/sasl/digest-md5.lua
@@ -29,6 +29,21 @@ module "digest-md5"
--=========================
--SASL DIGEST-MD5 according to RFC 2831
+--[[
+Supported Authentication Backends
+
+digest-md5:
+ function(username, domain, realm, encoding) -- domain and realm are usually the same; for some broken
+ -- implementations it's not
+ return digesthash, state;
+ end
+
+digest-md5-test:
+ function(username, domain, realm, encoding, digesthash)
+ return true or false, state;
+ end
+]]
+
local function digest(self, message)
--TODO complete support for authzid
diff --git a/util/sasl/plain.lua b/util/sasl/plain.lua
index ae5c777a..43bb239f 100644
--- a/util/sasl/plain.lua
+++ b/util/sasl/plain.lua
@@ -19,6 +19,21 @@ module "plain"
-- ================================
-- SASL PLAIN according to RFC 4616
+
+--[[
+Supported Authentication Backends
+
+plain:
+ function(username, realm)
+ return password, state;
+ end
+
+plain-test:
+ function(username, realm, password)
+ return true or false, state;
+ end
+]]
+
local function plain(self, message)
if not message then
return "failure", "malformed-request";