Skip to content

File noise.h

Headers > cais > noise.h

Go to the source code of this file

  • #include <stddef.h>
  • #include <cais/types.h>

Types

Type Name
enum cais_noise_action_t
enum cais_noise_pattern_t
enum cais_noise_role_t
typedef struct cais_noise cais_noise_t

Functions

Type Name
cais_noise_t * cais_noise_create (cais_noise_pattern_t pattern, cais_noise_role_t role, char * err_buf, size_t err_cap)
cais_status_t cais_noise_decrypt (cais_noise_t * noise, const void * cipher, size_t cipher_len, void * out_plain, size_t out_cap, size_t * out_len, char * err_buf, size_t err_cap)
cais_status_t cais_noise_encrypt (cais_noise_t * noise, const void * plain, size_t plain_len, void * out_cipher, size_t out_cap, size_t * out_len, char * err_buf, size_t err_cap)
void cais_noise_free (cais_noise_t * noise)
cais_noise_action_t cais_noise_get_action (const cais_noise_t * noise)
cais_status_t cais_noise_get_handshake_hash (const cais_noise_t * noise, unsigned char out_hash, char * err_buf, size_t err_cap)
const unsigned char * cais_noise_get_remote_static (const cais_noise_t * noise)
cais_status_t cais_noise_handshake_socket (cais_noise_t * noise, struct cais_socket * sock, char * err_buf, size_t err_cap)
cais_bool_t cais_noise_is_complete (const cais_noise_t * noise)
cais_status_t cais_noise_keygen (unsigned char priv, unsigned char pub, char * err_buf, size_t err_cap)
cais_status_t cais_noise_read_message (cais_noise_t * noise, const void * in_msg, size_t in_len, void * out_payload, size_t out_cap, size_t * out_payload_len, char * err_buf, size_t err_cap)
cais_status_t cais_noise_recv_socket (cais_noise_t * noise, struct cais_socket * sock, void * buf, size_t cap, size_t * received, char * err_buf, size_t err_cap)
cais_status_t cais_noise_seed (const void * entropy, size_t len)
cais_status_t cais_noise_send_socket (cais_noise_t * noise, struct cais_socket * sock, const void * data, size_t len, size_t * sent, char * err_buf, size_t err_cap)
cais_status_t cais_noise_set_ephemeral_key (cais_noise_t * noise, const unsigned char priv, char * err_buf, size_t err_cap)
cais_status_t cais_noise_set_prologue (cais_noise_t * noise, const void * prologue, size_t len, char * err_buf, size_t err_cap)
cais_status_t cais_noise_set_remote_key (cais_noise_t * noise, const unsigned char pub, char * err_buf, size_t err_cap)
cais_status_t cais_noise_set_static_key (cais_noise_t * noise, const unsigned char priv, char * err_buf, size_t err_cap)
cais_status_t cais_noise_start (cais_noise_t * noise, char * err_buf, size_t err_cap)
cais_status_t cais_noise_write_message (cais_noise_t * noise, const void * payload, size_t payload_len, void * out_msg, size_t out_cap, size_t * out_len, char * err_buf, size_t err_cap)

Macros

Type Name
define CAIS_NOISE_HASH_LEN 32
define CAIS_NOISE_KEY_LEN 32
define CAIS_NOISE_MAX_MSG_LEN 65535
define CAIS_NOISE_TAG_LEN 16

Type Details

enum cais_noise_action_t

enum cais_noise_action_t {
    CAIS_NOISE_ACTION_WRITE_MSG = 1,
    CAIS_NOISE_ACTION_READ_MSG = 2,
    CAIS_NOISE_ACTION_SPLIT = 3,
    CAIS_NOISE_ACTION_FAILED = -1
};

enum cais_noise_pattern_t

enum cais_noise_pattern_t {
    CAIS_NOISE_XX = 0,
    CAIS_NOISE_NN = 1,
    CAIS_NOISE_NK = 2,
    CAIS_NOISE_IK = 3
};

enum cais_noise_role_t

enum cais_noise_role_t {
    CAIS_NOISE_INITIATOR = 0,
    CAIS_NOISE_RESPONDER = 1
};

cais_noise_t

typedef struct cais_noise cais_noise_t;

Function Details

cais_noise_create

cais_noise_t * cais_noise_create (
    cais_noise_pattern_t pattern,
    cais_noise_role_t role,
    char * err_buf,
    size_t err_cap
) 

cais_noise_decrypt

cais_status_t cais_noise_decrypt (
    cais_noise_t * noise,
    const void * cipher,
    size_t cipher_len,
    void * out_plain,
    size_t out_cap,
    size_t * out_len,
    char * err_buf,
    size_t err_cap
) 

cais_noise_encrypt

cais_status_t cais_noise_encrypt (
    cais_noise_t * noise,
    const void * plain,
    size_t plain_len,
    void * out_cipher,
    size_t out_cap,
    size_t * out_len,
    char * err_buf,
    size_t err_cap
) 

cais_noise_free

void cais_noise_free (
    cais_noise_t * noise
) 

cais_noise_get_action

cais_noise_action_t cais_noise_get_action (
    const cais_noise_t * noise
) 

cais_noise_get_handshake_hash

cais_status_t cais_noise_get_handshake_hash (
    const cais_noise_t * noise,
    unsigned char out_hash,
    char * err_buf,
    size_t err_cap
) 

cais_noise_get_remote_static

const unsigned char * cais_noise_get_remote_static (
    const cais_noise_t * noise
) 

cais_noise_handshake_socket

cais_status_t cais_noise_handshake_socket (
    cais_noise_t * noise,
    struct cais_socket * sock,
    char * err_buf,
    size_t err_cap
) 

cais_noise_is_complete

cais_bool_t cais_noise_is_complete (
    const cais_noise_t * noise
) 

cais_noise_keygen

cais_status_t cais_noise_keygen (
    unsigned char priv,
    unsigned char pub,
    char * err_buf,
    size_t err_cap
) 

cais_noise_read_message

cais_status_t cais_noise_read_message (
    cais_noise_t * noise,
    const void * in_msg,
    size_t in_len,
    void * out_payload,
    size_t out_cap,
    size_t * out_payload_len,
    char * err_buf,
    size_t err_cap
) 

cais_noise_recv_socket

cais_status_t cais_noise_recv_socket (
    cais_noise_t * noise,
    struct cais_socket * sock,
    void * buf,
    size_t cap,
    size_t * received,
    char * err_buf,
    size_t err_cap
) 

cais_noise_seed

cais_status_t cais_noise_seed (
    const void * entropy,
    size_t len
) 

cais_noise_send_socket

cais_status_t cais_noise_send_socket (
    cais_noise_t * noise,
    struct cais_socket * sock,
    const void * data,
    size_t len,
    size_t * sent,
    char * err_buf,
    size_t err_cap
) 

cais_noise_set_ephemeral_key

cais_status_t cais_noise_set_ephemeral_key (
    cais_noise_t * noise,
    const unsigned char priv,
    char * err_buf,
    size_t err_cap
) 

cais_noise_set_prologue

cais_status_t cais_noise_set_prologue (
    cais_noise_t * noise,
    const void * prologue,
    size_t len,
    char * err_buf,
    size_t err_cap
) 

cais_noise_set_remote_key

cais_status_t cais_noise_set_remote_key (
    cais_noise_t * noise,
    const unsigned char pub,
    char * err_buf,
    size_t err_cap
) 

cais_noise_set_static_key

cais_status_t cais_noise_set_static_key (
    cais_noise_t * noise,
    const unsigned char priv,
    char * err_buf,
    size_t err_cap
) 

cais_noise_start

cais_status_t cais_noise_start (
    cais_noise_t * noise,
    char * err_buf,
    size_t err_cap
) 

cais_noise_write_message

cais_status_t cais_noise_write_message (
    cais_noise_t * noise,
    const void * payload,
    size_t payload_len,
    void * out_msg,
    size_t out_cap,
    size_t * out_len,
    char * err_buf,
    size_t err_cap
) 

Macro Details

CAIS_NOISE_HASH_LEN

#define CAIS_NOISE_HASH_LEN `32`

CAIS_NOISE_KEY_LEN

#define CAIS_NOISE_KEY_LEN `32`

CAIS_NOISE_MAX_MSG_LEN

#define CAIS_NOISE_MAX_MSG_LEN `65535`

CAIS_NOISE_TAG_LEN

#define CAIS_NOISE_TAG_LEN `16`


The documentation was generated from the following file: include/cais/noise.h