chiark - git - mdw - 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 import sys as _sys
  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 name.
  39 _base._ego(_sys.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.translate(None, '/')
  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   def __div__(me, you):
 316     n, d = _split_rat(you)
 317     return type(me)(me._n*d, me._d*n)
 318   def __rdiv__(me, you):
 319     n, d = _split_rat(you)
 320     return type(me)(me._d*n, me._n*d)
 321   def __cmp__(me, you):
 322     n, d = _split_rat(you)
 323     return type(me)(me._n*d, n*me._d)
 324   def __rcmp__(me, you):
 325     n, d = _split_rat(you)
 326     return cmp(n*me._d, me._n*d)
 327
 328 class IntRat (BaseRat):
 329   RING = MP
 330
 331 class GFRat (BaseRat):
 332   RING = GF
 333
 334 class _tmp:
 335   def negp(x): return x < 0
 336   def posp(x): return x > 0
 337   def zerop(x): return x == 0
 338   def oddp(x): return x.testbit(0)
 339   def evenp(x): return not x.testbit(0)
 340   def mont(x): return MPMont(x)
 341   def barrett(x): return MPBarrett(x)
 342   def reduce(x): return MPReduce(x)
 343   def __div__(me, you): return IntRat(me, you)
 344   def __rdiv__(me, you): return IntRat(you, me)
 345   _repr_pretty_ = _pp_str
 346 _augment(MP, _tmp)
 347
 348 class _tmp:
 349   def zerop(x): return x == 0
 350   def reduce(x): return GFReduce(x)
 351   def trace(x, y): return x.reduce().trace(y)
 352   def halftrace(x, y): return x.reduce().halftrace(y)
 353   def modsqrt(x, y): return x.reduce().sqrt(y)
 354   def quadsolve(x, y): return x.reduce().quadsolve(y)
 355   def __div__(me, you): return GFRat(me, you)
 356   def __rdiv__(me, you): return GFRat(you, me)
 357   _repr_pretty_ = _pp_str
 358 _augment(GF, _tmp)
 359
 360 class _tmp:
 361   def product(*arg):
 362     'product(ITERABLE) or product(I, ...) -> PRODUCT'
 363     return MPMul(*arg).done()
 364   product = staticmethod(product)
 365 _augment(MPMul, _tmp)
 366
 367 ###--------------------------------------------------------------------------
 368 ### Abstract fields.
 369
 370 class _tmp:
 371   def fromstring(str): return _checkend(Field.parse(str))
 372   fromstring = staticmethod(fromstring)
 373 _augment(Field, _tmp)
 374
 375 class _tmp:
 376   def __repr__(me): return '%s(%sL)' % (_clsname(me), me.p)
 377   def __hash__(me): return 0x114401de ^ hash(me.p)
 378   def _repr_pretty_(me, pp, cyclep):
 379     ind = _pp_bgroup_tyname(pp, me)
 380     if cyclep: pp.text('...')
 381     else: pp.pretty(me.p)
 382     pp.end_group(ind, ')')
 383   def ec(me, a, b): return ECPrimeProjCurve(me, a, b)
 384 _augment(PrimeField, _tmp)
 385
 386 class _tmp:
 387   def __repr__(me): return '%s(%#xL)' % (_clsname(me), me.p)
 388   def ec(me, a, b): return ECBinProjCurve(me, a, b)
 389   def _repr_pretty_(me, pp, cyclep):
 390     ind = _pp_bgroup_tyname(pp, me)
 391     if cyclep: pp.text('...')
 392     else: pp.text('%#x' % me.p)
 393     pp.end_group(ind, ')')
 394 _augment(BinField, _tmp)
 395
 396 class _tmp:
 397   def __hash__(me): return 0x23e4701c ^ hash(me.p)
 398 _augment(BinPolyField, _tmp)
 399
 400 class _tmp:
 401   def __hash__(me):
 402     h = 0x9a7d6240
 403     h ^=   hash(me.p)
 404     h ^= 2*hash(me.beta) & 0xffffffff
 405     return h
 406 _augment(BinNormField, _tmp)
 407
 408 class _tmp:
 409   def __str__(me): return str(me.value)
 410   def __repr__(me): return '%s(%s)' % (repr(me.field), repr(me.value))
 411   _repr_pretty_ = _pp_str
 412 _augment(FE, _tmp)
 413
 414 ###--------------------------------------------------------------------------
 415 ### Elliptic curves.
 416
 417 class _tmp:
 418   def __repr__(me):
 419     return '%s(%r, %s, %s)' % (_clsname(me), me.field, me.a, me.b)
 420   def _repr_pretty_(me, pp, cyclep):
 421     ind = _pp_bgroup_tyname(pp, me)
 422     if cyclep:
 423       pp.text('...')
 424     else:
 425       pp.pretty(me.field); pp.text(','); pp.breakable()
 426       pp.pretty(me.a); pp.text(','); pp.breakable()
 427       pp.pretty(me.b)
 428     pp.end_group(ind, ')')
 429   def frombuf(me, s):
 430     return ecpt.frombuf(me, s)
 431   def fromraw(me, s):
 432     return ecpt.fromraw(me, s)
 433   def pt(me, *args):
 434     return me(*args)
 435 _augment(ECCurve, _tmp)
 436
 437 class _tmp:
 438   def __hash__(me):
 439     h = 0x6751d341
 440     h ^=   hash(me.field)
 441     h ^= 2*hash(me.a) ^ 0xffffffff
 442     h ^= 5*hash(me.b) ^ 0xffffffff
 443     return h
 444 _augment(ECPrimeCurve, _tmp)
 445
 446 class _tmp:
 447   def __hash__(me):
 448     h = 0x2ac203c5
 449     h ^=   hash(me.field)
 450     h ^= 2*hash(me.a) ^ 0xffffffff
 451     h ^= 5*hash(me.b) ^ 0xffffffff
 452     return h
 453 _augment(ECBinCurve, _tmp)
 454
 455 class _tmp:
 456   def __repr__(me):
 457     if not me: return '%s()' % _clsname(me)
 458     return '%s(%s, %s)' % (_clsname(me), me.ix, me.iy)
 459   def __str__(me):
 460     if not me: return 'inf'
 461     return '(%s, %s)' % (me.ix, me.iy)
 462   def _repr_pretty_(me, pp, cyclep):
 463     if cyclep:
 464       pp.text('...')
 465     elif not me:
 466       pp.text('inf')
 467     else:
 468       ind = _pp_bgroup(pp, '(')
 469       pp.pretty(me.ix); pp.text(','); pp.breakable()
 470       pp.pretty(me.iy)
 471       pp.end_group(ind, ')')
 472 _augment(ECPt, _tmp)
 473
 474 class _tmp:
 475   def __repr__(me):
 476     return '%s(curve = %r, G = %r, r = %s, h = %s)' % \
 477            (_clsname(me), me.curve, me.G, me.r, me.h)
 478   def _repr_pretty_(me, pp, cyclep):
 479     ind = _pp_bgroup_tyname(pp, me)
 480     if cyclep:
 481       pp.text('...')
 482     else:
 483       _pp_kv(pp, 'curve', me.curve); pp.text(','); pp.breakable()
 484       _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
 485       _pp_kv(pp, 'r', me.r); pp.text(','); pp.breakable()
 486       _pp_kv(pp, 'h', me.h)
 487     pp.end_group(ind, ')')
 488   def __hash__(me):
 489     h = 0x9bedb8de
 490     h ^=   hash(me.curve)
 491     h ^= 2*hash(me.G) & 0xffffffff
 492     return h
 493   def group(me):
 494     return ECGroup(me)
 495 _augment(ECInfo, _tmp)
 496
 497 class _tmp:
 498   def __repr__(me):
 499     if not me: return '%r()' % (me.curve)
 500     return '%r(%s, %s)' % (me.curve, me.x, me.y)
 501   def __str__(me):
 502     if not me: return 'inf'
 503     return '(%s, %s)' % (me.x, me.y)
 504   def _repr_pretty_(me, pp, cyclep):
 505     if cyclep:
 506       pp.text('...')
 507     elif not me:
 508       pp.text('inf')
 509     else:
 510       ind = _pp_bgroup(pp, '(')
 511       pp.pretty(me.x); pp.text(','); pp.breakable()
 512       pp.pretty(me.y)
 513       pp.end_group(ind, ')')
 514 _augment(ECPtCurve, _tmp)
 515
 516 ###--------------------------------------------------------------------------
 517 ### Key sizes.
 518
 519 class _tmp:
 520   def __repr__(me): return '%s(%d)' % (_clsname(me), me.default)
 521   def check(me, sz): return True
 522   def best(me, sz): return sz
 523 _augment(KeySZAny, _tmp)
 524
 525 class _tmp:
 526   def __repr__(me):
 527     return '%s(%d, %d, %d, %d)' % \
 528            (_clsname(me), me.default, me.min, me.max, me.mod)
 529   def _repr_pretty_(me, pp, cyclep):
 530     ind = _pp_bgroup_tyname(pp, me)
 531     if cyclep:
 532       pp.text('...')
 533     else:
 534       pp.pretty(me.default); pp.text(','); pp.breakable()
 535       pp.pretty(me.min); pp.text(','); pp.breakable()
 536       pp.pretty(me.max); pp.text(','); pp.breakable()
 537       pp.pretty(me.mod)
 538     pp.end_group(ind, ')')
 539   def check(me, sz): return me.min <= sz <= me.max and sz % me.mod == 0
 540   def best(me, sz):
 541     if sz < me.min: raise ValueError, 'key too small'
 542     elif sz > me.max: return me.max
 543     else: return sz - (sz % me.mod)
 544 _augment(KeySZRange, _tmp)
 545
 546 class _tmp:
 547   def __repr__(me): return '%s(%d, %s)' % (_clsname(me), me.default, me.set)
 548   def _repr_pretty_(me, pp, cyclep):
 549     ind = _pp_bgroup_tyname(pp, me)
 550     if cyclep:
 551       pp.text('...')
 552     else:
 553       pp.pretty(me.default); pp.text(','); pp.breakable()
 554       ind1 = _pp_bgroup(pp, '{')
 555       _pp_commas(pp, pp.pretty, me.set)
 556       pp.end_group(ind1, '}')
 557     pp.end_group(ind, ')')
 558   def check(me, sz): return sz in me.set
 559   def best(me, sz):
 560     found = -1
 561     for i in me.set:
 562       if found < i <= sz: found = i
 563     if found < 0: raise ValueError, 'key too small'
 564     return found
 565 _augment(KeySZSet, _tmp)
 566
 567 ###--------------------------------------------------------------------------
 568 ### Key data objects.
 569
 570 class _tmp:
 571   def __repr__(me): return '%s(%r)' % (_clsname(me), me.name)
 572 _augment(KeyFile, _tmp)
 573
 574 class _tmp:
 575   def __repr__(me): return '%s(%r)' % (_clsname(me), me.fulltag)
 576 _augment(Key, _tmp)
 577
 578 class _tmp:
 579   def __repr__(me):
 580     return '%s({%s})' % (_clsname(me),
 581                          ', '.join(['%r: %r' % kv for kv in me.iteritems()]))
 582   def _repr_pretty_(me, pp, cyclep):
 583     ind = _pp_bgroup_tyname(pp, me)
 584     if cyclep: pp.text('...')
 585     else: _pp_dict(pp, me.iteritems())
 586     pp.end_group(ind, ')')
 587 _augment(KeyAttributes, _tmp)
 588
 589 class _tmp:
 590   def __repr__(me):
 591     return '%s(%s, %r)' % (_clsname(me),
 592                            _repr_secret(me._guts(),
 593                                         not (me.flags & KF_NONSECRET)),
 594                            me.writeflags(me.flags))
 595   def _repr_pretty_(me, pp, cyclep):
 596     ind = _pp_bgroup_tyname(pp, me)
 597     if cyclep:
 598       pp.text('...')
 599     else:
 600       _pp_secret(pp, me._guts(), not (me.flags & KF_NONSECRET))
 601       pp.text(','); pp.breakable()
 602       pp.pretty(me.writeflags(me.flags))
 603     pp.end_group(ind, ')')
 604 _augment(KeyData, _tmp)
 605
 606 class _tmp:
 607   def _guts(me): return me.bin
 608 _augment(KeyDataBinary, _tmp)
 609
 610 class _tmp:
 611   def _guts(me): return me.ct
 612 _augment(KeyDataEncrypted, _tmp)
 613
 614 class _tmp:
 615   def _guts(me): return me.mp
 616 _augment(KeyDataMP, _tmp)
 617
 618 class _tmp:
 619   def _guts(me): return me.str
 620 _augment(KeyDataString, _tmp)
 621
 622 class _tmp:
 623   def _guts(me): return me.ecpt
 624 _augment(KeyDataECPt, _tmp)
 625
 626 class _tmp:
 627   def __repr__(me):
 628     return '%s({%s})' % (_clsname(me),
 629                          ', '.join(['%r: %r' % kv for kv in me.iteritems()]))
 630   def _repr_pretty_(me, pp, cyclep):
 631     ind = _pp_bgroup_tyname(pp, me, '({ ')
 632     if cyclep: pp.text('...')
 633     else: _pp_dict(pp, me.iteritems())
 634     pp.end_group(ind, ' })')
 635 _augment(KeyDataStructured, _tmp)
 636
 637 ###--------------------------------------------------------------------------
 638 ### Abstract groups.
 639
 640 class _tmp:
 641   def __repr__(me):
 642     return '%s(p = %s, r = %s, g = %s)' % (_clsname(me), me.p, me.r, me.g)
 643   def _repr_pretty_(me, pp, cyclep):
 644     ind = _pp_bgroup_tyname(pp, me)
 645     if cyclep:
 646       pp.text('...')
 647     else:
 648       _pp_kv(pp, 'p', me.p); pp.text(','); pp.breakable()
 649       _pp_kv(pp, 'r', me.r); pp.text(','); pp.breakable()
 650       _pp_kv(pp, 'g', me.g)
 651     pp.end_group(ind, ')')
 652 _augment(FGInfo, _tmp)
 653
 654 class _tmp:
 655   def group(me): return PrimeGroup(me)
 656 _augment(DHInfo, _tmp)
 657
 658 class _tmp:
 659   def group(me): return BinGroup(me)
 660 _augment(BinDHInfo, _tmp)
 661
 662 class _tmp:
 663   def __repr__(me):
 664     return '%s(%r)' % (_clsname(me), me.info)
 665   def _repr_pretty_(me, pp, cyclep):
 666     ind = _pp_bgroup_tyname(pp, me)
 667     if cyclep: pp.text('...')
 668     else: pp.pretty(me.info)
 669     pp.end_group(ind, ')')
 670 _augment(Group, _tmp)
 671
 672 class _tmp:
 673   def __hash__(me):
 674     info = me.info
 675     h = 0xbce3cfe6
 676     h ^=   hash(info.p)
 677     h ^= 2*hash(info.r) & 0xffffffff
 678     h ^= 5*hash(info.g) & 0xffffffff
 679     return h
 680   def _get_geval(me, x): return MP(x)
 681 _augment(PrimeGroup, _tmp)
 682
 683 class _tmp:
 684   def __hash__(me):
 685     info = me.info
 686     h = 0x80695949
 687     h ^=   hash(info.p)
 688     h ^= 2*hash(info.r) & 0xffffffff
 689     h ^= 5*hash(info.g) & 0xffffffff
 690     return h
 691   def _get_geval(me, x): return GF(x)
 692 _augment(BinGroup, _tmp)
 693
 694 class _tmp:
 695   def __hash__(me): return 0x0ec23dab ^ hash(me.info)
 696   def _get_geval(me, x): return x.toec()
 697 _augment(ECGroup, _tmp)
 698
 699 class _tmp:
 700   def __repr__(me):
 701     return '%r(%r)' % (me.group, str(me))
 702   def _repr_pretty_(me, pp, cyclep):
 703     pp.pretty(type(me)._get_geval(me))
 704 _augment(GE, _tmp)
 705
 706 ###--------------------------------------------------------------------------
 707 ### RSA encoding techniques.
 708
 709 class PKCS1Crypt (object):
 710   def __init__(me, ep = '', rng = rand):
 711     me.ep = ep
 712     me.rng = rng
 713   def encode(me, msg, nbits):
 714     return _base._p1crypt_encode(msg, nbits, me.ep, me.rng)
 715   def decode(me, ct, nbits):
 716     return _base._p1crypt_decode(ct, nbits, me.ep, me.rng)
 717
 718 class PKCS1Sig (object):
 719   def __init__(me, ep = '', rng = rand):
 720     me.ep = ep
 721     me.rng = rng
 722   def encode(me, msg, nbits):
 723     return _base._p1sig_encode(msg, nbits, me.ep, me.rng)
 724   def decode(me, msg, sig, nbits):
 725     return _base._p1sig_decode(msg, sig, nbits, me.ep, me.rng)
 726
 727 class OAEP (object):
 728   def __init__(me, mgf = sha_mgf, hash = sha, ep = '', rng = rand):
 729     me.mgf = mgf
 730     me.hash = hash
 731     me.ep = ep
 732     me.rng = rng
 733   def encode(me, msg, nbits):
 734     return _base._oaep_encode(msg, nbits, me.mgf, me.hash, me.ep, me.rng)
 735   def decode(me, ct, nbits):
 736     return _base._oaep_decode(ct, nbits, me.mgf, me.hash, me.ep, me.rng)
 737
 738 class PSS (object):
 739   def __init__(me, mgf = sha_mgf, hash = sha, saltsz = None, rng = rand):
 740     me.mgf = mgf
 741     me.hash = hash
 742     if saltsz is None:
 743       saltsz = hash.hashsz
 744     me.saltsz = saltsz
 745     me.rng = rng
 746   def encode(me, msg, nbits):
 747     return _base._pss_encode(msg, nbits, me.mgf, me.hash, me.saltsz, me.rng)
 748   def decode(me, msg, sig, nbits):
 749     return _base._pss_decode(msg, sig, nbits,
 750                              me.mgf, me.hash, me.saltsz, me.rng)
 751
 752 class _tmp:
 753   def encrypt(me, msg, enc):
 754     return me.pubop(enc.encode(msg, me.n.nbits))
 755   def verify(me, msg, sig, enc):
 756     if msg is None: return enc.decode(msg, me.pubop(sig), me.n.nbits)
 757     try:
 758       x = enc.decode(msg, me.pubop(sig), me.n.nbits)
 759       return x is None or x == msg
 760     except ValueError:
 761       return False
 762   def __repr__(me):
 763     return '%s(n = %r, e = %r)' % (_clsname(me), me.n, me.e)
 764   def _repr_pretty_(me, pp, cyclep):
 765     ind = _pp_bgroup_tyname(pp, me)
 766     if cyclep:
 767       pp.text('...')
 768     else:
 769       _pp_kv(pp, 'n', me.n); pp.text(','); pp.breakable()
 770       _pp_kv(pp, 'e', me.e)
 771     pp.end_group(ind, ')')
 772 _augment(RSAPub, _tmp)
 773
 774 class _tmp:
 775   def decrypt(me, ct, enc): return enc.decode(me.privop(ct), me.n.nbits)
 776   def sign(me, msg, enc): return me.privop(enc.encode(msg, me.n.nbits))
 777   def __repr__(me):
 778     return '%s(n = %r, e = %r, d = %s, ' \
 779       'p = %s, q = %s, dp = %s, dq = %s, q_inv = %s)' % \
 780       (_clsname(me), me.n, me.e,
 781        _repr_secret(me.d), _repr_secret(me.p), _repr_secret(me.q),
 782        _repr_secret(me.dp), _repr_secret(me.dq), _repr_secret(me.q_inv))
 783   def _repr_pretty_(me, pp, cyclep):
 784     ind = _pp_bgroup_tyname(pp, me)
 785     if cyclep:
 786       pp.text('...')
 787     else:
 788       _pp_kv(pp, 'n', me.n); pp.text(','); pp.breakable()
 789       _pp_kv(pp, 'e', me.e); pp.text(','); pp.breakable()
 790       _pp_kv(pp, 'd', me.d, secretp = True); pp.text(','); pp.breakable()
 791       _pp_kv(pp, 'p', me.p, secretp = True); pp.text(','); pp.breakable()
 792       _pp_kv(pp, 'q', me.q, secretp = True); pp.text(','); pp.breakable()
 793       _pp_kv(pp, 'dp', me.dp, secretp = True); pp.text(','); pp.breakable()
 794       _pp_kv(pp, 'dq', me.dq, secretp = True); pp.text(','); pp.breakable()
 795       _pp_kv(pp, 'q_inv', me.q_inv, secretp = True)
 796     pp.end_group(ind, ')')
 797 _augment(RSAPriv, _tmp)
 798
 799 ###--------------------------------------------------------------------------
 800 ### DSA and related schemes.
 801
 802 class _tmp:
 803   def __repr__(me): return '%s(G = %r, p = %r, hash = %r)' % \
 804         (_clsname(me), me.G, me.p, me.hash)
 805   def _repr_pretty_(me, pp, cyclep):
 806     ind = _pp_bgroup_tyname(pp, me)
 807     if cyclep:
 808       pp.text('...')
 809     else:
 810       _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
 811       _pp_kv(pp, 'p', me.p); pp.text(','); pp.breakable()
 812       _pp_kv(pp, 'hash', me.hash)
 813     pp.end_group(ind, ')')
 814 _augment(DSAPub, _tmp)
 815 _augment(KCDSAPub, _tmp)
 816
 817 class _tmp:
 818   def __repr__(me): return '%s(G = %r, u = %s, p = %r, hash = %r)' % \
 819       (_clsname(me), me.G, _repr_secret(me.u), me.p, me.hash)
 820   def _repr_pretty_(me, pp, cyclep):
 821     ind = _pp_bgroup_tyname(pp, me)
 822     if cyclep:
 823       pp.text('...')
 824     else:
 825       _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
 826       _pp_kv(pp, 'u', me.u, True); pp.text(','); pp.breakable()
 827       _pp_kv(pp, 'p', me.p); pp.text(','); pp.breakable()
 828       _pp_kv(pp, 'hash', me.hash)
 829     pp.end_group(ind, ')')
 830 _augment(DSAPriv, _tmp)
 831 _augment(KCDSAPriv, _tmp)
 832
 833 ###--------------------------------------------------------------------------
 834 ### Bernstein's elliptic curve crypto and related schemes.
 835
 836 X25519_BASE = MP(9).storel(32)
 837 X448_BASE = MP(5).storel(56)
 838
 839 Z128 = ByteString.zero(16)
 840
 841 class _BasePub (object):
 842   def __init__(me, pub, *args, **kw):
 843     if not me._PUBSZ.check(len(pub)): raise ValueError, 'bad public key'
 844     super(_BasePub, me).__init__(*args, **kw)
 845     me.pub = pub
 846   def __repr__(me): return '%s(pub = %r)' % (_clsname(me), me.pub)
 847   def _pp(me, pp): _pp_kv(pp, 'pub', me.pub)
 848   def _repr_pretty_(me, pp, cyclep):
 849     ind = _pp_bgroup_tyname(pp, me)
 850     if cyclep: pp.text('...')
 851     else: me._pp(pp)
 852     pp.end_group(ind, ')')
 853
 854 class _BasePriv (object):
 855   def __init__(me, priv, pub = None, *args, **kw):
 856     if not me._KEYSZ.check(len(priv)): raise ValueError, 'bad private key'
 857     if pub is None: pub = me._pubkey(priv)
 858     super(_BasePriv, me).__init__(pub = pub, *args, **kw)
 859     me.priv = priv
 860   @classmethod
 861   def generate(cls, rng = rand):
 862     return cls(rng.block(cls._KEYSZ.default))
 863   def __repr__(me):
 864     return '%s(priv = %d, pub = %r)' % \
 865         (_clsname(me), _repr_secret(me.priv), me.pub)
 866   def _pp(me, pp):
 867     _pp_kv(pp, 'priv', me.priv, secretp = True); pp.text(','); pp.breakable()
 868     super(_BasePriv, me)._pp(pp)
 869
 870 class _XDHPub (_BasePub):  pass
 871
 872 class _XDHPriv (_BasePriv):
 873   def _pubkey(me, priv): return me._op(priv, me._BASE)
 874   def agree(me, you): return me._op(me.priv, you.pub)
 875   def boxkey(me, recip): return me._hashkey(me.agree(recip))
 876   def box(me, recip, n, m): return secret_box(me.boxkey(recip), n, m)
 877   def unbox(me, recip, n, c): return secret_unbox(me.boxkey(recip), n, c)
 878
 879 class X25519Pub (_XDHPub):
 880   _PUBSZ = KeySZSet(X25519_PUBSZ)
 881   _BASE = X25519_BASE
 882
 883 class X25519Priv (_XDHPriv, X25519Pub):
 884   _KEYSZ = KeySZSet(X25519_KEYSZ)
 885   def _op(me, k, X): return x25519(k, X)
 886   def _hashkey(me, z): return hsalsa20_prf(z, Z128)
 887
 888 class X448Pub (_XDHPub):
 889   _PUBSZ = KeySZSet(X448_PUBSZ)
 890   _BASE = X448_BASE
 891
 892 class X448Priv (_XDHPriv, X448Pub):
 893   _KEYSZ = KeySZSet(X448_KEYSZ)
 894   def _op(me, k, X): return x448(k, X)
 895   def _hashkey(me, z): return Shake256().hash(z).done(salsa20.keysz.default)
 896
 897 class _EdDSAPub (_BasePub):
 898   def beginhash(me): return me._HASH()
 899   def endhash(me, h): return h.done()
 900
 901 class _EdDSAPriv (_BasePriv, _EdDSAPub):
 902   pass
 903
 904 class Ed25519Pub (_EdDSAPub):
 905   _PUBSZ = KeySZSet(ED25519_PUBSZ)
 906   _HASH = sha512
 907   def verify(me, msg, sig, **kw):
 908     return ed25519_verify(me.pub, msg, sig, **kw)
 909
 910 class Ed25519Priv (_EdDSAPriv, Ed25519Pub):
 911   _KEYSZ = KeySZAny(ED25519_KEYSZ)
 912   def _pubkey(me, priv): return ed25519_pubkey(priv)
 913   def sign(me, msg, **kw):
 914     return ed25519_sign(me.priv, msg, pub = me.pub, **kw)
 915
 916 class Ed448Pub (_EdDSAPub):
 917   _PUBSZ = KeySZSet(ED448_PUBSZ)
 918   _HASH = shake256
 919   def verify(me, msg, sig, **kw):
 920     return ed448_verify(me.pub, msg, sig, **kw)
 921
 922 class Ed448Priv (_EdDSAPriv, Ed448Pub):
 923   _KEYSZ = KeySZAny(ED448_KEYSZ)
 924   def _pubkey(me, priv): return ed448_pubkey(priv)
 925   def sign(me, msg, **kw):
 926     return ed448_sign(me.priv, msg, pub = me.pub, **kw)
 927
 928 ###--------------------------------------------------------------------------
 929 ### Built-in named curves and prime groups.
 930
 931 class _groupmap (object):
 932   def __init__(me, map, nth):
 933     me.map = map
 934     me.nth = nth
 935     me._n = max(map.values()) + 1
 936     me.i = me._n*[None]
 937   def __repr__(me):
 938     return '{%s}' % ', '.join(['%r: %r' % kv for kv in me.iteritems()])
 939   def _repr_pretty_(me, pp, cyclep):
 940     ind = _pp_bgroup(pp, '{ ')
 941     if cyclep: pp.text('...')
 942     else: _pp_dict(pp, me.iteritems())
 943     pp.end_group(ind, ' }')
 944   def __len__(me):
 945     return me._n
 946   def __contains__(me, k):
 947     return k in me.map
 948   def __getitem__(me, k):
 949     i = me.map[k]
 950     if me.i[i] is None:
 951       me.i[i] = me.nth(i)
 952     return me.i[i]
 953   def __setitem__(me, k, v):
 954     raise TypeError, "immutable object"
 955   def __iter__(me):
 956     return iter(me.map)
 957   def iterkeys(me):
 958     return iter(me.map)
 959   def itervalues(me):
 960     for k in me:
 961       yield me[k]
 962   def iteritems(me):
 963     for k in me:
 964       yield k, me[k]
 965   def keys(me):
 966     return [k for k in me]
 967   def values(me):
 968     return [me[k] for k in me]
 969   def items(me):
 970     return [(k, me[k]) for k in me]
 971 eccurves = _groupmap(_base._eccurves, ECInfo._curven)
 972 primegroups = _groupmap(_base._pgroups, DHInfo._groupn)
 973 bingroups = _groupmap(_base._bingroups, BinDHInfo._groupn)
 974
 975 ###--------------------------------------------------------------------------
 976 ### Prime number generation.
 977
 978 class PrimeGenEventHandler (object):
 979   def pg_begin(me, ev):
 980     return me.pg_try(ev)
 981   def pg_done(me, ev):
 982     return PGEN_DONE
 983   def pg_abort(me, ev):
 984     return PGEN_TRY
 985   def pg_fail(me, ev):
 986     return PGEN_TRY
 987   def pg_pass(me, ev):
 988     return PGEN_TRY
 989
 990 class SophieGermainStepJump (object):
 991   def pg_begin(me, ev):
 992     me.lf = PrimeFilter(ev.x)
 993     me.hf = me.lf.muladd(2, 1)
 994     return me.cont(ev)
 995   def pg_try(me, ev):
 996     me.step()
 997     return me.cont(ev)
 998   def cont(me, ev):
 999     while me.lf.status == PGEN_FAIL or me.hf.status == PGEN_FAIL:
1000       me.step()
1001     if me.lf.status == PGEN_ABORT or me.hf.status == PGEN_ABORT:
1002       return PGEN_ABORT
1003     ev.x = me.lf.x
1004     if me.lf.status == PGEN_DONE and me.hf.status == PGEN_DONE:
1005       return PGEN_DONE
1006     return PGEN_TRY
1007   def pg_done(me, ev):
1008     del me.lf
1009     del me.hf
1010
1011 class SophieGermainStepper (SophieGermainStepJump):
1012   def __init__(me, step):
1013     me.lstep = step;
1014     me.hstep = 2 * step
1015   def step(me):
1016     me.lf.step(me.lstep)
1017     me.hf.step(me.hstep)
1018
1019 class SophieGermainJumper (SophieGermainStepJump):
1020   def __init__(me, jump):
1021     me.ljump = PrimeFilter(jump);
1022     me.hjump = me.ljump.muladd(2, 0)
1023   def step(me):
1024     me.lf.jump(me.ljump)
1025     me.hf.jump(me.hjump)
1026   def pg_done(me, ev):
1027     del me.ljump
1028     del me.hjump
1029     SophieGermainStepJump.pg_done(me, ev)
1030
1031 class SophieGermainTester (object):
1032   def __init__(me):
1033     pass
1034   def pg_begin(me, ev):
1035     me.lr = RabinMiller(ev.x)
1036     me.hr = RabinMiller(2 * ev.x + 1)
1037   def pg_try(me, ev):
1038     lst = me.lr.test(ev.rng.range(me.lr.x))
1039     if lst != PGEN_PASS and lst != PGEN_DONE:
1040       return lst
1041     rst = me.hr.test(ev.rng.range(me.hr.x))
1042     if rst != PGEN_PASS and rst != PGEN_DONE:
1043       return rst
1044     if lst == PGEN_DONE and rst == PGEN_DONE:
1045       return PGEN_DONE
1046     return PGEN_PASS
1047   def pg_done(me, ev):
1048     del me.lr
1049     del me.hr
1050
1051 class PrimitiveStepper (PrimeGenEventHandler):
1052   def __init__(me):
1053     pass
1054   def pg_try(me, ev):
1055     ev.x = me.i.next()
1056     return PGEN_TRY
1057   def pg_begin(me, ev):
1058     me.i = iter(smallprimes)
1059     return me.pg_try(ev)
1060
1061 class PrimitiveTester (PrimeGenEventHandler):
1062   def __init__(me, mod, hh = [], exp = None):
1063     me.mod = MPMont(mod)
1064     me.exp = exp
1065     me.hh = hh
1066   def pg_try(me, ev):
1067     x = ev.x
1068     if me.exp is not None:
1069       x = me.mod.exp(x, me.exp)
1070       if x == 1: return PGEN_FAIL
1071     for h in me.hh:
1072       if me.mod.exp(x, h) == 1: return PGEN_FAIL
1073     ev.x = x
1074     return PGEN_DONE
1075
1076 class SimulStepper (PrimeGenEventHandler):
1077   def __init__(me, mul = 2, add = 1, step = 2):
1078     me.step = step
1079     me.mul = mul
1080     me.add = add
1081   def _stepfn(me, step):
1082     if step <= 0:
1083       raise ValueError, 'step must be positive'
1084     if step <= MPW_MAX:
1085       return lambda f: f.step(step)
1086     j = PrimeFilter(step)
1087     return lambda f: f.jump(j)
1088   def pg_begin(me, ev):
1089     x = ev.x
1090     me.lf = PrimeFilter(x)
1091     me.hf = PrimeFilter(x * me.mul + me.add)
1092     me.lstep = me._stepfn(me.step)
1093     me.hstep = me._stepfn(me.step * me.mul)
1094     SimulStepper._cont(me, ev)
1095   def pg_try(me, ev):
1096     me._step()
1097     me._cont(ev)
1098   def _step(me):
1099     me.lstep(me.lf)
1100     me.hstep(me.hf)
1101   def _cont(me, ev):
1102     while me.lf.status == PGEN_FAIL or me.hf.status == PGEN_FAIL:
1103       me._step()
1104     if me.lf.status == PGEN_ABORT or me.hf.status == PGEN_ABORT:
1105       return PGEN_ABORT
1106     ev.x = me.lf.x
1107     if me.lf.status == PGEN_DONE and me.hf.status == PGEN_DONE:
1108       return PGEN_DONE
1109     return PGEN_TRY
1110   def pg_done(me, ev):
1111     del me.lf
1112     del me.hf
1113     del me.lstep
1114     del me.hstep
1115
1116 class SimulTester (PrimeGenEventHandler):
1117   def __init__(me, mul = 2, add = 1):
1118     me.mul = mul
1119     me.add = add
1120   def pg_begin(me, ev):
1121     x = ev.x
1122     me.lr = RabinMiller(x)
1123     me.hr = RabinMiller(x * me.mul + me.add)
1124   def pg_try(me, ev):
1125     lst = me.lr.test(ev.rng.range(me.lr.x))
1126     if lst != PGEN_PASS and lst != PGEN_DONE:
1127       return lst
1128     rst = me.hr.test(ev.rng.range(me.hr.x))
1129     if rst != PGEN_PASS and rst != PGEN_DONE:
1130       return rst
1131     if lst == PGEN_DONE and rst == PGEN_DONE:
1132       return PGEN_DONE
1133     return PGEN_PASS
1134   def pg_done(me, ev):
1135     del me.lr
1136     del me.hr
1137
1138 def sgprime(start, step = 2, name = 'p', event = pgen_nullev, nsteps = 0):
1139   start = MP(start)
1140   return pgen(start, name, SimulStepper(step = step), SimulTester(), event,
1141               nsteps, RabinMiller.iters(start.nbits))
1142
1143 def findprimitive(mod, hh = [], exp = None, name = 'g', event = pgen_nullev):
1144   return pgen(0, name, PrimitiveStepper(), PrimitiveTester(mod, hh, exp),
1145               event, 0, 1)
1146
1147 def kcdsaprime(pbits, qbits, rng = rand,
1148                event = pgen_nullev, name = 'p', nsteps = 0):
1149   hbits = pbits - qbits
1150   h = pgen(rng.mp(hbits, 1), name + ' [h]',
1151            PrimeGenStepper(2), PrimeGenTester(),
1152            event, nsteps, RabinMiller.iters(hbits))
1153   q = pgen(rng.mp(qbits, 1), name, SimulStepper(2 * h, 1, 2),
1154            SimulTester(2 * h, 1), event, nsteps, RabinMiller.iters(qbits))
1155   p = 2 * q * h + 1
1156   return p, q, h
1157
1158 #----- That's all, folks ----------------------------------------------------