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