source4/lib/registry/registry.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Registry interface
   4    Copyright (C) Gerald Carter                        2002.
   5    Copyright (C) Jelmer Vernooij                                          2003-2004.
   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 _REGISTRY_H /* _REGISTRY_H */
  23 #define _REGISTRY_H
  24
  25 #include "librpc/gen_ndr/security.h"
  26 #include "auth/credentials/credentials.h"
  27
  28 /* Handles for the predefined keys */
  29 #define HKEY_CLASSES_ROOT                0x80000000
  30 #define HKEY_CURRENT_USER                0x80000001
  31 #define HKEY_LOCAL_MACHINE               0x80000002
  32 #define HKEY_USERS                               0x80000003
  33 #define HKEY_PERFORMANCE_DATA    0x80000004
  34 #define HKEY_CURRENT_CONFIG              0x80000005
  35 #define HKEY_DYN_DATA                    0x80000006
  36 #define HKEY_PERFORMANCE_TEXT    0x80000050
  37 #define HKEY_PERFORMANCE_NLSTEXT 0x80000060
  38
  39 struct reg_predefined_key {
  40         uint32_t handle;
  41         const char *name;
  42 };
  43
  44 extern const struct reg_predefined_key reg_predefined_keys[];
  45
  46 #define REG_DELETE              -1
  47
  48 /*
  49  * The general idea here is that every backend provides a 'hive'. Combining
  50  * various hives gives you a complete registry like windows has
  51  */
  52
  53 #define REGISTRY_INTERFACE_VERSION 1
  54
  55 /* structure to store the registry handles */
  56 struct registry_key
  57 {
  58   char *name;
  59   const char *path;
  60   char *class_name;
  61   NTTIME last_mod;
  62   struct registry_hive *hive;
  63   void *backend_data;
  64 };
  65
  66 struct registry_value
  67 {
  68   char *name;
  69   unsigned int data_type;
  70   DATA_BLOB data;
  71 };
  72
  73 /* FIXME */
  74 typedef void (*reg_key_notification_function) (void);
  75 typedef void (*reg_value_notification_function) (void);
  76
  77 /*
  78  * Container for function pointers to enumeration routines
  79  * for virtual registry view
  80  *
  81  * Backends can provide :
  82  *  - just one hive (example: nt4, w95)
  83  *  - several hives (example: rpc).
  84  *
  85  * Backends should always do case-insensitive compares
  86  * (everything is case-insensitive but case-preserving,
  87  * just like the FS)
  88  *
  89  * There is no save function as all operations are expected to
  90  * be atomic.
  91  */
  92
  93 struct hive_operations {
  94         const char *name;
  95
  96         /* Implement this one */
  97         WERROR (*open_hive) (struct registry_hive *, struct registry_key **);
  98
  99         /* Or this one */
 100         WERROR (*open_key) (TALLOC_CTX *, const struct registry_key *, const char *name, struct registry_key **);
 101
 102         WERROR (*num_subkeys) (const struct registry_key *, uint32_t *count);
 103         WERROR (*num_values) (const struct registry_key *, uint32_t *count);
 104         WERROR (*get_subkey_by_index) (TALLOC_CTX *, const struct registry_key *, int idx, struct registry_key **);
 105
 106         /* Can not contain more than one level */
 107         WERROR (*get_subkey_by_name) (TALLOC_CTX *, const struct registry_key *, const char *name, struct registry_key **);
 108         WERROR (*get_value_by_index) (TALLOC_CTX *, const struct registry_key *, int idx, struct registry_value **);
 109
 110         /* Can not contain more than one level */
 111         WERROR (*get_value_by_name) (TALLOC_CTX *, const struct registry_key *, const char *name, struct registry_value **);
 112
 113         /* Security control */
 114         WERROR (*key_get_sec_desc) (TALLOC_CTX *, const struct registry_key *, struct security_descriptor **);
 115         WERROR (*key_set_sec_desc) (const struct registry_key *, const struct security_descriptor *);
 116
 117         /* Notification */
 118         WERROR (*request_key_change_notify) (const struct registry_key *, reg_key_notification_function);
 119         WERROR (*request_value_change_notify) (const struct registry_value *, reg_value_notification_function);
 120
 121         /* Key management */
 122         WERROR (*add_key)(TALLOC_CTX *, const struct registry_key *, const char *name, uint32_t access_mask, struct security_descriptor *, struct registry_key **);
 123         WERROR (*del_key)(const struct registry_key *, const char *name);
 124         WERROR (*flush_key) (const struct registry_key *);
 125
 126         /* Value management */
 127         WERROR (*set_value)(const struct registry_key *, const char *name, uint32_t type, const DATA_BLOB data);
 128         WERROR (*del_value)(const struct registry_key *, const char *valname);
 129 };
 130
 131 struct registry_hive
 132 {
 133         const struct hive_operations *functions;
 134         struct registry_key *root;
 135         struct auth_session_info *session_info;
 136         struct cli_credentials *credentials;
 137         void *backend_data;
 138         const char *location;
 139 };
 140
 141 /* Handle to a full registry
 142  * contains zero or more hives */
 143 struct registry_context {
 144     void *backend_data;
 145         struct cli_credentials *credentials;
 146         struct auth_session_info *session_info;
 147         WERROR (*get_predefined_key) (struct registry_context *, uint32_t hkey, struct registry_key **);
 148 };
 149
 150 struct reg_init_function_entry {
 151         const struct hive_operations *hive_functions;
 152         struct reg_init_function_entry *prev, *next;
 153 };
 154
 155 /* Representing differences between registry files */
 156
 157 struct reg_diff_value
 158 {
 159         char *name;
 160         enum { REG_DIFF_DEL_VAL, REG_DIFF_SET_VAL } changetype;
 161         uint32_t type;
 162         DATA_BLOB data;
 163 };
 164
 165 struct reg_diff_key
 166 {
 167         char *name;
 168         enum { REG_DIFF_CHANGE_KEY, REG_DIFF_DEL_KEY } changetype;
 169         uint32_t numvalues;
 170         struct reg_diff_value *values;
 171 };
 172
 173 struct reg_diff
 174 {
 175         char *format;
 176         uint32_t numkeys;
 177         struct reg_diff_key *keys;
 178 };
 179
 180 struct auth_session_info;
 181 struct event_context;
 182
 183 #include "lib/registry/registry_proto.h"
 184
 185 #endif /* _REGISTRY_H */