chiark / gitweb /
catacomb/__init__.py: Calculate `X25519_BASE' and `X448_BASE'.
[catacomb-python] / catacomb / __init__.py
index 022c5f97119fc6e88b73a834e529a5d3dab5a14b..860cfb5e07cd3d119a45771fed15068b360fd572 100644 (file)
@@ -34,6 +34,20 @@ from sys import argv as _argv
 ## For the benefit of the default keyreporter, we need the program na,e.
 _base._ego(_argv[0])
 
+## How to fix a name back into the right identifier.  Alas, the rules are not
+## consistent.
+def _fixname(name):
+
+  ## Hyphens consistently become underscores.
+  name = name.replace('-', '_')
+
+  ## But slashes might become underscores or just vanish.
+  if name.startswith('salsa20'): name = name.translate(None, '/')
+  else: name = name.replace('/', '_')
+
+  ## Done.
+  return name
+
 ## Initialize the module.  Drag in the static methods of the various
 ## classes; create names for the various known crypto algorithms.
 def _init():
@@ -56,9 +70,9 @@ def _init():
         setattr(c, j[plen:], classmethod(b[j]))
   for i in [gcciphers, gchashes, gcmacs, gcprps]:
     for c in i.itervalues():
-      d[c.name.replace('-', '_').translate(None, '/')] = c
+      d[_fixname(c.name)] = c
   for c in gccrands.itervalues():
-    d[c.name.replace('-', '_').translate(None, '/') + 'rand'] = c
+    d[_fixname(c.name + 'rand')] = c
 _init()
 
 ## A handy function for our work: add the methods of a named class to an
@@ -82,6 +96,44 @@ def _checkend(r):
     raise SyntaxError, 'junk at end of string'
   return x
 
+## Some pretty-printing utilities.
+PRINT_SECRETS = False
+def _clsname(me): return type(me).__name__
+def _repr_secret(thing, secretp = True):
+  if not secretp or PRINT_SECRETS: return repr(thing)
+  else: return '#<SECRET>'
+def _pp_str(me, pp, cyclep): pp.text(cyclep and '...' or str(me))
+def _pp_secret(pp, thing, secretp = True):
+  if not secretp or PRINT_SECRETS: pp.pretty(thing)
+  else: pp.text('#<SECRET>')
+def _pp_bgroup(pp, text):
+  ind = len(text)
+  pp.begin_group(ind, text)
+  return ind
+def _pp_bgroup_tyname(pp, obj, open = '('):
+  return _pp_bgroup(pp, _clsname(obj) + open)
+def _pp_kv(pp, k, v, secretp = False):
+  ind = _pp_bgroup(pp, k + ' = ')
+  _pp_secret(pp, v, secretp)
+  pp.end_group(ind, '')
+def _pp_commas(pp, printfn, items):
+  firstp = True
+  for i in items:
+    if firstp: firstp = False
+    else: pp.text(','); pp.breakable()
+    printfn(i)
+def _pp_dict(pp, items):
+  def p((k, v)):
+    pp.begin_group(0)
+    pp.pretty(k)
+    pp.text(':')
+    pp.begin_group(2)
+    pp.breakable()
+    pp.pretty(v)
+    pp.end_group(2)
+    pp.end_group(0)
+  _pp_commas(pp, p, items)
+
 ###--------------------------------------------------------------------------
 ### Bytestrings.
 
@@ -149,7 +201,8 @@ class BaseRat (object):
   @property
   def denom(me): return me._d
   def __str__(me): return '%s/%s' % (me._n, me._d)
-  def __repr__(me): return '%s(%s, %s)' % (type(me).__name__, me._n, me._d)
+  def __repr__(me): return '%s(%s, %s)' % (_clsname(me), me._n, me._d)
+  _repr_pretty_ = _pp_str
 
   def __add__(me, you):
     n, d = _split_rat(you)
@@ -194,6 +247,7 @@ class _tmp:
   def reduce(x): return MPReduce(x)
   def __div__(me, you): return IntRat(me, you)
   def __rdiv__(me, you): return IntRat(you, me)
+  _repr_pretty_ = _pp_str
 _augment(MP, _tmp)
 
 class _tmp:
@@ -205,6 +259,7 @@ class _tmp:
   def quadsolve(x, y): return x.reduce().quadsolve(y)
   def __div__(me, you): return GFRat(me, you)
   def __rdiv__(me, you): return GFRat(you, me)
+  _repr_pretty_ = _pp_str
 _augment(GF, _tmp)
 
 class _tmp:
@@ -223,14 +278,24 @@ class _tmp:
 _augment(Field, _tmp)
 
 class _tmp:
-  def __repr__(me): return '%s(%sL)' % (type(me).__name__, me.p)
+  def __repr__(me): return '%s(%sL)' % (_clsname(me), me.p)
   def __hash__(me): return 0x114401de ^ hash(me.p)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep: pp.text('...')
+    else: pp.pretty(me.p)
+    pp.end_group(ind, ')')
   def ec(me, a, b): return ECPrimeProjCurve(me, a, b)
 _augment(PrimeField, _tmp)
 
 class _tmp:
-  def __repr__(me): return '%s(%#xL)' % (type(me).__name__, me.p)
+  def __repr__(me): return '%s(%#xL)' % (_clsname(me), me.p)
   def ec(me, a, b): return ECBinProjCurve(me, a, b)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep: pp.text('...')
+    else: pp.text('%#x' % me.p)
+    pp.end_group(ind, ')')
 _augment(BinField, _tmp)
 
 class _tmp:
@@ -248,6 +313,7 @@ _augment(BinNormField, _tmp)
 class _tmp:
   def __str__(me): return str(me.value)
   def __repr__(me): return '%s(%s)' % (repr(me.field), repr(me.value))
+  _repr_pretty_ = _pp_str
 _augment(FE, _tmp)
 
 ###--------------------------------------------------------------------------
@@ -255,7 +321,16 @@ _augment(FE, _tmp)
 
 class _tmp:
   def __repr__(me):
-    return '%s(%r, %s, %s)' % (type(me).__name__, me.field, me.a, me.b)
+    return '%s(%r, %s, %s)' % (_clsname(me), me.field, me.a, me.b)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      pp.pretty(me.field); pp.text(','); pp.breakable()
+      pp.pretty(me.a); pp.text(','); pp.breakable()
+      pp.pretty(me.b)
+    pp.end_group(ind, ')')
   def frombuf(me, s):
     return ecpt.frombuf(me, s)
   def fromraw(me, s):
@@ -284,17 +359,37 @@ _augment(ECBinCurve, _tmp)
 
 class _tmp:
   def __repr__(me):
-    if not me: return 'ECPt()'
-    return 'ECPt(%s, %s)' % (me.ix, me.iy)
+    if not me: return '%s()' % _clsname(me)
+    return '%s(%s, %s)' % (_clsname(me), me.ix, me.iy)
   def __str__(me):
     if not me: return 'inf'
     return '(%s, %s)' % (me.ix, me.iy)
+  def _repr_pretty_(me, pp, cyclep):
+    if cyclep:
+      pp.text('...')
+    elif not me:
+      pp.text('inf')
+    else:
+      ind = _pp_bgroup(pp, '(')
+      pp.pretty(me.ix); pp.text(','); pp.breakable()
+      pp.pretty(me.iy)
+      pp.end_group(ind, ')')
 _augment(ECPt, _tmp)
 
 class _tmp:
   def __repr__(me):
-    return 'ECInfo(curve = %r, G = %r, r = %s, h = %s)' % \
-           (me.curve, me.G, me.r, me.h)
+    return '%s(curve = %r, G = %r, r = %s, h = %s)' % \
+           (_clsname(me), me.curve, me.G, me.r, me.h)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      _pp_kv(pp, 'curve', me.curve); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'r', me.r); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'h', me.h)
+    pp.end_group(ind, ')')
   def __hash__(me):
     h = 0x9bedb8de
     h ^=   hash(me.curve)
@@ -311,21 +406,41 @@ class _tmp:
   def __str__(me):
     if not me: return 'inf'
     return '(%s, %s)' % (me.x, me.y)
+  def _repr_pretty_(me, pp, cyclep):
+    if cyclep:
+      pp.text('...')
+    elif not me:
+      pp.text('inf')
+    else:
+      ind = _pp_bgroup(pp, '(')
+      pp.pretty(me.x); pp.text(','); pp.breakable()
+      pp.pretty(me.y)
+      pp.end_group(ind, ')')
 _augment(ECPtCurve, _tmp)
 
 ###--------------------------------------------------------------------------
 ### Key sizes.
 
 class _tmp:
-  def __repr__(me): return 'KeySZAny(%d)' % me.default
+  def __repr__(me): return '%s(%d)' % (_clsname(me), me.default)
   def check(me, sz): return True
   def best(me, sz): return sz
 _augment(KeySZAny, _tmp)
 
 class _tmp:
   def __repr__(me):
-    return 'KeySZRange(%d, %d, %d, %d)' % \
-           (me.default, me.min, me.max, me.mod)
+    return '%s(%d, %d, %d, %d)' % \
+           (_clsname(me), me.default, me.min, me.max, me.mod)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      pp.pretty(me.default); pp.text(','); pp.breakable()
+      pp.pretty(me.min); pp.text(','); pp.breakable()
+      pp.pretty(me.max); pp.text(','); pp.breakable()
+      pp.pretty(me.mod)
+    pp.end_group(ind, ')')
   def check(me, sz): return me.min <= sz <= me.max and sz % me.mod == 0
   def best(me, sz):
     if sz < me.min: raise ValueError, 'key too small'
@@ -334,7 +449,17 @@ class _tmp:
 _augment(KeySZRange, _tmp)
 
 class _tmp:
-  def __repr__(me): return 'KeySZSet(%d, %s)' % (me.default, me.set)
+  def __repr__(me): return '%s(%d, %s)' % (_clsname(me), me.default, me.set)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      pp.pretty(me.default); pp.text(','); pp.breakable()
+      ind1 = _pp_bgroup(pp, '{')
+      _pp_commas(pp, pp.pretty, me.set)
+      pp.end_group(ind1, '}')
+    pp.end_group(ind, ')')
   def check(me, sz): return sz in me.set
   def best(me, sz):
     found = -1
@@ -344,13 +469,91 @@ class _tmp:
     return found
 _augment(KeySZSet, _tmp)
 
+###--------------------------------------------------------------------------
+### Key data objects.
+
+class _tmp:
+  def __repr__(me): return '%s(%r)' % (_clsname(me), me.name)
+_augment(KeyFile, _tmp)
+
+class _tmp:
+  def __repr__(me): return '%s(%r)' % (_clsname(me), me.fulltag)
+_augment(Key, _tmp)
+
+class _tmp:
+  def __repr__(me):
+    return '%s({%s})' % (_clsname(me),
+                         ', '.join(['%r: %r' % kv for kv in me.iteritems()]))
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep: pp.text('...')
+    else: _pp_dict(pp, me.iteritems())
+    pp.end_group(ind, ')')
+_augment(KeyAttributes, _tmp)
+
+class _tmp:
+  def __repr__(me):
+    return '%s(%s, %r)' % (_clsname(me),
+                           _repr_secret(me._guts(),
+                                        not (me.flags & KF_NONSECRET)),
+                           me.writeflags(me.flags))
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      _pp_secret(pp, me._guts(), not (me.flags & KF_NONSECRET))
+      pp.text(','); pp.breakable()
+      pp.pretty(me.writeflags(me.flags))
+    pp.end_group(ind, ')')
+_augment(KeyData, _tmp)
+
+class _tmp:
+  def _guts(me): return me.bin
+_augment(KeyDataBinary, _tmp)
+
+class _tmp:
+  def _guts(me): return me.ct
+_augment(KeyDataEncrypted, _tmp)
+
+class _tmp:
+  def _guts(me): return me.mp
+_augment(KeyDataMP, _tmp)
+
+class _tmp:
+  def _guts(me): return me.str
+_augment(KeyDataString, _tmp)
+
+class _tmp:
+  def _guts(me): return me.ecpt
+_augment(KeyDataECPt, _tmp)
+
+class _tmp:
+  def __repr__(me):
+    return '%s({%s})' % (_clsname(me),
+                         ', '.join(['%r: %r' % kv for kv in me.iteritems()]))
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me, '({ ')
+    if cyclep: pp.text('...')
+    else: _pp_dict(pp, me.iteritems())
+    pp.end_group(ind, ' })')
+_augment(KeyDataStructured, _tmp)
+
 ###--------------------------------------------------------------------------
 ### Abstract groups.
 
 class _tmp:
   def __repr__(me):
-    return '%s(p = %s, r = %s, g = %s)' % \
-           (type(me).__name__, me.p, me.r, me.g)
+    return '%s(p = %s, r = %s, g = %s)' % (_clsname(me), me.p, me.r, me.g)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      _pp_kv(pp, 'p', me.p); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'r', me.r); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'g', me.g)
+    pp.end_group(ind, ')')
 _augment(FGInfo, _tmp)
 
 class _tmp:
@@ -363,7 +566,12 @@ _augment(BinDHInfo, _tmp)
 
 class _tmp:
   def __repr__(me):
-    return '%s(%r)' % (type(me).__name__, me.info)
+    return '%s(%r)' % (_clsname(me), me.info)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep: pp.text('...')
+    else: pp.pretty(me.info)
+    pp.end_group(ind, ')')
 _augment(Group, _tmp)
 
 class _tmp:
@@ -374,6 +582,7 @@ class _tmp:
     h ^= 2*hash(info.r) & 0xffffffff
     h ^= 5*hash(info.g) & 0xffffffff
     return h
+  def _get_geval(me, x): return MP(x)
 _augment(PrimeGroup, _tmp)
 
 class _tmp:
@@ -384,15 +593,19 @@ class _tmp:
     h ^= 2*hash(info.r) & 0xffffffff
     h ^= 5*hash(info.g) & 0xffffffff
     return h
+  def _get_geval(me, x): return GF(x)
 _augment(BinGroup, _tmp)
 
 class _tmp:
   def __hash__(me): return 0x0ec23dab ^ hash(me.info)
+  def _get_geval(me, x): return x.toec()
 _augment(ECGroup, _tmp)
 
 class _tmp:
   def __repr__(me):
     return '%r(%r)' % (me.group, str(me))
+  def _repr_pretty_(me, pp, cyclep):
+    pp.pretty(type(me)._get_geval(me))
 _augment(GE, _tmp)
 
 ###--------------------------------------------------------------------------
@@ -451,36 +664,101 @@ class _tmp:
       return x is None or x == msg
     except ValueError:
       return False
+  def __repr__(me):
+    return '%s(n = %r, e = %r)' % (_clsname(me), me.n, me.e)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      _pp_kv(pp, 'n', me.n); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'e', me.e)
+    pp.end_group(ind, ')')
 _augment(RSAPub, _tmp)
 
 class _tmp:
   def decrypt(me, ct, enc): return enc.decode(me.privop(ct), me.n.nbits)
   def sign(me, msg, enc): return me.privop(enc.encode(msg, me.n.nbits))
+  def __repr__(me):
+    return '%s(n = %r, e = %r, d = %s, ' \
+      'p = %s, q = %s, dp = %s, dq = %s, q_inv = %s)' % \
+      (_clsname(me), me.n, me.e,
+       _repr_secret(me.d), _repr_secret(me.p), _repr_secret(me.q),
+       _repr_secret(me.dp), _repr_secret(me.dq), _repr_secret(me.q_inv))
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      _pp_kv(pp, 'n', me.n); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'e', me.e); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'd', me.d, secretp = True); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'p', me.p, secretp = True); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'q', me.q, secretp = True); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'dp', me.dp, secretp = True); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'dq', me.dq, secretp = True); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'q_inv', me.q_inv, secretp = True)
+    pp.end_group(ind, ')')
 _augment(RSAPriv, _tmp)
 
 ###--------------------------------------------------------------------------
-### Bernstein's elliptic curve crypto and related schemes.
+### DSA and related schemes.
+
+class _tmp:
+  def __repr__(me): return '%s(G = %r, p = %r)' % (_clsname(me), me.G, me.p)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'p', me.p)
+    pp.end_group(ind, ')')
+_augment(DSAPub, _tmp)
+_augment(KCDSAPub, _tmp)
 
-X25519_BASE = \
-  bytes('0900000000000000000000000000000000000000000000000000000000000000')
+class _tmp:
+  def __repr__(me): return '%s(G = %r, u = %s, p = %r)' % \
+      (_clsname(me), me.G, _repr_secret(me.u), me.p)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      _pp_kv(pp, 'G', me.G); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'u', me.u, True); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'p', me.p)
+    pp.end_group(ind, ')')
+_augment(DSAPriv, _tmp)
+_augment(KCDSAPriv, _tmp)
+
+###--------------------------------------------------------------------------
+### Bernstein's elliptic curve crypto and related schemes.
 
-X448_BASE = \
-  bytes('05000000000000000000000000000000000000000000000000000000'
-        '00000000000000000000000000000000000000000000000000000000')
+X25519_BASE = MP(9).storel(32)
+X448_BASE = MP(5).storel(56)
 
 Z128 = bytes('00000000000000000000000000000000')
 
 class _BoxyPub (object):
-  def __init__(me, pub, *kw, **kwargs):
+  def __init__(me, pub, *args, **kw):
     if len(pub) != me._PUBSZ: raise ValueError, 'bad public key'
-    super(_BoxyPub, me).__init__(*kw, **kwargs)
+    super(_BoxyPub, me).__init__(*args, **kw)
     me.pub = pub
+  def __repr__(me): return '%s(pub = %r)' % (_clsname(me), me.pub)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      _pp_kv(pp, 'pub', me.pub)
+    pp.end_group(ind, ')')
 
 class _BoxyPriv (_BoxyPub):
-  def __init__(me, priv, pub = None, *kw, **kwargs):
+  def __init__(me, priv, pub = None, *args, **kw):
     if len(priv) != me._KEYSZ: raise ValueError, 'bad private key'
     if pub is None: pub = me._op(priv, me._BASE)
-    super(_BoxyPriv, me).__init__(pub = pub, *kw, **kwargs)
+    super(_BoxyPriv, me).__init__(pub = pub, *args, **kw)
     me.priv = priv
   def agree(me, you): return me._op(me.priv, you.pub)
   def boxkey(me, recip):
@@ -488,7 +766,17 @@ class _BoxyPriv (_BoxyPub):
   def box(me, recip, n, m):
     return secret_box(me.boxkey(recip), n, m)
   def unbox(me, recip, n, c):
-    return secret_unbox(me.boxkey(recip, n, c))
+    return secret_unbox(me.boxkey(recip), n, c)
+  def __repr__(me): return '%s(priv = %s, pub = %r)' % \
+      (_clsname(me), _repr_secret(me.priv), me.pub)
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup_tyname(pp, me)
+    if cyclep:
+      pp.text('...')
+    else:
+      _pp_kv(pp, 'priv', me.priv, True); pp.text(','); pp.breakable()
+      _pp_kv(pp, 'pub', me.pub)
+    pp.end_group(ind, ')')
 
 class X25519Pub (_BoxyPub):
   _PUBSZ = X25519_PUBSZ
@@ -534,7 +822,12 @@ class _groupmap (object):
     me._n = max(map.values()) + 1
     me.i = me._n*[None]
   def __repr__(me):
-    return '{%s}' % ', '.join(['%r: %r' % (k, me[k]) for k in me])
+    return '{%s}' % ', '.join(['%r: %r' % kv for kv in me.iteritems()])
+  def _repr_pretty_(me, pp, cyclep):
+    ind = _pp_bgroup(pp, '{ ')
+    if cyclep: pp.text('...')
+    else: _pp_dict(pp, me.iteritems())
+    pp.end_group(ind, ' }')
   def __len__(me):
     return me._n
   def __contains__(me, k):