conn.h

Go to the documentation of this file.

/* *
 * Lightway Core
 * Copyright (C) 2021 Express VPN International Ltd.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef CONN_H
#define CONN_H

#include <he.h>

// Scale 1 second to wolf to 100ms
#define HE_WOLF_TIMEOUT_MULTIPLIER 100
#define HE_WOLF_RENEGOTIATION_TIMEOUT_MULTIPLIER 1000

he_conn_t *he_conn_create(void);

void he_conn_destroy(he_conn_t *conn);

he_return_code_t he_conn_is_valid_client(he_ssl_ctx_t *ssl_ctx, he_conn_t *conn);

he_return_code_t he_conn_is_valid_server(he_ssl_ctx_t *ssl_ctx, he_conn_t *conn);

int he_conn_set_username(he_conn_t *conn, const char *username);

const char *he_conn_get_username(const he_conn_t *conn);

bool he_conn_is_username_set(const he_conn_t *conn);

he_return_code_t he_conn_set_password(he_conn_t *conn, const char *password);

bool he_conn_is_password_set(const he_conn_t *conn);

he_return_code_t he_conn_set_auth_buffer(he_conn_t *conn, uint8_t auth_type, uint8_t *buffer,
                                         uint16_t length);
bool he_conn_is_auth_buffer_set(const he_conn_t *conn);

int he_conn_set_outside_mtu(he_conn_t *conn, int mtu);

int he_conn_get_outside_mtu(he_conn_t *conn);

bool he_conn_is_outside_mtu_set(he_conn_t *conn);

he_return_code_t he_conn_set_context(he_conn_t *conn, void *data);

void *he_conn_get_context(he_conn_t *conn);
he_return_code_t he_internal_conn_configure(he_conn_t *conn, he_ssl_ctx_t *ctx);

he_return_code_t he_conn_client_connect(he_conn_t *conn, he_ssl_ctx_t *ssl_ctx,
                                        he_plugin_chain_t *inside_plugins,
                                        he_plugin_chain_t *outside_plugins);

he_return_code_t he_conn_server_connect(he_conn_t *conn, he_ssl_ctx_t *ssl_ctx,
                                        he_plugin_chain_t *inside_plugins,
                                        he_plugin_chain_t *outside_plugins);

he_return_code_t he_conn_disconnect(he_conn_t *conn);

void he_internal_disconnect_and_shutdown(he_conn_t *conn);

void he_internal_change_conn_state(he_conn_t *conn, he_conn_state_t state);

he_return_code_t he_internal_send_message(he_conn_t *conn, uint8_t *message, uint16_t length);
he_return_code_t he_internal_send_goodbye(he_conn_t *conn);
he_return_code_t he_internal_send_auth(he_conn_t *conn);

he_return_code_t he_conn_send_keepalive(he_conn_t *conn);

he_return_code_t he_conn_schedule_renegotiation(he_conn_t *conn);
he_return_code_t he_internal_renegotiate_ssl(he_conn_t *conn);

void he_internal_update_timeout(he_conn_t *conn);

int he_conn_get_nudge_time(he_conn_t *conn);

he_return_code_t he_conn_nudge(he_conn_t *conn);

he_conn_state_t he_conn_get_state(he_conn_t *conn);

uint64_t he_conn_get_session_id(he_conn_t *conn);

he_return_code_t he_conn_set_session_id(he_conn_t *conn, uint64_t session_id);

uint64_t he_conn_get_pending_session_id(he_conn_t *conn);

bool he_conn_is_error_fatal(he_conn_t *conn, he_return_code_t error_msg);

he_return_code_t he_conn_rotate_session_id(he_conn_t *conn, uint64_t *new_session_id);

bool he_conn_supports_renegotiation(he_conn_t *conn);

void he_internal_generate_event(he_conn_t *conn, he_conn_event_t event);

he_return_code_t he_conn_set_protocol_version(he_conn_t *conn, uint8_t major_version,
                                              uint8_t minor_version);

size_t he_internal_calculate_data_packet_length(he_conn_t *conn, size_t length);

he_return_code_t he_internal_generate_session_id(he_conn_t *conn, uint64_t *session_id_out);

#endif  // CONN_H