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