package mec

You can search for identifiers within the package.

in-package search v0.2.0

Mec - Mini Elliptic Curve library

Install

Dune Dependency

gitlab.com Readme Edit opam file Versions (1)

Authors

D

Danny Willems <be.danny.willems@gmail.com>

Maintainers

D

Danny Willems <be.danny.willems@gmail.com>

Sources

ocaml-ec-0.1.0.tar.bz2

md5=7c68b531c8011b5d032f0a0d8523e8c5

sha512=f428751c5f2b7c7fc07548551bea0277c9c8c32c1052aecf22787188e7678939dbb091844e29178b2819d724cf843c65774d9211c0a0ede5bf71caff3f2dd1bc

doc/mec_curve_utils/Mec_curve_utils/Ec/MakeAffineMontgomery/index.html

Module `Ec.MakeAffineMontgomery`Source

Parameters

module Fq : Ff_sig.PRIME

module Fp : Ff_sig.PRIME

module Params : sig ... end

Signature

by^2 = x3 + ax^2 + x with b * (a^2 - 4) != 0

include Mec_curve_sig.Ec_sig.MontgomeryT
  with type Scalar.t = Fp.t
  with type Base.t = Fq.t

include Mec_curve_sig.Ec_sig.BASE
  with type Scalar.t = Fp.t
  with type Base.t = Fq.t

Sourceexception Not_on_curve of Bytes.t

Sourcetype t

Represents an element on the curve. In the case of a curve with a cofactor, the element is not necessarily in the prime subgroup.

Sourceval size_in_bytes : int

The size of a point representation, in bytes

Sourcemodule Scalar : Ff_sig.PRIME with type t = Fp.t

Sourcemodule Base : Ff_sig.PRIME with type t = Fq.t

Sourceval check_bytes : Bytes.t -> bool

Check if a point, represented as a byte array, is on the curve *

Sourceval of_bytes_opt : Bytes.t -> t option

Attempt to construct a point from a byte array

Sourceval of_bytes_exn : Bytes.t -> t

Attempt to construct a point from a byte array. Raise Not_on_curve if the point is not on the curve

Sourceval to_bytes : t -> Bytes.t

Return a representation in bytes

Sourceval zero : t

Zero of the elliptic curve

Sourceval one : t

A fixed generator of the elliptic curve

Sourceval is_zero : t -> bool

Return true if the given element is zero

Sourceval random : ?state:Random.State.t -> unit -> t

Generate a random element

Sourceval add : t -> t -> t

Return the addition of two element

Sourceval double : t -> t

Double the element

Sourceval negate : t -> t

Return the opposite of the element

Sourceval eq : t -> t -> bool

Return true if the two elements are algebraically the same

Sourceval mul : t -> Scalar.t -> t

Multiply an element by a scalar

Sourceval a : Base.t

Sourceval b : Base.t

Sourceval cofactor : Z.t

Sourceval is_on_curve : x:Base.t -> y:Base.t -> bool

is_on_curve ~x ~y returns true if the coordinates (x, y) represents a point on the curve. It does not check the point is in the prime subgroup.

Sourceval is_in_prime_subgroup : x:Base.t -> y:Base.t -> bool

is_in_prime_subgroup ~x ~y returns true if the coordinates (x, y) represents a point in the prime subgroup. The coordinates must be a point on the curve

Sourceval get_x_coordinate : t -> Base.t

Sourceval get_y_coordinate : t -> Base.t

Source

val to_twisted_curve_parameters : 
  unit ->
  (Base.t * Base.t * Z.t * (Base.t * Base.t)) option

Sourceval to_twisted : t -> (Base.t * Base.t) option

Source

val to_weierstrass_curve_parameters : 
  unit ->
  (Base.t * Base.t * Z.t * (Base.t * Base.t)) option

Sourceval to_weierstrass : t -> (Base.t * Base.t) option

Sourceval from_coordinates_opt : x:Base.t -> y:Base.t -> t option

Build a point from the affine coordinates. If the point is not on the curve and in the subgroup, returns None

Sourceval from_coordinates_exn : x:Base.t -> y:Base.t -> t

Build a point from the affine coordinates. If the point is not on the curve and in the subgroup, raise Not_on_curve.

Sourceval of_compressed_bytes_exn : Bytes.t -> t

Build a point from a compressed representation. It supposes the base field leaves at least a free bit in the last byte to encode the sign. Raise Not_on_curve if the bytes do not represent a point on the curve and in the prime subgroup.

Sourceval of_compressed_bytes_opt : Bytes.t -> t option

Same than of_compressed_bytes_exn but returns an option instead of raising an exception

Sourceval to_compressed_bytes : t -> Bytes.t

Return the compressed representation of the point

On This Page

Parameters
Signature