/* * Copyright (C) 2011, 2012, 2013 Citrix Systems * * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the project nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #ifndef __LIB_TURN_MSG__ #define __LIB_TURN_MSG__ #include "ns_turn_ioaddr.h" #include "ns_turn_msg_defs.h" #ifdef __cplusplus extern "C" { #endif /////////////////////////////////// /** * Structure holding the STUN message Transaction ID */ #define STUN_TID_SIZE (12) typedef struct { /** * Binary array */ uint8_t tsx_id[STUN_TID_SIZE]; } stun_tid; typedef enum { TURN_CREDENTIALS_NONE = 0, TURN_CREDENTIALS_LONG_TERM, TURN_CREDENTIALS_SHORT_TERM, TURN_CREDENTIALS_UNDEFINED } turn_credential_type; /** * HMAC key */ typedef uint8_t hmackey_t[64]; typedef uint8_t password_t[STUN_MAX_PWD_SIZE + 1]; typedef unsigned long band_limit_t; /////////////////////////////////// typedef const void *stun_attr_ref; ////////////////////////////////////////////////////////////// int stun_tid_equals(const stun_tid *id1, const stun_tid *id2); void stun_tid_cpy(stun_tid *id_dst, const stun_tid *id_src); void stun_tid_generate(stun_tid *id); /////////////////////////////////////////////////////////////// uint16_t stun_make_type(uint16_t method); uint16_t stun_make_request(uint16_t method); uint16_t stun_make_indication(uint16_t method); uint16_t stun_make_success_response(uint16_t method); uint16_t stun_make_error_response(uint16_t method); /////////////////////////////////////////////////////////////// turn_time_t stun_adjust_allocate_lifetime(turn_time_t lifetime, turn_time_t max_allowed_lifetime, turn_time_t max_lifetime); ///////////// STR //////////////////////////////////////////////// int stun_method_str(uint16_t method, char *smethod); int stun_get_message_len_str(uint8_t *buf, size_t len, int padding, size_t *app_len); void stun_init_buffer_str(uint8_t *buf, size_t *len); void stun_init_command_str(uint16_t message_type, uint8_t *buf, size_t *len); void old_stun_init_command_str(uint16_t message_type, uint8_t *buf, size_t *len, uint32_t cookie); void stun_init_request_str(uint16_t method, uint8_t *buf, size_t *len); void stun_init_indication_str(uint16_t method, uint8_t *buf, size_t *len); void stun_init_success_response_str(uint16_t method, uint8_t *buf, size_t *len, stun_tid *id); void old_stun_init_success_response_str(uint16_t method, uint8_t *buf, size_t *len, stun_tid *id, uint32_t cookie); void stun_init_error_response_str(uint16_t method, uint8_t *buf, size_t *len, uint16_t error_code, const uint8_t *reason, stun_tid *id); void old_stun_init_error_response_str(uint16_t method, uint8_t *buf, size_t *len, uint16_t error_code, const uint8_t *reason, stun_tid *id, uint32_t cookie); int stun_init_channel_message_str(uint16_t chnumber, uint8_t *buf, size_t *len, int length, int do_padding); int stun_is_command_message_str(const uint8_t *buf, size_t blen); int old_stun_is_command_message_str(const uint8_t *buf, size_t blen, uint32_t *cookie); int stun_is_command_message_full_check_str(const uint8_t *buf, size_t blen, int must_check_fingerprint, int *fingerprint_present); int stun_is_command_message_offset_str(const uint8_t *buf, size_t blen, int offset); int stun_is_request_str(const uint8_t *buf, size_t len); int stun_is_success_response_str(const uint8_t *buf, size_t len); int stun_is_error_response_str(const uint8_t *buf, size_t len, int *err_code, uint8_t *err_msg, size_t err_msg_size); int stun_is_challenge_response_str(const uint8_t *buf, size_t len, int *err_code, uint8_t *err_msg, size_t err_msg_size, uint8_t *realm, uint8_t *nonce, uint8_t *server_name, int *oauth); int stun_is_response_str(const uint8_t *buf, size_t len); int stun_is_indication_str(const uint8_t *buf, size_t len); uint16_t stun_get_method_str(const uint8_t *buf, size_t len); uint16_t stun_get_msg_type_str(const uint8_t *buf, size_t len); int stun_is_channel_message_str(const uint8_t *buf, size_t *blen, uint16_t *chnumber, int mandatory_padding); int is_channel_msg_str(const uint8_t *buf, size_t blen); void stun_set_binding_request_str(uint8_t *buf, size_t *len); int stun_set_binding_response_str(uint8_t *buf, size_t *len, stun_tid *tid, const ioa_addr *reflexive_addr, int error_code, const uint8_t *reason, uint32_t cookie, int old_stun, int no_stun_backward_compatibility); int stun_is_binding_request_str(const uint8_t *buf, size_t len, size_t offset); int stun_is_binding_response_str(const uint8_t *buf, size_t len); void stun_tid_from_message_str(const uint8_t *buf, size_t len, stun_tid *id); void stun_tid_message_cpy(uint8_t *buf, const stun_tid *id); void stun_tid_generate_in_message_str(uint8_t *buf, stun_tid *id); int stun_get_command_message_len_str(const uint8_t *buf, size_t len); const uint8_t *get_default_reason(int error_code); int stun_attr_is_addr(stun_attr_ref attr); int stun_attr_get_type(stun_attr_ref attr); int stun_attr_get_len(stun_attr_ref attr); const uint8_t *stun_attr_get_value(stun_attr_ref attr); uint16_t stun_attr_get_channel_number(stun_attr_ref attr); band_limit_t stun_attr_get_bandwidth(stun_attr_ref attr); uint8_t stun_attr_get_even_port(stun_attr_ref attr); uint64_t stun_attr_get_reservation_token_value(stun_attr_ref attr); stun_attr_ref stun_attr_get_first_by_type_str(const uint8_t *buf, size_t len, uint16_t attr_type); stun_attr_ref stun_attr_get_first_str(const uint8_t *buf, size_t len); stun_attr_ref stun_attr_get_next_str(const uint8_t *buf, size_t len, stun_attr_ref prev); int stun_attr_add_str(uint8_t *buf, size_t *len, uint16_t attr, const uint8_t *avalue, int alen); int stun_attr_add_addr_str(uint8_t *buf, size_t *len, uint16_t attr_type, const ioa_addr *ca); int stun_attr_get_addr_str(const uint8_t *buf, size_t len, stun_attr_ref attr, ioa_addr *ca, const ioa_addr *default_addr); int stun_attr_get_first_addr_str(const uint8_t *buf, size_t len, uint16_t attr_type, ioa_addr *ca, const ioa_addr *default_addr); int stun_attr_add_channel_number_str(uint8_t *buf, size_t *len, uint16_t chnumber); int stun_attr_add_bandwidth_str(uint8_t *buf, size_t *len, band_limit_t bps); int stun_attr_add_address_error_code(uint8_t *buf, size_t *len, int requested_address_family, int error_code); /* return +1 if present, 0 if not, -1 if error: */ int stun_attr_get_address_error_code(uint8_t *buf, size_t len, int *requested_address_family, int *error_code); uint16_t stun_attr_get_first_channel_number_str(const uint8_t *buf, size_t len); int stun_set_allocate_request_str(uint8_t *buf, size_t *len, uint32_t lifetime, int af4, int af6, uint8_t transport, int mobile, const char *rt, int ep); int stun_set_allocate_response_str(uint8_t *buf, size_t *len, stun_tid *tid, const ioa_addr *relayed_addr1, const ioa_addr *relayed_addr2, const ioa_addr *reflexive_addr, uint32_t lifetime, uint32_t max_lifetime, int error_code, const uint8_t *reason, uint64_t reservation_token, char *mobile_id); uint16_t stun_set_channel_bind_request_str(uint8_t *buf, size_t *len, const ioa_addr *peer_addr, uint16_t channel_number); void stun_set_channel_bind_response_str(uint8_t *buf, size_t *len, stun_tid *tid, int error_code, const uint8_t *reason); int stun_get_requested_address_family(stun_attr_ref attr); int stun_attr_add_fingerprint_str(uint8_t *buf, size_t *len); int SASLprep(uint8_t *s); #define print_bin(str, len, field) print_bin_func(str, len, field, __FUNCTION__) void print_bin_func(const char *name, size_t len, const void *s, const char *func); /* * Return -1 if failure, 0 if the integrity is not correct, 1 if OK */ int stun_check_message_integrity_by_key_str(turn_credential_type ct, uint8_t *buf, size_t len, hmackey_t key, password_t pwd, SHATYPE shatype); int stun_check_message_integrity_str(turn_credential_type ct, uint8_t *buf, size_t len, const uint8_t *uname, const uint8_t *realm, const uint8_t *upwd, SHATYPE shatype); int stun_attr_add_integrity_str(turn_credential_type ct, uint8_t *buf, size_t *len, hmackey_t key, password_t pwd, SHATYPE shatype); int stun_attr_add_integrity_by_key_str(uint8_t *buf, size_t *len, const uint8_t *uname, const uint8_t *realm, hmackey_t key, const uint8_t *nonce, SHATYPE shatype); int stun_attr_add_integrity_by_user_str(uint8_t *buf, size_t *len, const uint8_t *uname, const uint8_t *realm, const uint8_t *upwd, const uint8_t *nonce, SHATYPE shatype); int stun_attr_add_integrity_by_user_short_term_str(uint8_t *buf, size_t *len, const uint8_t *uname, password_t pwd, SHATYPE shatype); size_t get_hmackey_size(SHATYPE shatype); /* * To be implemented with openssl */ #define TURN_RANDOM_SIZE (sizeof(long)) long turn_random(void); int stun_produce_integrity_key_str(const uint8_t *uname, const uint8_t *realm, const uint8_t *upwd, hmackey_t key, SHATYPE shatype); int stun_calculate_hmac(const uint8_t *buf, size_t len, const uint8_t *key, size_t sz, uint8_t *hmac, unsigned int *hmac_len, SHATYPE shatype); /* RFC 5780 */ int stun_attr_get_change_request_str(stun_attr_ref attr, int *change_ip, int *change_port); int stun_attr_add_change_request_str(uint8_t *buf, size_t *len, int change_ip, int change_port); int stun_attr_get_response_port_str(stun_attr_ref attr); int stun_attr_add_response_port_str(uint8_t *buf, size_t *len, uint16_t port); int stun_attr_get_padding_len_str(stun_attr_ref attr); int stun_attr_add_padding_str(uint8_t *buf, size_t *len, uint16_t padding_len); /* HTTP */ int is_http(const char *s, size_t blen); /* OAUTH */ int convert_oauth_key_data(const oauth_key_data *oakd, oauth_key *key, char *err_msg, size_t err_msg_size); int decode_oauth_token(const uint8_t *server_name, const encoded_oauth_token *etoken, const oauth_key *key, oauth_token *dtoken); int encode_oauth_token(const uint8_t *server_name, encoded_oauth_token *etoken, const oauth_key *key, const oauth_token *dtoken, const uint8_t *nonce); /* Encrypted password */ void generate_new_enc_password(const char *pwd, char *result); int check_password(const char *pin, const char *pwd); /////////////////////////////////////////////////////////////// #ifdef __cplusplus } #endif #endif //__LIB_TURN_MSG__