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