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 /* low level structure to contain registry values */
  25
  26 struct regval_blob;
  27
  28 /*
  29  * A REG_SZ string is not necessarily NULL terminated. When retrieving it from
  30  * the net, we guarantee this however. A server might want to push it without
  31  * the terminator though.
  32  */
  33
  34 struct registry_string {
  35         size_t len;
  36         char *str;
  37 };
  38
  39 struct registry_value {
  40         enum winreg_Type type;
  41         union {
  42                 uint32 dword;
  43                 uint64 qword;
  44                 struct registry_string sz;
  45                 struct {
  46                         uint32 num_strings;
  47                         char **strings;
  48                 } multi_sz;
  49                 DATA_BLOB binary;
  50         } v;
  51 };
  52
  53 /* container for registry values */
  54
  55 struct regval_ctr;
  56
  57 /* container for registry subkey names */
  58
  59 struct regsubkey_ctr;
  60
  61 /*
  62  *
  63  * Macros that used to reside in rpc_reg.h
  64  *
  65  */
  66
  67 #define HKEY_CLASSES_ROOT       0x80000000
  68 #define HKEY_CURRENT_USER       0x80000001
  69 #define HKEY_LOCAL_MACHINE      0x80000002
  70 #define HKEY_USERS              0x80000003
  71 #define HKEY_PERFORMANCE_DATA   0x80000004
  72
  73 #define KEY_HKLM                "HKLM"
  74 #define KEY_HKU                 "HKU"
  75 #define KEY_HKCC                "HKCC"
  76 #define KEY_HKCR                "HKCR"
  77 #define KEY_HKPD                "HKPD"
  78 #define KEY_HKPT                "HKPT"
  79 #define KEY_HKPN                "HKPN"
  80 #define KEY_HKCU                "HKCU"
  81 #define KEY_HKDD                "HKDD"
  82 #define KEY_SERVICES            "HKLM\\SYSTEM\\CurrentControlSet\\Services"
  83 #define KEY_EVENTLOG            "HKLM\\SYSTEM\\CurrentControlSet\\Services\\Eventlog"
  84 #define KEY_SHARES              "HKLM\\SYSTEM\\CurrentControlSet\\Services\\LanmanServer\\Shares"
  85 #define KEY_NETLOGON_PARAMS     "HKLM\\SYSTEM\\CurrentControlSet\\Services\\Netlogon\\Parameters"
  86 #define KEY_TCPIP_PARAMS        "HKLM\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters"
  87 #define KEY_PROD_OPTIONS        "HKLM\\SYSTEM\\CurrentControlSet\\Control\\ProductOptions"
  88 #define KEY_PRINTING            "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print"
  89 #define KEY_PRINTING_2K         "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Print\\Printers"
  90 #define KEY_PRINTING_PORTS      "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Ports"
  91 #define KEY_CURRENT_VERSION     "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion"
  92 #define KEY_PERFLIB             "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Perflib"
  93 #define KEY_PERFLIB_009         "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Perflib\\009"
  94 #define KEY_GROUP_POLICY        "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Group Policy"
  95 #define KEY_WINLOGON            "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Winlogon"
  96 #define KEY_SMBCONF             "HKLM\\SOFTWARE\\Samba\\smbconf"
  97 #define KEY_SAMBA_GROUP_POLICY  "HKLM\\SOFTWARE\\Samba\\Group Policy"
  98 #define KEY_TREE_ROOT           ""
  99
 100 #define KEY_GP_MACHINE_POLICY           "HKLM\\Software\\Policies"
 101 #define KEY_GP_MACHINE_WIN_POLICY       "HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\Policies"
 102 #define KEY_GP_USER_POLICY              "HKCU\\Software\\Policies"
 103 #define KEY_GP_USER_WIN_POLICY          "HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Policies"
 104 /*
 105  * Registry key types
 106  *      Most keys are going to be GENERIC -- may need a better name?
 107  *      HKPD and HKPT are used by reg_perfcount.c
 108  *              they are special keys that contain performance data
 109  */
 110 #define REG_KEY_GENERIC         0
 111 #define REG_KEY_HKPD            1
 112 #define REG_KEY_HKPT            2
 113
 114 /*
 115  * container for function pointers to enumeration routines
 116  * for virtual registry view
 117  */
 118
 119 struct registry_ops {
 120         /* functions for enumerating subkeys and values */
 121         int     (*fetch_subkeys)( const char *key, struct regsubkey_ctr *subkeys);
 122         int     (*fetch_values) ( const char *key, struct regval_ctr *val );
 123         bool    (*store_subkeys)( const char *key, struct regsubkey_ctr *subkeys );
 124         WERROR  (*create_subkey)(const char *key, const char *subkey);
 125         WERROR  (*delete_subkey)(const char *key, const char *subkey);
 126         bool    (*store_values)( const char *key, struct regval_ctr *val );
 127         bool    (*reg_access_check)( const char *keyname, uint32 requested,
 128                                      uint32 *granted,
 129                                      const NT_USER_TOKEN *token );
 130         WERROR (*get_secdesc)(TALLOC_CTX *mem_ctx, const char *key,
 131                               struct security_descriptor **psecdesc);
 132         WERROR (*set_secdesc)(const char *key,
 133                               struct security_descriptor *sec_desc);
 134         bool    (*subkeys_need_update)(struct regsubkey_ctr *subkeys);
 135         bool    (*values_need_update)(struct regval_ctr *values);
 136 };
 137
 138
 139 /* structure to store the registry handles */
 140
 141 struct registry_key_handle {
 142         uint32          type;
 143         char            *name;          /* full name of registry key */
 144         uint32          access_granted;
 145         struct registry_ops     *ops;
 146 };
 147
 148 struct registry_key {
 149         struct registry_key_handle *key;
 150         struct regsubkey_ctr *subkeys;
 151         struct regval_ctr *values;
 152         struct nt_user_token *token;
 153 };
 154
 155 /* The following definitions come from registry/reg_objects.c  */
 156
 157 WERROR regsubkey_ctr_init(TALLOC_CTX *mem_ctx, struct regsubkey_ctr **ctr);
 158 WERROR regsubkey_ctr_reinit(struct regsubkey_ctr *ctr);
 159 WERROR regsubkey_ctr_set_seqnum(struct regsubkey_ctr *ctr, int seqnum);
 160 int regsubkey_ctr_get_seqnum(struct regsubkey_ctr *ctr);
 161 WERROR regsubkey_ctr_addkey( struct regsubkey_ctr *ctr, const char *keyname );
 162 WERROR regsubkey_ctr_delkey( struct regsubkey_ctr *ctr, const char *keyname );
 163 bool regsubkey_ctr_key_exists( struct regsubkey_ctr *ctr, const char *keyname );
 164 int regsubkey_ctr_numkeys( struct regsubkey_ctr *ctr );
 165 char* regsubkey_ctr_specific_key( struct regsubkey_ctr *ctr, uint32 key_index );
 166 WERROR regval_ctr_init(TALLOC_CTX *mem_ctx, struct regval_ctr **ctr);
 167 int regval_ctr_numvals(struct regval_ctr *ctr);
 168 struct regval_blob* dup_registry_value(struct regval_blob *val);
 169 void free_registry_value(struct regval_blob *val);
 170 uint8* regval_data_p(struct regval_blob *val);
 171 uint32 regval_size(struct regval_blob *val);
 172 char* regval_name(struct regval_blob *val);
 173 uint32 regval_type(struct regval_blob *val);
 174 struct regval_blob* regval_ctr_specific_value(struct regval_ctr *ctr,
 175                                               uint32 idx);
 176 bool regval_ctr_key_exists(struct regval_ctr *ctr, const char *value);
 177 struct regval_blob *regval_compose(TALLOC_CTX *ctx, const char *name,
 178                                    uint16 type,
 179                                    const uint8 *data_p, size_t size);
 180 int regval_ctr_addvalue(struct regval_ctr *ctr, const char *name, uint16 type,
 181                         const uint8 *data_p, size_t size);
 182 int regval_ctr_addvalue_sz(struct regval_ctr *ctr, const char *name, const char *data);
 183 int regval_ctr_addvalue_multi_sz(struct regval_ctr *ctr, const char *name, const char **data);
 184 int regval_ctr_copyvalue(struct regval_ctr *ctr, struct regval_blob *val);
 185 int regval_ctr_delvalue(struct regval_ctr *ctr, const char *name);
 186 struct regval_blob* regval_ctr_getvalue(struct regval_ctr *ctr,
 187                                         const char *name);
 188 int regval_ctr_get_seqnum(struct regval_ctr *ctr);
 189 WERROR regval_ctr_set_seqnum(struct regval_ctr *ctr, int seqnum);
 190 uint32 regval_dword(struct regval_blob *val);
 191 const char *regval_sz(struct regval_blob *val);
 192
 193
 194 #endif /* _REG_OBJECTS_H */