package callipyge

  1. Overview
  2. Docs
package callipyge
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module CallipygeSource

Sourcetype _ key = private int array

Type of keys.

Sourceand public
Sourceand secret
Sourceand shared
Sourceval base : public key

The base point 9.

Sourceval secret_key_of_string : string -> secret key

secret_key_of_string v is secret key of a 32-bytes string v. It makes a fresh allocated secretkey.

Sourceval secret_key_of_int_array : int array -> secret key

secret_key_of_string v is secret key of a 32-bytes int array v. It only verifies v (no allocation).

Sourceval public_key_of_string : string -> public key

public_key_of_string v is public key of 32-bytes string v. Null public key (String.make 32 '\x00') is not allowed. It makes a fresh allocated publickey.

Sourceval public_key_of_int_array : int array -> public key

public_key_of_int_array v is public key of 32-bytes int array v. It only verifies v (no allocation). Null public key (Array.make 32 0) is not allowed.

Sourceval string_of_key : _ key -> string

string_of_key k makes a fresh allocated string of k.

Sourceval ecdh_inplace : out:int array -> secret:secret key -> public:public key -> unit

ecdh_inplace ~out ~secret ~public computes the shared secret between secret key secret and public key public. The result is stored in out.

Sourceval ecdh_base_inplace : out:int array -> secret:secret key -> unit

ecdh_base_inplace ~out ~secret is eqauivalent to ecdh with the secret key secret and the base point base, with the resulting public key stored in out.

Sourceval public_of_secret : secret key -> public key

public_of_secret k is public key of k. It makes a fresh allocated public key.

Sourceval shared : secret:secret key -> public:public key -> shared key

shared ~secret ~public computes the shared secret between secret key secret and public key public. It makes a fresh allocated result.

Sourceval public_key_of_shared : shared key -> public key

public_key_of_shared k maps k to be a public key.

Sourceval secret_key_of_shared : shared key -> secret key

secret_key_of_shared k maps k to be a secret key.

Sourceval pp_public_key : public key Fmt.t

pp_public_key ppf v prints public key v on ppf.

Sourceval pp_shared_key : shared key Fmt.t

pp_shared_key ppf v prints shared key v on ppf.

Sourceval equal_key : 'a key -> 'a key -> bool

equal_key k1 k2 returns true iff k1 = k2. Otherwise, it returns false.