From 1d09ee0ce6d50d122352bfde66828d70cd7ed57b Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Thu, 26 Feb 2015 12:19:44 -0500
Subject: [PATCH] Added 'kpasswd' driver by Peter Allgeyer

---
 plugins/password/config.inc.php.dist |  200 ++++++++++++++++++++++++++++++++-----------------
 1 files changed, 130 insertions(+), 70 deletions(-)

diff --git a/plugins/password/config.inc.php.dist b/plugins/password/config.inc.php.dist
index aed0eaf..1814499 100644
--- a/plugins/password/config.inc.php.dist
+++ b/plugins/password/config.inc.php.dist
@@ -4,39 +4,53 @@
 // -----------------------
 // A driver to use for password change. Default: "sql".
 // See README file for list of supported driver names.
-$rcmail_config['password_driver'] = 'sql';
+$config['password_driver'] = 'sql';
 
 // Determine whether current password is required to change password.
 // Default: false.
-$rcmail_config['password_confirm_current'] = true;
+$config['password_confirm_current'] = true;
 
 // Require the new password to be a certain length.
 // set to blank to allow passwords of any length
-$rcmail_config['password_minimum_length'] = 0;
+$config['password_minimum_length'] = 0;
 
 // Require the new password to contain a letter and punctuation character
 // Change to false to remove this check.
-$rcmail_config['password_require_nonalpha'] = false;
+$config['password_require_nonalpha'] = false;
 
 // Enables logging of password changes into logs/password
-$rcmail_config['password_log'] = false;
+$config['password_log'] = false;
 
 // Comma-separated list of login exceptions for which password change
 // will be not available (no Password tab in Settings)
-$rcmail_config['password_login_exceptions'] = null;
+$config['password_login_exceptions'] = null;
+
+// Array of hosts that support password changing. Default is NULL.
+// Listed hosts will feature a Password option in Settings; others will not.
+// Example:
+//$config['password_hosts'] = array('mail.example.com', 'mail2.example.org');
+$config['password_hosts'] = null;
+
+// Enables saving the new password even if it matches the old password. Useful
+// for upgrading the stored passwords after the encryption scheme has changed.
+$config['password_force_save'] = false;
+
+// Enables forcing new users to change their password at their first login.
+$config['password_force_new_user'] = false;
 
 
 // SQL Driver options
 // ------------------
 // PEAR database DSN for performing the query. By default
 // Roundcube DB settings are used.
-$rcmail_config['password_db_dsn'] = '';
+$config['password_db_dsn'] = '';
 
 // The SQL query used to change the password.
 // The query can contain the following macros that will be expanded as follows:
 //      %p is replaced with the plaintext new password
 //      %c is replaced with the crypt version of the new password, MD5 if available
-//         otherwise DES.
+//         otherwise DES. More hash function can be enabled using the password_crypt_hash 
+//         configuration parameter.
 //      %D is replaced with the dovecotpw-crypted version of the new password
 //      %o is replaced with the password before the change
 //      %n is replaced with the hashed version of the new password
@@ -49,45 +63,57 @@
 //         (in case the username is an email address)
 // Escaping of macros is handled by this module.
 // Default: "SELECT update_passwd(%c, %u)"
-$rcmail_config['password_query'] = 'SELECT update_passwd(%c, %u)';
+$config['password_query'] = 'SELECT update_passwd(%c, %u)';
+
+// By default the crypt() function which is used to create the '%c' 
+// parameter uses the md5 algorithm. To use different algorithms 
+// you can choose between: des, md5, blowfish, sha256, sha512.
+// Before using other hash functions than des or md5 please make sure
+// your operating system supports the other hash functions.
+$config['password_crypt_hash'] = 'md5';
 
 // By default domains in variables are using unicode.
 // Enable this option to use punycoded names
-$rcmail_config['password_idn_ascii'] = false;
+$config['password_idn_ascii'] = false;
 
 // Path for dovecotpw (if not in $PATH)
-// $rcmail_config['password_dovecotpw'] = '/usr/local/sbin/dovecotpw';
+// $config['password_dovecotpw'] = '/usr/local/sbin/dovecotpw';
 
 // Dovecot method (dovecotpw -s 'method')
-$rcmail_config['password_dovecotpw_method'] = 'CRAM-MD5';
+$config['password_dovecotpw_method'] = 'CRAM-MD5';
 
 // Enables use of password with crypt method prefix in %D, e.g. {MD5}$1$LUiMYWqx$fEkg/ggr/L6Mb2X7be4i1/
-$rcmail_config['password_dovecotpw_with_method'] = false;
+$config['password_dovecotpw_with_method'] = false;
 
 // Using a password hash for %n and %q variables.
 // Determine which hashing algorithm should be used to generate
 // the hashed new and current password for using them within the
 // SQL query. Requires PHP's 'hash' extension.
-$rcmail_config['password_hash_algorithm'] = 'sha1';
+$config['password_hash_algorithm'] = 'sha1';
 
 // You can also decide whether the hash should be provided
 // as hex string or in base64 encoded format.
-$rcmail_config['password_hash_base64'] = false;
+$config['password_hash_base64'] = false;
+
+// Iteration count parameter for Blowfish-based hashing algo.
+// It must be between 4 and 31. Default: 12.
+// Be aware, the higher the value, the longer it takes to generate the password hashes.
+$config['password_blowfish_cost'] = 12;
 
 
 // Poppassd Driver options
 // -----------------------
 // The host which changes the password
-$rcmail_config['password_pop_host'] = 'localhost';
+$config['password_pop_host'] = 'localhost';
 
 // TCP port used for poppassd connections
-$rcmail_config['password_pop_port'] = 106;
+$config['password_pop_port'] = 106;
 
 
 // SASL Driver options
 // -------------------
 // Additional arguments for the saslpasswd2 call
-$rcmail_config['password_saslpasswd_args'] = '';
+$config['password_saslpasswd_args'] = '';
 
 
 // LDAP and LDAP_SIMPLE Driver options
@@ -96,41 +122,41 @@
 // You can provide one or several hosts in an array in which case the hosts are tried from left to right.
 // Exemple: array('ldap1.exemple.com', 'ldap2.exemple.com');
 // Default: 'localhost'
-$rcmail_config['password_ldap_host'] = 'localhost';
+$config['password_ldap_host'] = 'localhost';
 
 // LDAP server port to connect to
 // Default: '389'
-$rcmail_config['password_ldap_port'] = '389';
+$config['password_ldap_port'] = '389';
 
 // TLS is started after connecting
 // Using TLS for password modification is recommanded.
 // Default: false
-$rcmail_config['password_ldap_starttls'] = false;
+$config['password_ldap_starttls'] = false;
 
 // LDAP version
 // Default: '3'
-$rcmail_config['password_ldap_version'] = '3';
+$config['password_ldap_version'] = '3';
 
 // LDAP base name (root directory)
 // Exemple: 'dc=exemple,dc=com'
-$rcmail_config['password_ldap_basedn'] = 'dc=exemple,dc=com';
+$config['password_ldap_basedn'] = 'dc=exemple,dc=com';
 
 // LDAP connection method
 // There is two connection method for changing a user's LDAP password.
 // 'user': use user credential (recommanded, require password_confirm_current=true)
 // 'admin': use admin credential (this mode require password_ldap_adminDN and password_ldap_adminPW)
 // Default: 'user'
-$rcmail_config['password_ldap_method'] = 'user';
+$config['password_ldap_method'] = 'user';
 
 // LDAP Admin DN
 // Used only in admin connection mode
 // Default: null
-$rcmail_config['password_ldap_adminDN'] = null;
+$config['password_ldap_adminDN'] = null;
 
 // LDAP Admin Password
 // Used only in admin connection mode
 // Default: null
-$rcmail_config['password_ldap_adminPW'] = null;
+$config['password_ldap_adminPW'] = null;
 
 // LDAP user DN mask
 // The user's DN is mandatory and as we only have his login,
@@ -140,7 +166,7 @@
 // '%domain' will be replaced by the current roundcube user's domain part
 // '%dc' will be replaced by domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
 // Exemple: 'uid=%login,ou=people,dc=exemple,dc=com'
-$rcmail_config['password_ldap_userDN_mask'] = 'uid=%login,ou=people,dc=exemple,dc=com';
+$config['password_ldap_userDN_mask'] = 'uid=%login,ou=people,dc=exemple,dc=com';
 
 // LDAP search DN
 // The DN roundcube should bind with to find out user's DN
@@ -151,7 +177,7 @@
 // users login to find his DN instead. A common reason might be that
 // your users are placed under different ou's like engineering or
 // sales which cannot be derived from their login only.
-$rcmail_config['password_ldap_searchDN'] = 'cn=roundcube,ou=services,dc=example,dc=com';
+$config['password_ldap_searchDN'] = 'cn=roundcube,ou=services,dc=example,dc=com';
 
 // LDAP search password
 // If password_ldap_searchDN is set, the password to use for
@@ -161,13 +187,13 @@
 // is only accesible to roundcube and don't forget to restrict roundcube's access to
 // your directory as much as possible using ACLs. Should this password be compromised
 // you want to minimize the damage.
-$rcmail_config['password_ldap_searchPW'] = 'secret';
+$config['password_ldap_searchPW'] = 'secret';
 
 // LDAP search base
 // If password_ldap_searchDN is set, the base to search in using the filter below.
 // Note that you should comment out the default password_ldap_userDN_mask setting
 // for this to take effect.
-$rcmail_config['password_ldap_search_base'] = 'ou=people,dc=example,dc=com';
+$config['password_ldap_search_base'] = 'ou=people,dc=example,dc=com';
 
 // LDAP search filter
 // If password_ldap_searchDN is set, the filter to use when
@@ -179,42 +205,43 @@
 // '%dc' will be replaced by domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
 // Example: '(uid=%login)'
 // Example: '(&(objectClass=posixAccount)(uid=%login))'
-$rcmail_config['password_ldap_search_filter'] = '(uid=%login)';
+$config['password_ldap_search_filter'] = '(uid=%login)';
 
 // LDAP password hash type
 // Standard LDAP encryption type which must be one of: crypt,
-// ext_des, md5crypt, blowfish, md5, sha, smd5, ssha, or clear.
+// ext_des, md5crypt, blowfish, md5, sha, smd5, ssha, ad, cram-md5 (dovecot style) or clear.
 // Please note that most encodage types require external libraries
 // to be included in your PHP installation, see function hashPassword in drivers/ldap.php for more info.
-// Default: 'crypt'
-$rcmail_config['password_ldap_encodage'] = 'crypt';
+// Multiple password Values can be generated by concatenating encodings with a +. E.g. 'cram-md5+crypt'
+// Default: 'crypt'.
+$config['password_ldap_encodage'] = 'crypt';
 
 // LDAP password attribute
 // Name of the ldap's attribute used for storing user password
 // Default: 'userPassword'
-$rcmail_config['password_ldap_pwattr'] = 'userPassword';
+$config['password_ldap_pwattr'] = 'userPassword';
 
 // LDAP password force replace
 // Force LDAP replace in cases where ACL allows only replace not read
 // See http://pear.php.net/package/Net_LDAP2/docs/latest/Net_LDAP2/Net_LDAP2_Entry.html#methodreplace
 // Default: true
-$rcmail_config['password_ldap_force_replace'] = true;
+$config['password_ldap_force_replace'] = true;
 
 // LDAP Password Last Change Date
 // Some places use an attribute to store the date of the last password change
 // The date is meassured in "days since epoch" (an integer value)
 // Whenever the password is changed, the attribute will be updated if set (e.g. shadowLastChange)
-$rcmail_config['password_ldap_lchattr'] = '';
+$config['password_ldap_lchattr'] = '';
 
 // LDAP Samba password attribute, e.g. sambaNTPassword
 // Name of the LDAP's Samba attribute used for storing user password
-$rcmail_config['password_ldap_samba_pwattr'] = '';
+$config['password_ldap_samba_pwattr'] = '';
  
 // LDAP Samba Password Last Change Date attribute, e.g. sambaPwdLastSet
 // Some places use an attribute to store the date of the last password change
 // The date is meassured in "seconds since epoch" (an integer value)
 // Whenever the password is changed, the attribute will be updated if set
-$rcmail_config['password_ldap_samba_lchattr'] = '';
+$config['password_ldap_samba_lchattr'] = '';
 
 
 // DirectAdmin Driver options
@@ -224,63 +251,60 @@
 // The host can contain the following macros that will be expanded as follows:
 //     %h is replaced with the imap host (from the session info)
 //     %d is replaced with the domain part of the username (if the username is an email)
-$rcmail_config['password_directadmin_host'] = 'tcp://localhost';
+$config['password_directadmin_host'] = 'tcp://localhost';
 
 // TCP port used for DirectAdmin connections
-$rcmail_config['password_directadmin_port'] = 2222;
+$config['password_directadmin_port'] = 2222;
 
 
 // vpopmaild Driver options
 // -----------------------
 // The host which changes the password
-$rcmail_config['password_vpopmaild_host'] = 'localhost';
+$config['password_vpopmaild_host'] = 'localhost';
 
 // TCP port used for vpopmaild connections
-$rcmail_config['password_vpopmaild_port'] = 89;
+$config['password_vpopmaild_port'] = 89;
+
+// Timout used for the connection to vpopmaild (in seconds)
+$config['password_vpopmaild_timeout'] = 10;
 
 
 // cPanel Driver options
 // --------------------------
 // The cPanel Host name
-$rcmail_config['password_cpanel_host'] = 'host.domain.com';
+$config['password_cpanel_host'] = 'host.domain.com';
 
 // The cPanel admin username
-$rcmail_config['password_cpanel_username'] = 'username';
+$config['password_cpanel_username'] = 'username';
 
 // The cPanel admin password
-$rcmail_config['password_cpanel_password'] = 'password';
+$config['password_cpanel_password'] = 'password';
 
 // The cPanel port to use
-$rcmail_config['password_cpanel_port'] = 2082;
-
-// Using ssl for cPanel connections?
-$rcmail_config['password_cpanel_ssl'] = true;
-
-// The cPanel theme in use
-$rcmail_config['password_cpanel_theme'] = 'x';
+$config['password_cpanel_port'] = 2087;
 
 
 // XIMSS (Communigate server) Driver options
 // -----------------------------------------
 // Host name of the Communigate server
-$rcmail_config['password_ximss_host'] = 'mail.example.com';
+$config['password_ximss_host'] = 'mail.example.com';
 
 // XIMSS port on Communigate server
-$rcmail_config['password_ximss_port'] = 11024;
+$config['password_ximss_port'] = 11024;
 
 
 // chpasswd Driver options
 // ---------------------
 // Command to use
-$rcmail_config['password_chpasswd_cmd'] = 'sudo /usr/sbin/chpasswd 2> /dev/null';
+$config['password_chpasswd_cmd'] = 'sudo /usr/sbin/chpasswd 2> /dev/null';
 
 
 // XMail Driver options
 // ---------------------
-$rcmail_config['xmail_host'] = 'localhost';
-$rcmail_config['xmail_user'] = 'YourXmailControlUser';
-$rcmail_config['xmail_pass'] = 'YourXmailControlPass';
-$rcmail_config['xmail_port'] = 6017;
+$config['xmail_host'] = 'localhost';
+$config['xmail_user'] = 'YourXmailControlUser';
+$config['xmail_pass'] = 'YourXmailControlPass';
+$config['xmail_port'] = 6017;
 
 
 // hMail Driver options
@@ -288,9 +312,9 @@
 // Remote hMailServer configuration
 // true:  HMailserver is on a remote box (php.ini: com.allow_dcom = true)
 // false: Hmailserver is on same box as PHP
-$rcmail_config['hmailserver_remote_dcom'] = false;
+$config['hmailserver_remote_dcom'] = false;
 // Windows credentials
-$rcmail_config['hmailserver_server'] = array(
+$config['hmailserver_server'] = array(
     'Server' => 'localhost', // hostname or ip address
     'Username' => 'administrator', // windows username
     'Password' => 'password' // windows user password
@@ -308,7 +332,7 @@
 // 5: domain-username
 // 6: username_domain
 // 7: domain_username
-$rcmail_config['password_virtualmin_format'] = 0;
+$config['password_virtualmin_format'] = 0;
 
 
 // pw_usermod Driver options
@@ -316,32 +340,68 @@
 // Use comma delimited exlist to disable password change for users
 // Add the following line to visudo to tighten security:
 // www  ALL=NOPASSWORD: /usr/sbin/pw
-$rcmail_config['password_pw_usermod_cmd'] = 'sudo /usr/sbin/pw usermod -h 0 -n';
+$config['password_pw_usermod_cmd'] = 'sudo /usr/sbin/pw usermod -h 0 -n';
 
 
 // DBMail Driver options
 // -------------------
 // Additional arguments for the dbmail-users call
-$rcmail_config['password_dbmail_args'] = '-p sha512';
+$config['password_dbmail_args'] = '-p sha512';
 
 
 // Expect Driver options
 // ---------------------
 // Location of expect binary
-$rcmail_config['password_expect_bin'] = '/usr/bin/expect';
+$config['password_expect_bin'] = '/usr/bin/expect';
 
 // Location of expect script (see helpers/passwd-expect)
-$rcmail_config['password_expect_script'] = '';
+$config['password_expect_script'] = '';
 
 // Arguments for the expect script. See the helpers/passwd-expect file for details.
 // This is probably a good starting default:
 //   -telent -host localhost -output /tmp/passwd.log -log /tmp/passwd.log
-$rcmail_config['password_expect_params'] = '';
+$config['password_expect_params'] = '';
 
 
 // smb Driver options
 // ---------------------
 // Samba host (default: localhost)
-$rcmail_config['password_smb_host'] = 'localhost';
+// Supported replacement variables:
+// %n - hostname ($_SERVER['SERVER_NAME'])
+// %t - hostname without the first part
+// %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
+$config['password_smb_host'] = 'localhost';
 // Location of smbpasswd binary
-$rcmail_config['password_smb_cmd'] = '/usr/bin/smbpasswd';
+$config['password_smb_cmd'] = '/usr/bin/smbpasswd';
+
+// gearman driver options
+// ---------------------
+// Gearman host (default: localhost)
+$config['password_gearman_host'] = 'localhost';
+
+
+
+// Plesk/PPA Driver options
+// --------------------
+// You need to allow RCP for IP of roundcube-server in Plesk/PPA Panel 
+
+// Plesk RCP Host
+$config['password_plesk_host'] = '10.0.0.5';
+
+// Plesk RPC Username
+$config['password_plesk_user'] = 'admin';
+
+// Plesk RPC Password
+$config['password_plesk_pass'] = 'password';
+
+// Plesk RPC Port
+$config['password_plesk_rpc_port'] = '8443';
+
+// Plesk RPC Path
+$config['password_plesk_rpc_path'] = 'enterprise/control/agent.php';
+
+
+// kasswd Driver options
+// ---------------------
+// Command to use
+$config['password_kpasswd_cmd'] = '/usr/bin/kpasswd';

--
Gitblit v1.9.1