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