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