Update of /cvsroot/sandweb/sandweb/lib/SandWeb/Auth
In directory sc8-pr-cvs1:/tmp/cvs-serv17142/Auth
Modified Files:
FlatFile.pm
Log Message:
all API docs transferred from docs/API to POD.
some need to be formatted better, and some of the docs are
incomplete, but it's really close now :)
Index: FlatFile.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Auth/FlatFile.pm,v
retrieving revision 1.8
retrieving revision 1.9
diff -U2 -r1.8 -r1.9
--- FlatFile.pm 5 Jan 2003 08:59:08 -0000 1.8
+++ FlatFile.pm 6 Jan 2003 09:49:30 -0000 1.9
@@ -1,7 +1,99 @@
+=pod
+=head1
+
# SandWeb FlatFile authentication module
#
+# lib/SandWeb/Auth/FlatFile.pm
+#
+# This class verifies MD5 passwords for a given username, and returns
+# true if the user if authentic, false if not.
+--------------------------------------------------------------------------------
-=pod
-=head1
+METHOD
+ new
+
+SYNOPSIS
+
+ my $flatfile = SandWeb::Auth::FlatFile::->new(
+ 'log_obj' => $log,
+ );
+
+DESCRIPTION
+
+ This method is a constructor.
+
+PARAMETERS
+
+ log_obj (type: string) (required)
+
+ A reference to an instantiated log object.
+
+ Default: none.
+
+RETURN CODES
+
+ Returns a reference to a FlatFile object.
+
+ 0 = This means that the method got an error proccessing your request.
+ Perhaps an invalid parameter?
+
+--------------------------------------------------------------------------------
+
+METHOD
+
+ verify_password
+
+SYNOPSIS
+
+ my $user_is_authentic = $flatfile->verify_password(
+ username => $username,
+ password => $password,
+ user_dir => $user_dir,
+ salt => $salt,
+ };
+
+DESCRIPTION
+
+ This method verifies if a user is authentic or not by querying SandWeb's flat-file
+ database.
+
+
+PARAMETERS
+
+ username (type: string) (required)
+
+ The current user's full username.
+
+ Default: none.
+
+ password (type: string) (required)
+
+ The encrypted password to verify.
+
+ Default: none.
+
+ user_dir (type: string) (required)
+
+ The root of where homedirs are stored.
+
+ FIXME - why does verify_password need to know this?
+
+ Default: none.
+
+ salt (type: string) (required)
+
+ The salt used for the encrypted password.
+
+ Default: none.
+
+RETURN CODES
+
+ 1 = The operation completed successfully.
+
+ 0 = This means that the method got an error proccessing your request.
+ Perhaps an invalid parameter?
+
+# SandWeb FlatFile authentication module
+#
SandWeb::Auth::FlatFile
|
