Recent changes to Installing

WikiPage Installing modified by Andrew Kester

Andrew Kester — Fri, 21 Sep 2012 14:31:55 -0000

--- v8
+++ v9
@@ -1,5 +1,7 @@
 Quick Start:
 ============
+This guide is for Version 0.4, which will be released in the next day or so.
+
 Firstly, there are some decisions that need to be made about how your authentication model will work.  As of Version 0.4, two HTTP methods are supported: Digest Authentication (recommended) and Basic Authentication.  Both appear the same to the user and currently they both have the same limitations.
 
 Next, we need to select the authentication and backend method.  Currently, only MySQL functionality is built in.  In future versions, additional database structures will be supported.  You can also elect to create your own authentication and backend methods.  Look at the [Interface Functions] section as a guide.

WikiPage Installing modified by Andrew Kester

Andrew Kester — Fri, 21 Sep 2012 05:06:44 -0000

--- v7
+++ v8
@@ -1,21 +1,58 @@
-Installing/Using:
+Quick Start:
+============
+Firstly, there are some decisions that need to be made about how your authentication model will work.  As of Version 0.4, two HTTP methods are supported: Digest Authentication (recommended) and Basic Authentication.  Both appear the same to the user and currently they both have the same limitations.
 
-There are lots of config settings to be set, take a look at the [Configuration] section.
+Next, we need to select the authentication and backend method.  Currently, only MySQL functionality is built in.  In future versions, additional database structures will be supported.  You can also elect to create your own authentication and backend methods.  Look at the [Interface Functions] section as a guide.
 
-Next, the library requires integration with some type of data source.  To ease integration, several [Built-in MySQL] functions are provided to give basic functionality.  If you want to integrate the program into a more unique structure, it is reccomended to create your own functions using the [Interface Functions] section as a guide.
+Configuration
+-------------
+Now we need to configure the library to reflect the options we decided on.
+One of the first settings (before any section) is Debugging.  It is recommended to leave it on during testing and to turn it off before deploying the application.
 
-To make use of the library, drop the file in a directory on your web server and include it in each page.  Then run authUser() to secure the page:
+The first section of the configuration controls how users are directed after login failures and logouts.  You can elect to display text or to redirect to a static URL.  The options are commented as to their function and are rather self explanatory.
+
+The next section is where we select the authentication methods we've decided on.  Change the values in this section to reflect the settings we've decided on.  
+**auth_http_method** dictates whether we use Basic or Digest authentication.  
+**auth_verify_method** dictates how we retrive and validate user credentials.
+**backend_method**  dictates how we store backend information.
+**session_check_method** dictates how we check for user inactivity
+Currently, there are no issues with settings conflicts.  This may change in later versions.
+
+In the following sections, we set up Password Hash Settings (Defaults are recommended) as well as MySQL connections.
+Be sure to insert the proper database credentials.  (Note: Two separate databases can be used for authentication and backend processes if you want).
+
+Next are some critical values we must adjust ***BEFORE*** we begin testing the application.  First, set the realm to an appropriate value for your site.  Also, select a good secret value.  (256+ Charecters from /dev/urandom are a good choice here)
+
+The rest of the settings can be left on the default.
+
+Setting up the Database
+-----------------------
+If the MySQL authentication or backend processes are used, the database must match the structures included in the files.  The database and table names can be changed, however the column names must remain the same.  Also, feel free to add extra columns but the included columns MUST remain unchanged.
+
+Adding a user:
+--------------
+This library does not add or remove users to a database, it only checks to see if they are there.  Therefore, in order to generate the first user account several methods can be employed.  Ultimately, you should include the file (detailed below) and call 
+
+    genHash($user, $password)
+
+to generate a hash for the user.  Then insert that value into the database.
+
+Usage
+-----
+For some generic usage examples, check out the examples that are included (You must have the library configured and at least one user in the database.)
+
+Basically, to use the library include it and call authUser.
 
     :::php
     include_once '/dir/to/file/php-digest.php'
     authUser();
 
-There are also some extra functions that help user management tasks:
+authUser does accept one argument that adjusts if the script terminates the page load on a failed auth.  Specifying authUser(FALSE) will check if a user has passed credential and verify them if they have.  If they have not, the function will return false and allow the page to load.  (This feature is handy for creating pages with admin functions, etc).
 
-**genHash($user, $password)** - Where $user and $password are replaced with the paired user name and password.  This function will return the hash that should be stored in the database.
 
-**checkPassword($user, $password)** - Where $user and $password are the test user name and password.  Returns TRUE for pass, FALSE for fail.  (The stored data is fetched using the database function specified in the configuration)
-
-**logoutUser** - Logs a user out.
-
-We've outlined the [Logic] of the program as well.
+Other Functions
+---------------
+Some other helpful functions:
+**genHash($user, $password)** generates the hash that should be stored in the database.
+**logoutUser()** logs out the current user
+**checkPassword($user, $password)** This should NOT be used to login a user, only to validate the identity for other purposes (ie, changing a password).

WikiPage Installing modified by Andrew Kester

Andrew Kester — Thu, 12 Jul 2012 23:34:39 -0000

--- v6
+++ v7
@@ -10,4 +10,12 @@
     include_once '/dir/to/file/php-digest.php'
     authUser();
 
+There are also some extra functions that help user management tasks:
+
+**genHash($user, $password)** - Where $user and $password are replaced with the paired user name and password.  This function will return the hash that should be stored in the database.
+
+**checkPassword($user, $password)** - Where $user and $password are the test user name and password.  Returns TRUE for pass, FALSE for fail.  (The stored data is fetched using the database function specified in the configuration)
+
+**logoutUser** - Logs a user out.
+
 We've outlined the [Logic] of the program as well.

WikiPage Installing modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 19:56:19 -0000

--- v5
+++ v6
@@ -2,7 +2,7 @@
 
 There are lots of config settings to be set, take a look at the [Configuration] section.
 
-Next, the library requires integration with some type of data source.  To ease integration, several [Built-In MySQL] functions are provided to give basic functionality.  If you want to integrate the program into a more unique structure, it is reccomended to create your own functions using the [Interface Functions] section as a guide.
+Next, the library requires integration with some type of data source.  To ease integration, several [Built-in MySQL] functions are provided to give basic functionality.  If you want to integrate the program into a more unique structure, it is reccomended to create your own functions using the [Interface Functions] section as a guide.
 
 To make use of the library, drop the file in a directory on your web server and include it in each page.  Then run authUser() to secure the page:

WikiPage Installing modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 19:56:02 -0000

--- v4
+++ v5
@@ -1,16 +1,13 @@
 Installing/Using:
-To use, drop the file in a directory on your web server and include it in each page.  Then run authUser() to secure the page:
+
+There are lots of config settings to be set, take a look at the [Configuration] section.
+
+Next, the library requires integration with some type of data source.  To ease integration, several [Built-In MySQL] functions are provided to give basic functionality.  If you want to integrate the program into a more unique structure, it is reccomended to create your own functions using the [Interface Functions] section as a guide.
+
+To make use of the library, drop the file in a directory on your web server and include it in each page.  Then run authUser() to secure the page:
 
     :::php
     include_once '/dir/to/file/php-digest.php'
     authUser();
 
-The library is designed to be somewhat stand-alone in the sense that you as a designer have the option of using built in MySQL functions to access/store user data or creating your own.
-
-To use the built in functions, make sure your database structure emulates that which is found in the three .sql files included in the release.  (More information is in the [Built-in MySQL] section.
-Then plug in all of your user/password information and you should be set.
-
-If you want to make your own functions, read about the [Interface Functions].
-
-
-Generally the config is in the top of the document.  There is some basic information about the function, but more detailed information is in the [Configuration] section.
+We've outlined the [Logic] of the program as well.

WikiPage Installing modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 19:44:42 -0000

WikiPage install modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 19:44:26 -0000

--- v2
+++ v3
@@ -1,3 +1,16 @@
 Installing/Using:
+To use, drop the file in a directory on your web server and include it in each page.  Then run authUser() to secure the page:
 
-*Since we're still in alpha and adding lots of features, we aren't really going to go into installing now.
+    :::php
+    include_once '/dir/to/file/php-digest.php'
+    authUser();
+
+The library is designed to be somewhat stand-alone in the sense that you as a designer have the option of using built in MySQL functions to access/store user data or creating your own.
+
+To use the built in functions, make sure your database structure emulates that which is found in the three .sql files included in the release.  (More information is in the [Built-in MySQL] section.
+Then plug in all of your user/password information and you should be set.
+
+If you want to make your own functions, read about the [Interface Functions].
+
+
+Generally the config is in the top of the document.  There is some basic information about the function, but more detailed information is in the [Configuration] section.

WikiPage install modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 18:23:05 -0000

--- v1
+++ v2
@@ -1 +1,3 @@
 Installing/Using:
+
+*Since we're still in alpha and adding lots of features, we aren't really going to go into installing now.

WikiPage install modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 18:14:49 -0000

Installing/Using: