Loading...
Searching...
No Matches
stun_common.h
Go to the documentation of this file.
/*
* This file is part of the Sofia-SIP package
*
* Copyright (C) 2005 Nokia Corporation.
*
* Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
*/
#ifndef STUN_COMMON_H
#define STUN_COMMON_H
#include <sofia-sip/su_localinfo.h>
SOFIA_BEGIN_DECLS
/* Define Message Types */
#define BINDING_REQUEST 0x0001
#define BINDING_RESPONSE 0x0101
#define BINDING_ERROR_RESPONSE 0x0111
#define SHARED_SECRET_REQUEST 0x0002
#define SHARED_SECRET_RESPONSE 0x0102
#define SHARED_SECRET_ERROR_RESPONSE 0x0112
/* Define Attribute Types */
#define MAPPED_ADDRESS 0x0001
#define RESPONSE_ADDRESS 0x0002
#define CHANGE_REQUEST 0x0003
#define SOURCE_ADDRESS 0x0004
#define CHANGED_ADDRESS 0x0005
#define USERNAME 0x0006
#define PASSWORD 0x0007
#define MESSAGE_INTEGRITY 0x0008
#define ERROR_CODE 0x0009
#define UNKNOWN_ATTRIBUTES 0x000a
#define REFLECTED_FROM 0x000b
#define STUN_A_REALM 0x0014 /* XXX: check value in 3489bis-05+ */
#define STUN_A_NONCE 0x0015 /* XXX: check value in 3489bis-05+ */
#define STUN_A_XOR_MAPPED_ADDRESS 0x0020
#define STUN_A_FINGERPRINT 0x0023
#define STUN_A_SERVER 0x8022
#define STUN_A_ALTERNATE_SERVER 0x8023
#define STUN_A_REFRESH_INTERVAL 0x8024
/* Defines for mandatory and optional attributes */
#define STUN_A_LAST_MANDATORY 0x0023
#define STUN_A_OPTIONAL 0x7fff
/* Compability attribute types */
#define STUN_A_ALTERNATE_SERVER_DEP 0x000e
#define STUN_A_BUGGYSERVER_XORONLY 0x0021
#define STUN_A_BUGGYSERVER_SERVER 0x0022
#define LARGEST_ATTRIBUTE STUN_A_LAST_MANDATORY
#define OPTIONAL_ATTRIBUTE STUN_A_OPTIONAL
/* Stun response codes */
#define STUN_400_BAD_REQUEST 400
#define STUN_401_UNAUTHORIZED 401
#define STUN_420_UNKNOWN_ATTRIBUTE 420
#define STUN_430_STALE_CREDENTIALS 430
#define STUN_431_INTEGRITY_CHECK_FAILURE 431
#define STUN_432_MISSING_USERNAME 432
#define STUN_433_USE_TLS 433
#define STUN_500_SERVER_ERROR 500
#define STUN_600_GLOBAL_FAILURE 600
/* flags for CHANGE_REQUEST */
#define STUN_CR_CHANGE_IP 0x0004
#define STUN_CR_CHANGE_PORT 0x0002
/* mask for ERROR_CODE */
#define STUN_EC_CLASS 0x0070
#define STUN_EC_NUM 0x000F
#define RAND_MAX_16 65535
#define STUN_TID_BYTES 16
/* other protocol specific parameters */
#define STUN_MAX_RETRX 5 /* should be 8? */
#define STUN_MAX_RETRX_INT 1600
#define STUN_DEFAULT_PORT 3478
/*
* STUN header format
*/
/*
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| message type | message length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
| Transaction ID |
| |
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
struct stun_buffer_s {
unsigned char *data;
unsigned size;
};
typedef struct stun_buffer_s stun_buffer_t;
typedef struct {
uint16_t msg_type;
uint16_t msg_len;
uint8_t tran_id[16];
} stun_hdr_t;
typedef struct stun_attr_s {
uint16_t attr_type;
void *pattr;
stun_buffer_t enc_buf;
struct stun_attr_s *next;
} stun_attr_t;
typedef struct {
stun_hdr_t stun_hdr;
stun_attr_t *stun_attr;
stun_buffer_t enc_buf;
} stun_msg_t;
/* stun attribute definition */
/* stun_sockaddr_t is used for:
MAPPED_ADDRESS
RESPONSE_ADDRESS
SOURCE_ADDRESS
CHANGED_ADDRESS
REFLECTED_FROM
*/
typedef struct sockaddr_in stun_attr_sockaddr_t;
/* CHANGE_REQUEST attribute */
typedef struct stun_attr_uint32_s {
uint32_t value;
} stun_attr_uint32_t;
typedef stun_attr_uint32_t stun_attr_changerequest_t;
/* ERROR_CODE attribute */
typedef struct {
int code;
char *phrase;
} stun_attr_errorcode_t;
/* USERNAME attribute */
/* typedef struct {
stun_buffer_t *uname;
} stun_attr_username_t;
*/
typedef stun_buffer_t stun_attr_username_t;
/* PASSWORD attribute */
typedef stun_buffer_t stun_attr_password_t;
/* UNKNOWN_ATTRIBUTES attribute */
typedef struct stun_attr_unknownattributes_s{
uint16_t attr_type[2];
struct stun_attr_unknownattributes_s *next;
} stun_attr_unknownattributes_t;
/* Common functions */
int stun_parse_message(stun_msg_t *msg);
int stun_parse_attribute(stun_msg_t *msg, unsigned char *p, size_t left_len);
int stun_parse_attr_address(stun_attr_t *attr, const unsigned char *p, unsigned len);
int stun_parse_attr_error_code(stun_attr_t *attr, const unsigned char *p, unsigned len);
int stun_parse_attr_unknown_attributes(stun_attr_t *attr, const unsigned char *p, unsigned len);
int stun_parse_attr_uint32(stun_attr_t *attr, const unsigned char *p, unsigned len);
int stun_parse_attr_buffer(stun_attr_t *attr, const unsigned char *p, unsigned len);
stun_attr_t *stun_get_attr(stun_attr_t *attr, uint16_t attr_type);
int stun_encode_address(stun_attr_t *attr);
int stun_encode_uint32(stun_attr_t *attr);
int stun_encode_buffer(stun_attr_t *attr);
int stun_encode_error_code(stun_attr_t *attr);
int stun_encode_message_integrity(stun_attr_t *attr, unsigned char *buf, int len, stun_buffer_t *pwd);
int stun_encode_type_len(stun_attr_t *attr, uint16_t len);
int stun_encode_response_address(stun_attr_t *attr);
int stun_validate_message_integrity(stun_msg_t *msg, stun_buffer_t *pwd);
int stun_copy_buffer(stun_buffer_t *p, stun_buffer_t *p2);
void stun_init_buffer(stun_buffer_t *p);
int stun_free_buffer(stun_buffer_t *p);
int stun_free_message(stun_msg_t *msg);
int stun_init_message(stun_msg_t *msg);
/* int stun_send_message(int sockfd, struct sockaddr_in *to_addr, stun_msg_t *msg, stun_buffer_t *pwd); */
int stun_encode_message(stun_msg_t *msg, stun_buffer_t *pwd);
char const *stun_response_phrase(int status);
void debug_print(stun_buffer_t *buf);
char const *stun_attr_phrase(uint16_t type);
char *stun_determine_ip_address(int family);
SOFIA_END_DECLS
#endif /* !defined STUN_COMMON_H */
stun_encode_type_len
int stun_encode_type_len(stun_attr_t *attr, uint16_t len)
this function allocates the enc_buf, fills in type, length
Definition stun_common.c:500
stun_encode_address
int stun_encode_address(stun_attr_t *attr)
The set of functions encodes the corresponding attribute to network format, and save the result to th...
Definition stun_common.c:377
stun_get_attr
stun_attr_t * stun_get_attr(stun_attr_t *attr, uint16_t attr_type)
scan thru attribute list and return the next requested attr
Definition stun_common.c:313
stun_determine_ip_address
char * stun_determine_ip_address(int family)
Determines and returns local IP address.
Definition stun_common.c:788
stun_encode_message
int stun_encode_message(stun_msg_t *msg, stun_buffer_t *pwd)
Send a STUN message.
Definition stun_common.c:685
stun_validate_message_integrity
int stun_validate_message_integrity(stun_msg_t *msg, stun_buffer_t *pwd)
Validate the message integrity based on given STUN password 'pwd'.
Definition stun_common.c:521
su_localinfo.h
uint32_t
SU_U32_T uint32_t
uint16_t
SU_U16_T uint16_t
uint8_t
SU_U8_T uint8_t

Sofia-SIP 1.12.11devel - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.