mdw@git.distorted.org.uk Git - catacomb-python/blob - catacomb/__init__.py

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