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