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