source3/include/reg_objects.h

   1 /*
   2    Samba's Internal Registry objects
   3
   4    SMB parameters and setup
   5    Copyright (C) Gerald Carter                   2002-2006.
   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 3 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, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef _REG_OBJECTS_H /* _REG_OBJECTS_H */
  22 #define _REG_OBJECTS_H
  23
  24 /* structure to contain registry values */
  25
  26 typedef struct {
  27         fstring         valuename;
  28         uint16          type;
  29         /* this should be encapsulated in an RPC_DATA_BLOB */
  30         uint32          size;   /* in bytes */
  31         uint8           *data_p;
  32 } REGISTRY_VALUE;
  33
  34 /*
  35  * A REG_SZ string is not necessarily NULL terminated. When retrieving it from
  36  * the net, we guarantee this however. A server might want to push it without
  37  * the terminator though.
  38  */
  39
  40 struct registry_string {
  41         size_t len;
  42         char *str;
  43 };
  44
  45 struct registry_value {
  46         enum winreg_Type type;
  47         union {
  48                 uint32 dword;
  49                 uint64 qword;
  50                 struct registry_string sz;
  51                 struct {
  52                         uint32 num_strings;
  53                         char **strings;
  54                 } multi_sz;
  55                 DATA_BLOB binary;
  56         } v;
  57 };
  58
  59 /* container for registry values */
  60
  61 typedef struct {
  62         uint32          num_values;
  63         REGISTRY_VALUE  **values;
  64         int seqnum;
  65 } REGVAL_CTR;
  66
  67 /* container for registry subkey names */
  68
  69 typedef struct {
  70         uint32          num_subkeys;
  71         char            **subkeys;
  72         int seqnum;
  73 } REGSUBKEY_CTR;
  74
  75 /*
  76  *
  77  * Macros that used to reside in rpc_reg.h
  78  *
  79  */
  80
  81 #define HKEY_CLASSES_ROOT       0x80000000
  82 #define HKEY_CURRENT_USER       0x80000001
  83 #define HKEY_LOCAL_MACHINE      0x80000002
  84 #define HKEY_USERS              0x80000003
  85 #define HKEY_PERFORMANCE_DATA   0x80000004
  86
  87 #define KEY_HKLM                "HKLM"
  88 #define KEY_HKU                 "HKU"
  89 #define KEY_HKCC                "HKCC"
  90 #define KEY_HKCR                "HKCR"
  91 #define KEY_HKPD                "HKPD"
  92 #define KEY_HKPT                "HKPT"
  93 #define KEY_HKPN                "HKPN"
  94 #define KEY_HKCU                "HKCU"
  95 #define KEY_HKDD                "HKDD"
  96 #define KEY_SERVICES            "HKLM\\SYSTEM\\CurrentControlSet\\Services"
  97 #define KEY_PRINTING            "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print"
  98 #define KEY_PRINTING_2K         "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Print\\Printers"
  99 #define KEY_PRINTING_PORTS      "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Ports"
 100 #define KEY_EVENTLOG            "HKLM\\SYSTEM\\CurrentControlSet\\Services\\Eventlog"
 101 #define KEY_SHARES              "HKLM\\SYSTEM\\CurrentControlSet\\Services\\LanmanServer\\Shares"
 102 #define KEY_SMBCONF             "HKLM\\SOFTWARE\\Samba\\smbconf"
 103 #define KEY_TREE_ROOT           ""
 104
 105 /*
 106  * Registry key types
 107  *      Most keys are going to be GENERIC -- may need a better name?
 108  *      HKPD and HKPT are used by reg_perfcount.c
 109  *              they are special keys that contain performance data
 110  */
 111 #define REG_KEY_GENERIC         0
 112 #define REG_KEY_HKPD            1
 113 #define REG_KEY_HKPT            2
 114
 115 /*
 116  * container for function pointers to enumeration routines
 117  * for virtual registry view
 118  */
 119
 120 typedef struct {
 121         /* functions for enumerating subkeys and values */
 122         int     (*fetch_subkeys)( const char *key, REGSUBKEY_CTR *subkeys);
 123         int     (*fetch_values) ( const char *key, REGVAL_CTR *val );
 124         bool    (*store_subkeys)( const char *key, REGSUBKEY_CTR *subkeys );
 125         bool    (*store_values)( const char *key, REGVAL_CTR *val );
 126         bool    (*reg_access_check)( const char *keyname, uint32 requested,
 127                                      uint32 *granted,
 128                                      const NT_USER_TOKEN *token );
 129         WERROR (*get_secdesc)(TALLOC_CTX *mem_ctx, const char *key,
 130                               struct security_descriptor **psecdesc);
 131         WERROR (*set_secdesc)(const char *key,
 132                               struct security_descriptor *sec_desc);
 133         bool    (*subkeys_need_update)(REGSUBKEY_CTR *subkeys);
 134         bool    (*values_need_update)(REGVAL_CTR *values);
 135 } REGISTRY_OPS;
 136
 137 typedef struct {
 138         const char      *keyname;       /* full path to name of key */
 139         REGISTRY_OPS    *ops;           /* registry function hooks */
 140 } REGISTRY_HOOK;
 141
 142
 143 /* structure to store the registry handles */
 144
 145 typedef struct _RegistryKey {
 146         uint32          type;
 147         char            *name;          /* full name of registry key */
 148         uint32          access_granted;
 149         REGISTRY_HOOK   *hook;
 150 } REGISTRY_KEY;
 151
 152 struct registry_key {
 153         REGISTRY_KEY *key;
 154         REGSUBKEY_CTR *subkeys;
 155         REGVAL_CTR *values;
 156         struct nt_user_token *token;
 157 };
 158
 159 #endif /* _REG_OBJECTS_H */