ctdb-tools: Improve onnode's ShellCheck credibility
[samba.git] / wscript_configure_system_mitkrb5
blobb0bf2a8b40db66110a0c4fad3d2fdbc6ef1f65ea
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 # 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"
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.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'])
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')
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'])
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'])
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         raise Errors.WafError('--with-system-mitkrb5 cannot be used with system heimdal')
62     conf.define('USING_SYSTEM_KRB5', 1)
63     del conf.env.HEIMDAL_KRB5_CONFIG
64     krb5_conf_version = conf.cmd_and_log(conf.env.KRB5_CONFIG+['--version']).strip()
66     krb5_version = krb5_conf_version.split()[-1]
68     # drop '-prerelease' suffix
69     if krb5_version.find('-') > 0:
70         krb5_version = krb5_version.split("-")[0]
72     if parse_version(krb5_version) < parse_version(krb5_required_version):
73         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))
74         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))
75         Logs.error('ERROR: You may try to build with embedded Heimdal Kerberos by not specifying --with-system-mitkrb5')
76         sys.exit(1)
77     else:
78         Logs.info('MIT Kerberos %s detected, MIT krb5 build can proceed' % (krb5_version))
80     if parse_version(krb5_version) < parse_version('1.18'):
81         conf.DEFINE('HAVE_MIT_KRB5_PRE_1_18', 1)
83 conf.CHECK_CFG(args="--cflags --libs", package="com_err", uselib_store="com_err")
84 conf.CHECK_FUNCS_IN('_et_list', 'com_err')
85 conf.CHECK_HEADERS('com_err.h', lib='com_err')
86 conf.CHECK_HEADERS('kdb.h', lib='kdb5')
88 conf.CHECK_HEADERS('krb5.h krb5/locate_plugin.h', lib='krb5')
89 conf.CHECK_HEADERS('krb5.h krb5/localauth_plugin.h', lib='krb5')
90 possible_gssapi_headers="gssapi.h gssapi/gssapi_generic.h gssapi/gssapi.h gssapi/gssapi_ext.h gssapi/gssapi_krb5.h gssapi/gssapi_oid.h"
91 conf.CHECK_HEADERS(possible_gssapi_headers, lib='gssapi')
93 conf.CHECK_FUNCS_IN('krb5_encrypt_data', 'k5crypto')
94 conf.CHECK_FUNCS_IN('des_set_key','crypto')
95 conf.CHECK_FUNCS_IN('copy_Authenticator', 'asn1')
96 conf.CHECK_FUNCS_IN('roken_getaddrinfo_hostspec', 'roken')
98 conf.CHECK_HEADERS('profile.h')
100 if conf.CHECK_FUNCS_IN('gss_display_status', 'gssapi gssapi_krb5'):
101     have_gssapi=True
103 if not have_gssapi:
104     if conf.env.KRB5_CONFIG and conf.env.KRB5_CONFIG != 'heimdal':
105         Logs.error("ERROR: WAF build with MIT Krb5 requires working GSSAPI implementation")
106         sys.exit(1)
108 conf.CHECK_FUNCS_IN('''
109        gss_wrap_iov
110        gss_krb5_import_cred
111        gss_get_name_attribute
112        gss_mech_krb5
113        gss_oid_equal
114        gss_inquire_sec_context_by_oid
115        gsskrb5_extract_authz_data_from_sec_context
116        gss_krb5_export_lucid_sec_context
117        gss_import_cred gss_export_cred
118        gss_acquire_cred_from
119        ''', 'gssapi gssapi_krb5')
120 conf.CHECK_VARIABLE('GSS_KRB5_CRED_NO_CI_FLAGS_X', headers=possible_gssapi_headers)
121 conf.CHECK_FUNCS_IN('krb5_mk_req_extended krb5_kt_compare', 'krb5')
122 conf.CHECK_FUNCS('''
123        krb5_auth_con_getrecvsubkey
124        krb5_auth_con_getsendsubkey
125        krb5_set_default_in_tkt_etypes krb5_set_default_tgs_enctypes
126        krb5_set_default_tgs_ktypes krb5_principal2salt
127        krb5_c_string_to_key krb5_get_pw_salt krb5_string_to_key_salt krb5_auth_con_setkey
128        krb5_auth_con_setuseruserkey krb5_get_permitted_enctypes
129        krb5_get_default_in_tkt_etypes krb5_free_data_contents
130        krb5_principal_get_comp_string krb5_free_unparsed_name
131        krb5_free_keytab_entry_contents krb5_kt_free_entry krb5_krbhst_init
132        krb5_krbhst_get_addrinfo
133        krb5_crypto_init krb5_crypto_destroy
134        krb5_c_verify_checksum krb5_principal_compare_any_realm
135        krb5_parse_name_norealm krb5_princ_size krb5_get_init_creds_opt_set_pac_request
136        krb5_get_renewed_creds krb5_free_error_contents
137        initialize_krb5_error_table krb5_get_init_creds_opt_alloc
138        krb5_get_init_creds_opt_free krb5_get_init_creds_opt_get_error
139        krb5_enctype_to_string krb5_fwd_tgt_creds krb5_auth_con_set_req_cksumtype
140        krb5_get_creds_opt_alloc krb5_get_creds_opt_set_impersonate krb5_get_creds
141        krb5_get_credentials_for_user krb5_get_host_realm krb5_free_host_realm
142        krb5_get_init_creds_keyblock krb5_get_init_creds_keytab
143        krb5_make_principal krb5_build_principal_alloc_va
144        krb5_cc_get_lifetime krb5_cc_retrieve_cred
145        krb5_cc_copy_creds
146        krb5_free_checksum_contents krb5_c_make_checksum krb5_create_checksum
147        krb5_config_get_bool_default krb5_get_profile
148        krb5_data_copy
149        krb5_init_keyblock krb5_principal_set_realm krb5_principal_get_type
150        krb5_principal_set_type
151        krb5_warnx
152        krb5_get_prompt_types
153        ''',
154      lib='krb5 k5crypto')
155 conf.CHECK_DECLS('''krb5_get_credentials_for_user
156                     krb5_auth_con_set_req_cksumtype''',
157                     headers='krb5.h', always=True)
158 conf.CHECK_VARIABLE('AP_OPTS_USE_SUBKEY', headers='krb5.h')
159 conf.CHECK_VARIABLE('KV5M_KEYTAB', headers='krb5.h')
160 conf.CHECK_VARIABLE('KRB5_KU_OTHER_CKSUM', headers='krb5.h')
161 conf.CHECK_VARIABLE('KRB5_KEYUSAGE_APP_DATA_CKSUM', headers='krb5.h')
162 conf.CHECK_VARIABLE('ENCTYPE_AES128_CTS_HMAC_SHA1_96', headers='krb5.h')
163 conf.CHECK_VARIABLE('ENCTYPE_AES256_CTS_HMAC_SHA1_96', headers='krb5.h')
164 conf.CHECK_DECLS('KRB5_PDU_NONE', reverse=True, headers='krb5.h')
165 conf.CHECK_STRUCTURE_MEMBER('krb5_keytab_entry', 'key', headers='krb5.h',
166                             define='HAVE_KRB5_KEYTAB_ENTRY_KEY')
167 conf.CHECK_STRUCTURE_MEMBER('krb5_keytab_entry', 'keyblock', headers='krb5.h',
168                             define='HAVE_KRB5_KEYTAB_ENTRY_KEYBLOCK')
169 conf.CHECK_STRUCTURE_MEMBER('krb5_address', 'magic', headers='krb5.h',
170                             define='HAVE_MAGIC_IN_KRB5_ADDRESS')
171 conf.CHECK_STRUCTURE_MEMBER('krb5_address', 'addrtype', headers='krb5.h',
172                             define='HAVE_ADDRTYPE_IN_KRB5_ADDRESS')
173 conf.CHECK_STRUCTURE_MEMBER('krb5_ap_req', 'ticket', headers='krb5.h',
174                             define='HAVE_TICKET_POINTER_IN_KRB5_AP_REQ')
175 conf.CHECK_STRUCTURE_MEMBER('krb5_prompt', 'type', headers='krb5.h',
176                             define='HAVE_KRB5_PROMPT_TYPE')
177 conf.CHECK_CODE('krb5_trace_info', 'HAVE_KRB5_TRACE_INFO', headers='krb5.h')
178 conf.CHECK_CODE('struct krb5_trace_info', 'HAVE_KRB5_TRACE_INFO_STRUCT', headers='krb5.h')
179 conf.CHECK_TYPE('krb5_encrypt_block', headers='krb5.h')
181 conf.CHECK_CODE('''
182        krb5_context ctx;
183        krb5_get_init_creds_opt *opt = NULL;
184        krb5_get_init_creds_opt_free(ctx, opt);
185        ''',
186     'KRB5_CREDS_OPT_FREE_REQUIRES_CONTEXT',
187     headers='krb5.h', link=False,
188     msg="Checking whether krb5_get_init_creds_opt_free takes a context argument")
189 conf.CHECK_CODE('''
190        const krb5_data *pkdata;
191        krb5_context context;
192        krb5_principal principal;
193        pkdata = krb5_princ_component(context, principal, 0);
194        ''',
195     'HAVE_KRB5_PRINC_COMPONENT',
196     headers='krb5.h', lib='krb5',
197     msg="Checking whether krb5_princ_component is available")
199 conf.CHECK_CODE('''
200        int main(void) {
201        char buf[256];
202        krb5_enctype_to_string(1, buf, 256);
203        return 0;
204        }''',
205     'HAVE_KRB5_ENCTYPE_TO_STRING_WITH_SIZE_T_ARG',
206     headers='krb5.h', lib='krb5 k5crypto',
207     addmain=False, cflags=conf.env['WERROR_CFLAGS'],
208     msg="Checking whether krb5_enctype_to_string takes size_t argument")
210 conf.CHECK_CODE('''
211        int main(void) {
212        krb5_context context = NULL;
213        char *str = NULL;
214        krb5_enctype_to_string(context, 1, &str);
215        if (str) free (str);
216        return 0;
217        }''',
218     'HAVE_KRB5_ENCTYPE_TO_STRING_WITH_KRB5_CONTEXT_ARG',
219     headers='krb5.h stdlib.h', lib='krb5',
220     addmain=False, cflags=conf.env['WERROR_CFLAGS'],
221     msg="Checking whether krb5_enctype_to_string takes krb5_context argument")
222 conf.CHECK_CODE('''
223        int main(void) {
224        krb5_context ctx = NULL;
225        krb5_principal princ = NULL;
226        const char *str = krb5_princ_realm(ctx, princ)->data;
227        return 0;
228        }''',
229     'HAVE_KRB5_PRINC_REALM',
230     headers='krb5.h', lib='krb5',
231     addmain=False,
232     msg="Checking whether the macro krb5_princ_realm is defined")
233 conf.CHECK_CODE('''
234        int main(void) {
235            krb5_context context;
236            krb5_principal principal;
237            const char *realm; realm = krb5_principal_get_realm(context, principal);
238            return 0;
239        }''',
240     'HAVE_KRB5_PRINCIPAL_GET_REALM',
241     headers='krb5.h', lib='krb5',
242     addmain=False,
243     msg="Checking whether krb5_principal_get_realm is defined")
244 conf.CHECK_CODE('''
245        krb5_enctype enctype;
246        enctype = ENCTYPE_ARCFOUR_HMAC_MD5;
247        ''',
248     '_HAVE_ENCTYPE_ARCFOUR_HMAC_MD5',
249     headers='krb5.h', lib='krb5',
250     msg="Checking whether the ENCTYPE_ARCFOUR_HMAC_MD5 key type definition is available");
251 conf.CHECK_CODE('''
252        krb5_enctype enctype;
253        enctype = ENCTYPE_ARCFOUR_HMAC_MD5_56;
254        ''',
255     '_HAVE_ENCTYPE_ARCFOUR_HMAC_MD5_56',
256     headers='krb5.h', lib='krb5',
257     msg="Checking whether the ENCTYPE_ARCFOUR_HMAC_MD5_56 key type definition is available");
258 conf.CHECK_CODE('''
259        krb5_keytype keytype;
260        keytype = KEYTYPE_ARCFOUR_56;
261        ''',
262     '_HAVE_KEYTYPE_ARCFOUR_56',
263     headers='krb5.h', lib='krb5',
264     msg="Checking whether the HAVE_KEYTYPE_ARCFOUR_56 key type definition is available");
265 if conf.CONFIG_SET('_HAVE_ENCTYPE_ARCFOUR_HMAC_MD5') and conf.CONFIG_SET('_HAVE_KEYTYPE_ARCFOUR_56'):
266     conf.DEFINE('HAVE_ENCTYPE_ARCFOUR_HMAC_MD5', '1')
267 if conf.CONFIG_SET('_HAVE_ENCTYPE_ARCFOUR_HMAC_MD5_56') and conf.CONFIG_SET('_HAVE_KEYTYPE_ARCFOUR_56'):
268     conf.DEFINE('HAVE_ENCTYPE_ARCFOUR_HMAC_MD5_56', '1')
270 conf.CHECK_CODE('''
271        krb5_enctype enctype;
272        enctype = ENCTYPE_ARCFOUR_HMAC;
273        ''',
274     'HAVE_ENCTYPE_ARCFOUR_HMAC',
275     headers='krb5.h', lib='krb5',
276     msg="Checking whether the ENCTYPE_ARCFOUR_HMAC key type definition is available");
277 conf.CHECK_CODE('''
278        krb5_enctype enctype;
279        enctype = ENCTYPE_ARCFOUR_HMAC_EXP;
280        ''',
281     'HAVE_ENCTYPE_ARCFOUR_HMAC_EXP',
282     headers='krb5.h', lib='krb5',
283     msg="Checking whether the ENCTYPE_ARCFOUR_HMAC_EXP key type definition is available");
285 conf.CHECK_CODE('''
286        krb5_context context;
287        krb5_keytab keytab;
288        krb5_init_context(&context);
289        return krb5_kt_resolve(context, "WRFILE:api", &keytab);
290        ''',
291     'HAVE_WRFILE_KEYTAB',
292     headers='krb5.h', lib='krb5', execute=True,
293     msg="Checking whether the WRFILE -keytab is supported");
294 # Check for KRB5_DEPRECATED handling
295 conf.CHECK_CODE('''#define KRB5_DEPRECATED 1
296        #include <krb5.h>''',
297    'HAVE_KRB5_DEPRECATED_WITH_IDENTIFIER', addmain=False,
298     link=False,
299     msg="Checking for KRB5_DEPRECATED define taking an identifier")
301 conf.CHECK_CODE('''
302        krb5_creds creds;
303        creds.flags.b.initial = 0;
304        ''',
305     'HAVE_FLAGS_IN_KRB5_CREDS',
306     headers='krb5.h', lib='krb5', execute=False,
307     msg="Checking whether krb5_creds have flags property")
309 # Check for MIT KDC
310 if conf.CONFIG_SET('AD_DC_BUILD_IS_ENABLED'):
311     Logs.info("Looking for MIT KDC")
312     conf.DEFINE('SAMBA_USES_MITKDC', 1);
314     kdc_path_list = [ '/usr/sbin', '/usr/lib/mit/sbin']
316     if getattr(Options.options, 'with_system_mitkdc', None):
317         conf.DEFINE('MIT_KDC_PATH', '"' + Options.options.with_system_mitkdc + '"')
318     else:
319         conf.find_program('krb5kdc', path_list=kdc_path_list, var='MIT_KDC_BINARY', mandatory=True)
320         conf.DEFINE('MIT_KDC_PATH', '"' + " ".join(conf.env.MIT_KDC_BINARY) + '"')