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