Crypto.ECC

cryptonite-0.22: Cryptography Primitives sink

License | BSD-style
Maintainer | Vincent Hanquez <vincent@snarc.org>
Stability | experimental
Portability | unknown
Safe Haskell | None
Language | Haskell2010

Crypto.ECC

Description

Elliptic Curve Cryptography

Synopsis

- data Curve_P256R1 = Curve_P256R1
- data Curve_P384R1 = Curve_P384R1
- data Curve_P521R1 = Curve_P521R1
- data Curve_X25519 = Curve_X25519
- data Curve_X448 = Curve_X448
- class EllipticCurve curve where
  - type Point curve :: *
  - type Scalar curve :: *
- class EllipticCurve curve => EllipticCurveDH curve where
- class EllipticCurve curve => EllipticCurveArith curve where
- data KeyPair curve = KeyPair {
  - keypairGetPublic :: !(Point curve)
  - keypairGetPrivate :: !(Scalar curve)
  }
- newtype SharedSecret = SharedSecret ScrubbedBytes

# Documentation

data Curve_P256R1 #

P256 Curve

also known as P256

Constructors

Curve_P256R1 |

Instances

EllipticCurveArith Curve_P256R1 # |
Methods pointAdd :: proxy Curve_P256R1 -> Point Curve_P256R1 -> Point Curve_P256R1 -> Point Curve_P256R1 # pointSmul :: proxy Curve_P256R1 -> Scalar Curve_P256R1 -> Point Curve_P256R1 -> Point Curve_P256R1 #
EllipticCurveDH Curve_P256R1 # |
Methods ecdh :: proxy Curve_P256R1 -> Scalar Curve_P256R1 -> Point Curve_P256R1 -> SharedSecret #
EllipticCurve Curve_P256R1 # |
Associated Types type Point Curve_P256R1 :: * # type Scalar Curve_P256R1 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_P256R1 -> randomly (Scalar Curve_P256R1) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_P256R1 -> randomly (KeyPair Curve_P256R1) # curveSizeBits :: proxy Curve_P256R1 -> Int # encodePoint :: ByteArray bs => proxy Curve_P256R1 -> Point Curve_P256R1 -> bs # decodePoint :: ByteArray bs => proxy Curve_P256R1 -> bs -> CryptoFailable (Point Curve_P256R1) #
type Point Curve_P256R1 # |
type Point Curve_P256R1 = Point
type Scalar Curve_P256R1 # |
type Scalar Curve_P256R1 = Scalar

data Curve_P384R1 #

Constructors

Curve_P384R1 |

Instances

EllipticCurveArith Curve_P384R1 # |
Methods pointAdd :: proxy Curve_P384R1 -> Point Curve_P384R1 -> Point Curve_P384R1 -> Point Curve_P384R1 # pointSmul :: proxy Curve_P384R1 -> Scalar Curve_P384R1 -> Point Curve_P384R1 -> Point Curve_P384R1 #
EllipticCurveDH Curve_P384R1 # |
Methods ecdh :: proxy Curve_P384R1 -> Scalar Curve_P384R1 -> Point Curve_P384R1 -> SharedSecret #
EllipticCurve Curve_P384R1 # |
Associated Types type Point Curve_P384R1 :: * # type Scalar Curve_P384R1 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_P384R1 -> randomly (Scalar Curve_P384R1) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_P384R1 -> randomly (KeyPair Curve_P384R1) # curveSizeBits :: proxy Curve_P384R1 -> Int # encodePoint :: ByteArray bs => proxy Curve_P384R1 -> Point Curve_P384R1 -> bs # decodePoint :: ByteArray bs => proxy Curve_P384R1 -> bs -> CryptoFailable (Point Curve_P384R1) #
type Point Curve_P384R1 # |
type Point Curve_P384R1
type Scalar Curve_P384R1 # |
type Scalar Curve_P384R1

data Curve_P521R1 #

Constructors

Curve_P521R1 |

Instances

EllipticCurveArith Curve_P521R1 # |
Methods pointAdd :: proxy Curve_P521R1 -> Point Curve_P521R1 -> Point Curve_P521R1 -> Point Curve_P521R1 # pointSmul :: proxy Curve_P521R1 -> Scalar Curve_P521R1 -> Point Curve_P521R1 -> Point Curve_P521R1 #
EllipticCurveDH Curve_P521R1 # |
Methods ecdh :: proxy Curve_P521R1 -> Scalar Curve_P521R1 -> Point Curve_P521R1 -> SharedSecret #
EllipticCurve Curve_P521R1 # |
Associated Types type Point Curve_P521R1 :: * # type Scalar Curve_P521R1 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_P521R1 -> randomly (Scalar Curve_P521R1) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_P521R1 -> randomly (KeyPair Curve_P521R1) # curveSizeBits :: proxy Curve_P521R1 -> Int # encodePoint :: ByteArray bs => proxy Curve_P521R1 -> Point Curve_P521R1 -> bs # decodePoint :: ByteArray bs => proxy Curve_P521R1 -> bs -> CryptoFailable (Point Curve_P521R1) #
type Point Curve_P521R1 # |
type Point Curve_P521R1
type Scalar Curve_P521R1 # |
type Scalar Curve_P521R1

data Curve_X25519 #

Constructors

Curve_X25519 |

Instances

EllipticCurveDH Curve_X25519 # |
Methods ecdh :: proxy Curve_X25519 -> Scalar Curve_X25519 -> Point Curve_X25519 -> SharedSecret #
EllipticCurve Curve_X25519 # |
Associated Types type Point Curve_X25519 :: * # type Scalar Curve_X25519 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_X25519 -> randomly (Scalar Curve_X25519) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_X25519 -> randomly (KeyPair Curve_X25519) # curveSizeBits :: proxy Curve_X25519 -> Int # encodePoint :: ByteArray bs => proxy Curve_X25519 -> Point Curve_X25519 -> bs # decodePoint :: ByteArray bs => proxy Curve_X25519 -> bs -> CryptoFailable (Point Curve_X25519) #
type Point Curve_X25519 # |
type Point Curve_X25519 = PublicKey
type Scalar Curve_X25519 # |
type Scalar Curve_X25519 = SecretKey

data Curve_X448 #

Constructors

Curve_X448 |

Instances

EllipticCurveDH Curve_X448 # |
Methods ecdh :: proxy Curve_X448 -> Scalar Curve_X448 -> Point Curve_X448 -> SharedSecret #
EllipticCurve Curve_X448 # |
Associated Types type Point Curve_X448 :: * # type Scalar Curve_X448 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_X448 -> randomly (Scalar Curve_X448) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_X448 -> randomly (KeyPair Curve_X448) # curveSizeBits :: proxy Curve_X448 -> Int # encodePoint :: ByteArray bs => proxy Curve_X448 -> Point Curve_X448 -> bs # decodePoint :: ByteArray bs => proxy Curve_X448 -> bs -> CryptoFailable (Point Curve_X448) #
type Point Curve_X448 # |
type Point Curve_X448 = PublicKey
type Scalar Curve_X448 # |
type Scalar Curve_X448 = SecretKey

class EllipticCurve curve where #

Minimal complete definition

curveGenerateScalar, curveGenerateKeyPair, curveSizeBits, encodePoint, decodePoint

Associated Types

type Point curve :: * #

Point on an Elliptic Curve

type Scalar curve :: * #

Scalar in the Elliptic Curve domain

Methods

curveGenerateScalar :: MonadRandom randomly => proxy curve -> randomly (Scalar curve) #

Generate a new random scalar on the curve. The scalar will represent a number between 1 and the order of the curve non included

curveGenerateKeyPair :: MonadRandom randomly => proxy curve -> randomly (KeyPair curve) #

Generate a new random keypair

curveSizeBits :: proxy curve -> Int #

Get the curve size in bits

encodePoint :: ByteArray bs => proxy curve -> Point curve -> bs #

Encode a elliptic curve point into binary form

decodePoint :: ByteArray bs => proxy curve -> bs -> CryptoFailable (Point curve) #

Try to decode the binary form of an elliptic curve point

Instances

EllipticCurve Curve_X448 # |
Associated Types type Point Curve_X448 :: * # type Scalar Curve_X448 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_X448 -> randomly (Scalar Curve_X448) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_X448 -> randomly (KeyPair Curve_X448) # curveSizeBits :: proxy Curve_X448 -> Int # encodePoint :: ByteArray bs => proxy Curve_X448 -> Point Curve_X448 -> bs # decodePoint :: ByteArray bs => proxy Curve_X448 -> bs -> CryptoFailable (Point Curve_X448) #
EllipticCurve Curve_X25519 # |
Associated Types type Point Curve_X25519 :: * # type Scalar Curve_X25519 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_X25519 -> randomly (Scalar Curve_X25519) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_X25519 -> randomly (KeyPair Curve_X25519) # curveSizeBits :: proxy Curve_X25519 -> Int # encodePoint :: ByteArray bs => proxy Curve_X25519 -> Point Curve_X25519 -> bs # decodePoint :: ByteArray bs => proxy Curve_X25519 -> bs -> CryptoFailable (Point Curve_X25519) #
EllipticCurve Curve_P521R1 # |
Associated Types type Point Curve_P521R1 :: * # type Scalar Curve_P521R1 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_P521R1 -> randomly (Scalar Curve_P521R1) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_P521R1 -> randomly (KeyPair Curve_P521R1) # curveSizeBits :: proxy Curve_P521R1 -> Int # encodePoint :: ByteArray bs => proxy Curve_P521R1 -> Point Curve_P521R1 -> bs # decodePoint :: ByteArray bs => proxy Curve_P521R1 -> bs -> CryptoFailable (Point Curve_P521R1) #
EllipticCurve Curve_P384R1 # |
Associated Types type Point Curve_P384R1 :: * # type Scalar Curve_P384R1 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_P384R1 -> randomly (Scalar Curve_P384R1) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_P384R1 -> randomly (KeyPair Curve_P384R1) # curveSizeBits :: proxy Curve_P384R1 -> Int # encodePoint :: ByteArray bs => proxy Curve_P384R1 -> Point Curve_P384R1 -> bs # decodePoint :: ByteArray bs => proxy Curve_P384R1 -> bs -> CryptoFailable (Point Curve_P384R1) #
EllipticCurve Curve_P256R1 # |
Associated Types type Point Curve_P256R1 :: * # type Scalar Curve_P256R1 :: * # Methods curveGenerateScalar :: MonadRandom randomly => proxy Curve_P256R1 -> randomly (Scalar Curve_P256R1) # curveGenerateKeyPair :: MonadRandom randomly => proxy Curve_P256R1 -> randomly (KeyPair Curve_P256R1) # curveSizeBits :: proxy Curve_P256R1 -> Int # encodePoint :: ByteArray bs => proxy Curve_P256R1 -> Point Curve_P256R1 -> bs # decodePoint :: ByteArray bs => proxy Curve_P256R1 -> bs -> CryptoFailable (Point Curve_P256R1) #

class EllipticCurve curve => EllipticCurveDH curve where #

Minimal complete definition

ecdh

Methods

ecdh :: proxy curve -> Scalar curve -> Point curve -> SharedSecret #

Generate a Diffie hellman secret value.

This is generally just the .x coordinate of the resulting point, that is not hashed.

use `pointSmul` to keep the result in Point format.

Instances

EllipticCurveDH Curve_X448 # |
Methods ecdh :: proxy Curve_X448 -> Scalar Curve_X448 -> Point Curve_X448 -> SharedSecret #
EllipticCurveDH Curve_X25519 # |
Methods ecdh :: proxy Curve_X25519 -> Scalar Curve_X25519 -> Point Curve_X25519 -> SharedSecret #
EllipticCurveDH Curve_P521R1 # |
Methods ecdh :: proxy Curve_P521R1 -> Scalar Curve_P521R1 -> Point Curve_P521R1 -> SharedSecret #
EllipticCurveDH Curve_P384R1 # |
Methods ecdh :: proxy Curve_P384R1 -> Scalar Curve_P384R1 -> Point Curve_P384R1 -> SharedSecret #
EllipticCurveDH Curve_P256R1 # |
Methods ecdh :: proxy Curve_P256R1 -> Scalar Curve_P256R1 -> Point Curve_P256R1 -> SharedSecret #

class EllipticCurve curve => EllipticCurveArith curve where #

Minimal complete definition

pointAdd, pointSmul

Methods

pointAdd :: proxy curve -> Point curve -> Point curve -> Point curve #

Add points on a curve

pointSmul :: proxy curve -> Scalar curve -> Point curve -> Point curve #

Scalar Multiplication on a curve

Instances

EllipticCurveArith Curve_P521R1 # |
Methods pointAdd :: proxy Curve_P521R1 -> Point Curve_P521R1 -> Point Curve_P521R1 -> Point Curve_P521R1 # pointSmul :: proxy Curve_P521R1 -> Scalar Curve_P521R1 -> Point Curve_P521R1 -> Point Curve_P521R1 #
EllipticCurveArith Curve_P384R1 # |
Methods pointAdd :: proxy Curve_P384R1 -> Point Curve_P384R1 -> Point Curve_P384R1 -> Point Curve_P384R1 # pointSmul :: proxy Curve_P384R1 -> Scalar Curve_P384R1 -> Point Curve_P384R1 -> Point Curve_P384R1 #
EllipticCurveArith Curve_P256R1 # |
Methods pointAdd :: proxy Curve_P256R1 -> Point Curve_P256R1 -> Point Curve_P256R1 -> Point Curve_P256R1 # pointSmul :: proxy Curve_P256R1 -> Scalar Curve_P256R1 -> Point Curve_P256R1 -> Point Curve_P256R1 #

data KeyPair curve #

An elliptic curve key pair composed of the private part (a scalar), and the associated point.

Constructors

KeyPair |
Fields keypairGetPublic :: !(Point curve) keypairGetPrivate :: !(Scalar curve)

newtype SharedSecret #

Constructors

SharedSecret ScrubbedBytes |

Instances

Eq SharedSecret # |
Methods (==) :: SharedSecret -> SharedSecret -> Bool # (/=) :: SharedSecret -> SharedSecret -> Bool #
ByteArrayAccess SharedSecret # |
Methods length :: SharedSecret -> Int # withByteArray :: SharedSecret -> (Ptr p -> IO a) -> IO a #