initial import
[panda.git] / libs / libtommath / changes.txt
blobb0da4da4f915819a9dbd349695582a6421dc7edd
1 March 10th, 2007
2 v0.41  -- Wolfgang Ehrhardt suggested a quick fix to mp_div_d() which makes the detection of powers of two quicker. 
3        -- [CRI] Added libtommath.dsp for Visual C++ users.
5 December 24th, 2006
6 v0.40  -- Updated makefile to properly support LIBNAME
7        -- Fixed bug in fast_s_mp_mul_high_digs() which overflowed (line 83), thanks Valgrind!
9 April 4th, 2006
10 v0.39  -- Jim Wigginton pointed out my Montgomery examples in figures 6.4 and 6.6 were off by one, k should be 9 not 8
11        -- Bruce Guenter suggested I use --tag=CC for libtool builds where the compiler may think it's C++.
12        -- "mm" from sci.crypt pointed out that my mp_gcd was sub-optimal (I also updated and corrected the book)
13        -- updated some of the @@ tags in tommath.src to reflect source changes.
14        -- updated email and url info in all source files
16 Jan 26th, 2006
17 v0.38  -- broken makefile.shared fixed
18        -- removed some carry stores that were not required [updated text]
19        
20 November 18th, 2005
21 v0.37  -- [Don Porter] reported on a TCL list [HEY SEND ME BUGREPORTS ALREADY!!!] that mp_add_d() would compute -0 with some inputs.  Fixed.
22        -- [rinick@gmail.com] reported the makefile.bcc was messed up.  Fixed.
23        -- [Kevin Kenny] reported some issues with mp_toradix_n().  Now it doesn't require a min of 3 chars of output.  
24        -- Made the make command renamable.  Wee
26 August 1st, 2005
27 v0.36  -- LTM_PRIME_2MSB_ON was fixed and the "OFF" flag was removed.
28        -- [Peter LaDow] found a typo in the XREALLOC macro
29        -- [Peter LaDow] pointed out that mp_read_(un)signed_bin should have "const" on the input
30        -- Ported LTC patch to fix the prime_random_ex() function to get the bitsize correct [and the maskOR flags]
31        -- Kevin Kenny pointed out a stray //
32        -- David Hulton pointed out a typo in the textbook [mp_montgomery_setup() pseudo-code]
33        -- Neal Hamilton (Elliptic Semiconductor) pointed out that my Karatsuba notation was backwards and that I could use 
34           unsigned operations in the routine.  
35        -- Paul Schmidt pointed out a linking error in mp_exptmod() when BN_S_MP_EXPTMOD_C is undefined (and another for read_radix)
36        -- Updated makefiles to be way more flexible
38 March 12th, 2005
39 v0.35  -- Stupid XOR function missing line again... oops.
40        -- Fixed bug in invmod not handling negative inputs correctly [Wolfgang Ehrhardt]
41        -- Made exteuclid always give positive u3 output...[ Wolfgang Ehrhardt ]
42        -- [Wolfgang Ehrhardt] Suggested a fix for mp_reduce() which avoided underruns.  ;-)
43        -- mp_rand() would emit one too many digits and it was possible to get a 0 out of it ... oops
44        -- Added montgomery to the testing to make sure it handles 1..10 digit moduli correctly
45        -- Fixed bug in comba that would lead to possible erroneous outputs when "pa < digs" 
46        -- Fixed bug in mp_toradix_size for "0" [Kevin Kenny]
47        -- Updated chapters 1-5 of the textbook ;-) It now talks about the new comba code!
49 February 12th, 2005
50 v0.34  -- Fixed two more small errors in mp_prime_random_ex()
51        -- Fixed overflow in mp_mul_d() [Kevin Kenny]
52        -- Added mp_to_(un)signed_bin_n() functions which do bounds checking for ya [and report the size]
53        -- Added "large" diminished radix support.  Speeds up things like DSA where the moduli is of the form 2^k - P for some P < 2^(k/2) or so
54           Actually is faster than Montgomery on my AMD64 (and probably much faster on a P4)
55        -- Updated the manual a bit
56        -- Ok so I haven't done the textbook work yet... My current freelance gig has landed me in France till the 
57           end of Feb/05.  Once I get back I'll have tons of free time and I plan to go to town on the book.
58           As of this release the API will freeze.  At least until the book catches up with all the changes.  I welcome
59           bug reports but new algorithms will have to wait.
61 December 23rd, 2004
62 v0.33  -- Fixed "small" variant for mp_div() which would munge with negative dividends...
63        -- Fixed bug in mp_prime_random_ex() which would set the most significant byte to zero when
64           no special flags were set
65        -- Fixed overflow [minor] bug in fast_s_mp_sqr()
66        -- Made the makefiles easier to configure the group/user that ltm will install as
67        -- Fixed "final carry" bug in comba multipliers. (Volkan Ceylan)
68        -- Matt Johnston pointed out a missing semi-colon in mp_exptmod
70 October 29th, 2004
71 v0.32  -- Added "makefile.shared" for shared object support
72        -- Added more to the build options/configs in the manual
73        -- Started the Depends framework, wrote dep.pl to scan deps and 
74           produce "callgraph.txt" ;-)
75        -- Wrote SC_RSA_1 which will enable close to the minimum required to perform
76           RSA on 32-bit [or 64-bit] platforms with LibTomCrypt
77        -- Merged in the small/slower mp_div replacement.  You can now toggle which
78           you want to use as your mp_div() at build time.  Saves roughly 8KB or so.
79        -- Renamed a few files and changed some comments to make depends system work better.
80           (No changes to function names)
81        -- Merged in new Combas that perform 2 reads per inner loop instead of the older 
82           3reads/2writes per inner loop of the old code.  Really though if you want speed
83           learn to use TomsFastMath ;-)
85 August 9th, 2004
86 v0.31  -- "profiled" builds now :-) new timings for Intel Northwoods
87        -- Added "pretty" build target
88        -- Update mp_init() to actually assign 0's instead of relying on calloc()
89        -- "Wolfgang Ehrhardt" <Wolfgang.Ehrhardt@munich.netsurf.de> found a bug in mp_mul() where if
90           you multiply a negative by zero you get negative zero as the result.  Oops.
91        -- J Harper from PeerSec let me toy with his AMD64 and I got 60-bit digits working properly
92           [this also means that I fixed a bug where if sizeof(int) < sizeof(mp_digit) it would bug]
94 April 11th, 2004
95 v0.30  -- Added "mp_toradix_n" which stores upto "n-1" least significant digits of an mp_int
96        -- Johan Lindh sent a patch so MSVC wouldn't whine about redefining malloc [in weird dll modes]
97        -- Henrik Goldman spotted a missing OPT_CAST in mp_fwrite()
98        -- Tuned tommath.h so that when MP_LOW_MEM is defined MP_PREC shall be reduced.
99           [I also allow MP_PREC to be externally defined now]
100        -- Sped up mp_cnt_lsb() by using a 4x4 table [e.g. 4x speedup]
101        -- Added mp_prime_random_ex() which is a more versatile prime generator accurate to
102           exact bit lengths (unlike the deprecated but still available mp_prime_random() which
103           is only accurate to byte lengths).  See the new LTM_PRIME_* flags ;-)
104        -- Alex Polushin contributed an optimized mp_sqrt() as well as mp_get_int() and mp_is_square().
105           I've cleaned them all up to be a little more consistent [along with one bug fix] for this release.
106        -- Added mp_init_set and mp_init_set_int to initialize and set small constants with one function
107           call.
108        -- Removed /etclib directory [um LibTomPoly deprecates this].
109        -- Fixed mp_mod() so the sign of the result agrees with the sign of the modulus.
110        ++ N.B.  My semester is almost up so expect updates to the textbook to be posted to the libtomcrypt.org 
111           website.  
113 Jan 25th, 2004
114 v0.29  ++ Note: "Henrik" from the v0.28 changelog refers to Henrik Goldman ;-)
115        -- Added fix to mp_shrink to prevent a realloc when used == 0 [e.g. realloc zero bytes???]
116        -- Made the mp_prime_rabin_miller_trials() function internal table smaller and also
117           set the minimum number of tests to two (sounds a bit safer).
118        -- Added a mp_exteuclid() which computes the extended euclidean algorithm.
119        -- Fixed a memory leak in s_mp_exptmod() [called when Barrett reduction is to be used] which would arise
120           if a multiplication or subsequent reduction failed [would not free the temp result].
121        -- Made an API change to mp_radix_size().  It now returns an error code and stores the required size
122           through an "int star" passed to it.
124 Dec 24th, 2003
125 v0.28  -- Henrik Goldman suggested I add casts to the montomgery code [stores into mu...] so compilers wouldn't
126           spew [erroneous] diagnostics... fixed.
127        -- Henrik Goldman also spotted two typos.  One in mp_radix_size() and another in mp_toradix().
128        -- Added fix to mp_shrink() to avoid a memory leak.
129        -- Added mp_prime_random() which requires a callback to make truly random primes of a given nature
130           (idea from chat with Niels Ferguson at Crypto'03)
131        -- Picked up a second wind.  I'm filled with Gooo.  Mission Gooo!
132        -- Removed divisions from mp_reduce_is_2k()
133        -- Sped up mp_div_d() [general case] to use only one division per digit instead of two.
134        -- Added the heap macros from LTC to LTM.  Now you can easily [by editing four lines of tommath.h]
135           change the name of the heap functions used in LTM [also compatible with LTC via MPI mode]
136        -- Added bn_prime_rabin_miller_trials() which gives the number of Rabin-Miller trials to achieve
137           a failure rate of less than 2^-96
138        -- fixed bug in fast_mp_invmod().  The initial testing logic was wrong.  An invalid input is not when
139           "a" and "b" are even it's when "b" is even [the algo is for odd moduli only].
140        -- Started a new manual [finally].  It is incomplete and will be finished as time goes on.  I had to stop
141           adding full demos around half way in chapter three so I could at least get a good portion of the
142           manual done.   If you really need help using the library you can always email me!
143        -- My Textbook is now included as part of the package [all Public Domain]
145 Sept 19th, 2003
146 v0.27  -- Removed changes.txt~ which was made by accident since "kate" decided it was
147           a good time to re-enable backups... [kde is fun!]
148        -- In mp_grow() "a->dp" is not overwritten by realloc call [re: memory leak]
149           Now if mp_grow() fails the mp_int is still valid and can be cleared via
150           mp_clear() to reclaim the memory.
151        -- Henrik Goldman found a buffer overflow bug in mp_add_d().  Fixed.
152        -- Cleaned up mp_mul_d() to be much easier to read and follow.
154 Aug 29th, 2003
155 v0.26  -- Fixed typo that caused warning with GCC 3.2
156        -- Martin Marcel noticed a bug in mp_neg() that allowed negative zeroes.
157           Also, Martin is the fellow who noted the bugs in mp_gcd() of 0.24/0.25.
158        -- Martin Marcel noticed an optimization [and slight bug] in mp_lcm().
159        -- Added fix to mp_read_unsigned_bin to prevent a buffer overflow.
160        -- Beefed up the comments in the baseline multipliers [and montgomery]
161        -- Added "mont" demo to the makefile.msvc in etc/
162        -- Optimized sign compares in mp_cmp from 4 to 2 cases.
164 Aug 4th, 2003
165 v0.25  -- Fix to mp_gcd again... oops (0,-a) == (-a, 0) == a
166        -- Fix to mp_clear which didn't reset the sign  [Greg Rose]
167        -- Added mp_error_to_string() to convert return codes to strings.  [Greg Rose]
168        -- Optimized fast_mp_invmod() to do the test for invalid inputs [both even]
169           first so temps don't have to be initialized if it's going to fail.
170        -- Optimized mp_gcd() by removing mp_div_2d calls for when one of the inputs
171           is odd.
172        -- Tons of new comments, some indentation fixups, etc.
173        -- mp_jacobi() returns MP_VAL if the modulus is less than or equal to zero.
174        -- fixed two typos in the header of each file :-)
175        -- LibTomMath is officially Public Domain [see LICENSE]
177 July 15th, 2003
178 v0.24  -- Optimized mp_add_d and mp_sub_d to not allocate temporary variables
179        -- Fixed mp_gcd() so the gcd of 0,0 is 0.  Allows the gcd operation to be chained
180           e.g. (0,0,a) == a [instead of 1]
181        -- Should be one of the last release for a while.  Working on LibTomMath book now.
182        -- optimized the pprime demo [/etc/pprime.c] to first make a huge table of single
183           digit primes then it reads them randomly instead of randomly choosing/testing single
184           digit primes.
186 July 12th, 2003
187 v0.23  -- Optimized mp_prime_next_prime() to not use mp_mod [via is_divisible()] in each
188           iteration.  Instead now a smaller table is kept of the residues which can be updated
189           without division.
190        -- Fixed a bug in next_prime() where an input of zero would be treated as odd and
191           have two added to it [to move to the next odd].
192        -- fixed a bug in prime_fermat() and prime_miller_rabin() which allowed the base
193           to be negative, zero or one.  Normally the test is only valid if the base is
194           greater than one.
195        -- changed the next_prime() prototype to accept a new parameter "bbs_style" which
196           will find the next prime congruent to 3 mod 4.  The default [bbs_style==0] will
197           make primes which are either congruent to 1 or 3 mod 4.
198        -- fixed mp_read_unsigned_bin() so that it doesn't include both code for
199           the case DIGIT_BIT < 8 and >= 8
200        -- optimized div_d() to easy out on division by 1 [or if a == 0] and use
201           logical shifts if the divisor is a power of two.
202        -- the default DIGIT_BIT type was not int for non-default builds.  Fixed.
204 July 2nd, 2003
205 v0.22  -- Fixed up mp_invmod so the result is properly in range now [was always congruent to the inverse...]
206        -- Fixed up s_mp_exptmod and mp_exptmod_fast so the lower half of the pre-computed table isn't allocated
207           which makes the algorithm use half as much ram.
208        -- Fixed the install script not to make the book :-) [which isn't included anyways]
209        -- added mp_cnt_lsb() which counts how many of the lsbs are zero
210        -- optimized mp_gcd() to use the new mp_cnt_lsb() to replace multiple divisions by two by a single division.
211        -- applied similar optimization to mp_prime_miller_rabin().
212        -- Fixed a bug in both mp_invmod() and fast_mp_invmod() which tested for odd
213           via "mp_iseven() == 0" which is not valid [since zero is not even either].
215 June 19th, 2003
216 v0.21  -- Fixed bug in mp_mul_d which would not handle sign correctly [would not always forward it]
217        -- Removed the #line lines from gen.pl [was in violation of ISO C]
219 June 8th, 2003
220 v0.20  -- Removed the book from the package.  Added the TDCAL license document.
221        -- This release is officially pure-bred TDCAL again [last officially TDCAL based release was v0.16]
223 June 6th, 2003
224 v0.19  -- Fixed a bug in mp_montgomery_reduce() which was introduced when I tweaked mp_rshd() in the previous release.
225           Essentially the digits were not trimmed before the compare which cause a subtraction to occur all the time.
226        -- Fixed up etc/tune.c a bit to stop testing new cutoffs after 16 failures [to find more optimal points].
227           Brute force ho!
230 May 29th, 2003
231 v0.18  -- Fixed a bug in s_mp_sqr which would handle carries properly just not very elegantly.
232           (e.g. correct result, just bad looking code)
233        -- Fixed bug in mp_sqr which still had a 512 constant instead of MP_WARRAY
234        -- Added Toom-Cook multipliers [needs tuning!]
235        -- Added efficient divide by 3 algorithm mp_div_3
236        -- Re-wrote mp_div_d to be faster than calling mp_div
237        -- Added in a donated BCC makefile and a single page LTM poster (ahalhabsi@sbcglobal.net)
238        -- Added mp_reduce_2k which reduces an input modulo n = 2**p - k for any single digit k
239        -- Made the exptmod system be aware of the 2k reduction algorithms.
240        -- Rewrote mp_dr_reduce to be smaller, simpler and easier to understand.
242 May 17th, 2003
243 v0.17  -- Benjamin Goldberg submitted optimized mp_add and mp_sub routines.  A new gen.pl as well
244           as several smaller suggestions.  Thanks!
245        -- removed call to mp_cmp in inner loop of mp_div and put mp_cmp_mag in its place :-)
246        -- Fixed bug in mp_exptmod that would cause it to fail for odd moduli when DIGIT_BIT != 28
247        -- mp_exptmod now also returns errors if the modulus is negative and will handle negative exponents
248        -- mp_prime_is_prime will now return true if the input is one of the primes in the prime table
249        -- Damian M Gryski (dgryski@uwaterloo.ca) found a index out of bounds error in the
250           mp_fast_s_mp_mul_high_digs function which didn't come up before.  (fixed)
251        -- Refactored the DR reduction code so there is only one function per file.
252        -- Fixed bug in the mp_mul() which would erroneously avoid the faster multiplier [comba] when it was
253           allowed.  The bug would not cause the incorrect value to be produced just less efficient (fixed)
254        -- Fixed similar bug in the Montgomery reduction code.
255        -- Added tons of (mp_digit) casts so the 7/15/28/31 bit digit code will work flawlessly out of the box.
256           Also added limited support for 64-bit machines with a 60-bit digit.  Both thanks to Tom Wu (tom@arcot.com)
257        -- Added new comments here and there, cleaned up some code [style stuff]
258        -- Fixed a lingering typo in mp_exptmod* that would set bitcnt to zero then one.  Very silly stuff :-)
259        -- Fixed up mp_exptmod_fast so it would set "redux" to the comba Montgomery reduction if allowed.  This
260           saves quite a few calls and if statements.
261        -- Added etc/mont.c a test of the Montgomery reduction [assuming all else works :-| ]
262        -- Fixed up etc/tune.c to use a wider test range [more appropriate] also added a x86 based addition which
263           uses RDTSC for high precision timing.
264        -- Updated demo/demo.c to remove MPI stuff [won't work anyways], made the tests run for 2 seconds each so its
265           not so insanely slow.  Also made the output space delimited [and fixed up various errors]
266        -- Added logs directory, logs/graph.dem which will use gnuplot to make a series of PNG files
267           that go with the pre-made index.html.  You have to build [via make timing] and run ltmtest first in the
268           root of the package.
269        -- Fixed a bug in mp_sub and mp_add where "-a - -a" or "-a + a" would produce -0 as the result [obviously invalid].
270        -- Fixed a bug in mp_rshd.  If the count == a.used it should zero/return [instead of shifting]
271        -- Fixed a "off-by-one" bug in mp_mul2d.  The initial size check on alloc would be off by one if the residue
272           shifting caused a carry.
273        -- Fixed a bug where s_mp_mul_digs() would not call the Comba based routine if allowed.  This made Barrett reduction
274           slower than it had to be.
276 Mar 29th, 2003
277 v0.16  -- Sped up mp_div by making normalization one shift call
278        -- Sped up mp_mul_2d/mp_div_2d by aliasing pointers :-)
279        -- Cleaned up mp_gcd to use the macros for odd/even detection
280        -- Added comments here and there, mostly there but occasionally here too.
282 Mar 22nd, 2003
283 v0.15  -- Added series of prime testing routines to lib
284        -- Fixed up etc/tune.c
285        -- Added DR reduction algorithm
286        -- Beefed up the manual more.
287        -- Fixed up demo/demo.c so it doesn't have so many warnings and it does the full series of
288           tests
289        -- Added "pre-gen" directory which will hold a "gen.pl"'ed copy of the entire lib [done at
290           zipup time so its always the latest]
291        -- Added conditional casts for C++ users [boo!]
293 Mar 15th, 2003
294 v0.14  -- Tons of manual updates
295        -- cleaned up the directory
296        -- added MSVC makefiles
297        -- source changes [that I don't recall]
298        -- Fixed up the lshd/rshd code to use pointer aliasing
299        -- Fixed up the mul_2d and div_2d to not call rshd/lshd unless needed
300        -- Fixed up etc/tune.c a tad
301        -- fixed up demo/demo.c to output comma-delimited results of timing
302           also fixed up timing demo to use a finer granularity for various functions
303        -- fixed up demo/demo.c testing to pause during testing so my Duron won't catch on fire
304           [stays around 31-35C during testing :-)]
306 Feb 13th, 2003
307 v0.13  -- tons of minor speed-ups in low level add, sub, mul_2 and div_2 which propagate
308           to other functions like mp_invmod, mp_div, etc...
309        -- Sped up mp_exptmod_fast by using new code to find R mod m [e.g. B^n mod m]
310        -- minor fixes
312 Jan 17th, 2003
313 v0.12  -- re-wrote the majority of the makefile so its more portable and will
314           install via "make install" on most *nix platforms
315        -- Re-packaged all the source as seperate files.  Means the library a single
316           file packagage any more.  Instead of just adding "bn.c" you have to add
317           libtommath.a
318        -- Renamed "bn.h" to "tommath.h"
319        -- Changes to the manual to reflect all of this
320        -- Used GNU Indent to clean up the source
322 Jan 15th, 2003
323 v0.11  -- More subtle fixes
324        -- Moved to gentoo linux [hurrah!] so made *nix specific fixes to the make process
325        -- Sped up the montgomery reduction code quite a bit
326        -- fixed up demo so when building timing for the x86 it assumes ELF format now
328 Jan 9th, 2003
329 v0.10  -- Pekka Riikonen suggested fixes to the radix conversion code.
330        -- Added baseline montgomery and comba montgomery reductions, sped up exptmods
331           [to a point, see bn.h for MONTGOMERY_EXPT_CUTOFF]
333 Jan 6th, 2003
334 v0.09  -- Updated the manual to reflect recent changes.  :-)
335        -- Added Jacobi function (mp_jacobi) to supplement the number theory side of the lib
336        -- Added a Mersenne prime finder demo in ./etc/mersenne.c
338 Jan 2nd, 2003
339 v0.08  -- Sped up the multipliers by moving the inner loop variables into a smaller scope
340        -- Corrected a bunch of small "warnings"
341        -- Added more comments
342        -- Made "mtest" be able to use /dev/random, /dev/urandom or stdin for RNG data
343        -- Corrected some bugs where error messages were potentially ignored
344        -- add etc/pprime.c program which makes numbers which are provably prime.
346 Jan 1st, 2003
347 v0.07  -- Removed alot of heap operations from core functions to speed them up
348        -- Added a root finding function [and mp_sqrt macro like from MPI]
349        -- Added more to manual
351 Dec 31st, 2002
352 v0.06  -- Sped up the s_mp_add, s_mp_sub which inturn sped up mp_invmod, mp_exptmod, etc...
353        -- Cleaned up the header a bit more
355 Dec 30th, 2002
356 v0.05  -- Builds with MSVC out of the box
357        -- Fixed a bug in mp_invmod w.r.t. even moduli
358        -- Made mp_toradix and mp_read_radix use char instead of unsigned char arrays
359        -- Fixed up exptmod to use fewer multiplications
360        -- Fixed up mp_init_size to use only one heap operation
361           -- Note there is a slight "off-by-one" bug in the library somewhere
362              without the padding (see the source for comment) the library
363              crashes in libtomcrypt.  Anyways a reasonable workaround is to pad the
364              numbers which will always correct it since as the numbers grow the padding
365              will still be beyond the end of the number
366        -- Added more to the manual
368 Dec 29th, 2002
369 v0.04  -- Fixed a memory leak in mp_to_unsigned_bin
370        -- optimized invmod code
371        -- Fixed bug in mp_div
372        -- use exchange instead of copy for results
373        -- added a bit more to the manual
375 Dec 27th, 2002
376 v0.03  -- Sped up s_mp_mul_high_digs by not computing the carries of the lower digits
377        -- Fixed a bug where mp_set_int wouldn't zero the value first and set the used member.
378        -- fixed a bug in s_mp_mul_high_digs where the limit placed on the result digits was not calculated properly
379        -- fixed bugs in add/sub/mul/sqr_mod functions where if the modulus and dest were the same it wouldn't work
380        -- fixed a bug in mp_mod and mp_mod_d concerning negative inputs
381        -- mp_mul_d didn't preserve sign
382        -- Many many many many fixes
383        -- Works in LibTomCrypt now :-)
384        -- Added iterations to the timing demos... more accurate.
385        -- Tom needs a job.
387 Dec 26th, 2002
388 v0.02  -- Fixed a few "slips" in the manual.  This is "LibTomMath" afterall :-)
389        -- Added mp_cmp_mag, mp_neg, mp_abs and mp_radix_size that were missing.
390        -- Sped up the fast [comba] multipliers more [yahoo!]
392 Dec 25th,2002
393 v0.01  -- Initial release.  Gimme a break.
394        -- Todo list,
395            add details to manual [e.g. algorithms]
396            more comments in code
397            example programs