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