nat_stun.h File Reference

Message types for STUN server resolution. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	stun_trans_id
struct	stun_header
struct	stun_attr
struct	stun_addr
	The format normally used for addresses carried by STUN messages. More...

Macros
#define	STUN_IGNORE   (0)
#define	STUN_ACCEPT   (1)
#define	STUN_MAGIC_COOKIE   0x2112A442

Enumerations
enum	StunClasses {   INVALID_CLASS = 0 , STUN_REQUEST = 0x0000 , STUN_INDICATION = 0x0001 , STUN_RESPONSE = 0x0002 ,   STUN_ERROR_RESPONSE = 0x0003 }
	STUN message classes. More...
enum	StunMethods {   INVALID_METHOD = 0 , STUN_BINDING = 0x0001 , STUN_SHARED_SECRET = 0x0002 , STUN_ALLOCATE = 0x0003 ,   STUN_REFRESH = 0x0004 , STUN_SEND = 0x0006 , STUN_DATA = 0x0007 , STUN_CREATE_PERMISSION = 0x0008 ,   STUN_CHANNEL_BIND = 0x0009 }
enum	StunAttributes {   STUN_MAPPED_ADDRESS = 0x0001 , STUN_RESPONSE_ADDRESS = 0x0002 , STUN_CHANGE_ADDRESS = 0x0003 , STUN_SOURCE_ADDRESS = 0x0004 ,   STUN_CHANGED_ADDRESS = 0x0005 , STUN_USERNAME = 0x0006 , STUN_PASSWORD = 0x0007 , STUN_MESSAGE_INTEGRITY = 0x0008 ,   STUN_ERROR_CODE = 0x0009 , STUN_UNKNOWN_ATTRIBUTES = 0x000a , STUN_REFLECTED_FROM = 0x000b , STUN_REALM = 0x0014 ,   STUN_NONCE = 0x0015 , STUN_XOR_MAPPED_ADDRESS = 0x0020 , STUN_MS_VERSION = 0x8008 , STUN_MS_XOR_MAPPED_ADDRESS = 0x8020 ,   STUN_SOFTWARE = 0x8022 , STUN_ALTERNATE_SERVER = 0x8023 , STUN_FINGERPRINT = 0x8028 }
	Basic attribute types in stun messages. More...

Functions
static enum StunClasses	decode_class (int msg)
	Convert a message to a StunClass. More...
static enum StunMethods	decode_method (int msg)
	Convert a message to a StunMethod. More...
static const char *	stun_msg2str (int msg)
	Print a class and method from a STUN message. More...
static const char *	stun_attr2str (enum StunAttributes msg)
	Print attribute name. More...

Detailed Description

Message types for STUN server resolution.

Testcase for STUN library

Author

Bruno Souza Cabral

Mark Spencer (Original code borrowed from Asterisk)

Christian Grothoff

Definition in file nat_stun.h.

Macro Definition Documentation

STUN_IGNORE

#define STUN_IGNORE   (0)

Definition at line 31 of file nat_stun.h.

STUN_ACCEPT

#define STUN_ACCEPT   (1)

Definition at line 32 of file nat_stun.h.

STUN_MAGIC_COOKIE

#define STUN_MAGIC_COOKIE   0x2112A442

Definition at line 34 of file nat_stun.h.

Enumeration Type Documentation

StunClasses

enum StunClasses

STUN message classes.

Enumerator
INVALID_CLASS
STUN_REQUEST
STUN_INDICATION
STUN_RESPONSE
STUN_ERROR_RESPONSE

Definition at line 85 of file nat_stun.h.

{
  INVALID_CLASS = 0,
  STUN_REQUEST = 0x0000,
  STUN_INDICATION = 0x0001,
  STUN_RESPONSE = 0x0002,
  STUN_ERROR_RESPONSE = 0x0003
};

StunMethods

enum StunMethods

Enumerator
INVALID_METHOD
STUN_BINDING
STUN_SHARED_SECRET
STUN_ALLOCATE
STUN_REFRESH
STUN_SEND
STUN_DATA
STUN_CREATE_PERMISSION
STUN_CHANNEL_BIND

Definition at line 94 of file nat_stun.h.

{
  INVALID_METHOD = 0,
  STUN_BINDING = 0x0001,
  STUN_SHARED_SECRET = 0x0002,
  STUN_ALLOCATE = 0x0003,
  STUN_REFRESH = 0x0004,
  STUN_SEND = 0x0006,
  STUN_DATA = 0x0007,
  STUN_CREATE_PERMISSION = 0x0008,
  STUN_CHANNEL_BIND = 0x0009
};

StunAttributes

enum StunAttributes

Basic attribute types in stun messages.

Messages can also contain custom attributes (codes above 0x7fff)

Enumerator
STUN_MAPPED_ADDRESS
STUN_RESPONSE_ADDRESS
STUN_CHANGE_ADDRESS
STUN_SOURCE_ADDRESS
STUN_CHANGED_ADDRESS
STUN_USERNAME
STUN_PASSWORD
STUN_MESSAGE_INTEGRITY
STUN_ERROR_CODE
STUN_UNKNOWN_ATTRIBUTES
STUN_REFLECTED_FROM
STUN_REALM
STUN_NONCE
STUN_XOR_MAPPED_ADDRESS
STUN_MS_VERSION
STUN_MS_XOR_MAPPED_ADDRESS
STUN_SOFTWARE
STUN_ALTERNATE_SERVER
STUN_FINGERPRINT

Definition at line 112 of file nat_stun.h.

{
  STUN_MAPPED_ADDRESS = 0x0001,
  STUN_RESPONSE_ADDRESS = 0x0002,
  STUN_CHANGE_ADDRESS = 0x0003,
  STUN_SOURCE_ADDRESS = 0x0004,
  STUN_CHANGED_ADDRESS = 0x0005,
  STUN_USERNAME = 0x0006,
  STUN_PASSWORD = 0x0007,
  STUN_MESSAGE_INTEGRITY = 0x0008,
  STUN_ERROR_CODE = 0x0009,
  STUN_UNKNOWN_ATTRIBUTES = 0x000a,
  STUN_REFLECTED_FROM = 0x000b,
  STUN_REALM = 0x0014,
  STUN_NONCE = 0x0015,
  STUN_XOR_MAPPED_ADDRESS = 0x0020,
  STUN_MS_VERSION = 0x8008,
  STUN_MS_XOR_MAPPED_ADDRESS = 0x8020,
  STUN_SOFTWARE = 0x8022,
  STUN_ALTERNATE_SERVER = 0x8023,
  STUN_FINGERPRINT = 0x8028
};

Function Documentation

decode_class()

static enum StunClasses decode_class ( int  msg )

static

Convert a message to a StunClass.

Parameters

msg	the received message

Returns

the converted StunClass

Definition at line 1 of file nat_stun.h.

{
  /* Sorry for the magic, but this maps the class according to rfc5245 */
  return (enum StunClasses) ((msg & 0x0010) >> 4) | ((msg & 0x0100) >> 7);
}

Referenced by stun_msg2str().

Here is the caller graph for this function:

decode_method()

static enum StunMethods decode_method ( int  msg )

static

Convert a message to a StunMethod.

Parameters

msg	the received message

Returns

the converted StunMethod

Definition at line 1 of file nat_stun.h.

{
  return (enum StunMethods) (msg & 0x000f) | ((msg & 0x00e0) >> 1) | ((msg
                                                                       & 0x3e00)
                                                                      >> 2);
}

Referenced by stun_msg2str().

Here is the caller graph for this function:

stun_msg2str()

static const char* stun_msg2str ( int  msg )

static

Print a class and method from a STUN message.

Parameters

msg

Returns

string with the message class and method

Definition at line 173 of file nat_stun.h.

{
  static const struct
  {
    enum StunClasses value;
    const char *name;
  } classes[] = {
    { STUN_REQUEST, "Request" },
    { STUN_INDICATION, "Indication" },
    { STUN_RESPONSE, "Response" },
    { STUN_ERROR_RESPONSE, "Error Response" },
    { INVALID_CLASS, NULL }
  };
  static const struct
  {
    enum StunMethods value;
    const char *name;
  } methods[] = {
    { STUN_BINDING, "Binding" },
    { INVALID_METHOD, NULL }
  };
  static char result[64];
  const char *msg_class = NULL;
  const char *method = NULL;
  enum StunClasses cvalue;
  enum StunMethods mvalue;
 
  cvalue = decode_class (msg);
  for (unsigned int i = 0; classes[i].name; i++)
    if (classes[i].value == cvalue)
    {
      msg_class = classes[i].name;
      break;
    }
  mvalue = decode_method (msg);
  for (unsigned int i = 0; methods[i].name; i++)
    if (methods[i].value == mvalue)
    {
      method = methods[i].name;
      break;
    }
  GNUNET_snprintf (result,
                   sizeof(result),
                   "%s %s",
                   method ? : "Unknown Method",
                   msg_class ? : "Unknown Class Message");
  return result;
}

References decode_class(), decode_method(), GNUNET_snprintf(), INVALID_CLASS, INVALID_METHOD, msg, name, result, STUN_BINDING, STUN_ERROR_RESPONSE, STUN_INDICATION, STUN_REQUEST, STUN_RESPONSE, and value.

Referenced by GNUNET_NAT_stun_handle_packet_().

Here is the call graph for this function:

Here is the caller graph for this function:

stun_attr2str()

static const char* stun_attr2str ( enum StunAttributes  msg )

static

Print attribute name.

Parameters

msg	with a attribute type

Returns

string with the attribute name

Definition at line 231 of file nat_stun.h.

{
  static const struct
  {
    enum StunAttributes value;
    const char *name;
  } attrs[] = {
    { STUN_MAPPED_ADDRESS, "Mapped Address" },
    { STUN_RESPONSE_ADDRESS, "Response Address" },
    { STUN_CHANGE_ADDRESS, "Change Address" },
    { STUN_SOURCE_ADDRESS, "Source Address" },
    { STUN_CHANGED_ADDRESS, "Changed Address" },
    { STUN_USERNAME, "Username" },
    { STUN_PASSWORD, "Password" },
    { STUN_MESSAGE_INTEGRITY, "Message Integrity" },
    { STUN_ERROR_CODE, "Error Code" },
    { STUN_UNKNOWN_ATTRIBUTES, "Unknown Attributes" },
    { STUN_REFLECTED_FROM, "Reflected From" },
    { STUN_REALM, "Realm" },
    { STUN_NONCE, "Nonce" },
    { STUN_XOR_MAPPED_ADDRESS, "XOR Mapped Address" },
    { STUN_MS_VERSION, "MS Version" },
    { STUN_MS_XOR_MAPPED_ADDRESS, "MS XOR Mapped Address" },
    { STUN_SOFTWARE, "Software" },
    { STUN_ALTERNATE_SERVER, "Alternate Server" },
    { STUN_FINGERPRINT, "Fingerprint" },
    { 0, NULL }
  };
 
  for (unsigned int i = 0; attrs[i].name; i++)
    if (attrs[i].value == msg)
      return attrs[i].name;
  return "Unknown Attribute";
}

References msg, name, STUN_ALTERNATE_SERVER, STUN_CHANGE_ADDRESS, STUN_CHANGED_ADDRESS, STUN_ERROR_CODE, STUN_FINGERPRINT, STUN_MAPPED_ADDRESS, STUN_MESSAGE_INTEGRITY, STUN_MS_VERSION, STUN_MS_XOR_MAPPED_ADDRESS, STUN_NONCE, STUN_PASSWORD, STUN_REALM, STUN_REFLECTED_FROM, STUN_RESPONSE_ADDRESS, STUN_SOFTWARE, STUN_SOURCE_ADDRESS, STUN_UNKNOWN_ATTRIBUTES, STUN_USERNAME, STUN_XOR_MAPPED_ADDRESS, and value.