catacomb/__init__.py: Don't print secret bits of keys by default.
[catacomb-python] / catacomb / __init__.py
CommitLineData
00401529
MW
1### -*-python-*-
2###
3### Setup for Catacomb/Python bindings
4###
5### (c) 2004 Straylight/Edgeware
6###
7
8###----- Licensing notice ---------------------------------------------------
9###
10### This file is part of the Python interface to Catacomb.
11###
12### Catacomb/Python is free software; you can redistribute it and/or modify
13### it under the terms of the GNU General Public License as published by
14### the Free Software Foundation; either version 2 of the License, or
15### (at your option) any later version.
16###
17### Catacomb/Python is distributed in the hope that it will be useful,
18### but WITHOUT ANY WARRANTY; without even the implied warranty of
19### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20### GNU General Public License for more details.
21###
22### You should have received a copy of the GNU General Public License
23### along with Catacomb/Python; if not, write to the Free Software Foundation,
24### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
ed8cc62d 25
d7ab1bab 26import _base
27import types as _types
28from binascii import hexlify as _hexify, unhexlify as _unhexify
46e6ad89 29from sys import argv as _argv
30
00401529
MW
31###--------------------------------------------------------------------------
32### Basic stuff.
ed8cc62d
MW
33
34## For the benefit of the default keyreporter, we need the program na,e.
46e6ad89 35_base._ego(_argv[0])
d7ab1bab 36
ed8cc62d
MW
37## Initialize the module. Drag in the static methods of the various
38## classes; create names for the various known crypto algorithms.
d7ab1bab 39def _init():
40 d = globals()
41 b = _base.__dict__;
42 for i in b:
43 if i[0] != '_':
44 d[i] = b[i];
45 for i in ['MP', 'GF', 'Field',
00401529
MW
46 'ECPt', 'ECPtCurve', 'ECCurve', 'ECInfo',
47 'DHInfo', 'BinDHInfo', 'RSAPriv', 'BBSPriv',
48 'PrimeFilter', 'RabinMiller',
49 'Group', 'GE',
89157adc 50 'KeySZ', 'KeyData']:
d7ab1bab 51 c = d[i]
52 pre = '_' + i + '_'
53 plen = len(pre)
54 for j in b:
55 if j[:plen] == pre:
00401529 56 setattr(c, j[plen:], classmethod(b[j]))
ed8cc62d
MW
57 for i in [gcciphers, gchashes, gcmacs, gcprps]:
58 for c in i.itervalues():
3e04ec3a 59 d[c.name.replace('-', '_').translate(None, '/')] = c
ed8cc62d 60 for c in gccrands.itervalues():
3e04ec3a 61 d[c.name.replace('-', '_').translate(None, '/') + 'rand'] = c
d7ab1bab 62_init()
63
ed8cc62d
MW
64## A handy function for our work: add the methods of a named class to an
65## existing class. This is how we write the Python-implemented parts of our
66## mostly-C types.
d7ab1bab 67def _augment(c, cc):
68 for i in cc.__dict__:
69 a = cc.__dict__[i]
70 if type(a) is _types.MethodType:
71 a = a.im_func
72 elif type(a) not in (_types.FunctionType, staticmethod, classmethod):
73 continue
74 setattr(c, i, a)
75
ed8cc62d
MW
76## Parsing functions tend to return the object parsed and the remainder of
77## the input. This checks that the remainder is input and, if so, returns
78## just the object.
79def _checkend(r):
80 x, rest = r
81 if rest != '':
82 raise SyntaxError, 'junk at end of string'
83 return x
84
96d7ed6c 85## Some pretty-printing utilities.
652e16ea 86PRINT_SECRETS = False
330e6a74 87def _clsname(me): return type(me).__name__
652e16ea
MW
88def _repr_secret(thing, secretp = True):
89 if not secretp or PRINT_SECRETS: return repr(thing)
90 else: return '#<SECRET>'
96d7ed6c 91def _pp_str(me, pp, cyclep): pp.text(cyclep and '...' or str(me))
652e16ea
MW
92def _pp_secret(pp, thing, secretp = True):
93 if not secretp or PRINT_SECRETS: pp.pretty(thing)
94 else: pp.text('#<SECRET>')
582568f1
MW
95def _pp_bgroup(pp, text):
96 ind = len(text)
97 pp.begin_group(ind, text)
98 return ind
99def _pp_bgroup_tyname(pp, obj, open = '('):
330e6a74 100 return _pp_bgroup(pp, _clsname(obj) + open)
652e16ea 101def _pp_kv(pp, k, v, secretp = False):
582568f1 102 ind = _pp_bgroup(pp, k + ' = ')
652e16ea 103 _pp_secret(pp, v, secretp)
96d7ed6c
MW
104 pp.end_group(ind, '')
105def _pp_commas(pp, printfn, items):
106 firstp = True
107 for i in items:
108 if firstp: firstp = False
109 else: pp.text(','); pp.breakable()
110 printfn(i)
111def _pp_dict(pp, items):
112 def p((k, v)):
582568f1 113 pp.begin_group(0)
96d7ed6c
MW
114 pp.pretty(k)
115 pp.text(':')
582568f1 116 pp.begin_group(2)
96d7ed6c
MW
117 pp.breakable()
118 pp.pretty(v)
582568f1
MW
119 pp.end_group(2)
120 pp.end_group(0)
96d7ed6c
MW
121 _pp_commas(pp, p, items)
122
00401529
MW
123###--------------------------------------------------------------------------
124### Bytestrings.
ed8cc62d 125
d7ab1bab 126class _tmp:
127 def fromhex(x):
128 return ByteString(_unhexify(x))
129 fromhex = staticmethod(fromhex)
130 def __hex__(me):
131 return _hexify(me)
132 def __repr__(me):
133 return 'bytes(%r)' % hex(me)
134_augment(ByteString, _tmp)
bfb450cc 135ByteString.__hash__ = str.__hash__
d7ab1bab 136bytes = ByteString.fromhex
137
00401529 138###--------------------------------------------------------------------------
bfb450cc
MW
139### Hashing.
140
141class _tmp:
142 def check(me, h):
143 hh = me.done()
144 return ctstreq(h, hh)
145_augment(GHash, _tmp)
146_augment(Poly1305Hash, _tmp)
147
148###--------------------------------------------------------------------------
ce0340b6
MW
149### NaCl `secretbox'.
150
151def secret_box(k, n, m):
152 E = xsalsa20(k).setiv(n)
153 r = E.enczero(poly1305.keysz.default)
154 s = E.enczero(poly1305.masksz)
155 y = E.encrypt(m)
156 t = poly1305(r)(s).hash(y).done()
157 return ByteString(t + y)
158
159def secret_unbox(k, n, c):
160 E = xsalsa20(k).setiv(n)
161 r = E.enczero(poly1305.keysz.default)
162 s = E.enczero(poly1305.masksz)
163 y = c[poly1305.tagsz:]
164 if not poly1305(r)(s).hash(y).check(c[0:poly1305.tagsz]):
165 raise ValueError, 'decryption failed'
166 return E.decrypt(c[poly1305.tagsz:])
167
168###--------------------------------------------------------------------------
00401529 169### Multiprecision integers and binary polynomials.
ed8cc62d 170
2ef393b5 171def _split_rat(x):
83c77564 172 if isinstance(x, BaseRat): return x._n, x._d
2ef393b5 173 else: return x, 1
83c77564
MW
174class BaseRat (object):
175 """Base class implementing fields of fractions over Euclidean domains."""
2ef393b5 176 def __new__(cls, a, b):
83c77564 177 a, b = cls.RING(a), cls.RING(b)
2ef393b5
MW
178 q, r = divmod(a, b)
179 if r == 0: return q
180 g = b.gcd(r)
83c77564 181 me = super(BaseRat, cls).__new__(cls)
2ef393b5
MW
182 me._n = a//g
183 me._d = b//g
184 return me
185 @property
186 def numer(me): return me._n
187 @property
188 def denom(me): return me._d
189 def __str__(me): return '%s/%s' % (me._n, me._d)
330e6a74 190 def __repr__(me): return '%s(%s, %s)' % (_clsname(me), me._n, me._d)
96d7ed6c 191 _repr_pretty_ = _pp_str
2ef393b5
MW
192
193 def __add__(me, you):
194 n, d = _split_rat(you)
83c77564 195 return type(me)(me._n*d + n*me._d, d*me._d)
2ef393b5
MW
196 __radd__ = __add__
197 def __sub__(me, you):
198 n, d = _split_rat(you)
83c77564 199 return type(me)(me._n*d - n*me._d, d*me._d)
2ef393b5
MW
200 def __rsub__(me, you):
201 n, d = _split_rat(you)
83c77564 202 return type(me)(n*me._d - me._n*d, d*me._d)
2ef393b5
MW
203 def __mul__(me, you):
204 n, d = _split_rat(you)
83c77564 205 return type(me)(me._n*n, me._d*d)
2ef393b5
MW
206 def __div__(me, you):
207 n, d = _split_rat(you)
83c77564 208 return type(me)(me._n*d, me._d*n)
2ef393b5
MW
209 def __rdiv__(me, you):
210 n, d = _split_rat(you)
83c77564 211 return type(me)(me._d*n, me._n*d)
2ef393b5
MW
212 def __cmp__(me, you):
213 n, d = _split_rat(you)
83c77564 214 return type(me)(me._n*d, n*me._d)
2ef393b5
MW
215 def __rcmp__(me, you):
216 n, d = _split_rat(you)
217 return cmp(n*me._d, me._n*d)
218
83c77564
MW
219class IntRat (BaseRat):
220 RING = MP
221
222class GFRat (BaseRat):
223 RING = GF
224
d7ab1bab 225class _tmp:
226 def negp(x): return x < 0
227 def posp(x): return x > 0
228 def zerop(x): return x == 0
229 def oddp(x): return x.testbit(0)
230 def evenp(x): return not x.testbit(0)
231 def mont(x): return MPMont(x)
232 def barrett(x): return MPBarrett(x)
233 def reduce(x): return MPReduce(x)
83c77564
MW
234 def __div__(me, you): return IntRat(me, you)
235 def __rdiv__(me, you): return IntRat(you, me)
96d7ed6c 236 _repr_pretty_ = _pp_str
d7ab1bab 237_augment(MP, _tmp)
238
d7ab1bab 239class _tmp:
fbc145f3 240 def zerop(x): return x == 0
ed8cc62d 241 def reduce(x): return GFReduce(x)
fbc145f3
MW
242 def trace(x, y): return x.reduce().trace(y)
243 def halftrace(x, y): return x.reduce().halftrace(y)
244 def modsqrt(x, y): return x.reduce().sqrt(y)
245 def quadsolve(x, y): return x.reduce().quadsolve(y)
83c77564
MW
246 def __div__(me, you): return GFRat(me, you)
247 def __rdiv__(me, you): return GFRat(you, me)
96d7ed6c 248 _repr_pretty_ = _pp_str
d7ab1bab 249_augment(GF, _tmp)
250
251class _tmp:
ed8cc62d
MW
252 def product(*arg):
253 'product(ITERABLE) or product(I, ...) -> PRODUCT'
254 return MPMul(*arg).done()
255 product = staticmethod(product)
256_augment(MPMul, _tmp)
257
00401529
MW
258###--------------------------------------------------------------------------
259### Abstract fields.
ed8cc62d
MW
260
261class _tmp:
d7ab1bab 262 def fromstring(str): return _checkend(Field.parse(str))
263 fromstring = staticmethod(fromstring)
264_augment(Field, _tmp)
265
266class _tmp:
330e6a74 267 def __repr__(me): return '%s(%sL)' % (_clsname(me), me.p)
6d481bc6 268 def __hash__(me): return 0x114401de ^ hash(me.p)
96d7ed6c 269 def _repr_pretty_(me, pp, cyclep):
582568f1
MW
270 ind = _pp_bgroup_tyname(pp, me)
271 if cyclep: pp.text('...')
272 else: pp.pretty(me.p)
273 pp.end_group(ind, ')')
d7ab1bab 274 def ec(me, a, b): return ECPrimeProjCurve(me, a, b)
275_augment(PrimeField, _tmp)
276
277class _tmp:
330e6a74 278 def __repr__(me): return '%s(%#xL)' % (_clsname(me), me.p)
d7ab1bab 279 def ec(me, a, b): return ECBinProjCurve(me, a, b)
96d7ed6c 280 def _repr_pretty_(me, pp, cyclep):
582568f1
MW
281 ind = _pp_bgroup_tyname(pp, me)
282 if cyclep: pp.text('...')
283 else: pp.text('%#x' % me.p)
284 pp.end_group(ind, ')')
d7ab1bab 285_augment(BinField, _tmp)
286
287class _tmp:
6d481bc6
MW
288 def __hash__(me): return 0x23e4701c ^ hash(me.p)
289_augment(BinPolyField, _tmp)
290
291class _tmp:
292 def __hash__(me):
293 h = 0x9a7d6240
294 h ^= hash(me.p)
295 h ^= 2*hash(me.beta) & 0xffffffff
296 return h
297_augment(BinNormField, _tmp)
298
299class _tmp:
d7ab1bab 300 def __str__(me): return str(me.value)
301 def __repr__(me): return '%s(%s)' % (repr(me.field), repr(me.value))
96d7ed6c 302 _repr_pretty_ = _pp_str
d7ab1bab 303_augment(FE, _tmp)
304
00401529
MW
305###--------------------------------------------------------------------------
306### Elliptic curves.
d7ab1bab 307
308class _tmp:
309 def __repr__(me):
330e6a74 310 return '%s(%r, %s, %s)' % (_clsname(me), me.field, me.a, me.b)
96d7ed6c 311 def _repr_pretty_(me, pp, cyclep):
582568f1 312 ind = _pp_bgroup_tyname(pp, me)
96d7ed6c 313 if cyclep:
582568f1 314 pp.text('...')
96d7ed6c 315 else:
96d7ed6c
MW
316 pp.pretty(me.field); pp.text(','); pp.breakable()
317 pp.pretty(me.a); pp.text(','); pp.breakable()
318 pp.pretty(me.b)
582568f1 319 pp.end_group(ind, ')')
d7ab1bab 320 def frombuf(me, s):
321 return ecpt.frombuf(me, s)
322 def fromraw(me, s):
323 return ecpt.fromraw(me, s)
324 def pt(me, *args):
5f959e50 325 return me(*args)
d7ab1bab 326_augment(ECCurve, _tmp)
327
328class _tmp:
6d481bc6
MW
329 def __hash__(me):
330 h = 0x6751d341
331 h ^= hash(me.field)
332 h ^= 2*hash(me.a) ^ 0xffffffff
333 h ^= 5*hash(me.b) ^ 0xffffffff
334 return h
335_augment(ECPrimeCurve, _tmp)
336
337class _tmp:
338 def __hash__(me):
339 h = 0x2ac203c5
340 h ^= hash(me.field)
341 h ^= 2*hash(me.a) ^ 0xffffffff
342 h ^= 5*hash(me.b) ^ 0xffffffff
343 return h
344_augment(ECBinCurve, _tmp)
345
346class _tmp:
d7ab1bab 347 def __repr__(me):
330e6a74
MW
348 if not me: return '%s()' % _clsname(me)
349 return '%s(%s, %s)' % (_clsname(me), me.ix, me.iy)
d7ab1bab 350 def __str__(me):
351 if not me: return 'inf'
352 return '(%s, %s)' % (me.ix, me.iy)
96d7ed6c
MW
353 def _repr_pretty_(me, pp, cyclep):
354 if cyclep:
355 pp.text('...')
356 elif not me:
357 pp.text('inf')
358 else:
582568f1 359 ind = _pp_bgroup(pp, '(')
96d7ed6c
MW
360 pp.pretty(me.ix); pp.text(','); pp.breakable()
361 pp.pretty(me.iy)
582568f1 362 pp.end_group(ind, ')')
d7ab1bab 363_augment(ECPt, _tmp)
364
365class _tmp:
366 def __repr__(me):
330e6a74
MW
367 return '%s(curve = %r, G = %r, r = %s, h = %s)' % \
368 (_clsname(me), me.curve, me.G, me.r, me.h)
96d7ed6c 369 def _repr_pretty_(me, pp, cyclep):
582568f1 370 ind = _pp_bgroup_tyname(pp, me)
96d7ed6c 371 if cyclep:
582568f1 372 pp.text('...')
96d7ed6c 373 else:
96d7ed6c
MW
374 _pp_kv(pp, 'curve', me.curve); pp.text(','); pp.breakable()
375 _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
376 _pp_kv(pp, 'r', me.r); pp.text(','); pp.breakable()
377 _pp_kv(pp, 'h', me.h)
582568f1 378 pp.end_group(ind, ')')
6d481bc6
MW
379 def __hash__(me):
380 h = 0x9bedb8de
381 h ^= hash(me.curve)
382 h ^= 2*hash(me.G) & 0xffffffff
383 return h
d7ab1bab 384 def group(me):
385 return ECGroup(me)
386_augment(ECInfo, _tmp)
387
388class _tmp:
389 def __repr__(me):
390 if not me: return '%r()' % (me.curve)
391 return '%r(%s, %s)' % (me.curve, me.x, me.y)
392 def __str__(me):
393 if not me: return 'inf'
394 return '(%s, %s)' % (me.x, me.y)
7a7aa30e
MW
395 def _repr_pretty_(me, pp, cyclep):
396 if cyclep:
397 pp.text('...')
398 elif not me:
399 pp.text('inf')
400 else:
401 ind = _pp_bgroup(pp, '(')
402 pp.pretty(me.x); pp.text(','); pp.breakable()
403 pp.pretty(me.y)
404 pp.end_group(ind, ')')
d7ab1bab 405_augment(ECPtCurve, _tmp)
406
00401529
MW
407###--------------------------------------------------------------------------
408### Key sizes.
ed8cc62d 409
d7ab1bab 410class _tmp:
330e6a74 411 def __repr__(me): return '%s(%d)' % (_clsname(me), me.default)
d7ab1bab 412 def check(me, sz): return True
413 def best(me, sz): return sz
414_augment(KeySZAny, _tmp)
415
416class _tmp:
417 def __repr__(me):
330e6a74
MW
418 return '%s(%d, %d, %d, %d)' % \
419 (_clsname(me), me.default, me.min, me.max, me.mod)
96d7ed6c 420 def _repr_pretty_(me, pp, cyclep):
582568f1 421 ind = _pp_bgroup_tyname(pp, me)
96d7ed6c 422 if cyclep:
582568f1 423 pp.text('...')
96d7ed6c 424 else:
96d7ed6c
MW
425 pp.pretty(me.default); pp.text(','); pp.breakable()
426 pp.pretty(me.min); pp.text(','); pp.breakable()
427 pp.pretty(me.max); pp.text(','); pp.breakable()
428 pp.pretty(me.mod)
582568f1 429 pp.end_group(ind, ')')
d7ab1bab 430 def check(me, sz): return me.min <= sz <= me.max and sz % me.mod == 0
431 def best(me, sz):
432 if sz < me.min: raise ValueError, 'key too small'
433 elif sz > me.max: return me.max
434 else: return sz - (sz % me.mod)
435_augment(KeySZRange, _tmp)
436
437class _tmp:
330e6a74 438 def __repr__(me): return '%s(%d, %s)' % (_clsname(me), me.default, me.set)
96d7ed6c 439 def _repr_pretty_(me, pp, cyclep):
582568f1 440 ind = _pp_bgroup_tyname(pp, me)
96d7ed6c 441 if cyclep:
582568f1 442 pp.text('...')
96d7ed6c 443 else:
96d7ed6c 444 pp.pretty(me.default); pp.text(','); pp.breakable()
582568f1 445 ind1 = _pp_bgroup(pp, '{')
96d7ed6c 446 _pp_commas(pp, pp.pretty, me.set)
582568f1
MW
447 pp.end_group(ind1, '}')
448 pp.end_group(ind, ')')
d7ab1bab 449 def check(me, sz): return sz in me.set
450 def best(me, sz):
451 found = -1
452 for i in me.set:
453 if found < i <= sz: found = i
454 if found < 0: raise ValueError, 'key too small'
455 return found
456_augment(KeySZSet, _tmp)
457
00401529 458###--------------------------------------------------------------------------
96d7ed6c
MW
459### Key data objects.
460
461class _tmp:
330e6a74 462 def __repr__(me): return '%s(%r)' % (_clsname(me), me.name)
96d7ed6c
MW
463_augment(KeyFile, _tmp)
464
465class _tmp:
330e6a74 466 def __repr__(me): return '%s(%r)' % (_clsname(me), me.fulltag)
96d7ed6c
MW
467_augment(Key, _tmp)
468
469class _tmp:
470 def __repr__(me):
330e6a74
MW
471 return '%s({%s})' % (_clsname(me),
472 ', '.join(['%r: %r' % kv for kv in me.iteritems()]))
96d7ed6c 473 def _repr_pretty_(me, pp, cyclep):
582568f1 474 ind = _pp_bgroup_tyname(pp, me)
96d7ed6c
MW
475 if cyclep: pp.text('...')
476 else: _pp_dict(pp, me.iteritems())
582568f1 477 pp.end_group(ind, ')')
96d7ed6c
MW
478_augment(KeyAttributes, _tmp)
479
480class _tmp:
849e8a20 481 def __repr__(me):
652e16ea
MW
482 return '%s(%s, %r)' % (_clsname(me),
483 _repr_secret(me._guts(),
484 not (me.flags & KF_NONSECRET)),
485 me.writeflags(me.flags))
96d7ed6c 486 def _repr_pretty_(me, pp, cyclep):
582568f1 487 ind = _pp_bgroup_tyname(pp, me)
96d7ed6c 488 if cyclep:
582568f1 489 pp.text('...')
96d7ed6c 490 else:
652e16ea
MW
491 _pp_secret(pp, me._guts(), not (me.flags & KF_NONSECRET))
492 pp.text(','); pp.breakable()
96d7ed6c 493 pp.pretty(me.writeflags(me.flags))
582568f1 494 pp.end_group(ind, ')')
849e8a20
MW
495_augment(KeyData, _tmp)
496
497class _tmp:
498 def _guts(me): return me.bin
96d7ed6c
MW
499_augment(KeyDataBinary, _tmp)
500
501class _tmp:
849e8a20 502 def _guts(me): return me.ct
96d7ed6c
MW
503_augment(KeyDataEncrypted, _tmp)
504
505class _tmp:
849e8a20 506 def _guts(me): return me.mp
96d7ed6c
MW
507_augment(KeyDataMP, _tmp)
508
509class _tmp:
849e8a20 510 def _guts(me): return me.str
96d7ed6c
MW
511_augment(KeyDataString, _tmp)
512
513class _tmp:
849e8a20 514 def _guts(me): return me.ecpt
96d7ed6c
MW
515_augment(KeyDataECPt, _tmp)
516
517class _tmp:
518 def __repr__(me):
330e6a74
MW
519 return '%s({%s})' % (_clsname(me),
520 ', '.join(['%r: %r' % kv for kv in me.iteritems()]))
96d7ed6c 521 def _repr_pretty_(me, pp, cyclep):
582568f1 522 ind = _pp_bgroup_tyname(pp, me, '({ ')
96d7ed6c
MW
523 if cyclep: pp.text('...')
524 else: _pp_dict(pp, me.iteritems())
582568f1 525 pp.end_group(ind, ' })')
96d7ed6c
MW
526_augment(KeyDataStructured, _tmp)
527
528###--------------------------------------------------------------------------
00401529 529### Abstract groups.
ed8cc62d 530
d7ab1bab 531class _tmp:
532 def __repr__(me):
330e6a74 533 return '%s(p = %s, r = %s, g = %s)' % (_clsname(me), me.p, me.r, me.g)
96d7ed6c 534 def _repr_pretty_(me, pp, cyclep):
582568f1 535 ind = _pp_bgroup_tyname(pp, me)
96d7ed6c 536 if cyclep:
582568f1 537 pp.text('...')
96d7ed6c 538 else:
96d7ed6c
MW
539 _pp_kv(pp, 'p', me.p); pp.text(','); pp.breakable()
540 _pp_kv(pp, 'r', me.r); pp.text(','); pp.breakable()
541 _pp_kv(pp, 'g', me.g)
582568f1 542 pp.end_group(ind, ')')
d7ab1bab 543_augment(FGInfo, _tmp)
544
545class _tmp:
546 def group(me): return PrimeGroup(me)
547_augment(DHInfo, _tmp)
548
549class _tmp:
550 def group(me): return BinGroup(me)
551_augment(BinDHInfo, _tmp)
552
553class _tmp:
554 def __repr__(me):
330e6a74 555 return '%s(%r)' % (_clsname(me), me.info)
99d932fe
MW
556 def _repr_pretty_(me, pp, cyclep):
557 ind = _pp_bgroup_tyname(pp, me)
558 if cyclep: pp.text('...')
559 else: pp.pretty(me.info)
560 pp.end_group(ind, ')')
d7ab1bab 561_augment(Group, _tmp)
562
563class _tmp:
6d481bc6
MW
564 def __hash__(me):
565 info = me.info
566 h = 0xbce3cfe6
567 h ^= hash(info.p)
568 h ^= 2*hash(info.r) & 0xffffffff
569 h ^= 5*hash(info.g) & 0xffffffff
570 return h
d7012c2b 571 def _get_geval(me, x): return MP(x)
6d481bc6
MW
572_augment(PrimeGroup, _tmp)
573
574class _tmp:
575 def __hash__(me):
576 info = me.info
577 h = 0x80695949
578 h ^= hash(info.p)
579 h ^= 2*hash(info.r) & 0xffffffff
580 h ^= 5*hash(info.g) & 0xffffffff
581 return h
d7012c2b 582 def _get_geval(me, x): return GF(x)
6d481bc6
MW
583_augment(BinGroup, _tmp)
584
585class _tmp:
586 def __hash__(me): return 0x0ec23dab ^ hash(me.info)
d7012c2b 587 def _get_geval(me, x): return x.toec()
6d481bc6
MW
588_augment(ECGroup, _tmp)
589
590class _tmp:
d7ab1bab 591 def __repr__(me):
592 return '%r(%r)' % (me.group, str(me))
d7012c2b
MW
593 def _repr_pretty_(me, pp, cyclep):
594 pp.pretty(type(me)._get_geval(me))
d7ab1bab 595_augment(GE, _tmp)
596
00401529
MW
597###--------------------------------------------------------------------------
598### RSA encoding techniques.
ed8cc62d
MW
599
600class PKCS1Crypt (object):
d7ab1bab 601 def __init__(me, ep = '', rng = rand):
602 me.ep = ep
603 me.rng = rng
604 def encode(me, msg, nbits):
605 return _base._p1crypt_encode(msg, nbits, me.ep, me.rng)
606 def decode(me, ct, nbits):
607 return _base._p1crypt_decode(ct, nbits, me.ep, me.rng)
608
ed8cc62d 609class PKCS1Sig (object):
d7ab1bab 610 def __init__(me, ep = '', rng = rand):
611 me.ep = ep
612 me.rng = rng
613 def encode(me, msg, nbits):
614 return _base._p1sig_encode(msg, nbits, me.ep, me.rng)
615 def decode(me, msg, sig, nbits):
616 return _base._p1sig_decode(msg, sig, nbits, me.ep, me.rng)
617
ed8cc62d 618class OAEP (object):
d7ab1bab 619 def __init__(me, mgf = sha_mgf, hash = sha, ep = '', rng = rand):
620 me.mgf = mgf
621 me.hash = hash
622 me.ep = ep
623 me.rng = rng
624 def encode(me, msg, nbits):
625 return _base._oaep_encode(msg, nbits, me.mgf, me.hash, me.ep, me.rng)
626 def decode(me, ct, nbits):
627 return _base._oaep_decode(ct, nbits, me.mgf, me.hash, me.ep, me.rng)
628
ed8cc62d 629class PSS (object):
d7ab1bab 630 def __init__(me, mgf = sha_mgf, hash = sha, saltsz = None, rng = rand):
631 me.mgf = mgf
632 me.hash = hash
633 if saltsz is None:
634 saltsz = hash.hashsz
635 me.saltsz = saltsz
636 me.rng = rng
637 def encode(me, msg, nbits):
638 return _base._pss_encode(msg, nbits, me.mgf, me.hash, me.saltsz, me.rng)
639 def decode(me, msg, sig, nbits):
640 return _base._pss_decode(msg, sig, nbits,
00401529 641 me.mgf, me.hash, me.saltsz, me.rng)
d7ab1bab 642
643class _tmp:
644 def encrypt(me, msg, enc):
645 return me.pubop(enc.encode(msg, me.n.nbits))
646 def verify(me, msg, sig, enc):
647 if msg is None: return enc.decode(msg, me.pubop(sig), me.n.nbits)
648 try:
649 x = enc.decode(msg, me.pubop(sig), me.n.nbits)
650 return x is None or x == msg
651 except ValueError:
b2687a0a 652 return False
d7ab1bab 653_augment(RSAPub, _tmp)
654
655class _tmp:
656 def decrypt(me, ct, enc): return enc.decode(me.privop(ct), me.n.nbits)
657 def sign(me, msg, enc): return me.privop(enc.encode(msg, me.n.nbits))
658_augment(RSAPriv, _tmp)
659
00401529 660###--------------------------------------------------------------------------
eb8aa4ec 661### Bernstein's elliptic curve crypto and related schemes.
848ba392
MW
662
663X25519_BASE = \
664 bytes('0900000000000000000000000000000000000000000000000000000000000000')
665
eb8aa4ec
MW
666X448_BASE = \
667 bytes('05000000000000000000000000000000000000000000000000000000'
668 '00000000000000000000000000000000000000000000000000000000')
669
848ba392
MW
670Z128 = bytes('00000000000000000000000000000000')
671
672class _BoxyPub (object):
673 def __init__(me, pub, *kw, **kwargs):
674 if len(pub) != me._PUBSZ: raise ValueError, 'bad public key'
675 super(_BoxyPub, me).__init__(*kw, **kwargs)
676 me.pub = pub
677
678class _BoxyPriv (_BoxyPub):
679 def __init__(me, priv, pub = None, *kw, **kwargs):
680 if len(priv) != me._KEYSZ: raise ValueError, 'bad private key'
681 if pub is None: pub = me._op(priv, me._BASE)
682 super(_BoxyPriv, me).__init__(pub = pub, *kw, **kwargs)
683 me.priv = priv
684 def agree(me, you): return me._op(me.priv, you.pub)
685 def boxkey(me, recip):
686 return me._hashkey(me.agree(recip))
687 def box(me, recip, n, m):
688 return secret_box(me.boxkey(recip), n, m)
689 def unbox(me, recip, n, c):
690 return secret_unbox(me.boxkey(recip, n, c))
691
692class X25519Pub (_BoxyPub):
693 _PUBSZ = X25519_PUBSZ
694 _BASE = X25519_BASE
695
696class X25519Priv (_BoxyPriv, X25519Pub):
697 _KEYSZ = X25519_KEYSZ
698 def _op(me, k, X): return x25519(k, X)
699 def _hashkey(me, z): return hsalsa20_prf(z, Z128)
700
eb8aa4ec
MW
701class X448Pub (_BoxyPub):
702 _PUBSZ = X448_PUBSZ
703 _BASE = X448_BASE
704
705class X448Priv (_BoxyPriv, X448Pub):
706 _KEYSZ = X448_KEYSZ
707 def _op(me, k, X): return x448(k, X)
708 ##def _hashkey(me, z): return ???
709
dafb2da4
MW
710class Ed25519Pub (object):
711 def __init__(me, pub):
712 me.pub = pub
713 def verify(me, msg, sig):
714 return ed25519_verify(me.pub, msg, sig)
715
716class Ed25519Priv (Ed25519Pub):
717 def __init__(me, priv):
718 me.priv = priv
719 Ed25519Pub.__init__(me, ed25519_pubkey(priv))
720 def sign(me, msg):
721 return ed25519_sign(me.priv, msg, pub = me.pub)
722 @classmethod
723 def generate(cls, rng = rand):
724 return cls(rng.block(ED25519_KEYSZ))
725
848ba392 726###--------------------------------------------------------------------------
00401529 727### Built-in named curves and prime groups.
ed8cc62d
MW
728
729class _groupmap (object):
730 def __init__(me, map, nth):
731 me.map = map
732 me.nth = nth
1b61856d
MW
733 me._n = max(map.values()) + 1
734 me.i = me._n*[None]
ed8cc62d 735 def __repr__(me):
96d7ed6c
MW
736 return '{%s}' % ', '.join(['%r: %r' % kv for kv in me.iteritems()])
737 def _repr_pretty_(me, pp, cyclep):
582568f1
MW
738 ind = _pp_bgroup(pp, '{ ')
739 if cyclep: pp.text('...')
740 else: _pp_dict(pp, me.iteritems())
741 pp.end_group(ind, ' }')
1b61856d
MW
742 def __len__(me):
743 return me._n
ed8cc62d
MW
744 def __contains__(me, k):
745 return k in me.map
746 def __getitem__(me, k):
747 i = me.map[k]
748 if me.i[i] is None:
749 me.i[i] = me.nth(i)
750 return me.i[i]
751 def __setitem__(me, k, v):
752 raise TypeError, "immutable object"
753 def __iter__(me):
754 return iter(me.map)
96851f5d
MW
755 def iterkeys(me):
756 return iter(me.map)
757 def itervalues(me):
758 for k in me:
759 yield me[k]
760 def iteritems(me):
761 for k in me:
762 yield k, me[k]
ed8cc62d
MW
763 def keys(me):
764 return [k for k in me]
765 def values(me):
766 return [me[k] for k in me]
96851f5d
MW
767 def items(me):
768 return [(k, me[k]) for k in me]
ed8cc62d
MW
769eccurves = _groupmap(_base._eccurves, ECInfo._curven)
770primegroups = _groupmap(_base._pgroups, DHInfo._groupn)
771bingroups = _groupmap(_base._bingroups, BinDHInfo._groupn)
772
00401529
MW
773###--------------------------------------------------------------------------
774### Prime number generation.
ed8cc62d
MW
775
776class PrimeGenEventHandler (object):
777 def pg_begin(me, ev):
778 return me.pg_try(ev)
779 def pg_done(me, ev):
780 return PGEN_DONE
781 def pg_abort(me, ev):
782 return PGEN_TRY
783 def pg_fail(me, ev):
784 return PGEN_TRY
785 def pg_pass(me, ev):
786 return PGEN_TRY
d7ab1bab 787
788class SophieGermainStepJump (object):
789 def pg_begin(me, ev):
790 me.lf = PrimeFilter(ev.x)
791 me.hf = me.lf.muladd(2, 1)
792 return me.cont(ev)
793 def pg_try(me, ev):
794 me.step()
795 return me.cont(ev)
796 def cont(me, ev):
797 while me.lf.status == PGEN_FAIL or me.hf.status == PGEN_FAIL:
798 me.step()
799 if me.lf.status == PGEN_ABORT or me.hf.status == PGEN_ABORT:
800 return PGEN_ABORT
801 ev.x = me.lf.x
802 if me.lf.status == PGEN_DONE and me.hf.status == PGEN_DONE:
803 return PGEN_DONE
804 return PGEN_TRY
805 def pg_done(me, ev):
806 del me.lf
807 del me.hf
808
809class SophieGermainStepper (SophieGermainStepJump):
810 def __init__(me, step):
811 me.lstep = step;
812 me.hstep = 2 * step
813 def step(me):
814 me.lf.step(me.lstep)
815 me.hf.step(me.hstep)
816
817class SophieGermainJumper (SophieGermainStepJump):
818 def __init__(me, jump):
819 me.ljump = PrimeFilter(jump);
820 me.hjump = me.ljump.muladd(2, 0)
821 def step(me):
822 me.lf.jump(me.ljump)
823 me.hf.jump(me.hjump)
824 def pg_done(me, ev):
825 del me.ljump
826 del me.hjump
827 SophieGermainStepJump.pg_done(me, ev)
828
829class SophieGermainTester (object):
830 def __init__(me):
831 pass
832 def pg_begin(me, ev):
833 me.lr = RabinMiller(ev.x)
834 me.hr = RabinMiller(2 * ev.x + 1)
835 def pg_try(me, ev):
836 lst = me.lr.test(ev.rng.range(me.lr.x))
837 if lst != PGEN_PASS and lst != PGEN_DONE:
838 return lst
839 rst = me.hr.test(ev.rng.range(me.hr.x))
840 if rst != PGEN_PASS and rst != PGEN_DONE:
841 return rst
842 if lst == PGEN_DONE and rst == PGEN_DONE:
843 return PGEN_DONE
844 return PGEN_PASS
845 def pg_done(me, ev):
846 del me.lr
847 del me.hr
848
d7ab1bab 849class PrimitiveStepper (PrimeGenEventHandler):
850 def __init__(me):
851 pass
852 def pg_try(me, ev):
853 ev.x = me.i.next()
854 return PGEN_TRY
855 def pg_begin(me, ev):
856 me.i = iter(smallprimes)
857 return me.pg_try(ev)
858
859class PrimitiveTester (PrimeGenEventHandler):
860 def __init__(me, mod, hh = [], exp = None):
861 me.mod = MPMont(mod)
862 me.exp = exp
863 me.hh = hh
864 def pg_try(me, ev):
865 x = ev.x
866 if me.exp is not None:
867 x = me.mod.exp(x, me.exp)
868 if x == 1: return PGEN_FAIL
869 for h in me.hh:
870 if me.mod.exp(x, h) == 1: return PGEN_FAIL
871 ev.x = x
872 return PGEN_DONE
873
874class SimulStepper (PrimeGenEventHandler):
875 def __init__(me, mul = 2, add = 1, step = 2):
876 me.step = step
877 me.mul = mul
878 me.add = add
879 def _stepfn(me, step):
880 if step <= 0:
881 raise ValueError, 'step must be positive'
882 if step <= MPW_MAX:
883 return lambda f: f.step(step)
884 j = PrimeFilter(step)
885 return lambda f: f.jump(j)
886 def pg_begin(me, ev):
887 x = ev.x
888 me.lf = PrimeFilter(x)
889 me.hf = PrimeFilter(x * me.mul + me.add)
890 me.lstep = me._stepfn(me.step)
891 me.hstep = me._stepfn(me.step * me.mul)
892 SimulStepper._cont(me, ev)
893 def pg_try(me, ev):
894 me._step()
895 me._cont(ev)
896 def _step(me):
897 me.lstep(me.lf)
898 me.hstep(me.hf)
899 def _cont(me, ev):
900 while me.lf.status == PGEN_FAIL or me.hf.status == PGEN_FAIL:
901 me._step()
902 if me.lf.status == PGEN_ABORT or me.hf.status == PGEN_ABORT:
903 return PGEN_ABORT
904 ev.x = me.lf.x
905 if me.lf.status == PGEN_DONE and me.hf.status == PGEN_DONE:
906 return PGEN_DONE
907 return PGEN_TRY
908 def pg_done(me, ev):
909 del me.lf
910 del me.hf
911 del me.lstep
912 del me.hstep
913
914class SimulTester (PrimeGenEventHandler):
915 def __init__(me, mul = 2, add = 1):
916 me.mul = mul
917 me.add = add
918 def pg_begin(me, ev):
919 x = ev.x
920 me.lr = RabinMiller(x)
921 me.hr = RabinMiller(x * me.mul + me.add)
922 def pg_try(me, ev):
923 lst = me.lr.test(ev.rng.range(me.lr.x))
924 if lst != PGEN_PASS and lst != PGEN_DONE:
925 return lst
926 rst = me.hr.test(ev.rng.range(me.hr.x))
927 if rst != PGEN_PASS and rst != PGEN_DONE:
928 return rst
929 if lst == PGEN_DONE and rst == PGEN_DONE:
930 return PGEN_DONE
931 return PGEN_PASS
932 def pg_done(me, ev):
933 del me.lr
934 del me.hr
935
936def sgprime(start, step = 2, name = 'p', event = pgen_nullev, nsteps = 0):
937 start = MP(start)
938 return pgen(start, name, SimulStepper(step = step), SimulTester(), event,
00401529 939 nsteps, RabinMiller.iters(start.nbits))
d7ab1bab 940
941def findprimitive(mod, hh = [], exp = None, name = 'g', event = pgen_nullev):
942 return pgen(0, name, PrimitiveStepper(), PrimitiveTester(mod, hh, exp),
00401529 943 event, 0, 1)
d7ab1bab 944
945def kcdsaprime(pbits, qbits, rng = rand,
00401529 946 event = pgen_nullev, name = 'p', nsteps = 0):
d7ab1bab 947 hbits = pbits - qbits
948 h = pgen(rng.mp(hbits, 1), name + ' [h]',
00401529
MW
949 PrimeGenStepper(2), PrimeGenTester(),
950 event, nsteps, RabinMiller.iters(hbits))
d7ab1bab 951 q = pgen(rng.mp(qbits, 1), name, SimulStepper(2 * h, 1, 2),
00401529 952 SimulTester(2 * h, 1), event, nsteps, RabinMiller.iters(qbits))
d7ab1bab 953 p = 2 * q * h + 1
954 return p, q, h
955
956#----- That's all, folks ----------------------------------------------------