CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.6.0 (2025-01-22)

Added

• TryFrom<&[u8]> bound on Encoding::Repr (#261)
• New Uint functionality:
  • New methods: bitand_limb (#322), gcd (#472), from_str_radix_vartime (#603), to_string_radix_vartime (#659)
  • New trait impls: MulMod (#313), Div/Rem (#720)
• New BoxedUint functionality:
  • New methods: sbb/wrapping_sub/checked_sub (#303), mul (#306), from_be_slice/from_le_slice (#307), to_be_bytes/to_le_bytes (#308), bits (#328), conditional_select (#329), shl_vartime (#330), shr_vartime (#331), rem_vartime (#332), inv_mod2k/bitor (#334), pow (#337), inv_mod (#341), random (#349), cond_map/cond_and_then (#352), map_limbs (#357), div_rem/rem (#398), new_with_arc (#407), gcd (#497), from_str_radix_vartime (#603), to_string_radix_vartime (#659)
  • New trait impls: BitAnd* (#314), ConstantTimeGreater/Less/PartialOrd/Ord (#316), AddMod (#317), SubMod (#320), Hash/BoxedUint (#350), MulMod/BoxedUint (#343), RandomMod (#349), Rem (#356), BitNot/BitXor (#358), CheckedMul/Mul (#361), NegMod (#362), Div (#366), Integer (#367)
  • Montgomery multiplication support (#323)
• New traits: FixedInteger (#363), CheckedDiv (#369), WideningMul (#371), ConstantTimeSelect (#454), SquareAssign (#431), Gcd (#499), DivRemLimb/RemLimb (#496), InvMod (#505, #741), SquareRoot (#508), BitOperations (#507), ShrVartime/ShlVartime (#509), RandomBits (#510), RemMixed (#746)
• num-traits impls: Wrapping* (#425), Zero/One (#433), ConstZero (#573), Num (#720)
• safegcd (Bernstein-Yang) GCD + inv mod algorithm (#372, #493, #632, #635, #655)
• Constant-time square root and division (#376)
• Implement Zeroize for NonZero wrapper (#406)
• Zero::set_zero method (#426)
• Inverter/PrecomputeInverter traits (#438, #444)
• Uint: const fn encoders (#453)
• Traits to connect integers and Montgomery form representations (#431):
  • Integer::Monty associated type
  • Monty trait with arithmetic bounds and an associated Monty::Integer type
• Odd wrapper type (#487)
• NonZero::new_unwrap (#602)
• Implement Karatsuba multiplication for Uint and BoxedUint (#649)
• Efficient linear combination for Montgomery forms (#666)
• Doc comment support for impl_modulus! (#676)
• core::error::Error support (#680)
• Int type providing initial signed integer support using two's complement (#695, #730)
• Variable-time modular inversion support (#731)

Changed

• Toplevel modular module now contains all modular functionality (#300, #324)
• Integer trait: expand bounds to include *Mod (#318), Add/Sub/Mul (#435), RemAssign (#709), AddAssign/MulAssign/SubAssign (#716)
• Integer trait: add new methods bits(_vartime)/leading_zeros (#368), from_limb_like/one_like/zero_like` (#533)
• Replace BoxedUint::new with ::zero_with_precision (#327)
• Split Zero trait into Zero + ZeroConstant (#335)
• Refactor Integer trait; add Constants/LimbsConstant (#355)
  • The existing Bounded trait subsumes BITS/BYTES
  • Constants provides ONE and MAX
  • LimbsConstant provides LIMBS
• Rename BoxedUint::mul_wide to mul (#359)
• Round up bits_precision when creating BoxedUint (#365)
• Make bit ops use u32 for shifts and bit counts (#373)
• Align with core/std on overflow behavior for bit shifts (#395)
• Make inv_mod2k(_vartime) return a CtChoice (#416)
• Rename CtChoice to ConstChoice (#417)
• Make division methods take NonZero-wrapped divisors (#419)
• Align with core/std on overflowing_sh* for functions which return an overflow flag (#430)
• Uint: rename HLIMBS to RHS_LIMBS (#432)
• Bring Checked* traits in line with Wrapping* (#434)
• Rename *Residue* types i.e. Montgomery form representations (#485):
  • Residue -> ConstMontyForm
  • DynResidue -> MontyForm
  • BoxedResidue -> BoxedMontyForm
  • *ResidueParams -> *MontyParams
  • residue_params -> params
  • params.r -> params.one
• Make Monty::new_params() take an Odd-wrapped modulus (#488)
• Expand Uint support for const fn: square (#514), widening_mul (#515), to_le_bytes (#555)
• Have (Boxed)MontyParams::modulus return &Odd<_> (#517)
• Split MontyParams::new and new_vartime ([#516], #518)
• Reverse Concat(Mixed)/Split(Mixed) argument ordering (#526)
• Migrate from generic-array to hybrid-array (#544)
• Replace ZeroConstant with ConstZero trait from num-traits (#546, #573)
• Change Uint::concat_mixed and split_mixed to accept self; make pub (#556, #558)
• Make Uint::concat and split const generic over inputs (#557, #558)
• Split Uint::mul_mod and Uint::mul_mod_vartime (#623)
• Faster constant-time division (#643)
• BoxedMontyForm: always use Arc for params (#645)
• Leverage const_mut_refs; MSRV 1.83 (#667)
• Bump rlp dependency from 0.5 to 0.6 (#673)
• Require RngCore instead of CryptoRngCore for various random methods (#710)
• Bump serdect dependency to v0.3 (#719)
• Have rand feature enable rand_core/getrandom instead of rand_core/std (#745)

Fixed

• Argument ordering to BoxedUint::chain (#315)
• Modulus leading zeros calculation for MontyForm/BoxedMontyForm (#713)

Removed

• ct_* prefixes from method names since we're constant-time by default (#417)
• const_assert_* macros (#452, #690)

0.5.5 (2023-11-18)

Added

• Multi-exponentiation (#248)
• const_assert_eq! and const_assert_ne! macros (#293)

0.5.4 (2023-11-12)

Added

• trailing_ones[_vartime](), trailing_zeros_vartime(), leading_zeros_vartime() (#282)
• Implement ArrayEncoding for U832 (#288)

Changed

• Make Uint::random_mod() work identically on 32- and 64-bit targets (#285)

0.5.3 (2023-09-04)

Added

• BoxedUint: heap-allocated fixed-precision integers (#221)
• extra-sizes feature (#229)
• U4224 and U4352 (#233)
• Zeroizing support for DynResidue (#235)
• cmp_vartime, ct_cmp (#238)
• Expose Montgomery form in Residue/DynResidue (#239)
• Make Uint::pow work with different sized exponents (#251)
• Expose wrapping_neg (#252)
• Make concat, split, and multiply work with different sized operands (#253)
• U16384 and U32768 (#255)
• Uint::{inv_mod, inv_mod2k_vartime} (#263)
• const fn constructors for NonZero<Uint> and NonZero<Limb> (#266)
• Constant-time Uint::shr() and Uint::shl() (#267)
• Subtle trait impls for DynResidue and DynResidueParams (#269)

Changed

• Modular inversion improvements (#263)

Fixed

• serdect usage (#222)
• Enforce valid modulus for DynResidueParams (#240)
• Enforce valid modulus for Residue and associated macros (#243)
• Make Uint::{from_be_hex, from_le_hex} constant-time (#254)
• Remove conditionals in Uint::saturating_add() and saturating_mul() (#256)
• More logical checks in the Uint::random_mod() test (#256)
• Mark sqrt for renaming, to explicitly describe it as vartime (#256)

0.5.2 (2023-04-26)

Added

• Expose residue params and modulus in DynResidue (#197)
• Impl DefaultIsZeroes for Residue (#210)
• div_by_2() method for integers in Montgomery form (#211, #212)

Changed

• Montgomery multiplication improvements (#203)

0.5.1 (2023-03-13)

Changed

• Improve Debug impls on Limb and Uint (#195)

Fixed

• const_residue macro accessibility bug (#193)

0.5.0 (2023-02-27)

Added

• Residue: modular arithmetic with static compile-time moduli (#130)
• DynResidue: modular arithmetic with dynamic runtime moduli (#134)
• Constant-time division by a single Limb (#141)
• Windowed exponentiation for (Dyn)Residue (#147)
• SubResidue trait and impls for Residue and DynResidue (#149)
• Pow, Invert and Square (#155)
• CtChoice type (#159)
• BITS, BYTES, and LIMBS to Integer trait (#161)
• Impl Random for Wrapping (#168)
• Support to concat U320 and U640 (#173)
• Define U224 and U544 on 32-bit platforms (#179, #180)

Changed

• Rename UInt -> Uint (#143)
• Rename Uint methods (#144)
  • limbs -> as_limbs
  • limbs_mut -> as_limbs_mut
  • into_limbs -> to_limbs
• Faster random_mod (#146)
• Constant-time leading_zeros(), trailing_zeros(), bits(), and bit() for Uint (#153)
• Rename BIT_SIZE -> BITS, BYTE_SIZE -> BYTES (#157)
• More efficient squaring operation ([#133])
• Use CryptoRngCore (#164)
• Bump serdect to 0.2 (#185)
• Bump der dependency to v0.7; MSRV 1.65 (#187)

Fixed

• Integer overflow in div2by1() (#156)
• Convert from tuple element ordering (#183)

0.4.9 (2022-10-11)

Added

• UInt::from_word and ::from_wide_word (#105)
• UInt modulo operations for special moduli (#108)
• Non-const UInt decoding from an array (#110)
• const fn impls of concat and split (#111)
• Limb left/right bitshifts (#112)
• UInt::LIMBS constant (#114)

Changed

• Optimize UInt::neg_mod by simply calling ::sub_mod (#106)
• Relax bounds for UInt::add_mod and ::sub_mod (#104)
• Always inline Limb::bitand (#109)
• Faster const decoding of UInt (#113)
• Optimize UInt::neg_mod (#127)
• Faster comparisons (#128)
• UInt::resize (#129)
• UInt::bit accessor methods (#122)

Fixed

• Constant-time behaviour for ct_reduce/ct_div_rem (#117)

0.4.8 (2022-06-30)

Added

• Word as a replacement for LimbUInt (#88)
• WideWord as a replacement for WideLimbUInt (#88)
• UInt::*_words as a replacement for UInt::*_uint_array (#88)

Changed

• Deprecated *LimbUInt and UInt::*_uint_array (#88)

0.4.7 (2022-06-12)

Added

• Encoding tests (#93)

Changed

• Use const generic impls of *Mod traits (#98)

0.4.6 (2022-06-12)

Added

• Impl ArrayEncoding for U576 (#96)

0.4.5 (2022-06-12)

Added

• serde support (#73)
• U576 type alias (#94)

0.4.4 (2022-06-02)

Added

• UInt::as_uint_array (#91)

0.4.3 (2022-05-31)

Added

• Impl AsRef/AsMut<[LimbUInt]> for UInt (#89)

0.4.2 (2022-05-18)

Added

• UInt::inv_mod2k (#86)

Fixed

• Wrong results for remainder (#84)

0.4.1 (2022-05-10)

Fixed

• Bug in from_le_slice (#82)

0.4.0 (2022-05-08) [YANKED]

NOTE: this release was yanked due to #82.

Added

• Const-friendly NonZero from UInt (#56)
• Optional der feature (#61, #80)

Changed

• Use const_panic; MSRV 1.57 (#60)
• 2021 edition (#60)

Fixed

• Pad limbs with zeros when displaying hexadecimal representation (#74)

0.3.2 (2021-11-17)

Added

• Output = Self to all bitwise ops on Integer trait (#53)

0.3.1 (2021-11-17)

Added

• Bitwise ops to Integer trait (#51)

0.3.0 (2021-11-14) [YANKED]

Added

• Bitwise Xor/Not operations (#27)
• Zero trait (#35)
• Checked* traits (#41)
• prelude module (#45)
• saturating_* ops (#47)

Changed

• Rust 2021 edition upgrade; MSRV 1.56 (#33)
• Reverse ordering of UInt::mul_wide return tuple (#34)
• Have Div and Rem impls always take NonZero args (#39)
• Rename limb::Inner to LimbUInt (#40)
• Make limb module private (#40)
• Use Zero/Integer traits for is_zero, is_odd, and is_even (#46)

Fixed

• random_mod performance for small moduli (#36)
• NonZero moduli (#36)

Removed

• Deprecated LIMB_BYTES constant (#43)

0.2.11 (2021-10-16)

Added

• AddMod proptests (#24)
• Bitwise And/Or operations (#25)

0.2.10 (2021-09-21)

Added

• ArrayDecoding trait (#12)
• NonZero wrapper (#13, #16)
• Impl Div/Rem for NonZero<UInt> (#14)

0.2.9 (2021-09-16)

Added

• UInt::sqrt (#9)

Changed

• Make UInt division similar to other interfaces (#8)

0.2.8 (2021-09-14) [YANKED]

Added

• Implement constant-time division and modulo operations

Changed

• Moved from RustCrypto/utils to RustCrypto/crypto-bigint repo (#2)

0.2.7 (2021-09-12)

Added

• UInt::shl_vartime

Fixed

• add_mod overflow handling

0.2.6 (2021-09-08)

Added

• Integer trait
• ShrAssign impl for UInt
• Recursive Length Prefix (RLP) encoding support for UInt

0.2.5 (2021-09-02)

Fixed

• ConditionallySelectable impl for UInt

0.2.4 (2021-08-23) [YANKED]

Added

• Expose limb module
• [limb::Inner; LIMBS] conversions for UInt
• Bitwise right shift support for UInt ([#586], [#590])

0.2.3 (2021-08-16) [YANKED]

Fixed

• UInt::wrapping_mul

Added

• Implement the Hash trait for UInt and Limb

0.2.2 (2021-06-26) [YANKED]

Added

• Limb::is_odd and UInt::is_odd
• UInt::new
• rand feature

Changed

• Deprecate LIMB_BYTES constant
• Make Limb's Inner value public

0.2.1 (2021-06-21) [YANKED]

Added

• Limb newtype
• Target-specific rustdocs

0.2.0 (2021-06-07) [YANKED]

Added

• ConstantTimeGreater/ConstantTimeLess impls for UInt
• From conversions between UInt and limb arrays
• zeroize feature
• Additional ArrayEncoding::ByteSize bounds
• UInt::into_limbs
• Encoding trait

Removed

• NumBits/NumBytes traits; use Encoding instead

0.1.0 (2021-05-30)

• Initial release