chiark / gitweb /
catacomb/__init__.py (BaseRat): Add missing reverse-multiplication method.
[catacomb-python] / catacomb / __init__.py
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.
25
26 from __future__ import with_statement
27
28 import _base
29 import types as _types
30 from binascii import hexlify as _hexify, unhexlify as _unhexify
31 from contextlib import contextmanager as _ctxmgr
32 from sys import argv as _argv
33 from struct import pack as _pack
34
35 ###--------------------------------------------------------------------------
36 ### Basic stuff.
37
38 ## For the benefit of the default keyreporter, we need the program na,e.
39 _base._ego(_argv[0])
40
41 ## How to fix a name back into the right identifier.  Alas, the rules are not
42 ## consistent.
43 def _fixname(name):
44
45   ## Hyphens consistently become underscores.
46   name = name.replace('-', '_')
47
48   ## But slashes might become underscores or just vanish.
49   if name.startswith('salsa20'): name = name.replace('/', '')
50   else: name = name.replace('/', '_')
51
52   ## Done.
53   return name
54
55 ## Initialize the module.  Drag in the static methods of the various
56 ## classes; create names for the various known crypto algorithms.
57 def _init():
58   d = globals()
59   b = _base.__dict__;
60   for i in b:
61     if i[0] != '_':
62       d[i] = b[i];
63   for i in ['ByteString',
64             'MP', 'GF', 'Field',
65             'ECPt', 'ECPtCurve', 'ECCurve', 'ECInfo',
66             'DHInfo', 'BinDHInfo', 'RSAPriv', 'BBSPriv',
67             'PrimeFilter', 'RabinMiller',
68             'Group', 'GE',
69             'KeySZ', 'KeyData']:
70     c = d[i]
71     pre = '_' + i + '_'
72     plen = len(pre)
73     for j in b:
74       if j[:plen] == pre:
75         setattr(c, j[plen:], classmethod(b[j]))
76   for i in [gcciphers, gchashes, gcmacs, gcprps]:
77     for c in i.itervalues():
78       d[_fixname(c.name)] = c
79   for c in gccrands.itervalues():
80     d[_fixname(c.name + 'rand')] = c
81 _init()
82
83 ## A handy function for our work: add the methods of a named class to an
84 ## existing class.  This is how we write the Python-implemented parts of our
85 ## mostly-C types.
86 def _augment(c, cc):
87   for i in cc.__dict__:
88     a = cc.__dict__[i]
89     if type(a) is _types.MethodType:
90       a = a.im_func
91     elif type(a) not in (_types.FunctionType, staticmethod, classmethod):
92       continue
93     setattr(c, i, a)
94
95 ## Parsing functions tend to return the object parsed and the remainder of
96 ## the input.  This checks that the remainder is input and, if so, returns
97 ## just the object.
98 def _checkend(r):
99   x, rest = r
100   if rest != '':
101     raise SyntaxError, 'junk at end of string'
102   return x
103
104 ## Some pretty-printing utilities.
105 PRINT_SECRETS = False
106 def _clsname(me): return type(me).__name__
107 def _repr_secret(thing, secretp = True):
108   if not secretp or PRINT_SECRETS: return repr(thing)
109   else: return '#<SECRET>'
110 def _pp_str(me, pp, cyclep): pp.text(cyclep and '...' or str(me))
111 def _pp_secret(pp, thing, secretp = True):
112   if not secretp or PRINT_SECRETS: pp.pretty(thing)
113   else: pp.text('#<SECRET>')
114 def _pp_bgroup(pp, text):
115   ind = len(text)
116   pp.begin_group(ind, text)
117   return ind
118 def _pp_bgroup_tyname(pp, obj, open = '('):
119   return _pp_bgroup(pp, _clsname(obj) + open)
120 def _pp_kv(pp, k, v, secretp = False):
121   ind = _pp_bgroup(pp, k + ' = ')
122   _pp_secret(pp, v, secretp)
123   pp.end_group(ind, '')
124 def _pp_commas(pp, printfn, items):
125   firstp = True
126   for i in items:
127     if firstp: firstp = False
128     else: pp.text(','); pp.breakable()
129     printfn(i)
130 def _pp_dict(pp, items):
131   def p((k, v)):
132     pp.begin_group(0)
133     pp.pretty(k)
134     pp.text(':')
135     pp.begin_group(2)
136     pp.breakable()
137     pp.pretty(v)
138     pp.end_group(2)
139     pp.end_group(0)
140   _pp_commas(pp, p, items)
141
142 ###--------------------------------------------------------------------------
143 ### Bytestrings.
144
145 class _tmp:
146   def fromhex(x):
147     return ByteString(_unhexify(x))
148   fromhex = staticmethod(fromhex)
149   def __hex__(me):
150     return _hexify(me)
151   def __repr__(me):
152     return 'bytes(%r)' % hex(me)
153 _augment(ByteString, _tmp)
154 ByteString.__hash__ = str.__hash__
155 bytes = ByteString.fromhex
156
157 ###--------------------------------------------------------------------------
158 ### Hashing.
159
160 class _tmp:
161   def check(me, h):
162     hh = me.done()
163     return ctstreq(h, hh)
164 _augment(GHash, _tmp)
165 _augment(Poly1305Hash, _tmp)
166
167 class _HashBase (object):
168   ## The standard hash methods.  Assume that `hash' is defined and returns
169   ## the receiver.
170   def hashu8(me, n): return me.hash(_pack('B', n))
171   def hashu16l(me, n): return me.hash(_pack('<H', n))
172   def hashu16b(me, n): return me.hash(_pack('>H', n))
173   hashu16 = hashu16b
174   def hashu32l(me, n): return me.hash(_pack('<L', n))
175   def hashu32b(me, n): return me.hash(_pack('>L', n))
176   hashu32 = hashu32b
177   def hashu64l(me, n): return me.hash(_pack('<Q', n))
178   def hashu64b(me, n): return me.hash(_pack('>Q', n))
179   hashu64 = hashu64b
180   def hashbuf8(me, s): return me.hashu8(len(s)).hash(s)
181   def hashbuf16l(me, s): return me.hashu16l(len(s)).hash(s)
182   def hashbuf16b(me, s): return me.hashu16b(len(s)).hash(s)
183   hashbuf16 = hashbuf16b
184   def hashbuf32l(me, s): return me.hashu32l(len(s)).hash(s)
185   def hashbuf32b(me, s): return me.hashu32b(len(s)).hash(s)
186   hashbuf32 = hashbuf32b
187   def hashbuf64l(me, s): return me.hashu64l(len(s)).hash(s)
188   def hashbuf64b(me, s): return me.hashu64b(len(s)).hash(s)
189   hashbuf64 = hashbuf64b
190   def hashstrz(me, s): return me.hash(s).hashu8(0)
191
192 class _ShakeBase (_HashBase):
193
194   ## Python gets really confused if I try to augment `__new__' on native
195   ## classes, so wrap and delegate.  Sorry.
196   def __init__(me, perso = '', *args, **kw):
197     super(_ShakeBase, me).__init__(*args, **kw)
198     me._h = me._SHAKE(perso = perso, func = me._FUNC)
199
200   ## Delegate methods...
201   def copy(me): new = me.__class__(); new._copy(me)
202   def _copy(me, other): me._h = other._h
203   def hash(me, m): me._h.hash(m); return me
204   def xof(me): me._h.xof(); return me
205   def get(me, n): return me._h.get(n)
206   def mask(me, m): return me._h.mask(m)
207   def done(me, n): return me._h.done(n)
208   def check(me, h): return ctstreq(h, me.done(len(h)))
209   @property
210   def state(me): return me._h.state
211   @property
212   def buffered(me): return me._h.buffered
213   @property
214   def rate(me): return me._h.rate
215
216 class _tmp:
217   def check(me, h):
218     return ctstreq(h, me.done(len(h)))
219   def leftenc(me, n):
220     nn = MP(n).storeb()
221     return me.hashu8(len(nn)).hash(nn)
222   def rightenc(me, n):
223     nn = MP(n).storeb()
224     return me.hash(nn).hashu8(len(nn))
225   def stringenc(me, str):
226     return me.leftenc(8*len(str)).hash(str)
227   def bytepad_before(me):
228     return me.leftenc(me.rate)
229   def bytepad_after(me):
230     if me.buffered: me.hash(me._Z[:me.rate - me.buffered])
231     return me
232   @_ctxmgr
233   def bytepad(me):
234     me.bytepad_before()
235     yield me
236     me.bytepad_after()
237 _augment(Shake, _tmp)
238 _augment(_ShakeBase, _tmp)
239 Shake._Z = _ShakeBase._Z = ByteString(200*'\0')
240
241 class KMAC (_ShakeBase):
242   _FUNC = 'KMAC'
243   def __init__(me, k, *arg, **kw):
244     super(KMAC, me).__init__(*arg, **kw)
245     with me.bytepad(): me.stringenc(k)
246   def done(me, n = -1):
247     if n < 0: n = me._TAGSZ
248     me.rightenc(8*n)
249     return super(KMAC, me).done(n)
250   def xof(me):
251     me.rightenc(0)
252     return super(KMAC, me).xof()
253
254 class KMAC128 (KMAC): _SHAKE = Shake128; _TAGSZ = 16
255 class KMAC256 (KMAC): _SHAKE = Shake256; _TAGSZ = 32
256
257 ###--------------------------------------------------------------------------
258 ### NaCl `secretbox'.
259
260 def secret_box(k, n, m):
261   E = xsalsa20(k).setiv(n)
262   r = E.enczero(poly1305.keysz.default)
263   s = E.enczero(poly1305.masksz)
264   y = E.encrypt(m)
265   t = poly1305(r)(s).hash(y).done()
266   return ByteString(t + y)
267
268 def secret_unbox(k, n, c):
269   E = xsalsa20(k).setiv(n)
270   r = E.enczero(poly1305.keysz.default)
271   s = E.enczero(poly1305.masksz)
272   y = c[poly1305.tagsz:]
273   if not poly1305(r)(s).hash(y).check(c[0:poly1305.tagsz]):
274     raise ValueError, 'decryption failed'
275   return E.decrypt(c[poly1305.tagsz:])
276
277 ###--------------------------------------------------------------------------
278 ### Multiprecision integers and binary polynomials.
279
280 def _split_rat(x):
281   if isinstance(x, BaseRat): return x._n, x._d
282   else: return x, 1
283 class BaseRat (object):
284   """Base class implementing fields of fractions over Euclidean domains."""
285   def __new__(cls, a, b):
286     a, b = cls.RING(a), cls.RING(b)
287     q, r = divmod(a, b)
288     if r == 0: return q
289     g = b.gcd(r)
290     me = super(BaseRat, cls).__new__(cls)
291     me._n = a//g
292     me._d = b//g
293     return me
294   @property
295   def numer(me): return me._n
296   @property
297   def denom(me): return me._d
298   def __str__(me): return '%s/%s' % (me._n, me._d)
299   def __repr__(me): return '%s(%s, %s)' % (_clsname(me), me._n, me._d)
300   _repr_pretty_ = _pp_str
301
302   def __add__(me, you):
303     n, d = _split_rat(you)
304     return type(me)(me._n*d + n*me._d, d*me._d)
305   __radd__ = __add__
306   def __sub__(me, you):
307     n, d = _split_rat(you)
308     return type(me)(me._n*d - n*me._d, d*me._d)
309   def __rsub__(me, you):
310     n, d = _split_rat(you)
311     return type(me)(n*me._d - me._n*d, d*me._d)
312   def __mul__(me, you):
313     n, d = _split_rat(you)
314     return type(me)(me._n*n, me._d*d)
315   __rmul__ = __mul__
316   def __div__(me, you):
317     n, d = _split_rat(you)
318     return type(me)(me._n*d, me._d*n)
319   def __rdiv__(me, you):
320     n, d = _split_rat(you)
321     return type(me)(me._d*n, me._n*d)
322   def __cmp__(me, you):
323     n, d = _split_rat(you)
324     return cmp(me._n*d, n*me._d)
325   def __rcmp__(me, you):
326     n, d = _split_rat(you)
327     return cmp(n*me._d, me._n*d)
328
329 class IntRat (BaseRat):
330   RING = MP
331
332 class GFRat (BaseRat):
333   RING = GF
334
335 class _tmp:
336   def negp(x): return x < 0
337   def posp(x): return x > 0
338   def zerop(x): return x == 0
339   def oddp(x): return x.testbit(0)
340   def evenp(x): return not x.testbit(0)
341   def mont(x): return MPMont(x)
342   def barrett(x): return MPBarrett(x)
343   def reduce(x): return MPReduce(x)
344   def __div__(me, you): return IntRat(me, you)
345   def __rdiv__(me, you): return IntRat(you, me)
346   _repr_pretty_ = _pp_str
347 _augment(MP, _tmp)
348
349 class _tmp:
350   def zerop(x): return x == 0
351   def reduce(x): return GFReduce(x)
352   def trace(x, y): return x.reduce().trace(y)
353   def halftrace(x, y): return x.reduce().halftrace(y)
354   def modsqrt(x, y): return x.reduce().sqrt(y)
355   def quadsolve(x, y): return x.reduce().quadsolve(y)
356   def __div__(me, you): return GFRat(me, you)
357   def __rdiv__(me, you): return GFRat(you, me)
358   _repr_pretty_ = _pp_str
359 _augment(GF, _tmp)
360
361 class _tmp:
362   def product(*arg):
363     'product(ITERABLE) or product(I, ...) -> PRODUCT'
364     return MPMul(*arg).done()
365   product = staticmethod(product)
366 _augment(MPMul, _tmp)
367
368 ###--------------------------------------------------------------------------
369 ### Abstract fields.
370
371 class _tmp:
372   def fromstring(str): return _checkend(Field.parse(str))
373   fromstring = staticmethod(fromstring)
374 _augment(Field, _tmp)
375
376 class _tmp:
377   def __repr__(me): return '%s(%sL)' % (_clsname(me), me.p)
378   def __hash__(me): return 0x114401de ^ hash(me.p)
379   def _repr_pretty_(me, pp, cyclep):
380     ind = _pp_bgroup_tyname(pp, me)
381     if cyclep: pp.text('...')
382     else: pp.pretty(me.p)
383     pp.end_group(ind, ')')
384   def ec(me, a, b): return ECPrimeProjCurve(me, a, b)
385 _augment(PrimeField, _tmp)
386
387 class _tmp:
388   def __repr__(me): return '%s(%#xL)' % (_clsname(me), me.p)
389   def ec(me, a, b): return ECBinProjCurve(me, a, b)
390   def _repr_pretty_(me, pp, cyclep):
391     ind = _pp_bgroup_tyname(pp, me)
392     if cyclep: pp.text('...')
393     else: pp.text('%#x' % me.p)
394     pp.end_group(ind, ')')
395 _augment(BinField, _tmp)
396
397 class _tmp:
398   def __hash__(me): return 0x23e4701c ^ hash(me.p)
399 _augment(BinPolyField, _tmp)
400
401 class _tmp:
402   def __hash__(me):
403     h = 0x9a7d6240
404     h ^=   hash(me.p)
405     h ^= 2*hash(me.beta) & 0xffffffff
406     return h
407 _augment(BinNormField, _tmp)
408
409 class _tmp:
410   def __str__(me): return str(me.value)
411   def __repr__(me): return '%s(%s)' % (repr(me.field), repr(me.value))
412   _repr_pretty_ = _pp_str
413 _augment(FE, _tmp)
414
415 ###--------------------------------------------------------------------------
416 ### Elliptic curves.
417
418 class _tmp:
419   def __repr__(me):
420     return '%s(%r, %s, %s)' % (_clsname(me), me.field, me.a, me.b)
421   def _repr_pretty_(me, pp, cyclep):
422     ind = _pp_bgroup_tyname(pp, me)
423     if cyclep:
424       pp.text('...')
425     else:
426       pp.pretty(me.field); pp.text(','); pp.breakable()
427       pp.pretty(me.a); pp.text(','); pp.breakable()
428       pp.pretty(me.b)
429     pp.end_group(ind, ')')
430   def frombuf(me, s):
431     return ecpt.frombuf(me, s)
432   def fromraw(me, s):
433     return ecpt.fromraw(me, s)
434   def pt(me, *args):
435     return me(*args)
436 _augment(ECCurve, _tmp)
437
438 class _tmp:
439   def __hash__(me):
440     h = 0x6751d341
441     h ^=   hash(me.field)
442     h ^= 2*hash(me.a) ^ 0xffffffff
443     h ^= 5*hash(me.b) ^ 0xffffffff
444     return h
445 _augment(ECPrimeCurve, _tmp)
446
447 class _tmp:
448   def __hash__(me):
449     h = 0x2ac203c5
450     h ^=   hash(me.field)
451     h ^= 2*hash(me.a) ^ 0xffffffff
452     h ^= 5*hash(me.b) ^ 0xffffffff
453     return h
454 _augment(ECBinCurve, _tmp)
455
456 class _tmp:
457   def __repr__(me):
458     if not me: return '%s()' % _clsname(me)
459     return '%s(%s, %s)' % (_clsname(me), me.ix, me.iy)
460   def __str__(me):
461     if not me: return 'inf'
462     return '(%s, %s)' % (me.ix, me.iy)
463   def _repr_pretty_(me, pp, cyclep):
464     if cyclep:
465       pp.text('...')
466     elif not me:
467       pp.text('inf')
468     else:
469       ind = _pp_bgroup(pp, '(')
470       pp.pretty(me.ix); pp.text(','); pp.breakable()
471       pp.pretty(me.iy)
472       pp.end_group(ind, ')')
473 _augment(ECPt, _tmp)
474
475 class _tmp:
476   def __repr__(me):
477     return '%s(curve = %r, G = %r, r = %s, h = %s)' % \
478            (_clsname(me), me.curve, me.G, me.r, me.h)
479   def _repr_pretty_(me, pp, cyclep):
480     ind = _pp_bgroup_tyname(pp, me)
481     if cyclep:
482       pp.text('...')
483     else:
484       _pp_kv(pp, 'curve', me.curve); pp.text(','); pp.breakable()
485       _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
486       _pp_kv(pp, 'r', me.r); pp.text(','); pp.breakable()
487       _pp_kv(pp, 'h', me.h)
488     pp.end_group(ind, ')')
489   def __hash__(me):
490     h = 0x9bedb8de
491     h ^=   hash(me.curve)
492     h ^= 2*hash(me.G) & 0xffffffff
493     return h
494   def group(me):
495     return ECGroup(me)
496 _augment(ECInfo, _tmp)
497
498 class _tmp:
499   def __repr__(me):
500     if not me: return '%r()' % (me.curve)
501     return '%r(%s, %s)' % (me.curve, me.x, me.y)
502   def __str__(me):
503     if not me: return 'inf'
504     return '(%s, %s)' % (me.x, me.y)
505   def _repr_pretty_(me, pp, cyclep):
506     if cyclep:
507       pp.text('...')
508     elif not me:
509       pp.text('inf')
510     else:
511       ind = _pp_bgroup(pp, '(')
512       pp.pretty(me.x); pp.text(','); pp.breakable()
513       pp.pretty(me.y)
514       pp.end_group(ind, ')')
515 _augment(ECPtCurve, _tmp)
516
517 ###--------------------------------------------------------------------------
518 ### Key sizes.
519
520 class _tmp:
521   def __repr__(me): return '%s(%d)' % (_clsname(me), me.default)
522   def check(me, sz): return True
523   def best(me, sz): return sz
524 _augment(KeySZAny, _tmp)
525
526 class _tmp:
527   def __repr__(me):
528     return '%s(%d, %d, %d, %d)' % \
529            (_clsname(me), me.default, me.min, me.max, me.mod)
530   def _repr_pretty_(me, pp, cyclep):
531     ind = _pp_bgroup_tyname(pp, me)
532     if cyclep:
533       pp.text('...')
534     else:
535       pp.pretty(me.default); pp.text(','); pp.breakable()
536       pp.pretty(me.min); pp.text(','); pp.breakable()
537       pp.pretty(me.max); pp.text(','); pp.breakable()
538       pp.pretty(me.mod)
539     pp.end_group(ind, ')')
540   def check(me, sz): return me.min <= sz <= me.max and sz % me.mod == 0
541   def best(me, sz):
542     if sz < me.min: raise ValueError, 'key too small'
543     elif sz > me.max: return me.max
544     else: return sz - (sz % me.mod)
545 _augment(KeySZRange, _tmp)
546
547 class _tmp:
548   def __repr__(me): return '%s(%d, %s)' % (_clsname(me), me.default, me.set)
549   def _repr_pretty_(me, pp, cyclep):
550     ind = _pp_bgroup_tyname(pp, me)
551     if cyclep:
552       pp.text('...')
553     else:
554       pp.pretty(me.default); pp.text(','); pp.breakable()
555       ind1 = _pp_bgroup(pp, '{')
556       _pp_commas(pp, pp.pretty, me.set)
557       pp.end_group(ind1, '}')
558     pp.end_group(ind, ')')
559   def check(me, sz): return sz in me.set
560   def best(me, sz):
561     found = -1
562     for i in me.set:
563       if found < i <= sz: found = i
564     if found < 0: raise ValueError, 'key too small'
565     return found
566 _augment(KeySZSet, _tmp)
567
568 ###--------------------------------------------------------------------------
569 ### Key data objects.
570
571 class _tmp:
572   def __repr__(me): return '%s(%r)' % (_clsname(me), me.name)
573 _augment(KeyFile, _tmp)
574
575 class _tmp:
576   def __repr__(me): return '%s(%r)' % (_clsname(me), me.fulltag)
577 _augment(Key, _tmp)
578
579 class _tmp:
580   def __repr__(me):
581     return '%s({%s})' % (_clsname(me),
582                          ', '.join(['%r: %r' % kv for kv in me.iteritems()]))
583   def _repr_pretty_(me, pp, cyclep):
584     ind = _pp_bgroup_tyname(pp, me)
585     if cyclep: pp.text('...')
586     else: _pp_dict(pp, me.iteritems())
587     pp.end_group(ind, ')')
588 _augment(KeyAttributes, _tmp)
589
590 class _tmp:
591   def __repr__(me):
592     return '%s(%s, %r)' % (_clsname(me),
593                            _repr_secret(me._guts(),
594                                         not (me.flags & KF_NONSECRET)),
595                            me.writeflags(me.flags))
596   def _repr_pretty_(me, pp, cyclep):
597     ind = _pp_bgroup_tyname(pp, me)
598     if cyclep:
599       pp.text('...')
600     else:
601       _pp_secret(pp, me._guts(), not (me.flags & KF_NONSECRET))
602       pp.text(','); pp.breakable()
603       pp.pretty(me.writeflags(me.flags))
604     pp.end_group(ind, ')')
605 _augment(KeyData, _tmp)
606
607 class _tmp:
608   def _guts(me): return me.bin
609 _augment(KeyDataBinary, _tmp)
610
611 class _tmp:
612   def _guts(me): return me.ct
613 _augment(KeyDataEncrypted, _tmp)
614
615 class _tmp:
616   def _guts(me): return me.mp
617 _augment(KeyDataMP, _tmp)
618
619 class _tmp:
620   def _guts(me): return me.str
621 _augment(KeyDataString, _tmp)
622
623 class _tmp:
624   def _guts(me): return me.ecpt
625 _augment(KeyDataECPt, _tmp)
626
627 class _tmp:
628   def __repr__(me):
629     return '%s({%s})' % (_clsname(me),
630                          ', '.join(['%r: %r' % kv for kv in me.iteritems()]))
631   def _repr_pretty_(me, pp, cyclep):
632     ind = _pp_bgroup_tyname(pp, me, '({ ')
633     if cyclep: pp.text('...')
634     else: _pp_dict(pp, me.iteritems())
635     pp.end_group(ind, ' })')
636 _augment(KeyDataStructured, _tmp)
637
638 ###--------------------------------------------------------------------------
639 ### Abstract groups.
640
641 class _tmp:
642   def __repr__(me):
643     return '%s(p = %s, r = %s, g = %s)' % (_clsname(me), me.p, me.r, me.g)
644   def _repr_pretty_(me, pp, cyclep):
645     ind = _pp_bgroup_tyname(pp, me)
646     if cyclep:
647       pp.text('...')
648     else:
649       _pp_kv(pp, 'p', me.p); pp.text(','); pp.breakable()
650       _pp_kv(pp, 'r', me.r); pp.text(','); pp.breakable()
651       _pp_kv(pp, 'g', me.g)
652     pp.end_group(ind, ')')
653 _augment(FGInfo, _tmp)
654
655 class _tmp:
656   def group(me): return PrimeGroup(me)
657 _augment(DHInfo, _tmp)
658
659 class _tmp:
660   def group(me): return BinGroup(me)
661 _augment(BinDHInfo, _tmp)
662
663 class _tmp:
664   def __repr__(me):
665     return '%s(%r)' % (_clsname(me), me.info)
666   def _repr_pretty_(me, pp, cyclep):
667     ind = _pp_bgroup_tyname(pp, me)
668     if cyclep: pp.text('...')
669     else: pp.pretty(me.info)
670     pp.end_group(ind, ')')
671 _augment(Group, _tmp)
672
673 class _tmp:
674   def __hash__(me):
675     info = me.info
676     h = 0xbce3cfe6
677     h ^=   hash(info.p)
678     h ^= 2*hash(info.r) & 0xffffffff
679     h ^= 5*hash(info.g) & 0xffffffff
680     return h
681   def _get_geval(me, x): return MP(x)
682 _augment(PrimeGroup, _tmp)
683
684 class _tmp:
685   def __hash__(me):
686     info = me.info
687     h = 0x80695949
688     h ^=   hash(info.p)
689     h ^= 2*hash(info.r) & 0xffffffff
690     h ^= 5*hash(info.g) & 0xffffffff
691     return h
692   def _get_geval(me, x): return GF(x)
693 _augment(BinGroup, _tmp)
694
695 class _tmp:
696   def __hash__(me): return 0x0ec23dab ^ hash(me.info)
697   def _get_geval(me, x): return x.toec()
698 _augment(ECGroup, _tmp)
699
700 class _tmp:
701   def __repr__(me):
702     return '%r(%r)' % (me.group, str(me))
703   def _repr_pretty_(me, pp, cyclep):
704     pp.pretty(type(me)._get_geval(me))
705 _augment(GE, _tmp)
706
707 ###--------------------------------------------------------------------------
708 ### RSA encoding techniques.
709
710 class PKCS1Crypt (object):
711   def __init__(me, ep = '', rng = rand):
712     me.ep = ep
713     me.rng = rng
714   def encode(me, msg, nbits):
715     return _base._p1crypt_encode(msg, nbits, me.ep, me.rng)
716   def decode(me, ct, nbits):
717     return _base._p1crypt_decode(ct, nbits, me.ep, me.rng)
718
719 class PKCS1Sig (object):
720   def __init__(me, ep = '', rng = rand):
721     me.ep = ep
722     me.rng = rng
723   def encode(me, msg, nbits):
724     return _base._p1sig_encode(msg, nbits, me.ep, me.rng)
725   def decode(me, msg, sig, nbits):
726     return _base._p1sig_decode(msg, sig, nbits, me.ep, me.rng)
727
728 class OAEP (object):
729   def __init__(me, mgf = sha_mgf, hash = sha, ep = '', rng = rand):
730     me.mgf = mgf
731     me.hash = hash
732     me.ep = ep
733     me.rng = rng
734   def encode(me, msg, nbits):
735     return _base._oaep_encode(msg, nbits, me.mgf, me.hash, me.ep, me.rng)
736   def decode(me, ct, nbits):
737     return _base._oaep_decode(ct, nbits, me.mgf, me.hash, me.ep, me.rng)
738
739 class PSS (object):
740   def __init__(me, mgf = sha_mgf, hash = sha, saltsz = None, rng = rand):
741     me.mgf = mgf
742     me.hash = hash
743     if saltsz is None:
744       saltsz = hash.hashsz
745     me.saltsz = saltsz
746     me.rng = rng
747   def encode(me, msg, nbits):
748     return _base._pss_encode(msg, nbits, me.mgf, me.hash, me.saltsz, me.rng)
749   def decode(me, msg, sig, nbits):
750     return _base._pss_decode(msg, sig, nbits,
751                              me.mgf, me.hash, me.saltsz, me.rng)
752
753 class _tmp:
754   def encrypt(me, msg, enc):
755     return me.pubop(enc.encode(msg, me.n.nbits))
756   def verify(me, msg, sig, enc):
757     if msg is None: return enc.decode(msg, me.pubop(sig), me.n.nbits)
758     try:
759       x = enc.decode(msg, me.pubop(sig), me.n.nbits)
760       return x is None or x == msg
761     except ValueError:
762       return False
763   def __repr__(me):
764     return '%s(n = %r, e = %r)' % (_clsname(me), me.n, me.e)
765   def _repr_pretty_(me, pp, cyclep):
766     ind = _pp_bgroup_tyname(pp, me)
767     if cyclep:
768       pp.text('...')
769     else:
770       _pp_kv(pp, 'n', me.n); pp.text(','); pp.breakable()
771       _pp_kv(pp, 'e', me.e)
772     pp.end_group(ind, ')')
773 _augment(RSAPub, _tmp)
774
775 class _tmp:
776   def decrypt(me, ct, enc): return enc.decode(me.privop(ct), me.n.nbits)
777   def sign(me, msg, enc): return me.privop(enc.encode(msg, me.n.nbits))
778   def __repr__(me):
779     return '%s(n = %r, e = %r, d = %s, ' \
780       'p = %s, q = %s, dp = %s, dq = %s, q_inv = %s)' % \
781       (_clsname(me), me.n, me.e,
782        _repr_secret(me.d), _repr_secret(me.p), _repr_secret(me.q),
783        _repr_secret(me.dp), _repr_secret(me.dq), _repr_secret(me.q_inv))
784   def _repr_pretty_(me, pp, cyclep):
785     ind = _pp_bgroup_tyname(pp, me)
786     if cyclep:
787       pp.text('...')
788     else:
789       _pp_kv(pp, 'n', me.n); pp.text(','); pp.breakable()
790       _pp_kv(pp, 'e', me.e); pp.text(','); pp.breakable()
791       _pp_kv(pp, 'd', me.d, secretp = True); pp.text(','); pp.breakable()
792       _pp_kv(pp, 'p', me.p, secretp = True); pp.text(','); pp.breakable()
793       _pp_kv(pp, 'q', me.q, secretp = True); pp.text(','); pp.breakable()
794       _pp_kv(pp, 'dp', me.dp, secretp = True); pp.text(','); pp.breakable()
795       _pp_kv(pp, 'dq', me.dq, secretp = True); pp.text(','); pp.breakable()
796       _pp_kv(pp, 'q_inv', me.q_inv, secretp = True)
797     pp.end_group(ind, ')')
798 _augment(RSAPriv, _tmp)
799
800 ###--------------------------------------------------------------------------
801 ### DSA and related schemes.
802
803 class _tmp:
804   def __repr__(me): return '%s(G = %r, p = %r)' % (_clsname(me), me.G, me.p)
805   def _repr_pretty_(me, pp, cyclep):
806     ind = _pp_bgroup_tyname(pp, me)
807     if cyclep:
808       pp.text('...')
809     else:
810       _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
811       _pp_kv(pp, 'p', me.p)
812     pp.end_group(ind, ')')
813 _augment(DSAPub, _tmp)
814 _augment(KCDSAPub, _tmp)
815
816 class _tmp:
817   def __repr__(me): return '%s(G = %r, u = %s, p = %r)' % \
818       (_clsname(me), me.G, _repr_secret(me.u), me.p)
819   def _repr_pretty_(me, pp, cyclep):
820     ind = _pp_bgroup_tyname(pp, me)
821     if cyclep:
822       pp.text('...')
823     else:
824       _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
825       _pp_kv(pp, 'u', me.u, True); pp.text(','); pp.breakable()
826       _pp_kv(pp, 'p', me.p)
827     pp.end_group(ind, ')')
828 _augment(DSAPriv, _tmp)
829 _augment(KCDSAPriv, _tmp)
830
831 ###--------------------------------------------------------------------------
832 ### Bernstein's elliptic curve crypto and related schemes.
833
834 X25519_BASE = MP(9).storel(32)
835 X448_BASE = MP(5).storel(56)
836
837 Z128 = ByteString.zero(16)
838
839 class _BasePub (object):
840   def __init__(me, pub, *args, **kw):
841     if not me._PUBSZ.check(len(pub)): raise ValueError, 'bad public key'
842     super(_BasePub, me).__init__(*args, **kw)
843     me.pub = pub
844   def __repr__(me): return '%s(pub = %r)' % (_clsname(me), me.pub)
845   def _pp(me, pp): _pp_kv(pp, 'pub', me.pub)
846   def _repr_pretty_(me, pp, cyclep):
847     ind = _pp_bgroup_tyname(pp, me)
848     if cyclep: pp.text('...')
849     else: me._pp(pp)
850     pp.end_group(ind, ')')
851
852 class _BasePriv (object):
853   def __init__(me, priv, pub = None, *args, **kw):
854     if not me._KEYSZ.check(len(priv)): raise ValueError, 'bad private key'
855     if pub is None: pub = me._pubkey(priv)
856     super(_BasePriv, me).__init__(pub = pub, *args, **kw)
857     me.priv = priv
858   @classmethod
859   def generate(cls, rng = rand):
860     return cls(rng.block(cls._KEYSZ.default))
861   def __repr__(me):
862     return '%s(priv = %d, pub = %r)' % \
863         (_clsname(me), _repr_secret(me.priv), me.pub)
864   def _pp(me, pp):
865     _pp_kv(pp, 'priv', me.priv, secretp = True); pp.text(','); pp.breakable()
866     super(_BasePriv, me)._pp(pp)
867
868 class _XDHPub (_BasePub):  pass
869
870 class _XDHPriv (_BasePriv):
871   def _pubkey(me, priv): return me._op(priv, me._BASE)
872   def agree(me, you): return me._op(me.priv, you.pub)
873   def boxkey(me, recip): return me._hashkey(me.agree(recip))
874   def box(me, recip, n, m): return secret_box(me.boxkey(recip), n, m)
875   def unbox(me, recip, n, c): return secret_unbox(me.boxkey(recip), n, c)
876
877 class X25519Pub (_XDHPub):
878   _PUBSZ = KeySZSet(X25519_PUBSZ)
879   _BASE = X25519_BASE
880
881 class X25519Priv (_XDHPriv, X25519Pub):
882   _KEYSZ = KeySZSet(X25519_KEYSZ)
883   def _op(me, k, X): return x25519(k, X)
884   def _hashkey(me, z): return hsalsa20_prf(z, Z128)
885
886 class X448Pub (_XDHPub):
887   _PUBSZ = KeySZSet(X448_PUBSZ)
888   _BASE = X448_BASE
889
890 class X448Priv (_XDHPriv, X448Pub):
891   _KEYSZ = KeySZSet(X448_KEYSZ)
892   def _op(me, k, X): return x448(k, X)
893   def _hashkey(me, z): return Shake256().hash(z).done(salsa20.keysz.default)
894
895 class _EdDSAPub (_BasePub):
896   def beginhash(me): return me._HASH()
897   def endhash(me, h): return h.done()
898
899 class _EdDSAPriv (_BasePriv, _EdDSAPub):
900   pass
901
902 class Ed25519Pub (_EdDSAPub):
903   _PUBSZ = KeySZSet(ED25519_PUBSZ)
904   _HASH = sha512
905   def verify(me, msg, sig, **kw):
906     return ed25519_verify(me.pub, msg, sig, **kw)
907
908 class Ed25519Priv (_EdDSAPriv, Ed25519Pub):
909   _KEYSZ = KeySZAny(ED25519_KEYSZ)
910   def _pubkey(me, priv): return ed25519_pubkey(priv)
911   def sign(me, msg, **kw):
912     return ed25519_sign(me.priv, msg, pub = me.pub, **kw)
913
914 class Ed448Pub (_EdDSAPub):
915   _PUBSZ = KeySZSet(ED448_PUBSZ)
916   _HASH = shake256
917   def verify(me, msg, sig, **kw):
918     return ed448_verify(me.pub, msg, sig, **kw)
919
920 class Ed448Priv (_EdDSAPriv, Ed448Pub):
921   _KEYSZ = KeySZAny(ED448_KEYSZ)
922   def _pubkey(me, priv): return ed448_pubkey(priv)
923   def sign(me, msg, **kw):
924     return ed448_sign(me.priv, msg, pub = me.pub, **kw)
925
926 ###--------------------------------------------------------------------------
927 ### Built-in named curves and prime groups.
928
929 class _groupmap (object):
930   def __init__(me, map, nth):
931     me.map = map
932     me.nth = nth
933     me._n = max(map.values()) + 1
934     me.i = me._n*[None]
935   def __repr__(me):
936     return '{%s}' % ', '.join(['%r: %r' % kv for kv in me.iteritems()])
937   def _repr_pretty_(me, pp, cyclep):
938     ind = _pp_bgroup(pp, '{ ')
939     if cyclep: pp.text('...')
940     else: _pp_dict(pp, me.iteritems())
941     pp.end_group(ind, ' }')
942   def __len__(me):
943     return me._n
944   def __contains__(me, k):
945     return k in me.map
946   def __getitem__(me, k):
947     i = me.map[k]
948     if me.i[i] is None:
949       me.i[i] = me.nth(i)
950     return me.i[i]
951   def __setitem__(me, k, v):
952     raise TypeError, "immutable object"
953   def __iter__(me):
954     return iter(me.map)
955   def iterkeys(me):
956     return iter(me.map)
957   def itervalues(me):
958     for k in me:
959       yield me[k]
960   def iteritems(me):
961     for k in me:
962       yield k, me[k]
963   def keys(me):
964     return [k for k in me]
965   def values(me):
966     return [me[k] for k in me]
967   def items(me):
968     return [(k, me[k]) for k in me]
969 eccurves = _groupmap(_base._eccurves, ECInfo._curven)
970 primegroups = _groupmap(_base._pgroups, DHInfo._groupn)
971 bingroups = _groupmap(_base._bingroups, BinDHInfo._groupn)
972
973 ###--------------------------------------------------------------------------
974 ### Prime number generation.
975
976 class PrimeGenEventHandler (object):
977   def pg_begin(me, ev):
978     return me.pg_try(ev)
979   def pg_done(me, ev):
980     return PGEN_DONE
981   def pg_abort(me, ev):
982     return PGEN_TRY
983   def pg_fail(me, ev):
984     return PGEN_TRY
985   def pg_pass(me, ev):
986     return PGEN_TRY
987
988 class SophieGermainStepJump (object):
989   def pg_begin(me, ev):
990     me.lf = PrimeFilter(ev.x)
991     me.hf = me.lf.muladd(2, 1)
992     return me.cont(ev)
993   def pg_try(me, ev):
994     me.step()
995     return me.cont(ev)
996   def cont(me, ev):
997     while me.lf.status == PGEN_FAIL or me.hf.status == PGEN_FAIL:
998       me.step()
999     if me.lf.status == PGEN_ABORT or me.hf.status == PGEN_ABORT:
1000       return PGEN_ABORT
1001     ev.x = me.lf.x
1002     if me.lf.status == PGEN_DONE and me.hf.status == PGEN_DONE:
1003       return PGEN_DONE
1004     return PGEN_TRY
1005   def pg_done(me, ev):
1006     del me.lf
1007     del me.hf
1008
1009 class SophieGermainStepper (SophieGermainStepJump):
1010   def __init__(me, step):
1011     me.lstep = step;
1012     me.hstep = 2 * step
1013   def step(me):
1014     me.lf.step(me.lstep)
1015     me.hf.step(me.hstep)
1016
1017 class SophieGermainJumper (SophieGermainStepJump):
1018   def __init__(me, jump):
1019     me.ljump = PrimeFilter(jump);
1020     me.hjump = me.ljump.muladd(2, 0)
1021   def step(me):
1022     me.lf.jump(me.ljump)
1023     me.hf.jump(me.hjump)
1024   def pg_done(me, ev):
1025     del me.ljump
1026     del me.hjump
1027     SophieGermainStepJump.pg_done(me, ev)
1028
1029 class SophieGermainTester (object):
1030   def __init__(me):
1031     pass
1032   def pg_begin(me, ev):
1033     me.lr = RabinMiller(ev.x)
1034     me.hr = RabinMiller(2 * ev.x + 1)
1035   def pg_try(me, ev):
1036     lst = me.lr.test(ev.rng.range(me.lr.x))
1037     if lst != PGEN_PASS and lst != PGEN_DONE:
1038       return lst
1039     rst = me.hr.test(ev.rng.range(me.hr.x))
1040     if rst != PGEN_PASS and rst != PGEN_DONE:
1041       return rst
1042     if lst == PGEN_DONE and rst == PGEN_DONE:
1043       return PGEN_DONE
1044     return PGEN_PASS
1045   def pg_done(me, ev):
1046     del me.lr
1047     del me.hr
1048
1049 class PrimitiveStepper (PrimeGenEventHandler):
1050   def __init__(me):
1051     pass
1052   def pg_try(me, ev):
1053     ev.x = me.i.next()
1054     return PGEN_TRY
1055   def pg_begin(me, ev):
1056     me.i = iter(smallprimes)
1057     return me.pg_try(ev)
1058
1059 class PrimitiveTester (PrimeGenEventHandler):
1060   def __init__(me, mod, hh = [], exp = None):
1061     me.mod = MPMont(mod)
1062     me.exp = exp
1063     me.hh = hh
1064   def pg_try(me, ev):
1065     x = ev.x
1066     if me.exp is not None:
1067       x = me.mod.exp(x, me.exp)
1068       if x == 1: return PGEN_FAIL
1069     for h in me.hh:
1070       if me.mod.exp(x, h) == 1: return PGEN_FAIL
1071     ev.x = x
1072     return PGEN_DONE
1073
1074 class SimulStepper (PrimeGenEventHandler):
1075   def __init__(me, mul = 2, add = 1, step = 2):
1076     me.step = step
1077     me.mul = mul
1078     me.add = add
1079   def _stepfn(me, step):
1080     if step <= 0:
1081       raise ValueError, 'step must be positive'
1082     if step <= MPW_MAX:
1083       return lambda f: f.step(step)
1084     j = PrimeFilter(step)
1085     return lambda f: f.jump(j)
1086   def pg_begin(me, ev):
1087     x = ev.x
1088     me.lf = PrimeFilter(x)
1089     me.hf = PrimeFilter(x * me.mul + me.add)
1090     me.lstep = me._stepfn(me.step)
1091     me.hstep = me._stepfn(me.step * me.mul)
1092     SimulStepper._cont(me, ev)
1093   def pg_try(me, ev):
1094     me._step()
1095     me._cont(ev)
1096   def _step(me):
1097     me.lstep(me.lf)
1098     me.hstep(me.hf)
1099   def _cont(me, ev):
1100     while me.lf.status == PGEN_FAIL or me.hf.status == PGEN_FAIL:
1101       me._step()
1102     if me.lf.status == PGEN_ABORT or me.hf.status == PGEN_ABORT:
1103       return PGEN_ABORT
1104     ev.x = me.lf.x
1105     if me.lf.status == PGEN_DONE and me.hf.status == PGEN_DONE:
1106       return PGEN_DONE
1107     return PGEN_TRY
1108   def pg_done(me, ev):
1109     del me.lf
1110     del me.hf
1111     del me.lstep
1112     del me.hstep
1113
1114 class SimulTester (PrimeGenEventHandler):
1115   def __init__(me, mul = 2, add = 1):
1116     me.mul = mul
1117     me.add = add
1118   def pg_begin(me, ev):
1119     x = ev.x
1120     me.lr = RabinMiller(x)
1121     me.hr = RabinMiller(x * me.mul + me.add)
1122   def pg_try(me, ev):
1123     lst = me.lr.test(ev.rng.range(me.lr.x))
1124     if lst != PGEN_PASS and lst != PGEN_DONE:
1125       return lst
1126     rst = me.hr.test(ev.rng.range(me.hr.x))
1127     if rst != PGEN_PASS and rst != PGEN_DONE:
1128       return rst
1129     if lst == PGEN_DONE and rst == PGEN_DONE:
1130       return PGEN_DONE
1131     return PGEN_PASS
1132   def pg_done(me, ev):
1133     del me.lr
1134     del me.hr
1135
1136 def sgprime(start, step = 2, name = 'p', event = pgen_nullev, nsteps = 0):
1137   start = MP(start)
1138   return pgen(start, name, SimulStepper(step = step), SimulTester(), event,
1139               nsteps, RabinMiller.iters(start.nbits))
1140
1141 def findprimitive(mod, hh = [], exp = None, name = 'g', event = pgen_nullev):
1142   return pgen(0, name, PrimitiveStepper(), PrimitiveTester(mod, hh, exp),
1143               event, 0, 1)
1144
1145 def kcdsaprime(pbits, qbits, rng = rand,
1146                event = pgen_nullev, name = 'p', nsteps = 0):
1147   hbits = pbits - qbits
1148   h = pgen(rng.mp(hbits, 1), name + ' [h]',
1149            PrimeGenStepper(2), PrimeGenTester(),
1150            event, nsteps, RabinMiller.iters(hbits))
1151   q = pgen(rng.mp(qbits, 1), name, SimulStepper(2 * h, 1, 2),
1152            SimulTester(2 * h, 1), event, nsteps, RabinMiller.iters(qbits))
1153   p = 2 * q * h + 1
1154   return p, q, h
1155
1156 #----- That's all, folks ----------------------------------------------------