libgpo: remove some unnecessary usage of ADS_STATUS.
[metze/samba/wip.git] / libgpo / gpo.h
1 /*
2  *  Unix SMB/CIFS implementation.
3  *  Group Policy Object Support
4  *  Copyright (C) Guenther Deschner 2005-2008
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 3 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef __GPO_H__
21 #define __GPO_H__
22
23 #include "ads.h"
24
25 enum GPO_LINK_TYPE {
26         GP_LINK_UNKOWN  = 0,
27         GP_LINK_MACHINE = 1,
28         GP_LINK_SITE    = 2,
29         GP_LINK_DOMAIN  = 3,
30         GP_LINK_OU      = 4,
31         GP_LINK_LOCAL   = 5 /* for convenience */
32 };
33
34 /* GPO_OPTIONS */
35 #define GPO_FLAG_DISABLE        0x00000001
36 #define GPO_FLAG_FORCE          0x00000002
37
38 /* GPO_LIST_FLAGS */
39 #define GPO_LIST_FLAG_MACHINE   0x00000001
40 #define GPO_LIST_FLAG_SITEONLY  0x00000002
41
42 /* following flags from http://support.microsoft.com/kb/312164/EN-US/ */
43 #define GPO_INFO_FLAG_MACHINE                   0x00000001
44 #define GPO_INFO_FLAG_BACKGROUND                0x00000010
45 #define GPO_INFO_FLAG_SLOWLINK                  0x00000020
46 #define GPO_INFO_FLAG_VERBOSE                   0x00000040
47 #define GPO_INFO_FLAG_NOCHANGES                 0x00000080
48 #define GPO_INFO_FLAG_LINKTRANSITION            0x00000100
49 #define GPO_INFO_FLAG_LOGRSOP_TRANSITION        0x00000200
50 #define GPO_INFO_FLAG_FORCED_REFRESH            0x00000400
51 #define GPO_INFO_FLAG_SAFEMODE_BOOT             0x00000800
52
53 #define GPO_VERSION_USER(x) (x >> 16)
54 #define GPO_VERSION_MACHINE(x) (x & 0xffff)
55
56 struct GROUP_POLICY_OBJECT {
57         uint32_t options;       /* GPFLAGS_* */
58         uint32_t version;
59         const char *ds_path;
60         const char *file_sys_path;
61         const char *display_name;
62         const char *name;
63         const char *link;
64         enum GPO_LINK_TYPE link_type;
65         const char *user_extensions;
66         const char *machine_extensions;
67         struct security_descriptor *security_descriptor;
68         struct GROUP_POLICY_OBJECT *next, *prev;
69 };
70
71 /* the following is seen on the DS (see adssearch.pl for details) */
72
73 /* the type field in a 'gPLink', the same as GPO_FLAG ? */
74 #define GPO_LINK_OPT_NONE       0x00000000
75 #define GPO_LINK_OPT_DISABLED   0x00000001
76 #define GPO_LINK_OPT_ENFORCED   0x00000002
77
78 /* GPO_LINK_OPT_ENFORCED takes precedence over GPOPTIONS_BLOCK_INHERITANCE */
79
80 /* 'gPOptions', maybe a bitmask as well */
81 enum GPO_INHERIT {
82         GPOPTIONS_INHERIT               = 0,
83         GPOPTIONS_BLOCK_INHERITANCE     = 1
84 };
85
86 /* 'flags' in a 'groupPolicyContainer' object */
87 #define GPFLAGS_ALL_ENABLED                     0x00000000
88 #define GPFLAGS_USER_SETTINGS_DISABLED          0x00000001
89 #define GPFLAGS_MACHINE_SETTINGS_DISABLED       0x00000002
90 #define GPFLAGS_ALL_DISABLED (GPFLAGS_USER_SETTINGS_DISABLED | \
91                               GPFLAGS_MACHINE_SETTINGS_DISABLED)
92
93 struct GP_LINK {
94         const char *gp_link;    /* raw link name */
95         uint32_t gp_opts;               /* inheritance options GPO_INHERIT */
96         uint32_t num_links;     /* number of links */
97         char **link_names;      /* array of parsed link names */
98         uint32_t *link_opts;    /* array of parsed link opts GPO_LINK_OPT_* */
99 };
100
101 struct GP_EXT {
102         const char *gp_extension;       /* raw extension name */
103         uint32_t num_exts;
104         char **extensions;
105         char **extensions_guid;
106         char **snapins;
107         char **snapins_guid;
108         struct GP_EXT *next, *prev;
109 };
110
111 #define GPO_CACHE_DIR "gpo_cache"
112 #define GPT_INI "GPT.INI"
113 #define GPO_REFRESH_INTERVAL 60*90
114
115 #define GPO_REG_STATE_MACHINE "State\\Machine"
116
117 enum gp_reg_action {
118         GP_REG_ACTION_NONE = 0,
119         GP_REG_ACTION_ADD_VALUE = 1,
120         GP_REG_ACTION_ADD_KEY = 2,
121         GP_REG_ACTION_DEL_VALUES = 3,
122         GP_REG_ACTION_DEL_VALUE = 4,
123         GP_REG_ACTION_DEL_ALL_VALUES = 5,
124         GP_REG_ACTION_DEL_KEYS = 6,
125         GP_REG_ACTION_SEC_KEY_SET = 7,
126         GP_REG_ACTION_SEC_KEY_RESET = 8
127 };
128
129 struct gp_registry_entry {
130         enum gp_reg_action action;
131         const char *key;
132         const char *value;
133         struct registry_value *data;
134 };
135
136 struct gp_registry_value {
137         const char *value;
138         struct registry_value *data;
139 };
140
141 struct gp_registry_entry2 {
142         enum gp_reg_action action;
143         const char *key;
144         size_t num_values;
145         struct gp_registry_value **values;
146 };
147
148 struct gp_registry_entries {
149         size_t num_entries;
150         struct gp_registry_entry **entries;
151 };
152
153 struct gp_registry_context {
154         const struct security_token *token;
155         const char *path;
156         struct registry_key *curr_key;
157 };
158
159 #define GP_EXT_GUID_SECURITY "827D319E-6EAC-11D2-A4EA-00C04F79F83A"
160 #define GP_EXT_GUID_REGISTRY "35378EAC-683F-11D2-A89A-00C04FBBCFA2"
161 #define GP_EXT_GUID_SCRIPTS  "42B5FAAE-6536-11D2-AE5A-0000F87571E3"
162 #define ADS_EXTENDED_RIGHT_APPLY_GROUP_POLICY "edacfd8f-ffb3-11d1-b41d-00a0c968f939"
163
164
165 struct cli_state;
166
167 /* The following definitions come from libgpo/gpo_fetch.c  */
168
169 NTSTATUS gpo_explode_filesyspath(TALLOC_CTX *mem_ctx,
170                                  const char *cache_dir,
171                                  const char *file_sys_path,
172                                  char **server,
173                                  char **service,
174                                  char **nt_path,
175                                  char **unix_path);
176 NTSTATUS gpo_fetch_files(TALLOC_CTX *mem_ctx,
177                          ADS_STRUCT *ads,
178                          const char *cache_dir,
179                          struct GROUP_POLICY_OBJECT *gpo);
180 NTSTATUS gpo_get_sysvol_gpt_version(TALLOC_CTX *mem_ctx,
181                                     const char *unix_path,
182                                     uint32_t *sysvol_version,
183                                     char **display_name);
184
185 /* The following definitions come from libgpo/gpo_ldap.c  */
186
187 bool ads_parse_gp_ext(TALLOC_CTX *mem_ctx,
188                       const char *extension_raw,
189                       struct GP_EXT **gp_ext);
190 ADS_STATUS ads_get_gpo_link(ADS_STRUCT *ads,
191                             TALLOC_CTX *mem_ctx,
192                             const char *link_dn,
193                             struct GP_LINK *gp_link_struct);
194 ADS_STATUS ads_add_gpo_link(ADS_STRUCT *ads,
195                             TALLOC_CTX *mem_ctx,
196                             const char *link_dn,
197                             const char *gpo_dn,
198                             uint32_t gpo_opt);
199 ADS_STATUS ads_delete_gpo_link(ADS_STRUCT *ads,
200                                TALLOC_CTX *mem_ctx,
201                                const char *link_dn,
202                                const char *gpo_dn);
203 ADS_STATUS ads_get_gpo(ADS_STRUCT *ads,
204                        TALLOC_CTX *mem_ctx,
205                        const char *gpo_dn,
206                        const char *display_name,
207                        const char *guid_name,
208                        struct GROUP_POLICY_OBJECT *gpo);
209 ADS_STATUS ads_get_sid_token(ADS_STRUCT *ads,
210                              TALLOC_CTX *mem_ctx,
211                              const char *dn,
212                              struct security_token **token);
213 ADS_STATUS ads_get_gpo_list(ADS_STRUCT *ads,
214                             TALLOC_CTX *mem_ctx,
215                             const char *dn,
216                             uint32_t flags,
217                             const struct security_token *token,
218                             struct GROUP_POLICY_OBJECT **gpo_list);
219
220 /* The following definitions come from libgpo/gpo_sec.c  */
221
222 NTSTATUS gpo_apply_security_filtering(const struct GROUP_POLICY_OBJECT *gpo,
223                                       const struct security_token *token);
224
225 /* The following definitions come from libgpo/gpo_util.c  */
226
227 const char *cse_gpo_guid_string_to_name(const char *guid);
228 const char *cse_gpo_name_to_guid_string(const char *name);
229 const char *cse_snapin_gpo_guid_string_to_name(const char *guid);
230 void dump_gp_ext(struct GP_EXT *gp_ext, int debuglevel);
231 void dump_gpo(ADS_STRUCT *ads,
232               TALLOC_CTX *mem_ctx,
233               struct GROUP_POLICY_OBJECT *gpo,
234               int debuglevel);
235 void dump_gpo_list(ADS_STRUCT *ads,
236                    TALLOC_CTX *mem_ctx,
237                    struct GROUP_POLICY_OBJECT *gpo_list,
238                    int debuglevel);
239 void dump_gplink(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, struct GP_LINK *gp_link);
240 NTSTATUS gpo_process_a_gpo(TALLOC_CTX *mem_ctx,
241                            const struct security_token *token,
242                            struct registry_key *root_key,
243                            struct GROUP_POLICY_OBJECT *gpo,
244                            const char *extension_guid_filter,
245                            uint32_t flags);
246 NTSTATUS gpo_process_gpo_list(TALLOC_CTX *mem_ctx,
247                               const struct security_token *token,
248                               struct GROUP_POLICY_OBJECT *gpo_list,
249                               const char *extensions_guid_filter,
250                               uint32_t flags);
251 NTSTATUS check_refresh_gpo(ADS_STRUCT *ads,
252                            TALLOC_CTX *mem_ctx,
253                            const char *cache_dir,
254                            uint32_t flags,
255                            struct GROUP_POLICY_OBJECT *gpo);
256 NTSTATUS check_refresh_gpo_list(ADS_STRUCT *ads,
257                                 TALLOC_CTX *mem_ctx,
258                                 const char *cache_dir,
259                                 uint32_t flags,
260                                 struct GROUP_POLICY_OBJECT *gpo_list);
261 NTSTATUS gpo_get_unix_path(TALLOC_CTX *mem_ctx,
262                            const char *cache_dir,
263                            struct GROUP_POLICY_OBJECT *gpo,
264                            char **unix_path);
265 char *gpo_flag_str(TALLOC_CTX *mem_ctx, uint32_t flags);
266 NTSTATUS gp_find_file(TALLOC_CTX *mem_ctx,
267                       uint32_t flags,
268                       const char *filename,
269                       const char *suffix,
270                       const char **filename_out);
271 ADS_STATUS gp_get_machine_token(ADS_STRUCT *ads,
272                                 TALLOC_CTX *mem_ctx,
273                                 const char *dn,
274                                 struct security_token **token);
275
276
277 #include "../libgpo/gpext/gpext.h"
278
279 #endif