source3/include/passdb.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    passdb structures and parameters
   4    Copyright (C) Gerald Carter 2001
   5    Copyright (C) Luke Kenneth Casson Leighton 1998 - 2000
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #ifndef _PASSDB_H
  23 #define _PASSDB_H
  24
  25
  26 /*****************************************************************
  27  Functions to be implemented by the new (v2) passdb API
  28 ****************************************************************/
  29
  30 typedef struct pdb_context
  31 {
  32     struct pdb_methods *pdb_methods;
  33         struct pdb_methods *pwent_methods;
  34
  35         /* These functions are wrappers for the functions listed above.
  36            They may do extra things like re-reading a SAM_ACCOUNT on update */
  37
  38         BOOL (*pdb_setsampwent)(struct pdb_context *, BOOL update);
  39
  40         void (*pdb_endsampwent)(struct pdb_context *);
  41
  42         BOOL (*pdb_getsampwent)(struct pdb_context *, SAM_ACCOUNT *user);
  43
  44         BOOL (*pdb_getsampwnam)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const char *username);
  45
  46         BOOL (*pdb_getsampwrid)(struct pdb_context *, SAM_ACCOUNT *sam_acct, uint32 rid);
  47
  48         BOOL (*pdb_add_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
  49
  50         BOOL (*pdb_update_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
  51
  52         BOOL (*pdb_delete_sam_account)(struct pdb_context *, SAM_ACCOUNT *username);
  53
  54         void (*free_fn)(struct pdb_context **);
  55
  56         TALLOC_CTX *mem_ctx;
  57
  58 } PDB_CONTEXT;
  59
  60 typedef struct pdb_methods
  61 {
  62         const char *name; /* What name got this module */
  63     struct pdb_context *parent;
  64
  65         /* Use macros from dlinklist.h on these two */
  66         struct pdb_methods *next;
  67         struct pdb_methods *prev;
  68
  69         BOOL (*setsampwent)(struct pdb_methods *, BOOL update);
  70
  71         void (*endsampwent)(struct pdb_methods *);
  72
  73         BOOL (*getsampwent)(struct pdb_methods *, SAM_ACCOUNT *user);
  74
  75         BOOL (*getsampwnam)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const char *username);
  76
  77         BOOL (*getsampwrid)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, uint32 rid);
  78
  79         BOOL (*add_sam_account)(struct pdb_methods *, const SAM_ACCOUNT *sampass);
  80
  81         BOOL (*update_sam_account)(struct pdb_methods *, const SAM_ACCOUNT *sampass);
  82
  83         BOOL (*delete_sam_account)(struct pdb_methods *, const SAM_ACCOUNT *username);
  84
  85         void *private_data;  /* Private data of some kind */
  86
  87         void (*free_private_data)(void **);
  88
  89 } PDB_METHODS;
  90
  91 typedef NTSTATUS (*pdb_init_function)(struct pdb_context *,
  92                          struct pdb_methods **,
  93                          const char *);
  94
  95 struct pdb_init_function_entry {
  96         char *name;
  97         /* Function to create a member of the authmethods list */
  98         NTSTATUS (*init)(struct pdb_context *pdb_context,
  99                          struct pdb_methods **pdb_method,
 100                          const char *location);
 101 };
 102
 103 #endif /* _PASSDB_H */