From bbb19248b67882e7a0baf8e0c533c199274813f4 Mon Sep 17 00:00:00 2001 From: Jesper Hvirring Henriksen <jesper@hvirring.dk> Date: Tue, 15 Mar 2011 10:25:35 +0100 Subject: [PATCH] Documentation cleanup --- .gitignore | 1 + docs/sql.txt | 8 ++++++-- readme.md | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 .gitignore mode change 100644 => 100755 docs/sql.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..90ec22b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.svn diff --git a/docs/sql.txt b/docs/sql.txt old mode 100644 new mode 100755 index 5aab9e9..1ea80f6 --- a/docs/sql.txt +++ b/docs/sql.txt @@ -1,7 +1,11 @@ `sqlauthBcrypt:SQL` ============= -This is an authentication module for authenticating a user against a SQL database. It uses bcrypt for validation of passwords against hashed passwords stored in the database. The implementation is based heavily on sqlauth:SQL. +This is an authentication module for [SimpleSAMLphp](http://simplesamlphp.org) to authenticate a user against a SQL database table. + +It assumes password hashes and salts are calculated using [bcrypt](http://bcrypt.sourceforge.net/). + +The implementation is based heavily on the SimpleSAMLphp module `sqlauth:SQL`. Options @@ -21,7 +25,7 @@ Options : The SQL query which should be used to retrieve the user. The parameters :username and :password are available. If the username/password is incorrect, the query should return no rows. The name of the columns in resultset will be used as attribute names. If the query returns multiple rows, they will be merged into the attributes. Duplicate values and NULL values will be removed. `pepper` -: The pepper string appended to the password before generating the hash. If you are not using a pepper, set this to the empty string (''). +: The pepper string appended to passwords before generating the hash. If you are not using a pepper, set this to the empty string (''). `hash_column` : The column storing password hashes. diff --git a/readme.md b/readme.md index b92964c..a4144e6 120000 --- a/readme.md +++ b/readme.md @@ -1 +1 @@ -docs/sql.txt \ No newline at end of file +./docs/sql.txt \ No newline at end of file -- GitLab