s3-passdb: remove unused (now samr.idl) ACCT_NT/LM_PWD_SET flags.
[kai/samba.git] / source3 / include / passdb.h
index 06409aa34eb9c892ad8ba56615674bc33f404f25..744b723c83f6cd5d154ca9c7a61afefcbf921ca8 100644 (file)
@@ -3,10 +3,12 @@
    passdb structures and parameters
    Copyright (C) Gerald Carter 2001
    Copyright (C) Luke Kenneth Casson Leighton 1998 - 2000
+   Copyright (C) Andrew Bartlett 2002
+   Copyright (C) Simo Sorce 2003
    
    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/>.
 */
 
 #ifndef _PASSDB_H
 #define _PASSDB_H
 
+/*
+ * bit flags representing initialized fields in struct samu
+ */
+enum pdb_elements {
+       PDB_UNINIT,
+       PDB_SMBHOME,
+       PDB_PROFILE,
+       PDB_DRIVE,
+       PDB_LOGONSCRIPT,
+       PDB_LOGONTIME,
+       PDB_LOGOFFTIME,
+       PDB_KICKOFFTIME,
+       PDB_BAD_PASSWORD_TIME,
+       PDB_CANCHANGETIME,
+       PDB_MUSTCHANGETIME,
+       PDB_PLAINTEXT_PW,
+       PDB_USERNAME,
+       PDB_FULLNAME,
+       PDB_DOMAIN,
+       PDB_NTUSERNAME,
+       PDB_HOURSLEN,
+       PDB_LOGONDIVS,
+       PDB_USERSID,
+       PDB_GROUPSID,
+       PDB_ACCTCTRL,
+       PDB_PASSLASTSET,
+       PDB_ACCTDESC,
+       PDB_WORKSTATIONS,
+       PDB_COMMENT,
+       PDB_MUNGEDDIAL,
+       PDB_HOURS,
+       PDB_FIELDS_PRESENT,
+       PDB_BAD_PASSWORD_COUNT,
+       PDB_LOGON_COUNT,
+       PDB_UNKNOWN6,
+       PDB_LMPASSWD,
+       PDB_NTPASSWD,
+       PDB_PWHISTORY,
+       PDB_BACKEND_PRIVATE_DATA,
+
+       /* this must be the last element */
+       PDB_COUNT
+};
+
+enum pdb_group_elements {
+       PDB_GROUP_NAME,
+       PDB_GROUP_SID,
+       PDB_GROUP_SID_NAME_USE,
+       PDB_GROUP_MEMBERS,
+
+       /* this must be the last element */
+       PDB_GROUP_COUNT
+};
+
+
+enum pdb_value_state {
+       PDB_DEFAULT=0,
+       PDB_SET,
+       PDB_CHANGED
+};
+
+#define IS_SAM_SET(x, flag)    (pdb_get_init_flags(x, flag) == PDB_SET)
+#define IS_SAM_CHANGED(x, flag)        (pdb_get_init_flags(x, flag) == PDB_CHANGED)
+#define IS_SAM_DEFAULT(x, flag)        (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
+
+/* cache for bad password lockout data, to be used on replicated SAMs */
+typedef struct logon_cache_struct {
+       time_t entry_timestamp;
+       uint32 acct_ctrl;
+       uint16 bad_password_count;
+       time_t bad_password_time;
+} LOGIN_CACHE;
+               
+struct samu {
+       struct pdb_methods *methods;
+
+       /* initialization flags */
+       struct bitmap *change_flags;
+       struct bitmap *set_flags;
+
+       time_t logon_time;            /* logon time */
+       time_t logoff_time;           /* logoff time */
+       time_t kickoff_time;          /* kickoff time */
+       time_t bad_password_time;     /* last bad password entered */
+       time_t pass_last_set_time;    /* password last set time */
+       time_t pass_can_change_time;  /* password can change time */
+       time_t pass_must_change_time; /* password must change time */
+               
+       const char *username;     /* UNIX username string */
+       const char *domain;       /* Windows Domain name */
+       const char *nt_username;  /* Windows username string */
+       const char *full_name;    /* user's full name string */
+       const char *home_dir;     /* home directory string */
+       const char *dir_drive;    /* home directory drive string */
+       const char *logon_script; /* logon script string */
+       const char *profile_path; /* profile path string */
+       const char *acct_desc;    /* user description string */
+       const char *workstations; /* login from workstations string */
+       const char *comment;
+       const char *munged_dial;  /* munged path name and dial-back tel number */
+               
+       DOM_SID user_sid;  
+       DOM_SID *group_sid;
+               
+       DATA_BLOB lm_pw; /* .data is Null if no password */
+       DATA_BLOB nt_pw; /* .data is Null if no password */
+       DATA_BLOB nt_pw_his; /* nt hashed password history .data is Null if not available */
+       char* plaintext_pw; /* is Null if not available */
+               
+       uint32 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
+       uint32 fields_present; /* 0x00ff ffff */
+               
+       uint16 logon_divs; /* 168 - number of hours in a week */
+       uint32 hours_len; /* normally 21 bytes */
+       uint8 hours[MAX_HOURS_LEN];
+       
+       /* Was unknown_5. */
+       uint16 bad_password_count;
+       uint16 logon_count;
+
+       uint32 unknown_6; /* 0x0000 04ec */
+
+       /* a tag for who added the private methods */
+
+       const struct pdb_methods *backend_private_methods;
+       void *backend_private_data; 
+       void (*backend_private_data_free_fn)(void **);
+       
+       /* maintain a copy of the user's struct passwd */
+
+       struct passwd *unix_pw;
+};
+
+struct acct_info {
+       fstring acct_name; /* account name */
+       fstring acct_desc; /* account name */
+       uint32 rid; /* domain-relative RID */
+};
+
+struct samr_displayentry {
+       uint32 idx;
+       uint32 rid;
+       uint32 acct_flags;
+       const char *account_name;
+       const char *fullname;
+       const char *description;
+};
+
+enum pdb_search_type {
+       PDB_USER_SEARCH,
+       PDB_GROUP_SEARCH,
+       PDB_ALIAS_SEARCH
+};
+
+struct pdb_search {
+       TALLOC_CTX *mem_ctx;
+       enum pdb_search_type type;
+       struct samr_displayentry *cache;
+       uint32 num_entries;
+       ssize_t cache_size;
+       bool search_ended;
+       void *private_data;
+       bool (*next_entry)(struct pdb_search *search,
+                          struct samr_displayentry *entry);
+       void (*search_end)(struct pdb_search *search);
+};
 
 /*****************************************************************
  Functions to be implemented by the new (v2) passdb API 
 /*
  * This next constant specifies the version number of the PASSDB interface
  * this SAMBA will load. Increment this if *ANY* changes are made to the interface. 
+ * Changed interface to fix int -> size_t problems. JRA.
+ * There's no point in allocating arrays in
+ * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
+ * the pdb module. Remove the latter, this might happen more often. VL.
+ * changed to version 14 to move lookup_rids and lookup_names to return
+ * enum lsa_SidType rather than uint32.
+ * Changed to 16 for access to the trusted domain passwords (obnox).
+ * Changed to 17, the sampwent interface is gone.
  */
 
-#define PASSDB_INTERFACE_VERSION 4
+#define PASSDB_INTERFACE_VERSION 17
 
-typedef struct pdb_context 
+struct pdb_methods 
 {
-       struct pdb_methods *pdb_methods;
-       struct pdb_methods *pwent_methods;
-       
-       /* These functions are wrappers for the functions listed above.
-          They may do extra things like re-reading a SAM_ACCOUNT on update */
+       const char *name; /* What name got this module */
 
-       NTSTATUS (*pdb_setsampwent)(struct pdb_context *, BOOL update);
-       
-       void (*pdb_endsampwent)(struct pdb_context *);
-       
-       NTSTATUS (*pdb_getsampwent)(struct pdb_context *, SAM_ACCOUNT *user);
-       
-       NTSTATUS (*pdb_getsampwnam)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const char *username);
+       NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
        
-       NTSTATUS (*pdb_getsampwsid)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
-       
-       NTSTATUS (*pdb_add_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
-       
-       NTSTATUS (*pdb_update_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
-       
-       NTSTATUS (*pdb_delete_sam_account)(struct pdb_context *, SAM_ACCOUNT *username);
+       NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const DOM_SID *sid);
 
-       NTSTATUS (*pdb_getgrsid)(struct pdb_context *context, GROUP_MAP *map,
-                                DOM_SID sid, BOOL with_priv);
-       
-       NTSTATUS (*pdb_getgrgid)(struct pdb_context *context, GROUP_MAP *map,
-                                gid_t gid, BOOL with_priv);
-       
-       NTSTATUS (*pdb_getgrnam)(struct pdb_context *context, GROUP_MAP *map,
-                                char *name, BOOL with_priv);
+       NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
+                               const char *name, uint32 acct_flags,
+                               uint32 *rid);
+
+       NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
+                               struct samu *sam_acct);
        
-       NTSTATUS (*pdb_add_group_mapping_entry)(struct pdb_context *context,
-                                               GROUP_MAP *map);
+       NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
        
-       NTSTATUS (*pdb_update_group_mapping_entry)(struct pdb_context *context,
-                                                  GROUP_MAP *map);
+       NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
        
-       NTSTATUS (*pdb_delete_group_mapping_entry)(struct pdb_context *context,
-                                                  DOM_SID sid);
+       NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
        
-       NTSTATUS (*pdb_enum_group_mapping)(struct pdb_context *context,
-                                          enum SID_NAME_USE sid_name_use,
-                                          GROUP_MAP **rmap, int *num_entries,
-                                          BOOL unix_only, BOOL with_priv);
-
-       void (*free_fn)(struct pdb_context **);
-       
-       TALLOC_CTX *mem_ctx;
+       NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
        
-} PDB_CONTEXT;
+       NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, bool success);
 
-typedef struct pdb_methods 
-{
-       const char *name; /* What name got this module */
-       struct pdb_context *parent;
+       NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
 
-       /* Use macros from dlinklist.h on these two */
-       struct pdb_methods *next;
-       struct pdb_methods *prev;
+       NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
 
-       NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update);
-       
-       void (*endsampwent)(struct pdb_methods *);
-       
-       NTSTATUS (*getsampwent)(struct pdb_methods *, SAM_ACCOUNT *user);
-       
-       NTSTATUS (*getsampwnam)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const char *username);
-       
-       NTSTATUS (*getsampwsid)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const DOM_SID *Sid);
-       
-       NTSTATUS (*add_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
-       
-       NTSTATUS (*update_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
-       
-       NTSTATUS (*delete_sam_account)(struct pdb_methods *, SAM_ACCOUNT *username);
-       
-       NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map,
-                            DOM_SID sid, BOOL with_priv);
+       NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
 
-       NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map,
-                            gid_t gid, BOOL with_priv);
+       NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
+                                    TALLOC_CTX *mem_ctx, const char *name,
+                                    uint32 *rid);
 
-       NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map,
-                            char *name, BOOL with_priv);
+       NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
+                                    TALLOC_CTX *mem_ctx, uint32 rid);
 
        NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
                                            GROUP_MAP *map);
@@ -131,24 +257,132 @@ typedef struct pdb_methods
                                               DOM_SID sid);
 
        NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
-                                      enum SID_NAME_USE sid_name_use,
-                                      GROUP_MAP **rmap, int *num_entries,
-                                      BOOL unix_only, BOOL with_priv);
+                                      const DOM_SID *sid, enum lsa_SidType sid_name_use,
+                                      GROUP_MAP **pp_rmap, size_t *p_num_entries,
+                                      bool unix_only);
+
+       NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
+                                      TALLOC_CTX *mem_ctx,
+                                      const DOM_SID *group,
+                                      uint32 **pp_member_rids,
+                                      size_t *p_num_members);
+
+       NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
+                                          TALLOC_CTX *mem_ctx,
+                                          struct samu *user,
+                                          DOM_SID **pp_sids, gid_t **pp_gids,
+                                          size_t *p_num_groups);
+
+       NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
+                                          TALLOC_CTX *mem_ctx,
+                                          struct samu *user);
+
+       NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
+                                TALLOC_CTX *mem_ctx,
+                                uint32 group_rid, uint32 member_rid);
+
+       NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
+                                TALLOC_CTX *mem_ctx,
+                                uint32 group_rid, uint32 member_rid);
+
+       NTSTATUS (*create_alias)(struct pdb_methods *methods,
+                                const char *name, uint32 *rid);
+
+       NTSTATUS (*delete_alias)(struct pdb_methods *methods,
+                                const DOM_SID *sid);
+
+       NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
+                                 const DOM_SID *sid,
+                                 struct acct_info *info);
+
+       NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
+                                 const DOM_SID *sid,
+                                 struct acct_info *info);
+
+       NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
+                                const DOM_SID *alias, const DOM_SID *member);
+       NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
+                                const DOM_SID *alias, const DOM_SID *member);
+       NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
+                                 const DOM_SID *alias, DOM_SID **members,
+                                 size_t *p_num_members);
+       NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
+                                          TALLOC_CTX *mem_ctx,
+                                          const DOM_SID *domain_sid,
+                                          const DOM_SID *members,
+                                          size_t num_members,
+                                          uint32 **pp_alias_rids,
+                                          size_t *p_num_alias_rids);
+
+       NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
+                               const DOM_SID *domain_sid,
+                               int num_rids,
+                               uint32 *rids,
+                               const char **pp_names,
+                               enum lsa_SidType *attrs);
+
+       NTSTATUS (*lookup_names)(struct pdb_methods *methods,
+                                const DOM_SID *domain_sid,
+                                int num_names,
+                                const char **pp_names,
+                                uint32 *rids,
+                                enum lsa_SidType *attrs);
+
+       NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
+                                      int policy_index, uint32 *value);
+
+       NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
+                                      int policy_index, uint32 value);
+
+       NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
+
+       bool (*search_users)(struct pdb_methods *methods,
+                            struct pdb_search *search,
+                            uint32 acct_flags);
+       bool (*search_groups)(struct pdb_methods *methods,
+                             struct pdb_search *search);
+       bool (*search_aliases)(struct pdb_methods *methods,
+                              struct pdb_search *search,
+                              const DOM_SID *sid);
+
+       bool (*uid_to_rid)(struct pdb_methods *methods, uid_t uid,
+                          uint32 *rid);
+       bool (*uid_to_sid)(struct pdb_methods *methods, uid_t uid,
+                          DOM_SID *sid);
+       bool (*gid_to_sid)(struct pdb_methods *methods, gid_t gid,
+                          DOM_SID *sid);
+       bool (*sid_to_id)(struct pdb_methods *methods, const DOM_SID *sid,
+                         union unid_t *id, enum lsa_SidType *type);
+
+       bool (*rid_algorithm)(struct pdb_methods *methods);
+       bool (*new_rid)(struct pdb_methods *methods, uint32 *rid);
+
+
+       bool (*get_trusteddom_pw)(struct pdb_methods *methods,
+                                 const char *domain, char** pwd, 
+                                 DOM_SID *sid, time_t *pass_last_set_time);
+       bool (*set_trusteddom_pw)(struct pdb_methods *methods, 
+                                 const char* domain, const char* pwd,
+                                 const DOM_SID *sid);
+       bool (*del_trusteddom_pw)(struct pdb_methods *methods, 
+                                 const char *domain);
+       NTSTATUS (*enum_trusteddoms)(struct pdb_methods *methods,
+                                    TALLOC_CTX *mem_ctx, uint32 *num_domains,
+                                    struct trustdom_info ***domains);
 
        void *private_data;  /* Private data of some kind */
        
        void (*free_private_data)(void **);
+};
 
-} PDB_METHODS;
-
-typedef NTSTATUS (*pdb_init_function)(struct pdb_context *, 
-                        struct pdb_methods **, 
-                        const char *);
+typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
 
 struct pdb_init_function_entry {
        const char *name;
+
        /* Function to create a member of the pdb_methods list */
        pdb_init_function init;
+
        struct pdb_init_function_entry *prev, *next;
 };