Copyright	Dong Han 2021
License	BSD
Maintainer	[email protected]
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Z.Crypto.MPI

Contents

Description

This module provide Botan's Multiple Precision Integer, featuring constant-time operations, which is suit for cryptograph usage.

Synopsis

data MPI
fromCInt :: CInt -> MPI
toWord32 :: MPI -> Word32
byteSize :: MPI -> Int
bitSize :: MPI -> Int
toHex :: MPI -> Builder ()
toDecimal :: MPI -> Builder ()
fromHex :: Parser MPI
fromDecimal :: Parser MPI
isNegative :: MPI -> Bool
isZero :: MPI -> Bool
isOdd :: MPI -> Bool
isEven :: MPI -> Bool
isPrim :: HasCallStack => RNG -> MPI -> Int -> IO Bool
mulMod :: MPI -> MPI -> MPI -> MPI
powMod :: MPI -> MPI -> MPI -> MPI
modInverse :: MPI -> MPI -> MPI
gcd :: MPI -> MPI -> MPI
randBits :: HasCallStack => RNG -> Int -> IO MPI
randRange :: HasCallStack => RNG -> MPI -> MPI -> IO MPI
copyMPI :: MPI -> IO MPI
newMPI :: (BotanStructT -> IO a) -> IO MPI
unsafeNewMPI :: (BotanStructT -> IO a) -> MPI
newMPI' :: (BotanStructT -> IO a) -> IO (MPI, a)
unsafeNewMPI' :: (BotanStructT -> IO a) -> (MPI, a)
withMPI :: MPI -> (BotanStructT -> IO a) -> IO a
unsafeWithMPI :: MPI -> (BotanStructT -> IO a) -> a

MPI

data MPI Source #

Opaque Botan Multiple Precision Integers.

Instances

Instances details

Enum MPI Source #
Instance details Defined in Z.Crypto.MPI Methods succ :: MPI -> MPI # pred :: MPI -> MPI # toEnum :: Int -> MPI # fromEnum :: MPI -> Int # enumFrom :: MPI -> [MPI] # enumFromThen :: MPI -> MPI -> [MPI] # enumFromTo :: MPI -> MPI -> [MPI] # enumFromThenTo :: MPI -> MPI -> MPI -> [MPI] #
Eq MPI Source #
Instance details Defined in Z.Crypto.MPI Methods (==) :: MPI -> MPI -> Bool # (/=) :: MPI -> MPI -> Bool #
Integral MPI Source #
Instance details Defined in Z.Crypto.MPI Methods quot :: MPI -> MPI -> MPI # rem :: MPI -> MPI -> MPI # div :: MPI -> MPI -> MPI # mod :: MPI -> MPI -> MPI # quotRem :: MPI -> MPI -> (MPI, MPI) # divMod :: MPI -> MPI -> (MPI, MPI) # toInteger :: MPI -> Integer #
Num MPI Source #
Instance details Defined in Z.Crypto.MPI Methods (+) :: MPI -> MPI -> MPI # (-) :: MPI -> MPI -> MPI # (*) :: MPI -> MPI -> MPI # negate :: MPI -> MPI # abs :: MPI -> MPI # signum :: MPI -> MPI # fromInteger :: Integer -> MPI #
Ord MPI Source #
Instance details Defined in Z.Crypto.MPI Methods compare :: MPI -> MPI -> Ordering # (<) :: MPI -> MPI -> Bool # (<=) :: MPI -> MPI -> Bool # (>) :: MPI -> MPI -> Bool # (>=) :: MPI -> MPI -> Bool # max :: MPI -> MPI -> MPI # min :: MPI -> MPI -> MPI #
Real MPI Source #
Instance details Defined in Z.Crypto.MPI Methods toRational :: MPI -> Rational #
Show MPI Source #
Instance details Defined in Z.Crypto.MPI Methods showsPrec :: Int -> MPI -> ShowS # show :: MPI -> String # showList :: [MPI] -> ShowS #
JSON MPI Source #
Instance details Defined in Z.Crypto.MPI Methods fromValue :: Value -> Converter MPI # toValue :: MPI -> Value # encodeJSON :: MPI -> Builder () #
Print MPI Source #
Instance details Defined in Z.Crypto.MPI Methods toUTF8BuilderP :: Int -> MPI -> Builder () #
Bits MPI Source #	The `testBit` implementation ignore sign.
Instance details Defined in Z.Crypto.MPI Methods (.&.) :: MPI -> MPI -> MPI # (.\|.) :: MPI -> MPI -> MPI # xor :: MPI -> MPI -> MPI # complement :: MPI -> MPI # shift :: MPI -> Int -> MPI # rotate :: MPI -> Int -> MPI # zeroBits :: MPI # bit :: Int -> MPI # setBit :: MPI -> Int -> MPI # clearBit :: MPI -> Int -> MPI # complementBit :: MPI -> Int -> MPI # testBit :: MPI -> Int -> Bool # bitSizeMaybe :: MPI -> Maybe Int # bitSize :: MPI -> Int # isSigned :: MPI -> Bool # shiftL :: MPI -> Int -> MPI # unsafeShiftL :: MPI -> Int -> MPI # shiftR :: MPI -> Int -> MPI # unsafeShiftR :: MPI -> Int -> MPI # rotateL :: MPI -> Int -> MPI # rotateR :: MPI -> Int -> MPI # popCount :: MPI -> Int #

fromCInt :: CInt -> MPI Source #

Set MPI from an integer value.

toWord32 :: MPI -> Word32 Source #

Convert a MPI to Word32, the sign is ignored.

byteSize :: MPI -> Int Source #

Get MPI 's byte size.

bitSize :: MPI -> Int Source #

Get MPI 's bit size.

MPI Builder & Parser

toHex :: MPI -> Builder () Source #

Write a MPI in hexadecimal format(without '0x' prefix), the sign is ignored.

toDecimal :: MPI -> Builder () Source #

Write a MPI in decimal format, with negative sign if < 0.

fromHex :: Parser MPI Source #

Parse a MPI in hexadecimal format(without '0x' prefix), no sign is allowed.

fromDecimal :: Parser MPI Source #

Parse a MPI in decimal format, parse leading minus sign.

MPI Predicator

isNegative :: MPI -> Bool Source #

isZero :: MPI -> Bool Source #

isOdd :: MPI -> Bool Source #

isEven :: MPI -> Bool Source #

isPrim :: HasCallStack => RNG -> MPI -> Int -> IO Bool Source #

Test if n is prime.

The algorithm used (Miller-Rabin) is probabilistic, set test_prob to the desired assurance level. For example if test_prob is 64, then sufficient Miller-Rabin iterations will run to assure there is at most a 1/2**64 chance that n is composite.