r23766: Add GTYPE_SECURITY_UNIVERSAL_GROUP define.
[samba.git] / source3 / include / ads.h
1 #ifndef _INCLUDE_ADS_H_
2 #define _INCLUDE_ADS_H_
3 /*
4   header for ads (active directory) library routines
5
6   basically this is a wrapper around ldap
7 */
8
9 enum wb_posix_mapping {
10         WB_POSIX_MAP_UNKNOWN    = -1,
11         WB_POSIX_MAP_TEMPLATE   = 0, 
12         WB_POSIX_MAP_SFU        = 1, 
13         WB_POSIX_MAP_SFU20      = 2, 
14         WB_POSIX_MAP_RFC2307    = 3,
15         WB_POSIX_MAP_UNIXINFO   = 4
16 };
17
18 typedef struct {
19 #ifdef HAVE_LDAP
20         LDAP *ld;
21 #else
22         void *ld; /* the active ldap structure */
23 #endif
24         struct in_addr ldap_ip; /* the ip of the active connection, if any */
25         time_t last_attempt; /* last attempt to reconnect */
26         int ldap_port;
27         
28         int is_mine;    /* do I own this structure's memory? */
29         
30         /* info needed to find the server */
31         struct {
32                 char *realm;
33                 char *workgroup;
34                 char *ldap_server;
35                 int foreign; /* set to 1 if connecting to a foreign realm */
36         } server;
37
38         /* info needed to authenticate */
39         struct {
40                 char *realm;
41                 char *password;
42                 char *user_name;
43                 char *kdc_server;
44                 unsigned flags;
45                 int time_offset;
46                 time_t tgt_expire;
47                 time_t tgs_expire;
48                 time_t renewable;
49         } auth;
50
51         /* info derived from the servers config */
52         struct {
53                 uint32 flags; /* cldap flags identifying the services. */
54                 char *realm;
55                 char *bind_path;
56                 char *ldap_server_name;
57                 char *server_site_name;
58                 char *client_site_name;
59                 time_t current_time;
60                 int tried_closest_dc;
61         } config;
62 } ADS_STRUCT;
63
64 /* used to remember the names of the posix attributes in AD */
65 /* see the rfc2307 & sfu nss backends */
66
67 struct posix_schema {
68         char *posix_homedir_attr;
69         char *posix_shell_attr;
70         char *posix_uidnumber_attr;
71         char *posix_gidnumber_attr;
72         char *posix_gecos_attr;
73 };
74
75
76 /* there are 5 possible types of errors the ads subsystem can produce */
77 enum ads_error_type {ENUM_ADS_ERROR_KRB5, ENUM_ADS_ERROR_GSS, 
78                      ENUM_ADS_ERROR_LDAP, ENUM_ADS_ERROR_SYSTEM, ENUM_ADS_ERROR_NT};
79
80 typedef struct {
81         enum ads_error_type error_type;
82         union err_state{                
83                 int rc;
84                 NTSTATUS nt_status;
85         } err;
86         /* For error_type = ENUM_ADS_ERROR_GSS minor_status describe GSS API error */
87         /* Where rc represents major_status of GSS API error */
88         int minor_status;
89 } ADS_STATUS;
90
91 #ifdef HAVE_ADS
92 typedef LDAPMod **ADS_MODLIST;
93 #else
94 typedef void **ADS_MODLIST;
95 #endif
96
97 /* macros to simplify error returning */
98 #define ADS_ERROR(rc) ADS_ERROR_LDAP(rc)
99 #define ADS_ERROR_LDAP(rc) ads_build_error(ENUM_ADS_ERROR_LDAP, rc, 0)
100 #define ADS_ERROR_SYSTEM(rc) ads_build_error(ENUM_ADS_ERROR_SYSTEM, rc?rc:EINVAL, 0)
101 #define ADS_ERROR_KRB5(rc) ads_build_error(ENUM_ADS_ERROR_KRB5, rc, 0)
102 #define ADS_ERROR_GSS(rc, minor) ads_build_error(ENUM_ADS_ERROR_GSS, rc, minor)
103 #define ADS_ERROR_NT(rc) ads_build_nt_error(ENUM_ADS_ERROR_NT,rc)
104
105 #define ADS_ERR_OK(status) ((status.error_type == ENUM_ADS_ERROR_NT) ? NT_STATUS_IS_OK(status.err.nt_status):(status.err.rc == 0))
106 #define ADS_SUCCESS ADS_ERROR(0)
107
108 #define ADS_ERROR_HAVE_NO_MEMORY(x) do { \
109         if (!(x)) {\
110                 return ADS_ERROR(LDAP_NO_MEMORY);\
111         }\
112 } while (0)
113
114
115 /* time between reconnect attempts */
116 #define ADS_RECONNECT_TIME 5
117
118 /* ldap control oids */
119 #define ADS_PAGE_CTL_OID        "1.2.840.113556.1.4.319"
120 #define ADS_NO_REFERRALS_OID    "1.2.840.113556.1.4.1339"
121 #define ADS_SERVER_SORT_OID     "1.2.840.113556.1.4.473"
122 #define ADS_PERMIT_MODIFY_OID   "1.2.840.113556.1.4.1413"
123 #define ADS_ASQ_OID             "1.2.840.113556.1.4.1504"
124 #define ADS_EXTENDED_DN_OID     "1.2.840.113556.1.4.529"
125 #define ADS_SD_FLAGS_OID        "1.2.840.113556.1.4.801"
126
127 /* ldap attribute oids (Services for Unix 3.0, 3.5) */
128 #define ADS_ATTR_SFU_UIDNUMBER_OID      "1.2.840.113556.1.6.18.1.310"
129 #define ADS_ATTR_SFU_GIDNUMBER_OID      "1.2.840.113556.1.6.18.1.311"
130 #define ADS_ATTR_SFU_HOMEDIR_OID        "1.2.840.113556.1.6.18.1.344"
131 #define ADS_ATTR_SFU_SHELL_OID          "1.2.840.113556.1.6.18.1.312"
132 #define ADS_ATTR_SFU_GECOS_OID          "1.2.840.113556.1.6.18.1.337"
133
134 /* ldap attribute oids (Services for Unix 2.0) */
135 #define ADS_ATTR_SFU20_UIDNUMBER_OID    "1.2.840.113556.1.4.7000.187.70"
136 #define ADS_ATTR_SFU20_GIDNUMBER_OID    "1.2.840.113556.1.4.7000.187.71"
137 #define ADS_ATTR_SFU20_HOMEDIR_OID      "1.2.840.113556.1.4.7000.187.106"
138 #define ADS_ATTR_SFU20_SHELL_OID        "1.2.840.113556.1.4.7000.187.72"
139 #define ADS_ATTR_SFU20_GECOS_OID        "1.2.840.113556.1.4.7000.187.97"
140
141 /* ldap attribute oids (RFC2307) */
142 #define ADS_ATTR_RFC2307_UIDNUMBER_OID  "1.3.6.1.1.1.1.0"
143 #define ADS_ATTR_RFC2307_GIDNUMBER_OID  "1.3.6.1.1.1.1.1"
144 #define ADS_ATTR_RFC2307_HOMEDIR_OID    "1.3.6.1.1.1.1.3"
145 #define ADS_ATTR_RFC2307_SHELL_OID      "1.3.6.1.1.1.1.4"
146 #define ADS_ATTR_RFC2307_GECOS_OID      "1.3.6.1.1.1.1.2"
147
148 /* ldap bitwise searches */
149 #define ADS_LDAP_MATCHING_RULE_BIT_AND  "1.2.840.113556.1.4.803"
150 #define ADS_LDAP_MATCHING_RULE_BIT_OR   "1.2.840.113556.1.4.804"
151
152 /* UserFlags for userAccountControl */
153 #define UF_SCRIPT                               0x00000001
154 #define UF_ACCOUNTDISABLE                       0x00000002
155 #define UF_UNUSED_1                             0x00000004
156 #define UF_HOMEDIR_REQUIRED                     0x00000008
157
158 #define UF_LOCKOUT                              0x00000010
159 #define UF_PASSWD_NOTREQD                       0x00000020
160 #define UF_PASSWD_CANT_CHANGE                   0x00000040
161 #define UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED      0x00000080
162
163 #define UF_TEMP_DUPLICATE_ACCOUNT               0x00000100
164 #define UF_NORMAL_ACCOUNT                       0x00000200
165 #define UF_UNUSED_2                             0x00000400
166 #define UF_INTERDOMAIN_TRUST_ACCOUNT            0x00000800
167
168 #define UF_WORKSTATION_TRUST_ACCOUNT            0x00001000
169 #define UF_SERVER_TRUST_ACCOUNT                 0x00002000
170 #define UF_UNUSED_3                             0x00004000
171 #define UF_UNUSED_4                             0x00008000
172
173 #define UF_DONT_EXPIRE_PASSWD                   0x00010000
174 #define UF_MNS_LOGON_ACCOUNT                    0x00020000
175 #define UF_SMARTCARD_REQUIRED                   0x00040000
176 #define UF_TRUSTED_FOR_DELEGATION               0x00080000
177
178 #define UF_NOT_DELEGATED                        0x00100000
179 #define UF_USE_DES_KEY_ONLY                     0x00200000
180 #define UF_DONT_REQUIRE_PREAUTH                 0x00400000
181 #define UF_PASSWORD_EXPIRED                     0x00800000
182
183 #define UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION 0x01000000
184 #define UF_NO_AUTH_DATA_REQUIRED                0x02000000
185 #define UF_UNUSED_8                             0x04000000
186 #define UF_UNUSED_9                             0x08000000
187
188 #define UF_UNUSED_10                            0x10000000
189 #define UF_UNUSED_11                            0x20000000
190 #define UF_UNUSED_12                            0x40000000
191 #define UF_UNUSED_13                            0x80000000
192
193 #define UF_MACHINE_ACCOUNT_MASK (\
194                 UF_INTERDOMAIN_TRUST_ACCOUNT |\
195                 UF_WORKSTATION_TRUST_ACCOUNT |\
196                 UF_SERVER_TRUST_ACCOUNT \
197                 )
198
199 #define UF_ACCOUNT_TYPE_MASK (\
200                 UF_TEMP_DUPLICATE_ACCOUNT |\
201                 UF_NORMAL_ACCOUNT |\
202                 UF_INTERDOMAIN_TRUST_ACCOUNT |\
203                 UF_WORKSTATION_TRUST_ACCOUNT |\
204                 UF_SERVER_TRUST_ACCOUNT \
205                 )
206
207 #define UF_SETTABLE_BITS (\
208                 UF_SCRIPT |\
209                 UF_ACCOUNTDISABLE |\
210                 UF_HOMEDIR_REQUIRED  |\
211                 UF_LOCKOUT |\
212                 UF_PASSWD_NOTREQD |\
213                 UF_PASSWD_CANT_CHANGE |\
214                 UF_ACCOUNT_TYPE_MASK | \
215                 UF_DONT_EXPIRE_PASSWD | \
216                 UF_MNS_LOGON_ACCOUNT |\
217                 UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED |\
218                 UF_SMARTCARD_REQUIRED |\
219                 UF_TRUSTED_FOR_DELEGATION |\
220                 UF_NOT_DELEGATED |\
221                 UF_USE_DES_KEY_ONLY  |\
222                 UF_DONT_REQUIRE_PREAUTH \
223                 )
224
225 /* sAMAccountType */
226 #define ATYPE_NORMAL_ACCOUNT                    0x30000000 /* 805306368 */
227 #define ATYPE_WORKSTATION_TRUST                 0x30000001 /* 805306369 */
228 #define ATYPE_INTERDOMAIN_TRUST                 0x30000002 /* 805306370 */ 
229 #define ATYPE_SECURITY_GLOBAL_GROUP             0x10000000 /* 268435456 */
230 #define ATYPE_DISTRIBUTION_GLOBAL_GROUP         0x10000001 /* 268435457 */
231 #define ATYPE_DISTRIBUTION_UNIVERSAL_GROUP      ATYPE_DISTRIBUTION_GLOBAL_GROUP
232 #define ATYPE_SECURITY_LOCAL_GROUP              0x20000000 /* 536870912 */
233 #define ATYPE_DISTRIBUTION_LOCAL_GROUP          0x20000001 /* 536870913 */
234
235 #define ATYPE_ACCOUNT           ATYPE_NORMAL_ACCOUNT            /* 0x30000000 805306368 */
236 #define ATYPE_GLOBAL_GROUP      ATYPE_SECURITY_GLOBAL_GROUP     /* 0x10000000 268435456 */
237 #define ATYPE_LOCAL_GROUP       ATYPE_SECURITY_LOCAL_GROUP      /* 0x20000000 536870912 */
238
239 /* groupType */
240 #define GROUP_TYPE_BUILTIN_LOCAL_GROUP          0x00000001
241 #define GROUP_TYPE_ACCOUNT_GROUP                0x00000002
242 #define GROUP_TYPE_RESOURCE_GROUP               0x00000004
243 #define GROUP_TYPE_UNIVERSAL_GROUP              0x00000008
244 #define GROUP_TYPE_APP_BASIC_GROUP              0x00000010
245 #define GROUP_TYPE_APP_QUERY_GROUP              0x00000020
246 #define GROUP_TYPE_SECURITY_ENABLED             0x80000000
247
248 #define GTYPE_SECURITY_BUILTIN_LOCAL_GROUP (    /* 0x80000005 -2147483643 */ \
249                 GROUP_TYPE_BUILTIN_LOCAL_GROUP| \
250                 GROUP_TYPE_RESOURCE_GROUP| \
251                 GROUP_TYPE_SECURITY_ENABLED \
252                 )
253 #define GTYPE_SECURITY_DOMAIN_LOCAL_GROUP (     /* 0x80000004 -2147483644 */ \
254                 GROUP_TYPE_RESOURCE_GROUP| \
255                 GROUP_TYPE_SECURITY_ENABLED \
256                 )
257 #define GTYPE_SECURITY_GLOBAL_GROUP (           /* 0x80000002 -2147483646 */ \
258                 GROUP_TYPE_ACCOUNT_GROUP| \
259                 GROUP_TYPE_SECURITY_ENABLED \
260                 )
261 #define GTYPE_SECURITY_UNIVERSAL_GROUP (        /* 0x80000008 -2147483656 */ \
262                 GROUP_TYPE_UNIVERSAL_GROUP| \
263                 GROUP_TYPE_SECURITY_ENABLED \
264                 )
265
266 #define GTYPE_DISTRIBUTION_GLOBAL_GROUP         0x00000002      /* 2 */
267 #define GTYPE_DISTRIBUTION_DOMAIN_LOCAL_GROUP   0x00000004      /* 4 */
268 #define GTYPE_DISTRIBUTION_UNIVERSAL_GROUP      0x00000008      /* 8 */
269
270 #define ADS_PINGS          0x0000FFFF  /* Ping response */
271 #define ADS_DNS_CONTROLLER 0x20000000  /* DomainControllerName is a DNS name*/
272 #define ADS_DNS_DOMAIN     0x40000000  /* DomainName is a DNS name */
273 #define ADS_DNS_FOREST     0x80000000  /* DnsForestName is a DNS name */
274
275 /* DomainControllerAddressType */
276 #define ADS_INET_ADDRESS      0x00000001
277 #define ADS_NETBIOS_ADDRESS   0x00000002
278
279
280 /* ads auth control flags */
281 #define ADS_AUTH_DISABLE_KERBEROS 0x01
282 #define ADS_AUTH_NO_BIND          0x02
283 #define ADS_AUTH_ANON_BIND        0x04
284 #define ADS_AUTH_SIMPLE_BIND      0x08
285 #define ADS_AUTH_ALLOW_NTLMSSP    0x10
286
287 /* Kerberos environment variable names */
288 #define KRB5_ENV_CCNAME "KRB5CCNAME"
289
290 /* Heimdal uses a slightly different name */
291 #if defined(HAVE_ENCTYPE_ARCFOUR_HMAC_MD5)
292 #define ENCTYPE_ARCFOUR_HMAC ENCTYPE_ARCFOUR_HMAC_MD5
293 #endif
294
295 /* The older versions of heimdal that don't have this
296    define don't seem to use it anyway.  I'm told they
297    always use a subkey */
298 #ifndef HAVE_AP_OPTS_USE_SUBKEY
299 #define AP_OPTS_USE_SUBKEY 0
300 #endif
301
302 #define WELL_KNOWN_GUID_COMPUTERS       "AA312825768811D1ADED00C04FD8D5CD" 
303 #define WELL_KNOWN_GUID_USERS           "A9D1CA15768811D1ADED00C04FD8D5CD"
304
305 #ifndef KRB5_ADDR_NETBIOS
306 #define KRB5_ADDR_NETBIOS 0x14
307 #endif
308
309 #ifndef KRB5KRB_ERR_RESPONSE_TOO_BIG
310 #define KRB5KRB_ERR_RESPONSE_TOO_BIG (-1765328332L)
311 #endif
312
313 #ifdef HAVE_KRB5
314 typedef struct {
315         NTSTATUS ntstatus;
316         uint32 unknown1;
317         uint32 unknown2; /* 0x00000001 */
318 } KRB5_EDATA_NTSTATUS;
319
320 typedef struct {
321 #if defined(HAVE_MAGIC_IN_KRB5_ADDRESS) && defined(HAVE_ADDRTYPE_IN_KRB5_ADDRESS) /* MIT */
322         krb5_address **addrs;
323 #elif defined(HAVE_KRB5_ADDRESSES) /* Heimdal */
324         krb5_addresses *addrs;
325 #else
326 #error UNKNOWN_KRB5_ADDRESS_TYPE
327 #endif
328 } smb_krb5_addresses;
329 #endif
330
331 enum ads_extended_dn_flags {
332         ADS_EXTENDED_DN_HEX_STRING      = 0,
333         ADS_EXTENDED_DN_STRING          = 1 /* not supported on win2k */
334 };
335
336 /* this is probably not very well suited to pass other controls generically but
337  * is good enough for the extended dn control where it is only used for atm */
338
339 typedef struct {
340         const char *control;
341         int val;
342         int critical;
343 } ads_control;
344 #endif  /* _INCLUDE_ADS_H_ */