e1854644d53cd03c22c578876df7f928920c3825
[samba.git] / source4 / dsdb / common / util.h
1 /*
2    Unix SMB/CIFS implementation.
3    Samba utility functions
4
5    Copyright (C) Andrew Tridgell 2010
6    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2009
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #ifndef __DSDB_COMMON_UTIL_H__
23 #define __DSDB_COMMON_UTIL_H__
24
25 /*
26    flags for dsdb_request_add_controls(). For the module functions,
27    the upper 16 bits are in dsdb/samdb/ldb_modules/util.h
28 */
29 #define DSDB_SEARCH_SEARCH_ALL_PARTITIONS     0x00001
30 #define DSDB_SEARCH_SHOW_DELETED              0x00002
31 #define DSDB_SEARCH_SHOW_DN_IN_STORAGE_FORMAT 0x00004
32 #define DSDB_SEARCH_REVEAL_INTERNALS          0x00008
33 #define DSDB_SEARCH_SHOW_EXTENDED_DN          0x00010
34 #define DSDB_MODIFY_RELAX                     0x00020
35 #define DSDB_MODIFY_PERMISSIVE                0x00040
36 #define DSDB_FLAG_AS_SYSTEM                   0x00080
37 #define DSDB_TREE_DELETE                      0x00100
38 #define DSDB_SEARCH_ONE_ONLY                  0x00200 /* give an error unless 1 record */
39 #define DSDB_SEARCH_SHOW_RECYCLED             0x00400
40 #define DSDB_PROVISION                        0x00800
41 #define DSDB_BYPASS_PASSWORD_HASH             0x01000
42 #define DSDB_SEARCH_NO_GLOBAL_CATALOG         0x02000
43 #define DSDB_MODIFY_PARTIAL_REPLICA           0x04000
44 #define DSDB_PASSWORD_BYPASS_LAST_SET         0x08000
45 #define DSDB_REPLMD_VANISH_LINKS              0x10000
46
47 bool is_attr_in_list(const char * const * attrs, const char *attr);
48
49 #define DSDB_SECRET_ATTRIBUTES_EX(sep) \
50         "pekList" sep \
51         "msDS-ExecuteScriptPassword" sep \
52         "currentValue" sep \
53         "dBCSPwd" sep \
54         "initialAuthIncoming" sep \
55         "initialAuthOutgoing" sep \
56         "lmPwdHistory" sep \
57         "ntPwdHistory" sep \
58         "priorValue" sep \
59         "supplementalCredentials" sep \
60         "trustAuthIncoming" sep \
61         "trustAuthOutgoing" sep \
62         "unicodePwd" sep \
63         "clearTextPassword"
64
65 #define DSDB_SECRET_ATTRIBUTES_COMMA ,
66 #define DSDB_SECRET_ATTRIBUTES DSDB_SECRET_ATTRIBUTES_EX(DSDB_SECRET_ATTRIBUTES_COMMA)
67
68 #define DSDB_PASSWORD_ATTRIBUTES \
69         "userPassword", \
70         "clearTextPassword", \
71         "unicodePwd", \
72         "dBCSPwd"
73
74 /*
75  * ldb opaque values used to pass the user session information to ldb modules
76  */
77 #define DSDB_SESSION_INFO "sessionInfo"
78 #define DSDB_NETWORK_SESSION_INFO "networkSessionInfo"
79
80 struct GUID;
81
82 struct ldb_context;
83
84 int dsdb_werror_at(struct ldb_context *ldb, int ldb_ecode, WERROR werr,
85                    const char *location, const char *func,
86                    const char *reason);
87
88 #define dsdb_module_werror(module, ldb_ecode, werr, reason) \
89         dsdb_werror_at(ldb_module_get_ctx(module), ldb_ecode, werr, \
90                        __location__, __func__, reason)
91
92
93 struct dsdb_ldb_dn_list_node {
94         struct dsdb_ldb_dn_list_node *prev, *next;
95
96         /* the dn of the partition */
97         struct ldb_dn *dn;
98 };
99
100
101
102 #endif /* __DSDB_COMMON_UTIL_H__ */