8db0209573bb82cc253d125cbcdfb31e1d1a84bf
[samba.git] / source4 / include / ads.h
1 /*
2    Unix SMB/CIFS implementation.
3    header for ads (active directory) library routines
4    basically this is a wrapper around ldap
5
6    Copyright (C) Andrew Tridgell 2001-2003
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22  
23 typedef struct {
24         void *ld; /* the active ldap structure */
25         struct ipv4_addr ldap_ip; /* the ip of the active connection, if any */
26         time_t last_attempt; /* last attempt to reconnect */
27         int ldap_port;
28         
29         int is_mine;    /* do I own this structure's memory? */
30         
31         /* info needed to find the server */
32         struct {
33                 char *realm;
34                 char *workgroup;
35                 char *ldap_server;
36                 char *ldap_uri;
37                 int foreign; /* set to 1 if connecting to a foreign realm */
38         } server;
39
40         /* info needed to authenticate */
41         struct {
42                 char *realm;
43                 char *password;
44                 char *user_name;
45                 char *kdc_server;
46                 uint_t flags;
47                 int time_offset;
48                 time_t expire;
49         } auth;
50
51         /* info derived from the servers config */
52         struct {
53                 char *realm;
54                 char *bind_path;
55                 char *ldap_server_name;
56                 time_t current_time;
57         } config;
58 } ADS_STRUCT;
59
60 /* there are 5 possible types of errors the ads subsystem can produce */
61 enum ads_error_type {ENUM_ADS_ERROR_KRB5, ENUM_ADS_ERROR_GSS, 
62                      ENUM_ADS_ERROR_LDAP, ENUM_ADS_ERROR_SYSTEM, ENUM_ADS_ERROR_NT};
63
64 typedef struct {
65         enum ads_error_type error_type;
66         union err_state{                
67                 int rc;
68                 NTSTATUS nt_status;
69         } err;
70         /* For error_type = ENUM_ADS_ERROR_GSS minor_status describe GSS API error */
71         /* Where rc represents major_status of GSS API error */
72         int minor_status;
73 } ADS_STATUS;
74
75 typedef void **ADS_MODLIST;
76
77 /* macros to simplify error returning */
78 #define ADS_ERROR(rc) ADS_ERROR_LDAP(rc)
79 #define ADS_ERROR_LDAP(rc) ads_build_error(ENUM_ADS_ERROR_LDAP, rc, 0)
80 #define ADS_ERROR_SYSTEM(rc) ads_build_error(ENUM_ADS_ERROR_SYSTEM, rc?rc:EINVAL, 0)
81 #define ADS_ERROR_KRB5(rc) ads_build_error(ENUM_ADS_ERROR_KRB5, rc, 0)
82 #define ADS_ERROR_GSS(rc, minor) ads_build_error(ENUM_ADS_ERROR_GSS, rc, minor)
83 #define ADS_ERROR_NT(rc) ads_build_nt_error(ENUM_ADS_ERROR_NT,rc)
84
85 #define ADS_ERR_OK(status) ((status.error_type == ENUM_ADS_ERROR_NT) ? NT_STATUS_IS_OK(status.err.nt_status):(status.err.rc == 0))
86 #define ADS_SUCCESS ADS_ERROR(0)
87
88 /* time between reconnect attempts */
89 #define ADS_RECONNECT_TIME 5
90
91 /* timeout on searches */
92 #define ADS_SEARCH_TIMEOUT 10
93
94 /* ldap control oids */
95 #define ADS_PAGE_CTL_OID "1.2.840.113556.1.4.319"
96 #define ADS_NO_REFERRALS_OID "1.2.840.113556.1.4.1339"
97 #define ADS_SERVER_SORT_OID "1.2.840.113556.1.4.473"
98 #define ADS_PERMIT_MODIFY_OID "1.2.840.113556.1.4.1413"
99
100 /* UserFlags for userAccountControl */
101 #define UF_SCRIPT                               0x00000001
102 #define UF_ACCOUNTDISABLE                       0x00000002
103 #define UF_UNUSED_1                             0x00000004
104 #define UF_HOMEDIR_REQUIRED                     0x00000008
105
106 #define UF_LOCKOUT                              0x00000010
107 #define UF_PASSWD_NOTREQD                       0x00000020
108 #define UF_PASSWD_CANT_CHANGE                   0x00000040
109 #define UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED      0x00000080
110
111 #define UF_TEMP_DUPLICATE_ACCOUNT               0x00000100
112 #define UF_NORMAL_ACCOUNT                       0x00000200
113 #define UF_UNUSED_2                             0x00000400
114 #define UF_INTERDOMAIN_TRUST_ACCOUNT            0x00000800
115
116 #define UF_WORKSTATION_TRUST_ACCOUNT            0x00001000
117 #define UF_SERVER_TRUST_ACCOUNT                 0x00002000
118 #define UF_UNUSED_3                             0x00004000
119 #define UF_UNUSED_4                             0x00008000
120
121 #define UF_DONT_EXPIRE_PASSWD                   0x00010000
122 #define UF_MNS_LOGON_ACCOUNT                    0x00020000
123 #define UF_SMARTCARD_REQUIRED                   0x00040000
124 #define UF_TRUSTED_FOR_DELEGATION               0x00080000
125
126 #define UF_NOT_DELEGATED                        0x00100000
127 #define UF_USE_DES_KEY_ONLY                     0x00200000
128 #define UF_DONT_REQUIRE_PREAUTH                 0x00400000
129 #define UF_UNUSED_5                             0x00800000
130
131 #define UF_UNUSED_6                             0x01000000
132 #define UF_UNUSED_7                             0x02000000
133 #define UF_UNUSED_8                             0x04000000
134 #define UF_UNUSED_9                             0x08000000
135
136 #define UF_UNUSED_10                            0x10000000
137 #define UF_UNUSED_11                            0x20000000
138 #define UF_UNUSED_12                            0x40000000
139 #define UF_UNUSED_13                            0x80000000
140
141 #define UF_MACHINE_ACCOUNT_MASK (\
142                 UF_INTERDOMAIN_TRUST_ACCOUNT |\
143                 UF_WORKSTATION_TRUST_ACCOUNT |\
144                 UF_SERVER_TRUST_ACCOUNT \
145                 )
146
147 #define UF_ACCOUNT_TYPE_MASK (\
148                 UF_TEMP_DUPLICATE_ACCOUNT |\
149                 UF_NORMAL_ACCOUNT |\
150                 UF_INTERDOMAIN_TRUST_ACCOUNT |\
151                 UF_WORKSTATION_TRUST_ACCOUNT |\
152                 UF_SERVER_TRUST_ACCOUNT \
153                 )
154
155 #define UF_SETTABLE_BITS (\
156                 UF_SCRIPT |\
157                 UF_ACCOUNTDISABLE |\
158                 UF_HOMEDIR_REQUIRED  |\
159                 UF_LOCKOUT |\
160                 UF_PASSWD_NOTREQD |\
161                 UF_PASSWD_CANT_CHANGE |\
162                 UF_ACCOUNT_TYPE_MASK | \
163                 UF_DONT_EXPIRE_PASSWD | \
164                 UF_MNS_LOGON_ACCOUNT |\
165                 UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED |\
166                 UF_SMARTCARD_REQUIRED |\
167                 UF_TRUSTED_FOR_DELEGATION |\
168                 UF_NOT_DELEGATED |\
169                 UF_USE_DES_KEY_ONLY  |\
170                 UF_DONT_REQUIRE_PREAUTH \
171                 )
172
173 /* sAMAccountType */
174 #define ATYPE_NORMAL_ACCOUNT                    0x30000000 /* 805306368 */
175 #define ATYPE_WORKSTATION_TRUST                 0x30000001 /* 805306369 */
176 #define ATYPE_INTERDOMAIN_TRUST                 0x30000002 /* 805306370 */ 
177 #define ATYPE_SECURITY_GLOBAL_GROUP             0x10000000 /* 268435456 */
178 #define ATYPE_DISTRIBUTION_GLOBAL_GROUP         0x10000001 /* 268435457 */
179 #define ATYPE_DISTRIBUTION_UNIVERSAL_GROUP      ATYPE_DISTRIBUTION_GLOBAL_GROUP
180 #define ATYPE_SECURITY_LOCAL_GROUP              0x20000000 /* 536870912 */
181 #define ATYPE_DISTRIBUTION_LOCAL_GROUP          0x20000001 /* 536870913 */
182
183 #define ATYPE_ACCOUNT           ATYPE_NORMAL_ACCOUNT            /* 0x30000000 805306368 */
184 #define ATYPE_GLOBAL_GROUP      ATYPE_SECURITY_GLOBAL_GROUP     /* 0x10000000 268435456 */
185 #define ATYPE_LOCAL_GROUP       ATYPE_SECURITY_LOCAL_GROUP      /* 0x20000000 536870912 */
186
187 /* groupType */
188 #define GTYPE_SECURITY_BUILTIN_LOCAL_GROUP      0x80000005      /* -2147483643 */
189 #define GTYPE_SECURITY_DOMAIN_LOCAL_GROUP       0x80000004      /* -2147483644 */
190 #define GTYPE_SECURITY_GLOBAL_GROUP             0x80000002      /* -2147483646 */
191 #define GTYPE_DISTRIBUTION_GLOBAL_GROUP         0x00000002      /* 2 */
192 #define GTYPE_DISTRIBUTION_DOMAIN_LOCAL_GROUP   0x00000004      /* 4 */
193 #define GTYPE_DISTRIBUTION_UNIVERSAL_GROUP      0x00000008      /* 8 */
194
195 /* Mailslot or cldap getdcname response flags */
196 #define ADS_PDC            0x00000001  /* DC is PDC */
197 #define ADS_GC             0x00000004  /* DC is a GC of forest */
198 #define ADS_LDAP           0x00000008  /* DC is an LDAP server */
199 #define ADS_DS             0x00000010  /* DC supports DS */
200 #define ADS_KDC            0x00000020  /* DC is running KDC */
201 #define ADS_TIMESERV       0x00000040  /* DC is running time services */
202 #define ADS_CLOSEST        0x00000080  /* DC is closest to client */
203 #define ADS_WRITABLE       0x00000100  /* DC has writable DS */
204 #define ADS_GOOD_TIMESERV  0x00000200  /* DC has hardware clock
205                                          (and running time) */
206 #define ADS_NDNC           0x00000400  /* DomainName is non-domain NC serviced
207                                          by LDAP server */
208 #define ADS_PINGS          0x0000FFFF  /* Ping response */
209 #define ADS_DNS_CONTROLLER 0x20000000  /* DomainControllerName is a DNS name*/
210 #define ADS_DNS_DOMAIN     0x40000000  /* DomainName is a DNS name */
211 #define ADS_DNS_FOREST     0x80000000  /* DnsForestName is a DNS name */
212
213 /* DomainCntrollerAddressType */
214 #define ADS_INET_ADDRESS      0x00000001
215 #define ADS_NETBIOS_ADDRESS   0x00000002
216
217
218 /* ads auth control flags */
219 #define ADS_AUTH_DISABLE_KERBEROS 0x01
220 #define ADS_AUTH_NO_BIND          0x02
221 #define ADS_AUTH_ANON_BIND        0x04
222 #define ADS_AUTH_SIMPLE_BIND      0x08
223 #define ADS_AUTH_ALLOW_NTLMSSP    0x10
224
225 /* Kerberos environment variable names */
226 #define KRB5_ENV_CCNAME "KRB5CCNAME"
227
228 /* Heimdal uses a slightly different name */
229 #if defined(HAVE_ENCTYPE_ARCFOUR_HMAC_MD5)
230 #define ENCTYPE_ARCFOUR_HMAC ENCTYPE_ARCFOUR_HMAC_MD5
231 #endif
232
233 /* The older versions of heimdal that don't have this
234    define don't seem to use it anyway.  I'm told they
235    always use a subkey */
236 #ifndef HAVE_AP_OPTS_USE_SUBKEY
237 #define AP_OPTS_USE_SUBKEY 0
238 #endif