RIP BOOL. Convert BOOL -> bool. I found a few interesting
[nivanova/samba-autobuild/.git] / source3 / lib / account_pol.c
index 2e619c0c6b303e28137143297f90e3744d0b0385..96a471cf06e7cae957315c7ef116686c6bfc2c3a 100644 (file)
@@ -3,10 +3,11 @@
  *  account policy storage
  *  Copyright (C) Jean François Micouleau      1998-2001.
  *  Copyright (C) Andrew Bartlett              2002
+ *  Copyright (C) Guenther Deschner            2004-2005
  *  
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
+ *  the Free Software Foundation; either version 3 of the License, or
  *  (at your option) any later version.
  *  
  *  This program is distributed in the hope that it will be useful,
  *  GNU General Public License for more details.
  *  
  *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #include "includes.h"
-static TDB_CONTEXT *tdb; /* used for driver files */
+static TDB_CONTEXT *tdb; 
 
-#define DATABASE_VERSION 1
+/* cache all entries for 60 seconds for to save ldap-queries (cache is updated
+ * after this period if admins do not use pdbedit or usermanager but manipulate
+ * ldap directly) - gd */
 
-/****************************************************************************
- Open the account policy tdb.
-****************************************************************************/
+#define DATABASE_VERSION       3
+#define AP_TTL                 60
 
-BOOL init_account_policy(void)
-{
-       static pid_t local_pid;
-       const char *vstring = "INFO/version";
-       uint32 version;
 
-       if (tdb && local_pid == sys_getpid())
-               return True;
-       tdb = tdb_open_log(lock_path("account_policy.tdb"), 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0600);
-       if (!tdb) {
-               DEBUG(0,("Failed to open account policy database\n"));
-               return False;
-       }
+struct ap_table {
+       int field;
+       const char *string;
+       uint32 default_val;
+       const char *description;
+       const char *ldap_attr;
+};
 
-       local_pid = sys_getpid();
+static const struct ap_table account_policy_names[] = {
+       {AP_MIN_PASSWORD_LEN, "min password length", MINPASSWDLENGTH, 
+               "Minimal password length (default: 5)", 
+               "sambaMinPwdLength" },
 
-       /* handle a Samba upgrade */
-       tdb_lock_bystring(tdb, vstring,0);
-       if (!tdb_fetch_uint32(tdb, vstring, &version) || version != DATABASE_VERSION) {
-               tdb_traverse(tdb, tdb_traverse_delete_fn, NULL);
-               tdb_store_uint32(tdb, vstring, DATABASE_VERSION);
+       {AP_PASSWORD_HISTORY, "password history", 0,
+               "Length of Password History Entries (default: 0 => off)", 
+               "sambaPwdHistoryLength" },
                
-               account_policy_set(AP_MIN_PASSWORD_LEN, MINPASSWDLENGTH);   /* 5 chars minimum             */
-               account_policy_set(AP_PASSWORD_HISTORY, 0);                 /* don't keep any old password */
-               account_policy_set(AP_USER_MUST_LOGON_TO_CHG_PASS, 0);      /* don't force user to logon   */
-               account_policy_set(AP_MAX_PASSWORD_AGE, MAX_PASSWORD_AGE);  /* 21 days                     */
-               account_policy_set(AP_MIN_PASSWORD_AGE, 0);                 /* 0 days                      */
-               account_policy_set(AP_LOCK_ACCOUNT_DURATION, 0);            /* lockout for 0 minutes       */
-               account_policy_set(AP_RESET_COUNT_TIME, 0);                 /* reset immediatly            */
-               account_policy_set(AP_BAD_ATTEMPT_LOCKOUT, 0);              /* don't lockout               */
-               account_policy_set(AP_TIME_TO_LOGOUT, -1);                  /* don't force logout          */
-       }
-       tdb_unlock_bystring(tdb, vstring);
+       {AP_USER_MUST_LOGON_TO_CHG_PASS, "user must logon to change password", 0,
+               "Force Users to logon for password change (default: 0 => off, 2 => on)",
+               "sambaLogonToChgPwd" },
+       
+       {AP_MAX_PASSWORD_AGE, "maximum password age", (uint32) -1,
+               "Maximum password age, in seconds (default: -1 => never expire passwords)", 
+               "sambaMaxPwdAge" },
+               
+       {AP_MIN_PASSWORD_AGE,"minimum password age", 0,
+               "Minimal password age, in seconds (default: 0 => allow immediate password change)", 
+               "sambaMinPwdAge" },
+               
+       {AP_LOCK_ACCOUNT_DURATION, "lockout duration", 30,
+               "Lockout duration in minutes (default: 30, -1 => forever)",
+               "sambaLockoutDuration" },
+               
+       {AP_RESET_COUNT_TIME, "reset count minutes", 30,
+               "Reset time after lockout in minutes (default: 30)", 
+               "sambaLockoutObservationWindow" },
+               
+       {AP_BAD_ATTEMPT_LOCKOUT, "bad lockout attempt", 0,
+               "Lockout users after bad logon attempts (default: 0 => off)", 
+               "sambaLockoutThreshold" },
+               
+       {AP_TIME_TO_LOGOUT, "disconnect time", (uint32) -1,
+               "Disconnect Users outside logon hours (default: -1 => off, 0 => on)", 
+               "sambaForceLogoff" }, 
+               
+       {AP_REFUSE_MACHINE_PW_CHANGE, "refuse machine password change", 0,
+               "Allow Machine Password changes (default: 0 => off)",
+               "sambaRefuseMachinePwdChange" },
+               
+       {0, NULL, 0, "", NULL}
+};
 
-       return True;
-}
+void account_policy_names_list(const char ***names, int *num_names)
+{      
+       const char **nl;
+       int i, count;
 
-static const struct {
-       int field;
-       const char *string;
-} account_policy_names[] = {
-       {AP_MIN_PASSWORD_LEN, "min password length"},
-       {AP_PASSWORD_HISTORY, "password history"},
-       {AP_USER_MUST_LOGON_TO_CHG_PASS, "user must logon to change password"},
-       {AP_MAX_PASSWORD_AGE, "maximum password age"},
-       {AP_MIN_PASSWORD_AGE,"minimum password age"},
-       {AP_LOCK_ACCOUNT_DURATION, "lockout duration"},
-       {AP_RESET_COUNT_TIME, "reset count minutes"},
-       {AP_BAD_ATTEMPT_LOCKOUT, "bad lockout attempt"},
-       {AP_TIME_TO_LOGOUT, "disconnect time"},
-       {0, NULL}
-};
+       for (count=0; account_policy_names[count].string; count++) {
+       }
+       nl = SMB_MALLOC_ARRAY(const char *, count);
+       if (!nl) {
+               *num_names = 0;
+               return;
+       }
+       for (i=0; account_policy_names[i].string; i++) {
+               nl[i] = account_policy_names[i].string;
+       }
+       *num_names = count;
+       *names = nl;
+       return;
+}
 
 /****************************************************************************
 Get the account policy name as a string from its #define'ed number
 ****************************************************************************/
 
-static const char *decode_account_policy_name(int field)
+const char *decode_account_policy_name(int field)
 {
        int i;
        for (i=0; account_policy_names[i].string; i++) {
-               if (field == account_policy_names[i].field)
+               if (field == account_policy_names[i].field) {
                        return account_policy_names[i].string;
+               }
+       }
+       return NULL;
+}
+
+/****************************************************************************
+Get the account policy LDAP attribute as a string from its #define'ed number
+****************************************************************************/
+
+const char *get_account_policy_attr(int field)
+{
+       int i;
+       for (i=0; account_policy_names[i].field; i++) {
+               if (field == account_policy_names[i].field) {
+                       return account_policy_names[i].ldap_attr;
+               }
        }
        return NULL;
+}
 
+/****************************************************************************
+Get the account policy description as a string from its #define'ed number
+****************************************************************************/
+
+const char *account_policy_get_desc(int field)
+{
+       int i;
+       for (i=0; account_policy_names[i].string; i++) {
+               if (field == account_policy_names[i].field) {
+                       return account_policy_names[i].description;
+               }
+       }
+       return NULL;
 }
 
 /****************************************************************************
@@ -104,59 +155,257 @@ int account_policy_name_to_fieldnum(const char *name)
 {
        int i;
        for (i=0; account_policy_names[i].string; i++) {
-               if (strcmp(name, account_policy_names[i].string) == 0)
+               if (strcmp(name, account_policy_names[i].string) == 0) {
                        return account_policy_names[i].field;
+               }
        }
        return 0;
+}
+
+/*****************************************************************************
+Get default value for account policy
+*****************************************************************************/
 
+bool account_policy_get_default(int account_policy, uint32 *val)
+{
+       int i;
+       for (i=0; account_policy_names[i].field; i++) {
+               if (account_policy_names[i].field == account_policy) {
+                       *val = account_policy_names[i].default_val;
+                       return True;
+               }
+       }
+       DEBUG(0,("no default for account_policy index %d found. This should never happen\n", 
+               account_policy));
+       return False;
 }
 
+/*****************************************************************************
+ Set default for a field if it is empty
+*****************************************************************************/
 
-/****************************************************************************
-****************************************************************************/
-BOOL account_policy_get(int field, uint32 *value)
+static bool account_policy_set_default_on_empty(int account_policy)
+{
+
+       uint32 value;
+
+       if (!account_policy_get(account_policy, &value) && 
+           !account_policy_get_default(account_policy, &value)) {
+               return False;
+       }
+
+       return account_policy_set(account_policy, value);
+}
+
+/*****************************************************************************
+ Open the account policy tdb.
+***`*************************************************************************/
+
+bool init_account_policy(void)
+{
+
+       const char *vstring = "INFO/version";
+       uint32 version;
+       int i;
+
+       if (tdb) {
+               return True;
+       }
+
+       tdb = tdb_open_log(lock_path("account_policy.tdb"), 0, TDB_DEFAULT, O_RDWR, 0600);
+       if (!tdb) { /* the account policies files does not exist or open failed, try to create a new one */
+               tdb = tdb_open_log(lock_path("account_policy.tdb"), 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0600);
+               if (!tdb) {
+                       DEBUG(0,("Failed to open account policy database\n"));
+                       return False;
+               }
+       }
+
+       /* handle a Samba upgrade */
+       tdb_lock_bystring(tdb, vstring);
+       if (!tdb_fetch_uint32(tdb, vstring, &version) || version != DATABASE_VERSION) {
+
+               tdb_store_uint32(tdb, vstring, DATABASE_VERSION);
+
+               for (i=0; account_policy_names[i].field; i++) {
+
+                       if (!account_policy_set_default_on_empty(account_policy_names[i].field)) {
+                               DEBUG(0,("failed to set default value in account policy tdb\n"));
+                               return False;
+                       }
+               }
+       }
+
+       tdb_unlock_bystring(tdb, vstring);
+
+       /* These exist by default on NT4 in [HKLM\SECURITY\Policy\Accounts] */
+
+       privilege_create_account( &global_sid_World );
+       privilege_create_account( &global_sid_Builtin_Account_Operators );
+       privilege_create_account( &global_sid_Builtin_Server_Operators );
+       privilege_create_account( &global_sid_Builtin_Print_Operators );
+       privilege_create_account( &global_sid_Builtin_Backup_Operators );
+
+       /* BUILTIN\Administrators get everything -- *always* */
+
+       if ( lp_enable_privileges() ) {
+               if ( !grant_all_privileges( &global_sid_Builtin_Administrators ) ) {
+                       DEBUG(1,("init_account_policy: Failed to grant privileges "
+                               "to BUILTIN\\Administrators!\n"));
+               }
+       }
+
+       return True;
+}
+
+/*****************************************************************************
+Get an account policy (from tdb) 
+*****************************************************************************/
+
+bool account_policy_get(int field, uint32 *value)
 {
-       fstring name;
+       const char *name;
+       uint32 regval;
 
-       init_account_policy();
+       if (!init_account_policy()) {
+               return False;
+       }
 
-       *value = 0;
+       if (value) {
+               *value = 0;
+       }
 
-       fstrcpy(name, decode_account_policy_name(field));
-       if (!*name) {
+       name = decode_account_policy_name(field);
+       if (name == NULL) {
                DEBUG(1, ("account_policy_get: Field %d is not a valid account policy type!  Cannot get, returning 0.\n", field));
                return False;
        }
-       if (!tdb_fetch_uint32(tdb, name, value)) {
-               DEBUG(1, ("account_policy_get: tdb_fetch_uint32 failed for efild %d (%s), returning 0", field, name));
+       
+       if (!tdb_fetch_uint32(tdb, name, &regval)) {
+               DEBUG(1, ("account_policy_get: tdb_fetch_uint32 failed for field %d (%s), returning 0\n", field, name));
                return False;
        }
-       DEBUG(10,("account_policy_get: %s:%d\n", name, *value));
+       
+       if (value) {
+               *value = regval;
+       }
+
+       DEBUG(10,("account_policy_get: name: %s, val: %d\n", name, regval));
        return True;
 }
 
 
 /****************************************************************************
+Set an account policy (in tdb) 
 ****************************************************************************/
-BOOL account_policy_set(int field, uint32 value)
+
+bool account_policy_set(int field, uint32 value)
 {
-       fstring name;
+       const char *name;
 
-       init_account_policy();
+       if (!init_account_policy()) {
+               return False;
+       }
 
-       fstrcpy(name, decode_account_policy_name(field));
-       if (!*name) {
+       name = decode_account_policy_name(field);
+       if (name == NULL) {
                DEBUG(1, ("Field %d is not a valid account policy type!  Cannot set.\n", field));
                return False;
        }
 
        if (!tdb_store_uint32(tdb, name, value)) {
-               DEBUG(1, ("tdb_store_uint32 failed for field %d (%s) on value %u", field, name, value));
+               DEBUG(1, ("tdb_store_uint32 failed for field %d (%s) on value %u\n", field, name, value));
                return False;
        }
 
-       DEBUG(10,("account_policy_set: %s:%d\n", name, value));
+       DEBUG(10,("account_policy_set: name: %s, value: %d\n", name, value));
        
        return True;
 }
 
+/****************************************************************************
+Set an account policy in the cache 
+****************************************************************************/
+
+bool cache_account_policy_set(int field, uint32 value)
+{
+       const char *policy_name = NULL;
+       char *cache_key = NULL;
+       char *cache_value = NULL;
+       bool ret = False;
+
+       policy_name = decode_account_policy_name(field);
+       if (policy_name == NULL) {
+               DEBUG(0,("cache_account_policy_set: no policy found\n"));
+               return False;
+       }
+
+       if (asprintf(&cache_key, "ACCT_POL/%s", policy_name) < 0) {
+               DEBUG(0, ("asprintf failed\n"));
+               goto done;
+       }
+
+       if (asprintf(&cache_value, "%lu\n", (unsigned long)value) < 0) {
+               DEBUG(0, ("asprintf failed\n"));
+               goto done;
+       }
+
+       DEBUG(10,("cache_account_policy_set: updating account pol cache\n"));
+
+       ret = gencache_set(cache_key, cache_value, time(NULL)+AP_TTL);
+
+ done:
+       SAFE_FREE(cache_key);
+       SAFE_FREE(cache_value);
+       return ret;
+}
+
+/*****************************************************************************
+Get an account policy from the cache 
+*****************************************************************************/
+
+bool cache_account_policy_get(int field, uint32 *value)
+{
+       const char *policy_name = NULL;
+       char *cache_key = NULL;
+       char *cache_value = NULL;
+       bool ret = False;
+
+       policy_name = decode_account_policy_name(field);
+       if (policy_name == NULL) {
+               DEBUG(0,("cache_account_policy_set: no policy found\n"));
+               return False;
+       }
+
+       if (asprintf(&cache_key, "ACCT_POL/%s", policy_name) < 0) {
+               DEBUG(0, ("asprintf failed\n"));
+               goto done;
+       }
+
+       if (gencache_get(cache_key, &cache_value, NULL)) {
+               uint32 tmp = strtoul(cache_value, NULL, 10);
+               *value = tmp;
+               ret = True;
+       }
+
+ done:
+       SAFE_FREE(cache_key);
+       SAFE_FREE(cache_value);
+       return ret;
+}
+
+/****************************************************************************
+****************************************************************************/
+
+TDB_CONTEXT *get_account_pol_tdb( void )
+{
+
+       if ( !tdb ) {
+               if ( !init_account_policy() ) {
+                       return NULL;
+               }
+       }
+
+       return tdb;
+}
+