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