StunMessage

StunMessage — STUN messages parsing and formatting functions

Stability Level

Stable, unless otherwise indicated

Synopsis


#include <stun/stunmessage.h>

                    StunMessage;
enum                StunClass;
enum                StunMethod;
enum                StunAttribute;
typedef             StunTransactionId;
enum                StunError;
enum                StunMessageReturn;
#define             STUN_MESSAGE_BUFFER_INCOMPLETE
#define             STUN_MESSAGE_BUFFER_INVALID
bool                stun_message_init                   (StunMessage *msg,
                                                         StunClass c,
                                                         StunMethod m,
                                                         const StunTransactionId id);
uint16_t            stun_message_length                 (const StunMessage *msg);
const void*         stun_message_find                   (const StunMessage *msg,
                                                         StunAttribute type,
                                                         uint16_t *palen);
StunMessageReturn   stun_message_find_flag              (const StunMessage *msg,
                                                         StunAttribute type);
StunMessageReturn   stun_message_find32                 (const StunMessage *msg,
                                                         StunAttribute type,
                                                         uint32_t *pval);
StunMessageReturn   stun_message_find64                 (const StunMessage *msg,
                                                         StunAttribute type,
                                                         uint64_t *pval);
StunMessageReturn   stun_message_find_string            (const StunMessage *msg,
                                                         StunAttribute type,
                                                         char *buf,
                                                         size_t buflen);
StunMessageReturn   stun_message_find_addr              (const StunMessage *msg,
                                                         StunAttribute type,
                                                         struct sockaddr *addr,
                                                         socklen_t *addrlen);
StunMessageReturn   stun_message_find_xor_addr          (const StunMessage *msg,
                                                         StunAttribute type,
                                                         struct sockaddr *addr,
                                                         socklen_t *addrlen);
StunMessageReturn   stun_message_find_xor_addr_full     (const StunMessage *msg,
                                                         StunAttribute type,
                                                         struct sockaddr *addr,
                                                         socklen_t *addrlen,
                                                         uint32_t magic_cookie);
StunMessageReturn   stun_message_find_error             (const StunMessage *msg,
                                                         int *code);
void*               stun_message_append                 (StunMessage *msg,
                                                         StunAttribute type,
                                                         size_t length);
StunMessageReturn   stun_message_append_bytes           (StunMessage *msg,
                                                         StunAttribute type,
                                                         const void *data,
                                                         size_t len);
StunMessageReturn   stun_message_append_flag            (StunMessage *msg,
                                                         StunAttribute type);
StunMessageReturn   stun_message_append32               (StunMessage *msg,
                                                         StunAttribute type,
                                                         uint32_t value);
StunMessageReturn   stun_message_append64               (StunMessage *msg,
                                                         StunAttribute type,
                                                         uint64_t value);
StunMessageReturn   stun_message_append_string          (StunMessage *msg,
                                                         StunAttribute type,
                                                         const char *str);
StunMessageReturn   stun_message_append_addr            (StunMessage *msg,
                                                         StunAttribute type,
                                                         const struct sockaddr *addr,
                                                         socklen_t addrlen);
StunMessageReturn   stun_message_append_xor_addr        (StunMessage *msg,
                                                         StunAttribute type,
                                                         const struct sockaddr *addr,
                                                         socklen_t addrlen);
StunMessageReturn   stun_message_append_xor_addr_full   (StunMessage *msg,
                                                         StunAttribute type,
                                                         const struct sockaddr *addr,
                                                         socklen_t addrlen,
                                                         uint32_t magic_cookie);
StunMessageReturn   stun_message_append_error           (StunMessage *msg,
                                                         StunError code);
int                 stun_message_validate_buffer_length (const uint8_t *msg,
                                                         size_t length);
void                stun_message_id                     (const StunMessage *msg,
                                                         StunTransactionId id);
StunClass           stun_message_get_class              (const StunMessage *msg);
StunMethod          stun_message_get_method             (const StunMessage *msg);
bool                stun_message_has_attribute          (const StunMessage *msg,
                                                         StunAttribute type);
bool                stun_message_has_cookie             (const StunMessage *msg);
bool                stun_optional                       (uint16_t t);
const char*         stun_strerror                       (StunError code);

Description

The STUN Messages API allows you to create STUN messages easily as well as to parse existing messages.

Details

StunMessage

typedef struct {
  StunAgent *agent;
  uint8_t *buffer;
  size_t buffer_len;
  uint8_t *key;
  size_t key_len;
  uint8_t long_term_key[16];
  bool long_term_valid;
} StunMessage;

This structure represents a STUN message

StunAgent *agent; The agent that created or validated this message
uint8_t *buffer; The buffer containing the STUN message
size_t buffer_len; The length of the buffer (not the size of the message)
uint8_t *key; The short term credentials key to use for authentication validation or that was used to finalize this message
size_t key_len; The length of the associated key
uint8_t long_term_key[16]; The long term credential key to use for authentication validation or that was used to finalize this message
bool long_term_valid; Whether or not the long_term_key variable contains valid data

enum StunClass

typedef enum
{
  STUN_REQUEST=0,
  STUN_INDICATION=1,
  STUN_RESPONSE=2,
  STUN_ERROR=3
} StunClass;

This enum is used to represent the class of a STUN message, as defined in RFC5389

STUN_REQUEST A STUN Request message
STUN_INDICATION A STUN indication message
STUN_RESPONSE A STUN Response message
STUN_ERROR A STUN Error message

enum StunMethod

typedef enum
{
  STUN_BINDING=0x001,    /* RFC5389 */
  STUN_SHARED_SECRET=0x002,  /* old RFC3489 */
  STUN_ALLOCATE=0x003,    /* TURN-12 */
  STUN_SET_ACTIVE_DST=0x004,  /* TURN-04 */
  STUN_REFRESH=0x004,  /* TURN-12 */
  STUN_SEND=0x004,  /* TURN-00 */
  STUN_CONNECT=0x005,    /* TURN-04 */
  STUN_OLD_SET_ACTIVE_DST=0x006,  /* TURN-00 */
  STUN_IND_SEND=0x006,    /* TURN-12 */
  STUN_IND_DATA=0x007,    /* TURN-12 */
  STUN_IND_CONNECT_STATUS=0x008,  /* TURN-04 */
  STUN_CREATEPERMISSION= 0x008, /* TURN-12 */
  STUN_CHANNELBIND= 0x009 /* TURN-12 */
} StunMethod;

This enum is used to represent the method of a STUN message, as defined by various RFCs

STUN_BINDING The Binding method as defined by the RFC5389
STUN_SHARED_SECRET The Shared-Secret method as defined by the RFC3489
STUN_ALLOCATE The Allocate method as defined by the TURN draft 12
STUN_SET_ACTIVE_DST The Set-Active-Destination method as defined by the TURN draft 4
STUN_REFRESH The Refresh method as defined by the TURN draft 12
STUN_SEND The Send method as defined by the TURN draft 00
STUN_CONNECT The Connect method as defined by the TURN draft 4
STUN_OLD_SET_ACTIVE_DST The older Set-Active-Destination method as defined by the TURN draft 0
STUN_IND_SEND The Send method used in indication messages as defined by the TURN draft 12
STUN_IND_DATA The Data method used in indication messages as defined by the TURN draft 12
STUN_IND_CONNECT_STATUS The Connect-Status method used in indication messages as defined by the TURN draft 4
STUN_CREATEPERMISSION The CreatePermission method as defined by the TURN draft 12
STUN_CHANNELBIND The ChannelBind method as defined by the TURN draft 12

enum StunAttribute

typedef enum
{
  /* Mandatory attributes */
  /* 0x0000 */        /* reserved */
  STUN_ATTRIBUTE_MAPPED_ADDRESS=0x0001,    /* RFC5389 */
  STUN_ATTRIBUTE_RESPONSE_ADDRESS=0x0002,  /* old RFC3489 */
  STUN_ATTRIBUTE_CHANGE_REQUEST=0x0003,    /* old RFC3489 */
  STUN_ATTRIBUTE_SOURCE_ADDRESS=0x0004,    /* old RFC3489 */
  STUN_ATTRIBUTE_CHANGED_ADDRESS=0x0005,  /* old RFC3489 */
  STUN_ATTRIBUTE_USERNAME=0x0006,      /* RFC5389 */
  STUN_ATTRIBUTE_PASSWORD=0x0007,    /* old RFC3489 */
  STUN_ATTRIBUTE_MESSAGE_INTEGRITY=0x0008,    /* RFC5389 */
  STUN_ATTRIBUTE_ERROR_CODE=0x0009,      /* RFC5389 */
  STUN_ATTRIBUTE_UNKNOWN_ATTRIBUTES=0x000A,    /* RFC5389 */
  STUN_ATTRIBUTE_REFLECTED_FROM=0x000B,    /* old RFC3489 */
  STUN_ATTRIBUTE_CHANNEL_NUMBER=0x000C,        /* TURN-12 */
  STUN_ATTRIBUTE_LIFETIME=0x000D,      /* TURN-12 */
  /* 0x000E */        /* reserved (was ALTERNATE-SERVER from midcom-TURN 08 */
  STUN_ATTRIBUTE_MAGIC_COOKIE=0x000F,        /* midcom-TURN 08 */
  STUN_ATTRIBUTE_BANDWIDTH=0x0010,      /* TURN-04 */
  STUN_ATTRIBUTE_DESTINATION_ADDRESS=0x0011,        /* midcom-TURN 08 */
  STUN_ATTRIBUTE_REMOTE_ADDRESS=0x0012,    /* TURN-04 */
  STUN_ATTRIBUTE_PEER_ADDRESS=0x0012,    /* TURN-09 */
  STUN_ATTRIBUTE_XOR_PEER_ADDRESS=0x0012,    /* TURN-12 */
  STUN_ATTRIBUTE_DATA=0x0013,      /* TURN-12 */
  STUN_ATTRIBUTE_REALM=0x0014,      /* RFC5389 */
  STUN_ATTRIBUTE_NONCE=0x0015,      /* RFC5389 */
  STUN_ATTRIBUTE_RELAY_ADDRESS=0x0016,    /* TURN-04 */
  STUN_ATTRIBUTE_RELAYED_ADDRESS=0x0016,    /* TURN-09 */
  STUN_ATTRIBUTE_XOR_RELAYED_ADDRESS=0x0016,    /* TURN-12 */
  STUN_ATTRIBUTE_REQUESTED_ADDRESS_TYPE=0x0017,  /* TURN-IPv6-05 */
  STUN_ATTRIBUTE_REQUESTED_PORT_PROPS=0x0018,  /* TURN-04 */
  STUN_ATTRIBUTE_REQUESTED_PROPS=0x0018,  /* TURN-09 */
  STUN_ATTRIBUTE_EVEN_PORT=0x0018,  /* TURN-12 */
  STUN_ATTRIBUTE_REQUESTED_TRANSPORT=0x0019,  /* TURN-12 */
  STUN_ATTRIBUTE_DONT_FRAGMENT=0x001A,  /* TURN-12 */
  /* 0x001B */        /* reserved */
  /* 0x001C */        /* reserved */
  /* 0x001D */        /* reserved */
  /* 0x001E */        /* reserved */
  /* 0x001F */        /* reserved */
  STUN_ATTRIBUTE_XOR_MAPPED_ADDRESS=0x0020,    /* RFC5389 */
  STUN_ATTRIBUTE_TIMER_VAL=0x0021,      /* TURN-04 */
  STUN_ATTRIBUTE_REQUESTED_IP=0x0022,    /* TURN-04 */
  STUN_ATTRIBUTE_RESERVATION_TOKEN=0x0022,    /* TURN-09 */
  STUN_ATTRIBUTE_CONNECT_STAT=0x0023,    /* TURN-04 */
  STUN_ATTRIBUTE_PRIORITY=0x0024,      /* ICE-19 */
  STUN_ATTRIBUTE_USE_CANDIDATE=0x0025,    /* ICE-19 */
  /* 0x0026 */        /* reserved */
  /* 0x0027 */        /* reserved */
  /* 0x0028 */        /* reserved */
  /* 0x0029 */        /* reserved */
  /* 0x002A-0x7fff */      /* reserved */

  /* Optional attributes */
  /* 0x8000-0x8021 */      /* reserved */
  STUN_ATTRIBUTE_OPTIONS=0x8001, /* libjingle */
  STUN_ATTRIBUTE_SOFTWARE=0x8022,      /* RFC5389 */
  STUN_ATTRIBUTE_ALTERNATE_SERVER=0x8023,    /* RFC5389 */
  /* 0x8024 */        /* reserved */
  /* 0x8025 */        /* reserved */
  /* 0x8026 */        /* reserved */
  /* 0x8027 */        /* reserved */
  STUN_ATTRIBUTE_FINGERPRINT=0x8028,    /* RFC5389 */
  STUN_ATTRIBUTE_ICE_CONTROLLED=0x8029,    /* ICE-19 */
  STUN_ATTRIBUTE_ICE_CONTROLLING=0x802A,    /* ICE-19 */
  /* 0x802B-0xFFFF */      /* reserved */
} StunAttribute;

Known STUN attribute types as defined by various RFCs and drafts

STUN_ATTRIBUTE_MAPPED_ADDRESS The MAPPED-ADDRESS attribute as defined by RFC5389
STUN_ATTRIBUTE_RESPONSE_ADDRESS The RESPONSE-ADDRESS attribute as defined by RFC3489
STUN_ATTRIBUTE_CHANGE_REQUEST The CHANGE-REQUEST attribute as defined by RFC3489
STUN_ATTRIBUTE_SOURCE_ADDRESS The SOURCE-ADDRESS attribute as defined by RFC3489
STUN_ATTRIBUTE_CHANGED_ADDRESS The CHANGED-ADDRESS attribute as defined by RFC3489
STUN_ATTRIBUTE_USERNAME The USERNAME attribute as defined by RFC5389
STUN_ATTRIBUTE_PASSWORD The PASSWORD attribute as defined by RFC3489
STUN_ATTRIBUTE_MESSAGE_INTEGRITY The MESSAGE-INTEGRITY attribute as defined by RFC5389
STUN_ATTRIBUTE_ERROR_CODE The ERROR-CODE attribute as defined by RFC5389
STUN_ATTRIBUTE_UNKNOWN_ATTRIBUTES The UNKNOWN-ATTRIBUTES attribute as defined by RFC5389
STUN_ATTRIBUTE_REFLECTED_FROM The REFLECTED-FROM attribute as defined by RFC3489
STUN_ATTRIBUTE_CHANNEL_NUMBER The CHANNEL-NUMBER attribute as defined by TURN draft 09 and 12
STUN_ATTRIBUTE_LIFETIME The LIFETIME attribute as defined by TURN draft 04, 09 and 12
STUN_ATTRIBUTE_MAGIC_COOKIE The MAGIC-COOKIE attribute as defined by the rosenberg-midcom TURN draft 08
STUN_ATTRIBUTE_BANDWIDTH The BANDWIDTH attribute as defined by TURN draft 04
STUN_ATTRIBUTE_DESTINATION_ADDRESS The DESTINATION-ADDRESS attribute as defined by the rosenberg-midcom TURN draft 08
STUN_ATTRIBUTE_REMOTE_ADDRESS The REMOTE-ADDRESS attribute as defined by TURN draft 04
STUN_ATTRIBUTE_PEER_ADDRESS The PEER-ADDRESS attribute as defined by TURN draft 09
STUN_ATTRIBUTE_XOR_PEER_ADDRESS The XOR-PEER-ADDRESS attribute as defined by TURN draft 12
STUN_ATTRIBUTE_DATA The DATA attribute as defined by TURN draft 04, 09 and 12
STUN_ATTRIBUTE_REALM The REALM attribute as defined by RFC5389
STUN_ATTRIBUTE_NONCE The NONCE attribute as defined by RFC5389
STUN_ATTRIBUTE_RELAY_ADDRESS The RELAY-ADDRESS attribute as defined by TURN draft 04
STUN_ATTRIBUTE_RELAYED_ADDRESS The RELAYED-ADDRESS attribute as defined by TURN draft 09
STUN_ATTRIBUTE_XOR_RELAYED_ADDRESS The XOR-RELAYED-ADDRESS attribute as defined by TURN draft 12
STUN_ATTRIBUTE_REQUESTED_ADDRESS_TYPE The REQUESTED-ADDRESS-TYPE attribute as defined by TURN-IPV6 draft 05
STUN_ATTRIBUTE_REQUESTED_PORT_PROPS The REQUESTED-PORT-PROPS attribute as defined by TURN draft 04
STUN_ATTRIBUTE_REQUESTED_PROPS The REQUESTED-PROPS attribute as defined by TURN draft 09
STUN_ATTRIBUTE_EVEN_PORT The EVEN-PORT attribute as defined by TURN draft 12
STUN_ATTRIBUTE_REQUESTED_TRANSPORT The REQUESTED-TRANSPORT attribute as defined by TURN draft 12
STUN_ATTRIBUTE_DONT_FRAGMENT The DONT-FRAGMENT attribute as defined by TURN draft 12
STUN_ATTRIBUTE_XOR_MAPPED_ADDRESS The XOR-MAPPED-ADDRESS attribute as defined by RFC5389
STUN_ATTRIBUTE_TIMER_VAL The TIMER-VAL attribute as defined by TURN draft 04
STUN_ATTRIBUTE_REQUESTED_IP The REQUESTED-IP attribute as defined by TURN draft 04
STUN_ATTRIBUTE_RESERVATION_TOKEN The RESERVATION-TOKEN attribute as defined by TURN draft 09 and 12
STUN_ATTRIBUTE_CONNECT_STAT The CONNECT-STAT attribute as defined by TURN draft 04
STUN_ATTRIBUTE_PRIORITY The PRIORITY attribute as defined by ICE draft 19
STUN_ATTRIBUTE_USE_CANDIDATE The USE-CANDIDATE attribute as defined by ICE draft 19
STUN_ATTRIBUTE_OPTIONS The OPTIONS optional attribute as defined by libjingle
STUN_ATTRIBUTE_SOFTWARE The SOFTWARE optional attribute as defined by RFC5389
STUN_ATTRIBUTE_ALTERNATE_SERVER The ALTERNATE-SERVER optional attribute as defined by RFC5389
STUN_ATTRIBUTE_FINGERPRINT The FINGERPRINT optional attribute as defined by RFC5389
STUN_ATTRIBUTE_ICE_CONTROLLED The ICE-CONTROLLED optional attribute as defined by ICE draft 19
STUN_ATTRIBUTE_ICE_CONTROLLING The ICE-CONTROLLING optional attribute as defined by ICE draft 19

StunTransactionId

typedef uint8_t StunTransactionId[STUN_MESSAGE_TRANS_ID_LEN];

A type that holds a STUN transaction id.

enum StunError

typedef enum
{
  STUN_ERROR_TRY_ALTERNATE=300,      /* RFC5389 */
  STUN_ERROR_BAD_REQUEST=400,      /* RFC5389 */
  STUN_ERROR_UNAUTHORIZED=401,      /* RFC5389 */
  STUN_ERROR_UNKNOWN_ATTRIBUTE=420,    /* RFC5389 */
  STUN_ERROR_ALLOCATION_MISMATCH=437,   /* TURN-12 */
  STUN_ERROR_STALE_NONCE=438,      /* RFC5389 */
  STUN_ERROR_ACT_DST_ALREADY=439,    /* TURN-04 */
  STUN_ERROR_UNSUPPORTED_FAMILY=440,      /* TURN-IPv6-05 */
  STUN_ERROR_WRONG_CREDENTIALS=441,    /* TURN-12 */
  STUN_ERROR_UNSUPPORTED_TRANSPORT=442,    /* TURN-12 */
  STUN_ERROR_INVALID_IP=443,      /* TURN-04 */
  STUN_ERROR_INVALID_PORT=444,      /* TURN-04 */
  STUN_ERROR_OP_TCP_ONLY=445,      /* TURN-04 */
  STUN_ERROR_CONN_ALREADY=446,      /* TURN-04 */
  STUN_ERROR_ALLOCATION_QUOTA_REACHED=486,    /* TURN-12 */
  STUN_ERROR_ROLE_CONFLICT=487,      /* ICE-19 */
  STUN_ERROR_SERVER_ERROR=500,      /* RFC5389 */
  STUN_ERROR_SERVER_CAPACITY=507,    /* TURN-04 */
  STUN_ERROR_INSUFFICIENT_CAPACITY=508,    /* TURN-12 */
  STUN_ERROR_MAX=699
} StunError;

STUN error codes as defined by various RFCs and drafts

STUN_ERROR_TRY_ALTERNATE The ERROR-CODE value for the "Try Alternate" error as defined in RFC5389
STUN_ERROR_BAD_REQUEST The ERROR-CODE value for the "Bad Request" error as defined in RFC5389
STUN_ERROR_UNAUTHORIZED The ERROR-CODE value for the "Unauthorized" error as defined in RFC5389
STUN_ERROR_UNKNOWN_ATTRIBUTE The ERROR-CODE value for the "Unknown Attribute" error as defined in RFC5389
STUN_ERROR_ALLOCATION_MISMATCH The ERROR-CODE value for the "Allocation Mismatch" error as defined in TURN draft 12. Equivalent to the "No Binding" error defined in TURN draft 04.
STUN_ERROR_STALE_NONCE The ERROR-CODE value for the "Stale Nonce" error as defined in RFC5389
STUN_ERROR_ACT_DST_ALREADY The ERROR-CODE value for the "Active Destination Already Set" error as defined in TURN draft 04.
STUN_ERROR_UNSUPPORTED_FAMILY The ERROR-CODE value for the "Address Family not Supported" error as defined in TURN IPV6 Draft 05.
STUN_ERROR_WRONG_CREDENTIALS The ERROR-CODE value for the "Wrong Credentials" error as defined in TURN Draft 12.
STUN_ERROR_UNSUPPORTED_TRANSPORT he ERROR-CODE value for the "Unsupported Transport Protocol" error as defined in TURN Draft 12.
STUN_ERROR_INVALID_IP The ERROR-CODE value for the "Invalid IP Address" error as defined in TURN draft 04.
STUN_ERROR_INVALID_PORT The ERROR-CODE value for the "Invalid Port" error as defined in TURN draft 04.
STUN_ERROR_OP_TCP_ONLY The ERROR-CODE value for the "Operation for TCP Only" error as defined in TURN draft 04.
STUN_ERROR_CONN_ALREADY The ERROR-CODE value for the "Connection Already Exists" error as defined in TURN draft 04.
STUN_ERROR_ALLOCATION_QUOTA_REACHED The ERROR-CODE value for the "Allocation Quota Reached" error as defined in TURN draft 12.
STUN_ERROR_ROLE_CONFLICT The ERROR-CODE value for the "Role Conflict" error as defined in ICE draft 19.
STUN_ERROR_SERVER_ERROR The ERROR-CODE value for the "Server Error" error as defined in RFC5389
STUN_ERROR_SERVER_CAPACITY The ERROR-CODE value for the "Insufficient Capacity" error as defined in TURN draft 04.
STUN_ERROR_INSUFFICIENT_CAPACITY The ERROR-CODE value for the "Insufficient Capacity" error as defined in TURN draft 12.
STUN_ERROR_MAX The maximum possible ERROR-CODE value as defined by RFC 5389.

enum StunMessageReturn

typedef enum
{
  STUN_MESSAGE_RETURN_SUCCESS,
  STUN_MESSAGE_RETURN_NOT_FOUND,
  STUN_MESSAGE_RETURN_INVALID,
  STUN_MESSAGE_RETURN_NOT_ENOUGH_SPACE,
  STUN_MESSAGE_RETURN_UNSUPPORTED_ADDRESS
} StunMessageReturn;

The return value of most stun_message_* functions. This enum will report on whether an operation was successful or not and what error occured if any.

STUN_MESSAGE_RETURN_SUCCESS The operation was successful
STUN_MESSAGE_RETURN_NOT_FOUND The attribute was not found
STUN_MESSAGE_RETURN_INVALID The argument or data is invalid
STUN_MESSAGE_RETURN_NOT_ENOUGH_SPACE There is not enough space in the message to append data to it, or not enough in an argument to fill it with the data requested.
STUN_MESSAGE_RETURN_UNSUPPORTED_ADDRESS The address in the arguments or in the STUN message is not supported.

STUN_MESSAGE_BUFFER_INCOMPLETE

#define STUN_MESSAGE_BUFFER_INCOMPLETE 0

Convenience macro for stun_message_validate_buffer_length() meaning that the data to validate does not hold a complete STUN message

STUN_MESSAGE_BUFFER_INVALID

#define STUN_MESSAGE_BUFFER_INVALID -1

Convenience macro for stun_message_validate_buffer_length() meaning that the data to validate is not a valid STUN message

stun_message_init ()

bool                stun_message_init                   (StunMessage *msg,
                                                         StunClass c,
                                                         StunMethod m,
                                                         const StunTransactionId id);

Initializes a STUN message buffer, with no attributes.

msg : The StunMessage to initialize
c : STUN message class (host byte order)
m : STUN message method (host byte order)
id : 16-bytes transaction ID
Returns : TRUE if the initialization was successful

stun_message_length ()

uint16_t            stun_message_length                 (const StunMessage *msg);

Get the length of the message (including the header)

msg : The StunMessage
Returns : The length of the message

stun_message_find ()

const void*         stun_message_find                   (const StunMessage *msg,
                                                         StunAttribute type,
                                                         uint16_t *palen);

Finds an attribute in a STUN message and fetches its content

msg : The StunMessage
type : The StunAttribute to find
palen : A pointer to store the length of the attribute
Returns : A pointer to the start of the attribute payload if found, otherwise NULL.

stun_message_find_flag ()

StunMessageReturn   stun_message_find_flag              (const StunMessage *msg,
                                                         StunAttribute type);

Looks for a flag attribute within a valid STUN message.

msg : The StunMessage
type : The StunAttribute to find
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the attribute's size is not zero.

stun_message_find32 ()

StunMessageReturn   stun_message_find32                 (const StunMessage *msg,
                                                         StunAttribute type,
                                                         uint32_t *pval);

Extracts a 32-bits attribute from a STUN message.

msg : The StunMessage
type : The StunAttribute to find
pval : A pointer where to store the value (host byte order)
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the attribute's size is not 4 bytes.

stun_message_find64 ()

StunMessageReturn   stun_message_find64                 (const StunMessage *msg,
                                                         StunAttribute type,
                                                         uint64_t *pval);

Extracts a 64-bits attribute from a STUN message.

msg : The StunMessage
type : The StunAttribute to find
pval : A pointer where to store the value (host byte order)
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the attribute's size is not 8 bytes.

stun_message_find_string ()

StunMessageReturn   stun_message_find_string            (const StunMessage *msg,
                                                         StunAttribute type,
                                                         char *buf,
                                                         size_t buflen);

Extracts an UTF-8 string from a valid STUN message.

msg : The StunMessage
type : The StunAttribute to find
buf : A pointer where to store the data
buflen : The length of the buffer
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the attribute is improperly encoded STUN_MESSAGE_RETURN_NOT_ENOUGH_SPACE is return if the buffer size is too small to hold the string

Note

The string will be NULL-terminated.

stun_message_find_addr ()

StunMessageReturn   stun_message_find_addr              (const StunMessage *msg,
                                                         StunAttribute type,
                                                         struct sockaddr *addr,
                                                         socklen_t *addrlen);

Extracts a network address attribute from a STUN message.

msg : The StunMessage
type : The StunAttribute to find
addr : The sockaddr to be filled
addrlen : The size of the addr variable. Must be set to the size of the addr socket address and will be set to the size of the extracted socket address.
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the attribute payload size is wrong or if the addrlen is too small STUN_MESSAGE_RETURN_UNSUPPORTED_ADDRESSS if the address family is unknown.

stun_message_find_xor_addr ()

StunMessageReturn   stun_message_find_xor_addr          (const StunMessage *msg,
                                                         StunAttribute type,
                                                         struct sockaddr *addr,
                                                         socklen_t *addrlen);

Extracts an obfuscated network address attribute from a STUN message.

msg : The StunMessage
type : The StunAttribute to find
addr : The sockaddr to be filled
addrlen : The size of the addr variable. Must be set to the size of the addr socket address and will be set to the size of the extracted socket address.
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the attribute payload size is wrong or if the addrlen is too small STUN_MESSAGE_RETURN_UNSUPPORTED_ADDRESSS if the address family is unknown.

stun_message_find_xor_addr_full ()

StunMessageReturn   stun_message_find_xor_addr_full     (const StunMessage *msg,
                                                         StunAttribute type,
                                                         struct sockaddr *addr,
                                                         socklen_t *addrlen,
                                                         uint32_t magic_cookie);

Extracts an obfuscated network address attribute from a STUN message.

msg : The StunMessage
type : The StunAttribute to find
addr : The sockaddr to be filled
addrlen : The size of the addr variable. Must be set to the size of the addr socket address and will be set to the size of the extracted socket address.
magic_cookie : The magic cookie to use to XOR the address.
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the attribute payload size is wrong or if the addrlen is too small STUN_MESSAGE_RETURN_UNSUPPORTED_ADDRESSS if the address family is unknown.

stun_message_find_error ()

StunMessageReturn   stun_message_find_error             (const StunMessage *msg,
                                                         int *code);

Extract the error response code from a STUN message

msg : The StunMessage
code : A pointer where to store the value
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the value is invalid

stun_message_append ()

void*               stun_message_append                 (StunMessage *msg,
                                                         StunAttribute type,
                                                         size_t length);

Reserves room for appending an attribute to an unfinished STUN message.

msg : The StunMessage
type : The StunAttribute to append
length : The length of the attribute
Returns : A pointer to an unitialized buffer of length bytes to where the attribute payload must be written, or NULL if there is not enough room in the STUN message buffer.

stun_message_append_bytes ()

StunMessageReturn   stun_message_append_bytes           (StunMessage *msg,
                                                         StunAttribute type,
                                                         const void *data,
                                                         size_t len);

Appends a binary value to a STUN message

msg : The StunMessage
type : The StunAttribute to append
data : The data to append
len : The length of the attribute
Returns : A StunMessageReturn value.

stun_message_append_flag ()

StunMessageReturn   stun_message_append_flag            (StunMessage *msg,
                                                         StunAttribute type);

Appends an empty flag attribute to a STUN message

msg : The StunMessage
type : The StunAttribute to append
Returns : A StunMessageReturn value.

stun_message_append32 ()

StunMessageReturn   stun_message_append32               (StunMessage *msg,
                                                         StunAttribute type,
                                                         uint32_t value);

Appends a 32-bits value attribute to a STUN message

msg : The StunMessage
type : The StunAttribute to append
value : The value to append (host byte order)
Returns : A StunMessageReturn value.

stun_message_append64 ()

StunMessageReturn   stun_message_append64               (StunMessage *msg,
                                                         StunAttribute type,
                                                         uint64_t value);

Appends a 64-bits value attribute to a STUN message

msg : The StunMessage
type : The StunAttribute to append
value : The value to append (host byte order)
Returns : A StunMessageReturn value.

stun_message_append_string ()

StunMessageReturn   stun_message_append_string          (StunMessage *msg,
                                                         StunAttribute type,
                                                         const char *str);

Adds an attribute from a NULL-terminated string to a STUN message

msg : The StunMessage
type : The StunAttribute to append
str : The string to append
Returns : A StunMessageReturn value.

stun_message_append_addr ()

StunMessageReturn   stun_message_append_addr            (StunMessage *msg,
                                                         StunAttribute type,
                                                         const struct sockaddr *addr,
                                                         socklen_t addrlen);

Append a network address attribute to a STUN message

msg : The StunMessage
type : The StunAttribute to append
addr : The sockaddr to be append
addrlen : The size of the addr variable.
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the addrlen is too small STUN_MESSAGE_RETURN_UNSUPPORTED_ADDRESSS if the address family is unknown.

stun_message_append_xor_addr ()

StunMessageReturn   stun_message_append_xor_addr        (StunMessage *msg,
                                                         StunAttribute type,
                                                         const struct sockaddr *addr,
                                                         socklen_t addrlen);

Append an obfuscated network address attribute to a STUN message

msg : The StunMessage
type : The StunAttribute to append
addr : The sockaddr to be append
addrlen : The size of the addr variable.
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the addrlen is too small STUN_MESSAGE_RETURN_UNSUPPORTED_ADDRESSS if the address family is unknown.

stun_message_append_xor_addr_full ()

StunMessageReturn   stun_message_append_xor_addr_full   (StunMessage *msg,
                                                         StunAttribute type,
                                                         const struct sockaddr *addr,
                                                         socklen_t addrlen,
                                                         uint32_t magic_cookie);

Append an obfuscated network address attribute from a STUN message.

msg : The StunMessage
type : The StunAttribute to append
addr : The sockaddr to be append
addrlen : The size of the addr variable.
magic_cookie : The magic cookie to use to XOR the address.
Returns : A StunMessageReturn value. STUN_MESSAGE_RETURN_INVALID is returned if the addrlen is too small STUN_MESSAGE_RETURN_UNSUPPORTED_ADDRESSS if the address family is unknown.

stun_message_append_error ()

StunMessageReturn   stun_message_append_error           (StunMessage *msg,
                                                         StunError code);

Appends the ERROR-CODE attribute to the STUN message and fills it according to code

msg : The StunMessage
code : The error code value
Returns : A StunMessageReturn value.

stun_message_validate_buffer_length ()

int                 stun_message_validate_buffer_length (const uint8_t *msg,
                                                         size_t length);

This function will take a data buffer and will try to validate whether it is a STUN message or if it's not or if it's an incomplete STUN message and will provide us with the length of the STUN message.

msg : The buffer to validate
length : The length of the buffer
Returns : The length of the valid STUN message in the buffer.

See also: STUN_MESSAGE_BUFFER_INCOMPLETE

See also: STUN_MESSAGE_BUFFER_INVALID

stun_message_id ()

void                stun_message_id                     (const StunMessage *msg,
                                                         StunTransactionId id);

Retreive the STUN transaction id from a STUN message

msg : The StunMessage
id : The StunTransactionId to fill

stun_message_get_class ()

StunClass           stun_message_get_class              (const StunMessage *msg);

Retreive the STUN class from a STUN message

msg : The StunMessage
Returns : The StunClass

stun_message_get_method ()

StunMethod          stun_message_get_method             (const StunMessage *msg);

Retreive the STUN method from a STUN message

msg : The StunMessage
Returns : The StunMethod

stun_message_has_attribute ()

bool                stun_message_has_attribute          (const StunMessage *msg,
                                                         StunAttribute type);

Checks if an attribute is present within a STUN message.

msg : The StunMessage
type : The StunAttribute to look for
Returns : TRUE if the attribute is found, FALSE otherwise

stun_message_has_cookie ()

bool                stun_message_has_cookie             (const StunMessage *msg);

Checks if the STUN message has a RFC5389 compatible cookie

msg : The StunMessage
Returns : TRUE if the cookie is present, FALSE otherwise

stun_optional ()

bool                stun_optional                       (uint16_t t);

Helper function that checks whether a STUN attribute is a mandatory or an optional attribute

t : An attribute type
Returns : TRUE if the attribute is an optional one

stun_strerror ()

const char*         stun_strerror                       (StunError code);

Transforms a STUN error-code into a human readable string

code : host-byte order error code
Returns : A static pointer to a NULL-terminated error message string.

See Also

StunAgent
Generated by GTK-Doc V1.10