stun_message_init ()

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

Initializes a STUN message buffer, with no attributes.

stun_message_length ()

uint16_t
stun_message_length (const StunMessage *msg);

Get the length of the message (including the header)

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

stun_message_find_flag ()

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

Looks for a flag attribute within a valid STUN message.

stun_message_find32 ()

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

Extracts a 32-bits attribute from a STUN message.

stun_message_find64 ()

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

Extracts a 64-bits attribute from a STUN message.

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.

stun_message_find_addr ()

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

Extracts a network address attribute from a STUN message.

stun_message_find_xor_addr ()

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

Extracts an obfuscated network address attribute from a STUN message.

stun_message_find_xor_addr_full ()

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

Extracts an obfuscated network address attribute from a STUN message.

stun_message_find_error ()

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

Extract the error response code from a STUN message

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.

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

stun_message_append_flag ()

StunMessageReturn
stun_message_append_flag (StunMessage *msg,
                          StunAttribute type);

Appends an empty flag attribute to a STUN message

stun_message_append32 ()

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

Appends a 32-bits value attribute to a STUN message

stun_message_append64 ()

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

Appends a 64-bits value attribute to a STUN message

stun_message_append_string ()

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

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

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

stun_message_append_xor_addr ()

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

Append an obfuscated network address attribute to a STUN message

stun_message_append_xor_addr_full ()

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

Append an obfuscated network address attribute from a STUN message.

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

stun_message_validate_buffer_length ()

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

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.

stun_message_validate_buffer_length_fast ()

ssize_t
stun_message_validate_buffer_length_fast
                               (StunInputVector *buffers,
                                int n_buffers,
                                size_t total_length,
                                bool has_padding);

Quickly validate whether the message in the given buffers is potentially a valid STUN message, an incomplete STUN message, or if it’s definitely not one at all.

This is designed as a first-pass validation only, and does not check the message’s attributes for validity. If this function returns success, the buffers can be compacted and a more thorough validation can be performed using stun_message_validate_buffer_length(). If it fails, the buffers definitely do not contain a complete, valid STUN message.

Since: 0.1.5

stun_message_id ()

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

Retreive the STUN transaction id from a STUN message

stun_message_get_class ()

StunClass
stun_message_get_class (const StunMessage *msg);

Retreive the STUN class from a STUN message

stun_message_get_method ()

StunMethod
stun_message_get_method (const StunMessage *msg);

Retreive the STUN method from a STUN message

stun_message_has_attribute ()

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

Checks if an attribute is present within a STUN message.

stun_message_has_cookie ()

bool
stun_message_has_cookie (const StunMessage *msg);

Checks if the STUN message has a RFC5389 compatible cookie

stun_optional ()

bool
stun_optional (uint16_t t);

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

stun_strerror ()

const char *
stun_strerror (StunError code);

Transforms a STUN error-code into a human readable string

struct StunMessage

struct StunMessage {
  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;
};

This structure represents a STUN message

enum StunClass

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

enum StunMethod

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

enum StunAttribute

Known STUN attribute types as defined by various RFCs and drafts

StunTransactionId

typedef uint8_t StunTransactionId[STUN_MESSAGE_TRANS_ID_LEN];

A type that holds a STUN transaction id.

enum StunError

STUN error codes as defined by various RFCs and drafts

enum 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_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

StunInputVector

typedef struct {
  const uint8_t *buffer;
  size_t size;
} StunInputVector;

Container for a single buffer which also stores its length. This is designed for vectored I/O: typically an array of StunInputVectors is passed to functions, providing multiple buffers which store logically contiguous received data.

This is guaranteed to be layed out identically in memory to GInputVector.

Since: 0.1.5