Merge lp:~hrvojem/percona-pam-for-mysql/dialog-intro into lp:percona-pam-for-mysql

[Hrvoje Matijakovic]

[Laurynas Biveinis (laurynas-biveinis)]

The text looks good, couple of nitpicks:

Line 29: s/plugin.This/plugin. This
Line 43: "mysqlclient", does it mean "MySQL client" or "libmysqlclient"?
Line 43: s/1/one

review: Needs Fixing

[Laurynas Biveinis (laurynas-biveinis)]

s/it support/it supports

OK with that change, thank you

review: Approve

[lp:~hrvojem/percona-pam-for-mysql/dialog-intro]

24. By Hrvoje Matijakovic on 2012-03-15

* dialog description added with list of features
* doc/build/ added to .bzrignore

=== modified file '.bzrignore'
--- .bzrignore	2012-02-01 14:42:43 +0000
+++ .bzrignore	2012-03-15 14:49:17 +0000
@@ -18,3 +18,4 @@
 build/build-binary.sh
 *.tar.gz
 m4/*.m4
+doc/build

=== modified file 'doc/source/glossary.rst'
--- doc/source/glossary.rst	2011-10-25 10:51:19 +0000
+++ doc/source/glossary.rst	2012-03-15 14:49:17 +0000
@@ -5,4 +5,4 @@
 .. glossary::
 
    PAM
-     Pluggable Authentication Module
+     Pluggable Authentication Module - allows integrating multiple authentication mechanisms which can be written independently of the underlying authentication scheme that's being used in the application.

=== modified file 'doc/source/intro.rst'
--- doc/source/intro.rst	2011-10-25 10:51:19 +0000
+++ doc/source/intro.rst	2012-03-15 14:49:17 +0000
@@ -2,5 +2,22 @@
  About Percona PAM Authentication Plugin for MySQL
 ==================================================
 
-
-A Free and Open Source PAM authentication plugin for MySQL and Percona Server.
+Percona PAM Authentication Plugin is a free and Open Source implementation of the MySQL's authentication plugin. This plugin acts as a mediator between the MySQL server, the MySQL client, and the PAM stack. The server plugin requests authentication from the PAM stack, forwards any requests and messages from the PAM stack over the wire to the client (in cleartext) and reads back any replies for the PAM stack.
+
+ PAM plugin uses dialog as its client side plugin. Dialog plugin can be loaded to any client application that uses libmysqlclient library.
+
+Here are some of the benefits that Percona dialog plugin offers over the default one:
+
+  * It correctly recognizes whether PAM wants input to be echoed or not, while the default one always echoes the input on the user's console.
+  * It can use the password which is passed to |MySQL| client via "-p" parameter.
+  * Dialog client `installation bug <http://bugs.mysql.com/bug.php?id=60745>`_ has been fixed.
+  * This plugin works on |MySQL| and |Percona Server|.
+
+Percona offers two versions of this plugin:  
+
+  * Full PAM plugin called *auth_pam*. This plugin uses *dialog.so*. It fully supports the PAM protocol with arbitrary communication between client and server.
+  * Oracle-compatible PAM called *auth_pam_compat*. This plugin uses *mysql_clear_password* which is a part of Oracle MySQL client. It also has some limitations, such as, it supports only one password input. You must use "-p" option in order to pass the password to auth_pam_compat.
+
+These two versions of plugins are physically different. To choose which one you want used, you must use *IDENTIFIED WITH 'auth_pam'* for auth_pam, and *IDENTIFIED WITH 'auth_pam_compat'* for auth_pam_compat.
+
+