1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
#!/usr/bin/env python2
"""
Used to generate lib/tls/tls_suite_info.cpp from IANA params
(C) 2011, 2012, 2013, 2014, 2015, 2016, 2017 Jack Lloyd
Botan is released under the Simplified BSD License (see license.txt)
"""
import sys
import re
import datetime
import hashlib
import optparse
def to_ciphersuite_info(code, name):
(sig_and_kex,cipher_and_mac) = name.split('_WITH_')
if sig_and_kex == 'RSA':
sig_algo = 'IMPLICIT'
kex_algo = 'RSA'
elif 'PSK' in sig_and_kex:
sig_algo = 'IMPLICIT'
kex_algo = sig_and_kex
elif 'SRP' in sig_and_kex:
srp_info = sig_and_kex.split('_')
if len(srp_info) == 2: # 'SRP_' + hash
kex_algo = sig_and_kex
sig_algo = 'IMPLICIT'
else:
kex_algo = '_'.join(srp_info[0:-1])
sig_algo = srp_info[-1]
else:
(kex_algo, sig_algo) = sig_and_kex.split('_')
cipher_and_mac = cipher_and_mac.split('_')
mac_algo = cipher_and_mac[-1]
cipher = cipher_and_mac[:-1]
if mac_algo == '8' and cipher[-1] == 'CCM':
cipher = cipher[:-1]
mac_algo = 'CCM_8'
elif cipher[-2] == 'CCM' and cipher[-1] == '8':
cipher = cipher[:-1]
mac_algo = 'CCM_8'
if mac_algo == 'CCM':
cipher += ['CCM']
mac_algo = 'SHA256'
elif mac_algo == 'CCM_8':
cipher += ['CCM(8)']
mac_algo = 'SHA256'
cipher_info = {
'CHACHA20': ('ChaCha',32),
'IDEA': ('IDEA',16),
'DES': ('DES',8),
'3DES': ('3DES',24),
'CAMELLIA': ('Camellia',None),
'AES': ('AES',None),
'SEED': ('SEED',16),
'ARIA': ('ARIA',None),
}
tls_to_botan_names = {
'IMPLICIT': 'IMPLICIT',
'anon': 'ANONYMOUS',
'MD5': 'MD5',
'SHA': 'SHA-1',
'SHA256': 'SHA-256',
'SHA384': 'SHA-384',
'SHA512': 'SHA-512',
'CHACHA': 'ChaCha',
'3DES': 'TripleDES',
'DSS': 'DSA',
'ECDSA': 'ECDSA',
'RSA': 'RSA',
'SRP_SHA': 'SRP_SHA',
'DHE': 'DH',
'DH': 'DH',
'ECDHE': 'ECDH',
'ECDH': 'ECDH',
'': '',
'PSK': 'PSK',
'DHE_PSK': 'DHE_PSK',
'PSK_DHE': 'DHE_PSK',
'ECDHE_PSK': 'ECDHE_PSK',
'CECPQ1': 'CECPQ1',
'CECPQ1_PSK': 'CECPQ1_PSK',
}
mac_keylen = {
'MD5': 16,
'SHA-1': 20,
'SHA-256': 32,
'SHA-384': 48,
'SHA-512': 64,
}
mac_algo = tls_to_botan_names[mac_algo]
sig_algo = tls_to_botan_names[sig_algo]
kex_algo = tls_to_botan_names[kex_algo]
if kex_algo == 'RSA':
kex_algo = 'STATIC_RSA'
(cipher_algo, cipher_keylen) = cipher_info[cipher[0]]
if cipher_keylen is None:
cipher_keylen = int(cipher[1]) / 8
if cipher_algo in ['AES', 'Camellia', 'ARIA']:
cipher_algo += '-%d' % (cipher_keylen*8)
mode = ''
if cipher[0] == 'CHACHA20' and cipher[1] == 'POLY1305':
return (name, code, sig_algo, kex_algo, "ChaCha20Poly1305", cipher_keylen, "AEAD", 0, mac_algo, 'AEAD_XOR_12')
mode = cipher[-1]
if mode not in ['CBC', 'GCM', 'CCM(8)', 'CCM', 'OCB']:
print "#warning Unknown mode '%s' for ciphersuite %s (0x%d)" % (' '.join(cipher), name, code)
if mode != 'CBC':
if mode == 'OCB':
cipher_algo += '/OCB(12)'
else:
cipher_algo += '/' + mode
if mode == 'CBC':
return (name, code, sig_algo, kex_algo, cipher_algo, cipher_keylen, mac_algo, mac_keylen[mac_algo], mac_algo, 'CBC_MODE')
elif mode == 'OCB':
return (name, code, sig_algo, kex_algo, cipher_algo, cipher_keylen, "AEAD", 0, mac_algo, 'AEAD_XOR_12')
else:
return (name, code, sig_algo, kex_algo, cipher_algo, cipher_keylen, "AEAD", 0, mac_algo, 'AEAD_IMPLICIT_4')
def open_input(args):
iana_url = 'https://www.iana.org/assignments/tls-parameters/tls-parameters.txt'
if len(args) == 1:
try:
return open('tls-parameters.txt')
except OSError:
pass
import urllib2
return urllib2.urlopen(iana_url)
else:
return open(args[1])
"""
Handle command line options
"""
def process_command_line(args):
parser = optparse.OptionParser()
parser.add_option('--with-ocb', action='store_true', default=True,
help='enable OCB AEAD suites')
parser.add_option('--without-ocb', action='store_false', dest='with_ocb',
help='disable OCB AEAD suites')
parser.add_option('--with-aria-cbc', action='store_true', default=False,
help='enable ARIA CBC suites')
parser.add_option('--without-aria-cbc', action='store_false', dest='with_aria_cbc',
help='disable ARIA CBC suites')
parser.add_option('--with-cecpq1', action='store_true', default=True,
help='enable CECPQ1 suites')
parser.add_option('--without-cecpq1', action='store_false', dest='with_cecpq1',
help='disable CECPQ1 suites')
parser.add_option('--with-srp-aead', action='store_true', default=False,
help='add SRP AEAD suites')
parser.add_option('--without-srp-aead', action='store_false', dest='with_srp_aead',
help='disable SRP AEAD suites')
parser.add_option('--save-download', action='store_true', default=False,
help='save downloaded tls-parameters.txt to cwd')
parser.add_option('--output', '-o',
help='file to write output to (default %default)',
default='src/lib/tls/tls_suite_info.cpp')
return parser.parse_args(args)
def main(args = None):
if args is None:
args = sys.argv
weak_crypto = ['EXPORT', 'RC2', 'IDEA', 'RC4', '_DES_', 'WITH_NULL', 'GOST']
static_dh = ['ECDH_ECDSA', 'ECDH_RSA', 'DH_DSS', 'DH_RSA'] # not supported
protocol_goop = ['SCSV', 'KRB5']
maybe_someday = ['RSA_PSK', 'ECCPWD']
not_supported = weak_crypto + static_dh + protocol_goop + maybe_someday
(options, args) = process_command_line(args)
if not options.with_aria_cbc:
not_supported += ['ARIA_128_CBC', 'ARIA_256_CBC']
ciphersuite_re = re.compile(' +0x([0-9a-fA-F][0-9a-fA-F]),0x([0-9a-fA-F][0-9a-fA-F]) + TLS_([A-Za-z_0-9]+) ')
suites = {}
contents = ''
for line in open_input(args):
contents += line
match = ciphersuite_re.match(line)
if match:
code = match.group(1) + match.group(2)
name = match.group(3)
should_use = True
for ns in not_supported:
if ns in name:
should_use = False
if should_use and name.find('_WITH_') > 0:
suites[code] = to_ciphersuite_info(code, name)
sha1 = hashlib.sha1()
sha1.update(contents)
contents_hash = sha1.hexdigest()
if options.save_download:
out = open('tls-parameters.txt', 'w')
out.write(contents)
out.close()
def define_custom_ciphersuite(name, code):
suites[code] = to_ciphersuite_info(code, name)
if options.with_cecpq1:
# CECPQ1 key exchange
define_custom_ciphersuite('CECPQ1_RSA_WITH_CHACHA20_POLY1305_SHA256', '16B7')
define_custom_ciphersuite('CECPQ1_ECDSA_WITH_CHACHA20_POLY1305_SHA256', '16B8')
define_custom_ciphersuite('CECPQ1_RSA_WITH_AES_256_GCM_SHA384', '16B9')
define_custom_ciphersuite('CECPQ1_ECDSA_WITH_AES_256_GCM_SHA384', '16BA')
if options.with_ocb:
# OCB ciphersuites draft-zauner-tls-aes-ocb-04
define_custom_ciphersuite('DHE_RSA_WITH_AES_128_OCB_SHA256', 'FFC0')
define_custom_ciphersuite('DHE_RSA_WITH_AES_256_OCB_SHA256', 'FFC1')
define_custom_ciphersuite('ECDHE_RSA_WITH_AES_128_OCB_SHA256', 'FFC2')
define_custom_ciphersuite('ECDHE_RSA_WITH_AES_256_OCB_SHA256', 'FFC3')
define_custom_ciphersuite('ECDHE_ECDSA_WITH_AES_128_OCB_SHA256', 'FFC4')
define_custom_ciphersuite('ECDHE_ECDSA_WITH_AES_256_OCB_SHA256', 'FFC5')
define_custom_ciphersuite('PSK_WITH_AES_128_OCB_SHA256', 'FFC6')
define_custom_ciphersuite('PSK_WITH_AES_256_OCB_SHA256', 'FFC7')
define_custom_ciphersuite('DHE_PSK_WITH_AES_128_OCB_SHA256', 'FFC8')
define_custom_ciphersuite('DHE_PSK_WITH_AES_256_OCB_SHA256', 'FFC9')
define_custom_ciphersuite('ECDHE_PSK_WITH_AES_128_OCB_SHA256', 'FFCA')
define_custom_ciphersuite('ECDHE_PSK_WITH_AES_256_OCB_SHA256', 'FFCB')
if options.with_cecpq1 and options.with_ocb:
# CECPQ1 OCB ciphersuites - Botan extension
define_custom_ciphersuite('CECPQ1_RSA_WITH_AES_256_OCB_SHA256', 'FFCC')
define_custom_ciphersuite('CECPQ1_ECDSA_WITH_AES_256_OCB_SHA256', 'FFCD')
#define_custom_ciphersuite('CECPQ1_PSK_WITH_AES_256_OCB_SHA256', 'FFCE')
if options.with_srp_aead:
# SRP using GCM or OCB - Botan extension
define_custom_ciphersuite('SRP_SHA_WITH_AES_256_GCM_SHA384', 'FFA0')
define_custom_ciphersuite('SRP_SHA_RSA_WITH_AES_256_GCM_SHA384', 'FFA1')
define_custom_ciphersuite('SRP_SHA_DSS_WITH_AES_256_GCM_SHA384', 'FFA2')
define_custom_ciphersuite('SRP_SHA_ECDSA_WITH_AES_256_GCM_SHA384', 'FFA3')
if options.with_ocb:
define_custom_ciphersuite('SRP_SHA_WITH_AES_256_OCB_SHA256', 'FFA4')
define_custom_ciphersuite('SRP_SHA_RSA_WITH_AES_256_OCB_SHA256', 'FFA5')
define_custom_ciphersuite('SRP_SHA_DSS_WITH_AES_256_OCB_SHA256', 'FFA6')
define_custom_ciphersuite('SRP_SHA_ECDSA_WITH_AES_256_OCB_SHA256', 'FFA7')
suite_info = ''
def header():
return """/*
* TLS cipher suite information
*
* This file was automatically generated from the IANA assignments
* (tls-parameters.txt hash %s)
* by %s on %s
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
""" % (contents_hash, sys.argv[0], datetime.date.today().strftime("%Y-%m-%d"))
suite_info += header()
suite_info += """#include <botan/tls_ciphersuite.h>
namespace Botan {
namespace TLS {
//static
const std::vector<Ciphersuite>& Ciphersuite::all_known_ciphersuites()
{
// Note that this list of ciphersuites is ordered by id!
static const std::vector<Ciphersuite> g_ciphersuite_list = {
"""
for code in sorted(suites.keys()):
info = suites[code]
assert len(info) == 10
suite_expr = 'Ciphersuite(0x%s, "%s", Auth_Method::%s, Kex_Algo::%s, "%s", %d, "%s", %d, KDF_Algo::%s, Nonce_Format::%s)' % (
code, info[0], info[2], info[3], info[4], info[5], info[6], info[7], info[8].replace('-','_'), info[9])
suite_info += " " + suite_expr + ",\n"
suite_info += """ };
return g_ciphersuite_list;
}
}
}
"""
if options.output == '-':
print suite_info,
else:
out = open(options.output, 'w')
out.write(suite_info)
out.close()
return 0
if __name__ == '__main__':
sys.exit(main())
|
