util.sasl.scram: Fixed global access.

[prosody.git] / util / sasl / plain.lua

diff --git a/util/sasl/plain.lua b/util/sasl/plain.lua
index ae5c777a77423f466ecd5977f696e0f9bec7e313..f1e04f32d5caf554f30112bbce4987dc9952636d 100644 (file)
--- a/util/sasl/plain.lua
+++ b/util/sasl/plain.lua
@@ -1,5 +1,5 @@
 -- sasl.lua v0.4
--- Copyright (C) 2008-2009 Tobias Markmann
+-- Copyright (C) 2008-2010 Tobias Markmann
 --
 --    All rights reserved.
 --
@@ -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";