tevent: Fix a docu typo
[samba.git] / wscript_configure_system_mitkrb5
1 import sys
2 from waflib import Logs, Options
3
4 # Check for kerberos
5 have_gssapi=False
6
7 krb5_min_required_version = "1.9"
8
9 # Requried versions
10 krb5_required_version = krb5_min_required_version
11 if conf.CONFIG_SET('AD_DC_BUILD_IS_ENABLED'):
12     krb5_required_version = "1.15.1"
13
14 def parse_version(v):
15     return tuple(map(int, (v.split("."))))
16
17 def krb5_define_syslib(conf, lib, deps):
18     found = 'FOUND_SYSTEMLIB_' + lib
19     if found in conf.env:
20         return
21     conf.SET_TARGET_TYPE(lib, 'SYSLIB')
22     conf.SET_SYSLIB_DEPS(lib, deps)
23     conf.env[found] = True
24
25 Logs.info("Looking for kerberos features")
26 conf.find_program('krb5-config.heimdal', var='HEIMDAL_KRB5_CONFIG')
27
28 if isinstance(Options.options.with_system_mitkrb5, list):
29     path_krb5_config = [x+'/bin' for x in Options.options.with_system_mitkrb5]
30 else:
31     path_krb5_config = None
32
33 conf.find_program('krb5-config', path_list=path_krb5_config, var='KRB5_CONFIG')
34 if conf.env.KRB5_CONFIG:
35     conf.CHECK_CFG(path=conf.env.KRB5_CONFIG, args="--cflags --libs",
36                package="", uselib_store="KRB5")
37     krb5_define_syslib(conf, "krb5", conf.env['LIB_KRB5'])
38
39     conf.CHECK_CFG(path=conf.env.KRB5_CONFIG, args="--cflags --libs",
40                    package="kadm-server", uselib_store="KADM-SERVER")
41     conf.CHECK_FUNCS_IN('kadm5_init', 'kadm5srv_mit')
42
43     conf.CHECK_CFG(path=conf.env.KRB5_CONFIG, args="--cflags --libs",
44                    package="kdb", uselib_store="KDB5")
45     krb5_define_syslib(conf, "kdb5", conf.env['LIB_KDB5'])
46
47     conf.CHECK_CFG(path=conf.env.KRB5_CONFIG, args="--cflags --libs",
48                package="gssapi", uselib_store="GSSAPI")
49     krb5_define_syslib(conf, "gssapi", conf.env['LIB_GSSAPI'])
50     if 'k5crypto' in conf.env['LIB_GSSAPI']:
51         krb5_define_syslib(conf, "k5crypto", conf.env['LIB_GSSAPI'])
52     if 'com_err' in conf.env['LIB_GSSAPI']:
53         krb5_define_syslib(conf, "com_err", conf.env['LIB_GSSAPI'])
54     if 'gssapi_krb5' in conf.env['LIB_GSSAPI']:
55         krb5_define_syslib(conf, "gssapi_krb5", conf.env['LIB_GSSAPI'])
56
57     vendor = conf.cmd_and_log(conf.env.KRB5_CONFIG+['--vendor'])
58     conf.env.KRB5_VENDOR = vendor.strip().lower()
59     if conf.env.KRB5_VENDOR != 'heimdal':
60         conf.define('USING_SYSTEM_KRB5', 1)
61         del conf.env.HEIMDAL_KRB5_CONFIG
62         krb5_conf_version = conf.cmd_and_log(conf.env.KRB5_CONFIG+['--version']).strip()
63
64         krb5_version = krb5_conf_version.split()[-1]
65
66         # drop '-prerelease' suffix
67         if krb5_version.find('-') > 0:
68             krb5_version = krb5_version.split("-")[0]
69
70         if parse_version(krb5_version) < parse_version(krb5_required_version):
71             Logs.error('ERROR: The MIT KRB5 build with Samba AD requires at least %s. %s has been found and cannot be used' % (krb5_required_version, krb5_version))
72             Logs.error('ERROR: If you want to just build Samba FS (File Server) use the option --without-ad-dc which requires version %s' % (krb5_min_required_version))
73             Logs.error('ERROR: You may try to build with embedded Heimdal Kerberos by not specifying --with-system-mitkrb5')
74             sys.exit(1)
75         else:
76             Logs.info('MIT Kerberos %s detected, MIT krb5 build can proceed' % (krb5_version))
77
78 conf.CHECK_CFG(args="--cflags --libs", package="com_err", uselib_store="com_err")
79 conf.CHECK_FUNCS_IN('_et_list', 'com_err')
80 conf.CHECK_HEADERS('com_err.h', lib='com_err')
81 conf.CHECK_HEADERS('kdb.h', lib='kdb5')
82
83 conf.CHECK_HEADERS('krb5.h krb5/locate_plugin.h', lib='krb5')
84 conf.CHECK_HEADERS('krb5.h krb5/localauth_plugin.h', lib='krb5')
85 possible_gssapi_headers="gssapi.h gssapi/gssapi_generic.h gssapi/gssapi.h gssapi/gssapi_ext.h gssapi/gssapi_krb5.h gssapi/gssapi_oid.h"
86 conf.CHECK_HEADERS(possible_gssapi_headers, lib='gssapi')
87
88 conf.CHECK_FUNCS_IN('krb5_encrypt_data', 'k5crypto')
89 conf.CHECK_FUNCS_IN('des_set_key','crypto')
90 conf.CHECK_FUNCS_IN('copy_Authenticator', 'asn1')
91 conf.CHECK_FUNCS_IN('roken_getaddrinfo_hostspec', 'roken')
92
93 conf.CHECK_HEADERS('profile.h')
94
95 if conf.CHECK_FUNCS_IN('gss_display_status', 'gssapi gssapi_krb5'):
96     have_gssapi=True
97
98 if not have_gssapi:
99     if conf.env.KRB5_CONFIG and conf.env.KRB5_CONFIG != 'heimdal':
100         Logs.error("ERROR: WAF build with MIT Krb5 requires working GSSAPI implementation")
101         sys.exit(1)
102
103 conf.CHECK_FUNCS_IN('''
104        gss_wrap_iov
105        gss_krb5_import_cred
106        gss_get_name_attribute
107        gss_mech_krb5
108        gss_oid_equal
109        gss_inquire_sec_context_by_oid
110        gsskrb5_extract_authz_data_from_sec_context
111        gss_krb5_export_lucid_sec_context
112        gss_import_cred gss_export_cred
113        gss_acquire_cred_from
114        ''', 'gssapi gssapi_krb5')
115 conf.CHECK_VARIABLE('GSS_KRB5_CRED_NO_CI_FLAGS_X', headers=possible_gssapi_headers)
116 conf.CHECK_FUNCS_IN('krb5_mk_req_extended krb5_kt_compare', 'krb5')
117 conf.CHECK_FUNCS('''
118        krb5_auth_con_getrecvsubkey
119        krb5_auth_con_getsendsubkey
120        krb5_set_default_in_tkt_etypes krb5_set_default_tgs_enctypes
121        krb5_set_default_tgs_ktypes krb5_principal2salt
122        krb5_c_string_to_key krb5_get_pw_salt krb5_string_to_key_salt krb5_auth_con_setkey
123        krb5_auth_con_setuseruserkey krb5_get_permitted_enctypes
124        krb5_get_default_in_tkt_etypes krb5_free_data_contents
125        krb5_principal_get_comp_string krb5_free_unparsed_name
126        krb5_free_keytab_entry_contents krb5_kt_free_entry krb5_krbhst_init
127        krb5_krbhst_get_addrinfo
128        krb5_crypto_init krb5_crypto_destroy
129        krb5_c_verify_checksum krb5_principal_compare_any_realm
130        krb5_parse_name_norealm krb5_princ_size krb5_get_init_creds_opt_set_pac_request
131        krb5_get_renewed_creds krb5_free_error_contents
132        initialize_krb5_error_table krb5_get_init_creds_opt_alloc
133        krb5_get_init_creds_opt_free krb5_get_init_creds_opt_get_error
134        krb5_enctype_to_string krb5_fwd_tgt_creds krb5_auth_con_set_req_cksumtype
135        krb5_get_creds_opt_alloc krb5_get_creds_opt_set_impersonate krb5_get_creds
136        krb5_get_credentials_for_user krb5_get_host_realm krb5_free_host_realm
137        krb5_get_init_creds_keyblock krb5_get_init_creds_keytab
138        krb5_make_principal krb5_build_principal_alloc_va
139        krb5_cc_get_lifetime krb5_cc_retrieve_cred
140        krb5_cc_copy_creds
141        krb5_free_checksum_contents krb5_c_make_checksum krb5_create_checksum
142        krb5_config_get_bool_default krb5_get_profile
143        krb5_data_copy
144        krb5_init_keyblock krb5_principal_set_realm krb5_principal_get_type
145        krb5_principal_set_type
146        krb5_warnx
147        krb5_get_prompt_types
148        ''',
149      lib='krb5 k5crypto')
150 conf.CHECK_DECLS('''krb5_get_credentials_for_user
151                     krb5_auth_con_set_req_cksumtype''',
152                     headers='krb5.h', always=True)
153 conf.CHECK_VARIABLE('AP_OPTS_USE_SUBKEY', headers='krb5.h')
154 conf.CHECK_VARIABLE('KV5M_KEYTAB', headers='krb5.h')
155 conf.CHECK_VARIABLE('KRB5_KU_OTHER_CKSUM', headers='krb5.h')
156 conf.CHECK_VARIABLE('KRB5_KEYUSAGE_APP_DATA_CKSUM', headers='krb5.h')
157 conf.CHECK_VARIABLE('ENCTYPE_AES128_CTS_HMAC_SHA1_96', headers='krb5.h')
158 conf.CHECK_VARIABLE('ENCTYPE_AES256_CTS_HMAC_SHA1_96', headers='krb5.h')
159 conf.CHECK_DECLS('KRB5_PDU_NONE', reverse=True, headers='krb5.h')
160 conf.CHECK_STRUCTURE_MEMBER('krb5_keytab_entry', 'key', headers='krb5.h',
161                             define='HAVE_KRB5_KEYTAB_ENTRY_KEY')
162 conf.CHECK_STRUCTURE_MEMBER('krb5_keytab_entry', 'keyblock', headers='krb5.h',
163                             define='HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK')
164 conf.CHECK_STRUCTURE_MEMBER('krb5_address', 'magic', headers='krb5.h',
165                             define='HAVE_MAGIC_IN_KRB5_ADDRESS')
166 conf.CHECK_STRUCTURE_MEMBER('krb5_address', 'addrtype', headers='krb5.h',
167                             define='HAVE_ADDRTYPE_IN_KRB5_ADDRESS')
168 conf.CHECK_STRUCTURE_MEMBER('krb5_ap_req', 'ticket', headers='krb5.h',
169                             define='HAVE_TICKET_POINTER_IN_KRB5_AP_REQ')
170 conf.CHECK_STRUCTURE_MEMBER('krb5_prompt', 'type', headers='krb5.h',
171                             define='HAVE_KRB5_PROMPT_TYPE')
172
173 conf.CHECK_TYPE('krb5_encrypt_block', headers='krb5.h')
174
175 conf.CHECK_CODE('''
176        krb5_context ctx;
177        krb5_get_init_creds_opt *opt = NULL;
178        krb5_get_init_creds_opt_free(ctx, opt);
179        ''',
180     'KRB5_CREDS_OPT_FREE_REQUIRES_CONTEXT',
181     headers='krb5.h', link=False,
182     msg="Checking whether krb5_get_init_creds_opt_free takes a context argument")
183 conf.CHECK_CODE('''
184        const krb5_data *pkdata;
185        krb5_context context;
186        krb5_principal principal;
187        pkdata = krb5_princ_component(context, principal, 0);
188        ''',
189     'HAVE_KRB5_PRINC_COMPONENT',
190     headers='krb5.h', lib='krb5',
191     msg="Checking whether krb5_princ_component is available")
192
193 conf.CHECK_CODE('''
194        int main(void) {
195        char buf[256];
196        krb5_enctype_to_string(1, buf, 256);
197        return 0;
198        }''',
199     'HAVE_KRB5_ENCTYPE_TO_STRING_WITH_SIZE_T_ARG',
200     headers='krb5.h', lib='krb5 k5crypto',
201     addmain=False, cflags=conf.env['WERROR_CFLAGS'],
202     msg="Checking whether krb5_enctype_to_string takes size_t argument")
203
204 conf.CHECK_CODE('''
205        int main(void) {
206        krb5_context context = NULL;
207        char *str = NULL;
208        krb5_enctype_to_string(context, 1, &str);
209        if (str) free (str);
210        return 0;
211        }''',
212     'HAVE_KRB5_ENCTYPE_TO_STRING_WITH_KRB5_CONTEXT_ARG',
213     headers='krb5.h stdlib.h', lib='krb5',
214     addmain=False, cflags=conf.env['WERROR_CFLAGS'],
215     msg="Checking whether krb5_enctype_to_string takes krb5_context argument")
216 conf.CHECK_CODE('''
217        int main(void) {
218        krb5_context ctx = NULL;
219        krb5_principal princ = NULL;
220        const char *str = krb5_princ_realm(ctx, princ)->data;
221        return 0;
222        }''',
223     'HAVE_KRB5_PRINC_REALM',
224     headers='krb5.h', lib='krb5',
225     addmain=False,
226     msg="Checking whether the macro krb5_princ_realm is defined")
227 conf.CHECK_CODE('''
228        int main(void) {
229            krb5_context context;
230            krb5_principal principal;
231            const char *realm; realm = krb5_principal_get_realm(context, principal);
232            return 0;
233        }''',
234     'HAVE_KRB5_PRINCIPAL_GET_REALM',
235     headers='krb5.h', lib='krb5',
236     addmain=False,
237     msg="Checking whether krb5_principal_get_realm is defined")
238 conf.CHECK_CODE('''
239        krb5_enctype enctype;
240        enctype = ENCTYPE_ARCFOUR_HMAC_MD5;
241        ''',
242     '_HAVE_ENCTYPE_ARCFOUR_HMAC_MD5',
243     headers='krb5.h', lib='krb5',
244     msg="Checking whether the ENCTYPE_ARCFOUR_HMAC_MD5 key type definition is available");
245 conf.CHECK_CODE('''
246        krb5_enctype enctype;
247        enctype = ENCTYPE_ARCFOUR_HMAC_MD5_56;
248        ''',
249     '_HAVE_ENCTYPE_ARCFOUR_HMAC_MD5_56',
250     headers='krb5.h', lib='krb5',
251     msg="Checking whether the ENCTYPE_ARCFOUR_HMAC_MD5_56 key type definition is available");
252 conf.CHECK_CODE('''
253        krb5_keytype keytype;
254        keytype = KEYTYPE_ARCFOUR_56;
255        ''',
256     '_HAVE_KEYTYPE_ARCFOUR_56',
257     headers='krb5.h', lib='krb5',
258     msg="Checking whether the HAVE_KEYTYPE_ARCFOUR_56 key type definition is available");
259 if conf.CONFIG_SET('_HAVE_ENCTYPE_ARCFOUR_HMAC_MD5') and conf.CONFIG_SET('_HAVE_KEYTYPE_ARCFOUR_56'):
260     conf.DEFINE('HAVE_ENCTYPE_ARCFOUR_HMAC_MD5', '1')
261 if conf.CONFIG_SET('_HAVE_ENCTYPE_ARCFOUR_HMAC_MD5_56') and conf.CONFIG_SET('_HAVE_KEYTYPE_ARCFOUR_56'):
262     conf.DEFINE('HAVE_ENCTYPE_ARCFOUR_HMAC_MD5_56', '1')
263
264 conf.CHECK_CODE('''
265        krb5_enctype enctype;
266        enctype = ENCTYPE_ARCFOUR_HMAC;
267        ''',
268     'HAVE_ENCTYPE_ARCFOUR_HMAC',
269     headers='krb5.h', lib='krb5',
270     msg="Checking whether the ENCTYPE_ARCFOUR_HMAC key type definition is available");
271 conf.CHECK_CODE('''
272        krb5_enctype enctype;
273        enctype = ENCTYPE_ARCFOUR_HMAC_EXP;
274        ''',
275     'HAVE_ENCTYPE_ARCFOUR_HMAC_EXP',
276     headers='krb5.h', lib='krb5',
277     msg="Checking whether the ENCTYPE_ARCFOUR_HMAC_EXP key type definition is available");
278
279 conf.CHECK_CODE('''
280        krb5_context context;
281        krb5_keytab keytab;
282        krb5_init_context(&context);
283        return krb5_kt_resolve(context, "WRFILE:api", &keytab);
284        ''',
285     'HAVE_WRFILE_KEYTAB',
286     headers='krb5.h', lib='krb5', execute=True,
287     msg="Checking whether the WRFILE -keytab is supported");
288 # Check for KRB5_DEPRECATED handling
289 conf.CHECK_CODE('''#define KRB5_DEPRECATED 1
290        #include <krb5.h>''',
291    'HAVE_KRB5_DEPRECATED_WITH_IDENTIFIER', addmain=False,
292     link=False,
293     msg="Checking for KRB5_DEPRECATED define taking an identifier")
294
295 conf.CHECK_CODE('''
296        krb5_creds creds;
297        creds.flags.b.initial = 0;
298        ''',
299     'HAVE_FLAGS_IN_KRB5_CREDS',
300     headers='krb5.h', lib='krb5', execute=False,
301     msg="Checking whether krb5_creds have flags property")
302
303 # Check for MIT KDC
304 if conf.CONFIG_SET('AD_DC_BUILD_IS_ENABLED'):
305     Logs.info("Looking for MIT KDC")
306     conf.DEFINE('SAMBA_USES_MITKDC', 1);
307
308     kdc_path_list = [ '/usr/sbin', '/usr/lib/mit/sbin']
309
310     if getattr(Options.options, 'with_system_mitkdc', None):
311         conf.DEFINE('MIT_KDC_PATH', '"' + Options.options.with_system_mitkdc + '"')
312     else:
313         conf.find_program('krb5kdc', path_list=kdc_path_list, var='MIT_KDC_BINARY', mandatory=True)
314         conf.DEFINE('MIT_KDC_PATH', '"' + " ".join(conf.env.MIT_KDC_BINARY) + '"')