A generic interface to Elliptic Curve Diffie-Hellman key exchange.

Collection Info

View Source
Collection
core
Path
crypto/ecdh
Entries
23
Constants 0
Types 3
Jump to Types
Curve Private_Key Public_Key
Procedures 16
Jump to Procedures
curve ecdh key_size private_key_bytes private_key_clear private_key_equal private_key_generate private_key_set private_key_set_bytes public_key_bytes public_key_clear public_key_equal public_key_set public_key_set_bytes public_key_set_priv shared_secret_size
Procedure Groups 0
Variables 4
Jump to Variables
CURVE_NAMES PRIVATE_KEY_SIZES PUBLIC_KEY_SIZES SHARED_SECRET_SIZES

Source Files

Types

3

Curve #

Source 
Curve :: Curve

Curve the curve identifier associated with a given Private_Key or Public_Key

Procedures

16

curve #

Source 
curve :: proc(k: ^$T) -> Curve {…}

curve returns the Curve used by a Private_Key or Public_Key instance.

ecdh #

Source 
@(require_results)
ecdh :: proc(priv_key: ^Private_Key, pub_key: ^Public_Key, dst: []u8) -> bool {…}

ecdh performs an Elliptic Curve Diffie-Hellman key exchange betwween the Private_Key and Public_Key, writing the shared secret to dst. The neutral element is rejected as an error.

key_size #

Source 
key_size :: proc(k: ^$T) -> int {…}

key_size returns the key size of a Private_Key or Public_Key in bytes.

private_key_bytes #

Source 
private_key_bytes :: proc(priv_key: ^Private_Key, dst: []u8) {…}

private_key_bytes sets dst to byte-encoding of priv_key.

private_key_clear #

Source 
private_key_clear :: proc "contextless" (priv_key: ^Private_Key) {…}

private_key_clear clears priv_key to the uninitialized state.

private_key_equal #

Source 
private_key_equal :: proc(p, q: ^Private_Key) -> bool {…}

private_key_equal returns true if and only if (⟺) the private keys are equal, in constant time.

private_key_generate #

Source 
private_key_generate :: proc(priv_key: ^Private_Key, curve: Curve) -> bool {…}

private_key_generate uses the system entropy source to generate a new Private_Key. This will only fail if and only if (⟺) the system entropy source is missing or broken.

private_key_set_bytes #

Source 
private_key_set_bytes :: proc(priv_key: ^Private_Key, curve: Curve, b: []u8) -> bool {…}

private_key_set_bytes decodes a byte-encoded private key, and returns true if and only if (⟺) the operation was successful.

public_key_bytes #

Source 
public_key_bytes :: proc(pub_key: ^Public_Key, dst: []u8) {…}

public_key_bytes sets dst to byte-encoding of pub_key.

public_key_clear #

Source 
public_key_clear :: proc "contextless" (pub_key: ^Public_Key) {…}

public_key_clear clears pub_key to the uninitialized state.

public_key_equal #

Source 
public_key_equal :: proc(p, q: ^Public_Key) -> bool {…}

public_key_equal returns true if and only if (⟺) the public keys are equal, in constant time.

public_key_set_bytes #

Source 
public_key_set_bytes :: proc(pub_key: ^Public_Key, curve: Curve, b: []u8) -> bool {…}

public_key_set_bytes decodes a byte-encoded public key, and returns true if and only if (⟺) the operation was successful.

public_key_set_priv #

Source 
public_key_set_priv :: proc(pub_key: ^Public_Key, priv_key: ^Private_Key) {…}

public_key_set_priv sets pub_key to the public component of priv_key.

shared_secret_size #

Source 
shared_secret_size :: proc(k: ^$T) -> int {…}

shared_secret_size returns the shared secret size of a key exchange in bytes.

Variables

4

CURVE_NAMES #

Source 
CURVE_NAMES: [Curve]string = [Curve]string{.Invalid = "Invalid", .SECP256R1 = "secp256r1", .SECP384R1 = "secp384r1", .X25519 = "X25519", .X448 = "X448"}

CURVE_NAMES is the Curve to curve name string.

PRIVATE_KEY_SIZES #

Source 
PRIVATE_KEY_SIZES: [Curve]int = [Curve]int{.Invalid = 0, .SECP256R1 = secec.SC_SIZE_P256R1, .SECP384R1 = secec.SC_SIZE_P384R1, .X25519 = x25519.SCALAR_SIZE, .X448 = x448.SCALAR_SIZE}

PRIVATE_KEY_SIZES is the Curve to private key size in bytes.

PUBLIC_KEY_SIZES #

Source 
PUBLIC_KEY_SIZES: [Curve]int = [Curve]int{.Invalid = 0, .SECP256R1 = 1 + 2 * secec.FE_SIZE_P256R1, .SECP384R1 = 1 + 2 * secec.FE_SIZE_P384R1, .X25519 = x25519.POINT_SIZE, .X448 = x448.POINT_SIZE}

PUBLIC_KEY_SIZES is the Curve to public key size in bytes.

SHARED_SECRET_SIZES #

Source 
SHARED_SECRET_SIZES: [Curve]int = [Curve]int{.Invalid = 0, .SECP256R1 = secec.FE_SIZE_P256R1, .SECP384R1 = secec.FE_SIZE_P384R1, .X25519 = x25519.POINT_SIZE, .X448 = x448.POINT_SIZE}

SHARED_SECRET_SIZES is the Curve to shared secret size in bytes.