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