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