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