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