ra8_tls.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"
 
/* =============================================================================
 * Limits
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_tls_max_sessions = 4U,
  k_ra8_tls_cipher_name_cap = 48U,
} ra8_tls_limits_t;

typedef enum : uint16_t {
  k_ra8_tls_ipv4_hdr_bytes = 20U,  
  k_ra8_tls_tcp_hdr_bytes  = 20U,  
  k_ra8_tls_mtu_min        = 128U, 
  k_ra8_tls_mss_min        = 64U,  
} ra8_tls_net_const_t;

typedef enum : uint8_t {
  k_ra8_tls_verify_default  = 0U, 
  k_ra8_tls_verify_none     = 1U, 
  k_ra8_tls_verify_optional = 2U, 
  k_ra8_tls_verify_required = 3U, 
} ra8_tls_verify_mode_t;
 
/* =============================================================================
 * BIO callback signatures
 * =============================================================================
 */

typedef int (*ra8_tls_bio_send_fn)(void* ctx, const uint8_t* buf, size_t len);

typedef int (*ra8_tls_bio_recv_fn)(void* ctx, uint8_t* buf, size_t len);
 
/* =============================================================================
 * Configuration
 * =============================================================================
 */

typedef struct ra8_tls_session_cfg {
  ra8_tls_bio_send_fn   bio_send;    
  ra8_tls_bio_recv_fn   bio_recv;    
  void*                 bio_ctx;     
  const char*           server_name; 
  ra8_tls_verify_mode_t verify_mode; 
  const char*           ca_pem;      
  size_t                ca_pem_len;  
} ra8_tls_session_cfg_t;
 
/* =============================================================================
 * Opaque session handle
 * =============================================================================
 */

struct ra8_tls_session_handle;

typedef struct ra8_tls_session_handle* ra8_tls_session_t;
 
/* =============================================================================
 * Public API
 * =============================================================================
 */

ra8_err_t ra8_tls_global_init(void);

ra8_err_t ra8_tls_global_deinit(void);

ra8_err_t ra8_tls_session_open(ra8_tls_session_t* out_session, const ra8_tls_session_cfg_t* cfg);

ra8_err_t ra8_tls_session_close(ra8_tls_session_t session);

ra8_err_t ra8_tls_handshake(ra8_tls_session_t session);

ra8_err_t ra8_tls_send(ra8_tls_session_t session, const uint8_t* buf, size_t len, size_t* out_sent);

ra8_err_t ra8_tls_recv(ra8_tls_session_t session, uint8_t* buf, size_t len, size_t* out_received);
 
/* =============================================================================
 * Session introspection
 * =============================================================================
 */

ra8_err_t ra8_tls_get_cipher_suite(ra8_tls_session_t session,
                                   uint16_t*         out_id,
                                   char*             out_name,
                                   size_t            name_cap);

ra8_err_t ra8_tls_get_verify_result(ra8_tls_session_t session, uint32_t* out_flags);

ra8_err_t ra8_tls_mss_clamp(uint16_t mtu, uint16_t* out_mss);
 
#ifdef __cplusplus
}
#endif