plugins/password/config.inc.php.dist

   1 <?php
   2
   3 // Password Plugin options
   4 // -----------------------
   5 // A driver to use for password change. Default: "sql".
   6 // Current possibilities: 'directadmin', 'ldap', 'poppassd', 'sasl', 'sql', 'vpopmaild', 'cpanel'
   7 $rcmail_config['password_driver'] = 'sql';
   8
   9 // Determine whether current password is required to change password.
  10 // Default: false.
  11 $rcmail_config['password_confirm_current'] = true;
  12
  13 // Require the new password to be a certain length.
  14 // set to blank to allow passwords of any length
  15 $rcmail_config['password_minimum_length'] = 0;
  16
  17 // Require the new password to contain a letter and punctuation character
  18 // Change to false to remove this check.
  19 $rcmail_config['password_require_nonalpha'] = false;
  20
  21
  22 // SQL Driver options
  23 // ------------------
  24 // PEAR database DSN for performing the query. By default
  25 // Roundcube DB settings are used.
  26 $rcmail_config['password_db_dsn'] = '';
  27
  28 // The SQL query used to change the password.
  29 // The query can contain the following macros that will be expanded as follows:
  30 //      %p is replaced with the plaintext new password
  31 //      %c is replaced with the crypt version of the new password, MD5 if available
  32 //         otherwise DES.
  33 //      %o is replaced with the password before the change
  34 //      %n is replaced with the hashed version of the new password
  35 //      %q is replaced with the hashed password before the change
  36 //      %h is replaced with the imap host (from the session info)
  37 //      %u is replaced with the username (from the session info)
  38 //      %l is replaced with the local part of the username
  39 //         (in case the username is an email address)
  40 //      %d is replaced with the domain part of the username
  41 //         (in case the username is an email address)
  42 // Escaping of macros is handled by this module.
  43 // Default: "SELECT update_passwd(%c, %u)"
  44 $rcmail_config['password_query'] = 'SELECT update_passwd(%c, %u)';
  45
  46 // Using a password hash for %n and %q variables.
  47 // Determine which hashing algorithm should be used to generate
  48 // the hashed new and current password for using them within the
  49 // SQL query. Requires PHP's 'hash' extension.
  50 $rcmail_config['password_hash_algorithm'] = 'sha1';
  51
  52 // You can also decide whether the hash should be provided
  53 // as hex string or in base64 encoded format.
  54 $rcmail_config['password_hash_base64'] = false;
  55
  56
  57 // Poppassd Driver options
  58 // -----------------------
  59 // The host which changes the password
  60 $rcmail_config['password_pop_host'] = 'localhost';
  61
  62 // TCP port used for poppassd connections
  63 $rcmail_config['password_pop_port'] = 106;
  64
  65
  66 // SASL Driver options
  67 // -------------------
  68 // Additional arguments for the saslpasswd2 call
  69 $rcmail_config['password_saslpasswd_args'] = '';
  70
  71
  72 // LDAP Driver options
  73 // -------------------
  74 // LDAP server name to connect to.
  75 // You can provide one or several hosts in an array in which case the hosts are tried from left to right.
  76 // Exemple: array('ldap1.exemple.com', 'ldap2.exemple.com');
  77 // Default: 'localhost'
  78 $rcmail_config['password_ldap_host'] = 'localhost';
  79
  80 // LDAP server port to connect to
  81 // Default: '389'
  82 $rcmail_config['password_ldap_port'] = '389';
  83
  84 // TLS is started after connecting
  85 // Using TLS for password modification is recommanded.
  86 // Default: false
  87 $rcmail_config['password_ldap_starttls'] = false;
  88
  89 // LDAP version
  90 // Default: '3'
  91 $rcmail_config['password_ldap_version'] = '3';
  92
  93 // LDAP base name (root directory)
  94 // Exemple: 'dc=exemple,dc=com'
  95 $rcmail_config['password_ldap_basedn'] = 'dc=exemple,dc=com';
  96
  97 // LDAP connection method
  98 // There is two connection method for changing a user's LDAP password.
  99 // 'user': use user credential (recommanded, require password_confirm_current=true)
 100 // 'admin': use admin credential (this mode require password_ldap_adminDN and password_ldap_adminPW)
 101 // Default: 'user'
 102 $rcmail_config['password_ldap_method'] = 'user';
 103
 104 // LDAP Admin DN
 105 // Used only in admin connection mode
 106 // Default: null
 107 $rcmail_config['password_ldap_adminDN'] = null;
 108
 109 // LDAP Admin Password
 110 // Used only in admin connection mode
 111 // Default: null
 112 $rcmail_config['password_ldap_adminPW'] = null;
 113
 114 // LDAP user DN mask
 115 // The user's DN is mandatory and as we only have his login,
 116 // we need to re-create his DN using a mask
 117 // '%login' will be replaced by the current roundcube user's login
 118 // '%name' will be replaced by the current roundcube user's name part
 119 // '%domain' will be replaced by the current roundcube user's domain part
 120 // Exemple: 'uid=%login,ou=people,dc=exemple,dc=com'
 121 $rcmail_config['password_ldap_userDN_mask'] = 'uid=%login,ou=people,dc=exemple,dc=com';
 122
 123 // LDAP password hash type
 124 // Standard LDAP encryption type which must be one of: crypt,
 125 // ext_des, md5crypt, blowfish, md5, sha, smd5, ssha, or clear.
 126 // Please note that most encodage types require external libraries
 127 // to be included in your PHP installation, see function hashPassword in drivers/ldap.php for more info.
 128 // Default: 'crypt'
 129 $rcmail_config['password_ldap_encodage'] = 'crypt';
 130
 131 // LDAP password attribute
 132 // Name of the ldap's attribute used for storing user password
 133 // Default: 'userPassword'
 134 $rcmail_config['password_ldap_pwattr'] = 'userPassword';
 135
 136 // LDAP password force replace
 137 // Force LDAP replace in cases where ACL allows only replace not read
 138 // See http://pear.php.net/package/Net_LDAP2/docs/latest/Net_LDAP2/Net_LDAP2_Entry.html#methodreplace
 139 // Default: true
 140 $rcmail_config['password_ldap_force_replace'] = true;
 141
 142
 143 // DirectAdmin Driver options
 144 // --------------------------
 145 // The host which changes the password
 146 // Use 'ssl://serverip' instead of 'tcp://serverip' when running DirectAdmin over SSL.
 147 $rcmail_config['password_directadmin_host'] = 'tcp://localhost';
 148
 149 // TCP port used for DirectAdmin connections
 150 $rcmail_config['password_directadmin_port'] = 2222;
 151
 152
 153 // vpopmaild Driver options
 154 // -----------------------
 155 // The host which changes the password
 156 $rcmail_config['password_vpopmaild_host'] = 'localhost';
 157
 158 // TCP port used for vpopmaild connections
 159 $rcmail_config['password_vpopmaild_port'] = 89;
 160
 161
 162 // cPanel Driver options
 163 // --------------------------
 164 // The cPanel Host name
 165 $rcmail_config['password_cpanel_host'] = 'host.domain.com';
 166
 167 // The cPanel admin username
 168 $rcmail_config['password_cpanel_username'] = 'username';
 169
 170 // The cPanel admin password
 171 $rcmail_config['password_cpanel_password'] = 'password';
 172
 173 // The cPanel port to use
 174 $rcmail_config['password_cpanel_port'] = 2082;
 175
 176 // Using ssl for cPanel connections?
 177 $rcmail_config['password_cpanel_ssl'] = true;
 178
 179 // The cPanel theme in use
 180 $rcmail_config['password_cpanel_theme'] = 'x';
 181
 182
 183 // XIMSS (Communigate server) Driver options
 184 // -----------------------------------------
 185 // Host name of the Communigate server
 186 $rcmail_config['password_ximss_host'] = 'mail.example.com';
 187
 188 // XIMSS port on Communigate server
 189 $rcmail_config['password_ximss_port'] = 11024;
 190
 191 ?>