chiark / gitweb /
algorithms.c: Add binding for `poly1305_flushzero'.
[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 ###--------------------------------------------------------------------------
86 ### Bytestrings.
87
88 class _tmp:
89   def fromhex(x):
90     return ByteString(_unhexify(x))
91   fromhex = staticmethod(fromhex)
92   def __hex__(me):
93     return _hexify(me)
94   def __repr__(me):
95     return 'bytes(%r)' % hex(me)
96 _augment(ByteString, _tmp)
97 ByteString.__hash__ = str.__hash__
98 bytes = ByteString.fromhex
99
100 ###--------------------------------------------------------------------------
101 ### Hashing.
102
103 class _tmp:
104   def check(me, h):
105     hh = me.done()
106     return ctstreq(h, hh)
107 _augment(GHash, _tmp)
108 _augment(Poly1305Hash, _tmp)
109
110 ###--------------------------------------------------------------------------
111 ### Multiprecision integers and binary polynomials.
112
113 def _split_rat(x):
114   if isinstance(x, BaseRat): return x._n, x._d
115   else: return x, 1
116 class BaseRat (object):
117   """Base class implementing fields of fractions over Euclidean domains."""
118   def __new__(cls, a, b):
119     a, b = cls.RING(a), cls.RING(b)
120     q, r = divmod(a, b)
121     if r == 0: return q
122     g = b.gcd(r)
123     me = super(BaseRat, cls).__new__(cls)
124     me._n = a//g
125     me._d = b//g
126     return me
127   @property
128   def numer(me): return me._n
129   @property
130   def denom(me): return me._d
131   def __str__(me): return '%s/%s' % (me._n, me._d)
132   def __repr__(me): return '%s(%s, %s)' % (type(me).__name__, me._n, me._d)
133
134   def __add__(me, you):
135     n, d = _split_rat(you)
136     return type(me)(me._n*d + n*me._d, d*me._d)
137   __radd__ = __add__
138   def __sub__(me, you):
139     n, d = _split_rat(you)
140     return type(me)(me._n*d - n*me._d, d*me._d)
141   def __rsub__(me, you):
142     n, d = _split_rat(you)
143     return type(me)(n*me._d - me._n*d, d*me._d)
144   def __mul__(me, you):
145     n, d = _split_rat(you)
146     return type(me)(me._n*n, me._d*d)
147   def __div__(me, you):
148     n, d = _split_rat(you)
149     return type(me)(me._n*d, me._d*n)
150   def __rdiv__(me, you):
151     n, d = _split_rat(you)
152     return type(me)(me._d*n, me._n*d)
153   def __cmp__(me, you):
154     n, d = _split_rat(you)
155     return type(me)(me._n*d, n*me._d)
156   def __rcmp__(me, you):
157     n, d = _split_rat(you)
158     return cmp(n*me._d, me._n*d)
159
160 class IntRat (BaseRat):
161   RING = MP
162
163 class GFRat (BaseRat):
164   RING = GF
165
166 class _tmp:
167   def negp(x): return x < 0
168   def posp(x): return x > 0
169   def zerop(x): return x == 0
170   def oddp(x): return x.testbit(0)
171   def evenp(x): return not x.testbit(0)
172   def mont(x): return MPMont(x)
173   def barrett(x): return MPBarrett(x)
174   def reduce(x): return MPReduce(x)
175   def __div__(me, you): return IntRat(me, you)
176   def __rdiv__(me, you): return IntRat(you, me)
177 _augment(MP, _tmp)
178
179 class _tmp:
180   def zerop(x): return x == 0
181   def reduce(x): return GFReduce(x)
182   def trace(x, y): return x.reduce().trace(y)
183   def halftrace(x, y): return x.reduce().halftrace(y)
184   def modsqrt(x, y): return x.reduce().sqrt(y)
185   def quadsolve(x, y): return x.reduce().quadsolve(y)
186   def __div__(me, you): return GFRat(me, you)
187   def __rdiv__(me, you): return GFRat(you, me)
188 _augment(GF, _tmp)
189
190 class _tmp:
191   def product(*arg):
192     'product(ITERABLE) or product(I, ...) -> PRODUCT'
193     return MPMul(*arg).done()
194   product = staticmethod(product)
195 _augment(MPMul, _tmp)
196
197 ###--------------------------------------------------------------------------
198 ### Abstract fields.
199
200 class _tmp:
201   def fromstring(str): return _checkend(Field.parse(str))
202   fromstring = staticmethod(fromstring)
203 _augment(Field, _tmp)
204
205 class _tmp:
206   def __repr__(me): return '%s(%sL)' % (type(me).__name__, me.p)
207   def __hash__(me): return 0x114401de ^ hash(me.p)
208   def ec(me, a, b): return ECPrimeProjCurve(me, a, b)
209 _augment(PrimeField, _tmp)
210
211 class _tmp:
212   def __repr__(me): return '%s(%sL)' % (type(me).__name__, hex(me.p))
213   def ec(me, a, b): return ECBinProjCurve(me, a, b)
214 _augment(BinField, _tmp)
215
216 class _tmp:
217   def __hash__(me): return 0x23e4701c ^ hash(me.p)
218 _augment(BinPolyField, _tmp)
219
220 class _tmp:
221   def __hash__(me):
222     h = 0x9a7d6240
223     h ^=   hash(me.p)
224     h ^= 2*hash(me.beta) & 0xffffffff
225     return h
226 _augment(BinNormField, _tmp)
227
228 class _tmp:
229   def __str__(me): return str(me.value)
230   def __repr__(me): return '%s(%s)' % (repr(me.field), repr(me.value))
231 _augment(FE, _tmp)
232
233 ###--------------------------------------------------------------------------
234 ### Elliptic curves.
235
236 class _tmp:
237   def __repr__(me):
238     return '%s(%r, %s, %s)' % (type(me).__name__, me.field, me.a, me.b)
239   def frombuf(me, s):
240     return ecpt.frombuf(me, s)
241   def fromraw(me, s):
242     return ecpt.fromraw(me, s)
243   def pt(me, *args):
244     return me(*args)
245 _augment(ECCurve, _tmp)
246
247 class _tmp:
248   def __hash__(me):
249     h = 0x6751d341
250     h ^=   hash(me.field)
251     h ^= 2*hash(me.a) ^ 0xffffffff
252     h ^= 5*hash(me.b) ^ 0xffffffff
253     return h
254 _augment(ECPrimeCurve, _tmp)
255
256 class _tmp:
257   def __hash__(me):
258     h = 0x2ac203c5
259     h ^=   hash(me.field)
260     h ^= 2*hash(me.a) ^ 0xffffffff
261     h ^= 5*hash(me.b) ^ 0xffffffff
262     return h
263 _augment(ECBinCurve, _tmp)
264
265 class _tmp:
266   def __repr__(me):
267     if not me: return 'ECPt()'
268     return 'ECPt(%s, %s)' % (me.ix, me.iy)
269   def __str__(me):
270     if not me: return 'inf'
271     return '(%s, %s)' % (me.ix, me.iy)
272 _augment(ECPt, _tmp)
273
274 class _tmp:
275   def __repr__(me):
276     return 'ECInfo(curve = %r, G = %r, r = %s, h = %s)' % \
277            (me.curve, me.G, me.r, me.h)
278   def __hash__(me):
279     h = 0x9bedb8de
280     h ^=   hash(me.curve)
281     h ^= 2*hash(me.G) & 0xffffffff
282     return h
283   def group(me):
284     return ECGroup(me)
285 _augment(ECInfo, _tmp)
286
287 class _tmp:
288   def __repr__(me):
289     if not me: return '%r()' % (me.curve)
290     return '%r(%s, %s)' % (me.curve, me.x, me.y)
291   def __str__(me):
292     if not me: return 'inf'
293     return '(%s, %s)' % (me.x, me.y)
294 _augment(ECPtCurve, _tmp)
295
296 ###--------------------------------------------------------------------------
297 ### Key sizes.
298
299 class _tmp:
300   def __repr__(me): return 'KeySZAny(%d)' % me.default
301   def check(me, sz): return True
302   def best(me, sz): return sz
303 _augment(KeySZAny, _tmp)
304
305 class _tmp:
306   def __repr__(me):
307     return 'KeySZRange(%d, %d, %d, %d)' % \
308            (me.default, me.min, me.max, me.mod)
309   def check(me, sz): return me.min <= sz <= me.max and sz % me.mod == 0
310   def best(me, sz):
311     if sz < me.min: raise ValueError, 'key too small'
312     elif sz > me.max: return me.max
313     else: return sz - (sz % me.mod)
314 _augment(KeySZRange, _tmp)
315
316 class _tmp:
317   def __repr__(me): return 'KeySZSet(%d, %s)' % (me.default, me.set)
318   def check(me, sz): return sz in me.set
319   def best(me, sz):
320     found = -1
321     for i in me.set:
322       if found < i <= sz: found = i
323     if found < 0: raise ValueError, 'key too small'
324     return found
325 _augment(KeySZSet, _tmp)
326
327 ###--------------------------------------------------------------------------
328 ### Abstract groups.
329
330 class _tmp:
331   def __repr__(me):
332     return '%s(p = %s, r = %s, g = %s)' % \
333            (type(me).__name__, me.p, me.r, me.g)
334 _augment(FGInfo, _tmp)
335
336 class _tmp:
337   def group(me): return PrimeGroup(me)
338 _augment(DHInfo, _tmp)
339
340 class _tmp:
341   def group(me): return BinGroup(me)
342 _augment(BinDHInfo, _tmp)
343
344 class _tmp:
345   def __repr__(me):
346     return '%s(%r)' % (type(me).__name__, me.info)
347 _augment(Group, _tmp)
348
349 class _tmp:
350   def __hash__(me):
351     info = me.info
352     h = 0xbce3cfe6
353     h ^=   hash(info.p)
354     h ^= 2*hash(info.r) & 0xffffffff
355     h ^= 5*hash(info.g) & 0xffffffff
356     return h
357 _augment(PrimeGroup, _tmp)
358
359 class _tmp:
360   def __hash__(me):
361     info = me.info
362     h = 0x80695949
363     h ^=   hash(info.p)
364     h ^= 2*hash(info.r) & 0xffffffff
365     h ^= 5*hash(info.g) & 0xffffffff
366     return h
367 _augment(BinGroup, _tmp)
368
369 class _tmp:
370   def __hash__(me): return 0x0ec23dab ^ hash(me.info)
371 _augment(ECGroup, _tmp)
372
373 class _tmp:
374   def __repr__(me):
375     return '%r(%r)' % (me.group, str(me))
376 _augment(GE, _tmp)
377
378 ###--------------------------------------------------------------------------
379 ### RSA encoding techniques.
380
381 class PKCS1Crypt (object):
382   def __init__(me, ep = '', rng = rand):
383     me.ep = ep
384     me.rng = rng
385   def encode(me, msg, nbits):
386     return _base._p1crypt_encode(msg, nbits, me.ep, me.rng)
387   def decode(me, ct, nbits):
388     return _base._p1crypt_decode(ct, nbits, me.ep, me.rng)
389
390 class PKCS1Sig (object):
391   def __init__(me, ep = '', rng = rand):
392     me.ep = ep
393     me.rng = rng
394   def encode(me, msg, nbits):
395     return _base._p1sig_encode(msg, nbits, me.ep, me.rng)
396   def decode(me, msg, sig, nbits):
397     return _base._p1sig_decode(msg, sig, nbits, me.ep, me.rng)
398
399 class OAEP (object):
400   def __init__(me, mgf = sha_mgf, hash = sha, ep = '', rng = rand):
401     me.mgf = mgf
402     me.hash = hash
403     me.ep = ep
404     me.rng = rng
405   def encode(me, msg, nbits):
406     return _base._oaep_encode(msg, nbits, me.mgf, me.hash, me.ep, me.rng)
407   def decode(me, ct, nbits):
408     return _base._oaep_decode(ct, nbits, me.mgf, me.hash, me.ep, me.rng)
409
410 class PSS (object):
411   def __init__(me, mgf = sha_mgf, hash = sha, saltsz = None, rng = rand):
412     me.mgf = mgf
413     me.hash = hash
414     if saltsz is None:
415       saltsz = hash.hashsz
416     me.saltsz = saltsz
417     me.rng = rng
418   def encode(me, msg, nbits):
419     return _base._pss_encode(msg, nbits, me.mgf, me.hash, me.saltsz, me.rng)
420   def decode(me, msg, sig, nbits):
421     return _base._pss_decode(msg, sig, nbits,
422                              me.mgf, me.hash, me.saltsz, me.rng)
423
424 class _tmp:
425   def encrypt(me, msg, enc):
426     return me.pubop(enc.encode(msg, me.n.nbits))
427   def verify(me, msg, sig, enc):
428     if msg is None: return enc.decode(msg, me.pubop(sig), me.n.nbits)
429     try:
430       x = enc.decode(msg, me.pubop(sig), me.n.nbits)
431       return x is None or x == msg
432     except ValueError:
433       return False
434 _augment(RSAPub, _tmp)
435
436 class _tmp:
437   def decrypt(me, ct, enc): return enc.decode(me.privop(ct), me.n.nbits)
438   def sign(me, msg, enc): return me.privop(enc.encode(msg, me.n.nbits))
439 _augment(RSAPriv, _tmp)
440
441 ###--------------------------------------------------------------------------
442 ### Built-in named curves and prime groups.
443
444 class _groupmap (object):
445   def __init__(me, map, nth):
446     me.map = map
447     me.nth = nth
448     me.i = [None] * (max(map.values()) + 1)
449   def __repr__(me):
450     return '{%s}' % ', '.join(['%r: %r' % (k, me[k]) for k in me])
451   def __contains__(me, k):
452     return k in me.map
453   def __getitem__(me, k):
454     i = me.map[k]
455     if me.i[i] is None:
456       me.i[i] = me.nth(i)
457     return me.i[i]
458   def __setitem__(me, k, v):
459     raise TypeError, "immutable object"
460   def __iter__(me):
461     return iter(me.map)
462   def iterkeys(me):
463     return iter(me.map)
464   def itervalues(me):
465     for k in me:
466       yield me[k]
467   def iteritems(me):
468     for k in me:
469       yield k, me[k]
470   def keys(me):
471     return [k for k in me]
472   def values(me):
473     return [me[k] for k in me]
474   def items(me):
475     return [(k, me[k]) for k in me]
476 eccurves = _groupmap(_base._eccurves, ECInfo._curven)
477 primegroups = _groupmap(_base._pgroups, DHInfo._groupn)
478 bingroups = _groupmap(_base._bingroups, BinDHInfo._groupn)
479
480 ###--------------------------------------------------------------------------
481 ### Prime number generation.
482
483 class PrimeGenEventHandler (object):
484   def pg_begin(me, ev):
485     return me.pg_try(ev)
486   def pg_done(me, ev):
487     return PGEN_DONE
488   def pg_abort(me, ev):
489     return PGEN_TRY
490   def pg_fail(me, ev):
491     return PGEN_TRY
492   def pg_pass(me, ev):
493     return PGEN_TRY
494
495 class SophieGermainStepJump (object):
496   def pg_begin(me, ev):
497     me.lf = PrimeFilter(ev.x)
498     me.hf = me.lf.muladd(2, 1)
499     return me.cont(ev)
500   def pg_try(me, ev):
501     me.step()
502     return me.cont(ev)
503   def cont(me, ev):
504     while me.lf.status == PGEN_FAIL or me.hf.status == PGEN_FAIL:
505       me.step()
506     if me.lf.status == PGEN_ABORT or me.hf.status == PGEN_ABORT:
507       return PGEN_ABORT
508     ev.x = me.lf.x
509     if me.lf.status == PGEN_DONE and me.hf.status == PGEN_DONE:
510       return PGEN_DONE
511     return PGEN_TRY
512   def pg_done(me, ev):
513     del me.lf
514     del me.hf
515
516 class SophieGermainStepper (SophieGermainStepJump):
517   def __init__(me, step):
518     me.lstep = step;
519     me.hstep = 2 * step
520   def step(me):
521     me.lf.step(me.lstep)
522     me.hf.step(me.hstep)
523
524 class SophieGermainJumper (SophieGermainStepJump):
525   def __init__(me, jump):
526     me.ljump = PrimeFilter(jump);
527     me.hjump = me.ljump.muladd(2, 0)
528   def step(me):
529     me.lf.jump(me.ljump)
530     me.hf.jump(me.hjump)
531   def pg_done(me, ev):
532     del me.ljump
533     del me.hjump
534     SophieGermainStepJump.pg_done(me, ev)
535
536 class SophieGermainTester (object):
537   def __init__(me):
538     pass
539   def pg_begin(me, ev):
540     me.lr = RabinMiller(ev.x)
541     me.hr = RabinMiller(2 * ev.x + 1)
542   def pg_try(me, ev):
543     lst = me.lr.test(ev.rng.range(me.lr.x))
544     if lst != PGEN_PASS and lst != PGEN_DONE:
545       return lst
546     rst = me.hr.test(ev.rng.range(me.hr.x))
547     if rst != PGEN_PASS and rst != PGEN_DONE:
548       return rst
549     if lst == PGEN_DONE and rst == PGEN_DONE:
550       return PGEN_DONE
551     return PGEN_PASS
552   def pg_done(me, ev):
553     del me.lr
554     del me.hr
555
556 class PrimitiveStepper (PrimeGenEventHandler):
557   def __init__(me):
558     pass
559   def pg_try(me, ev):
560     ev.x = me.i.next()
561     return PGEN_TRY
562   def pg_begin(me, ev):
563     me.i = iter(smallprimes)
564     return me.pg_try(ev)
565
566 class PrimitiveTester (PrimeGenEventHandler):
567   def __init__(me, mod, hh = [], exp = None):
568     me.mod = MPMont(mod)
569     me.exp = exp
570     me.hh = hh
571   def pg_try(me, ev):
572     x = ev.x
573     if me.exp is not None:
574       x = me.mod.exp(x, me.exp)
575       if x == 1: return PGEN_FAIL
576     for h in me.hh:
577       if me.mod.exp(x, h) == 1: return PGEN_FAIL
578     ev.x = x
579     return PGEN_DONE
580
581 class SimulStepper (PrimeGenEventHandler):
582   def __init__(me, mul = 2, add = 1, step = 2):
583     me.step = step
584     me.mul = mul
585     me.add = add
586   def _stepfn(me, step):
587     if step <= 0:
588       raise ValueError, 'step must be positive'
589     if step <= MPW_MAX:
590       return lambda f: f.step(step)
591     j = PrimeFilter(step)
592     return lambda f: f.jump(j)
593   def pg_begin(me, ev):
594     x = ev.x
595     me.lf = PrimeFilter(x)
596     me.hf = PrimeFilter(x * me.mul + me.add)
597     me.lstep = me._stepfn(me.step)
598     me.hstep = me._stepfn(me.step * me.mul)
599     SimulStepper._cont(me, ev)
600   def pg_try(me, ev):
601     me._step()
602     me._cont(ev)
603   def _step(me):
604     me.lstep(me.lf)
605     me.hstep(me.hf)
606   def _cont(me, ev):
607     while me.lf.status == PGEN_FAIL or me.hf.status == PGEN_FAIL:
608       me._step()
609     if me.lf.status == PGEN_ABORT or me.hf.status == PGEN_ABORT:
610       return PGEN_ABORT
611     ev.x = me.lf.x
612     if me.lf.status == PGEN_DONE and me.hf.status == PGEN_DONE:
613       return PGEN_DONE
614     return PGEN_TRY
615   def pg_done(me, ev):
616     del me.lf
617     del me.hf
618     del me.lstep
619     del me.hstep
620
621 class SimulTester (PrimeGenEventHandler):
622   def __init__(me, mul = 2, add = 1):
623     me.mul = mul
624     me.add = add
625   def pg_begin(me, ev):
626     x = ev.x
627     me.lr = RabinMiller(x)
628     me.hr = RabinMiller(x * me.mul + me.add)
629   def pg_try(me, ev):
630     lst = me.lr.test(ev.rng.range(me.lr.x))
631     if lst != PGEN_PASS and lst != PGEN_DONE:
632       return lst
633     rst = me.hr.test(ev.rng.range(me.hr.x))
634     if rst != PGEN_PASS and rst != PGEN_DONE:
635       return rst
636     if lst == PGEN_DONE and rst == PGEN_DONE:
637       return PGEN_DONE
638     return PGEN_PASS
639   def pg_done(me, ev):
640     del me.lr
641     del me.hr
642
643 def sgprime(start, step = 2, name = 'p', event = pgen_nullev, nsteps = 0):
644   start = MP(start)
645   return pgen(start, name, SimulStepper(step = step), SimulTester(), event,
646               nsteps, RabinMiller.iters(start.nbits))
647
648 def findprimitive(mod, hh = [], exp = None, name = 'g', event = pgen_nullev):
649   return pgen(0, name, PrimitiveStepper(), PrimitiveTester(mod, hh, exp),
650               event, 0, 1)
651
652 def kcdsaprime(pbits, qbits, rng = rand,
653                event = pgen_nullev, name = 'p', nsteps = 0):
654   hbits = pbits - qbits
655   h = pgen(rng.mp(hbits, 1), name + ' [h]',
656            PrimeGenStepper(2), PrimeGenTester(),
657            event, nsteps, RabinMiller.iters(hbits))
658   q = pgen(rng.mp(qbits, 1), name, SimulStepper(2 * h, 1, 2),
659            SimulTester(2 * h, 1), event, nsteps, RabinMiller.iters(qbits))
660   p = 2 * q * h + 1
661   return p, q, h
662
663 #----- That's all, folks ----------------------------------------------------