|
|
SIP/media Features About: PJLIB, PJLIB-UTIL, PJSIP, and PJMEDIA are created by: Benny Prijono <bennylp  pjsip.org>
|
Home --> Documentations --> PJNATH Reference STUN Message Representation and Parsing |
| #define PJ_STUN_ERROR_RESPONSE_BIT (0x0110) |
The error response bit in the message type.
| #define PJ_STUN_GET_CH_NB | ( | u32 | ) | ((pj_uint16_t)(u32>>16)) |
Get 16bit channel number from 32bit integral value. Note that uint32 attributes are always stored in host byte order after they have been parsed from the PDU, so no need to do ntohs() here.
| #define PJ_STUN_GET_METHOD | ( | msg_type | ) | ((msg_type) & 0xFEEF) |
Retrieve the STUN method from the message-type field of the STUN message.
| #define PJ_STUN_GET_PROP_TYPE | ( | u32 | ) | (u32 >> 24) |
Get the 8bit Prop-type value from a 32bit integral value of TURN TURN REQUESTED-PROPS attribute.
| #define PJ_STUN_GET_RT_PROTO | ( | u32 | ) | (u32 >> 24) |
Get protocol value from 32bit TURN REQUESTED-TRANSPORT attribute.
| #define PJ_STUN_INDICATION_BIT (0x0010) |
The error response bit in the message type.
| #define PJ_STUN_IS_ERROR_RESPONSE | ( | msg_type | ) | (((msg_type) & 0x0110) == 0x0110) |
Determine if the message type is an error response.
| #define PJ_STUN_IS_INDICATION | ( | msg_type | ) | (((msg_type) & 0x0110) == 0x0010) |
Determine if the message type is an indication message.
| #define PJ_STUN_IS_REQUEST | ( | msg_type | ) | (((msg_type) & 0x0110) == 0x0000) |
Determine if the message type is a request.
| #define PJ_STUN_IS_RESPONSE | ( | msg_type | ) | (((msg_type) & 0x0100) == 0x0100) |
Determine if the message type is a response.
| #define PJ_STUN_IS_SUCCESS_RESPONSE | ( | msg_type | ) | (((msg_type) & 0x0110) == 0x0100) |
Determine if the message type is a successful response.
| #define PJ_STUN_MAGIC 0x2112A442 |
STUN magic cookie.
| #define PJ_STUN_SET_CH_NB | ( | chnum | ) | (((pj_uint32_t)chnum) << 16) |
Convert 16bit channel number into 32bit integral value. Note that uint32 attributes will be converted to network byte order when the attribute is written to packet, so no need to do htons() here.
| #define PJ_STUN_SET_PROP_TYPE | ( | PropType | ) | (PropType << 24) |
Convert 8bit Prop-type value to a 32bit integral value of TURN REQUESTED-PROPS attribute.
| #define PJ_STUN_SET_RT_PROTO | ( | proto | ) | (((pj_uint32_t)(proto)) << 24) |
Convert protocol value to be placed in 32bit TURN REQUESTED-TRANSPORT attribute.
| #define PJ_STUN_SUCCESS_RESPONSE_BIT (0x0100) |
The response bit in the message type.
Typedef Documentation
| typedef struct pj_stun_sockaddr_attr pj_stun_alt_server_attr |
This describes STUN ALTERNATE-SERVER attribute. The alternate server represents an alternate transport address for a different STUN server to try. It is encoded in the same way as MAPPED-ADDRESS.
| typedef struct pj_stun_uint_attr pj_stun_bandwidth_attr |
This describes STUN BANDWIDTH attribute. The bandwidth attribute represents the peak bandwidth, measured in kbits per second, that the client expects to use on the binding. The value represents the sum in the receive and send directions.
| typedef struct pj_stun_uint_attr pj_stun_change_request_attr |
This structure describes STUN CHANGE-REQUEST attribute. The CHANGE-REQUEST attribute is used by the client to request that the server use a different address and/or port when sending the response.
Bit 29 of the value is the "change IP" flag. If true, it requests the server to send the Binding Response with a different IP address than the one the Binding Request was received on.
Bit 30 of the value is the "change port" flag. If true, it requests the server to send the Binding Response with a different port than the one the Binding Request was received on.
Note that the usage of this attribute has been deprecated by the RFC 3489-bis standard.
| typedef struct pj_stun_sockaddr_attr pj_stun_changed_addr_attr |
This structure describes STUN CHANGED-ADDRESS attribute. The CHANGED-ADDRESS attribute indicates the IP address and port where responses would have been sent from if the "change IP" and "change port" flags had been set in the CHANGE-REQUEST attribute of the Binding Request. The attribute is always present in a Binding Response, independent of the value of the flags. Its syntax is identical to MAPPED-ADDRESS.
Note that the usage of this attribute has been deprecated by the RFC 3489-bis standard.
| typedef struct pj_stun_uint_attr pj_stun_channel_number_attr |
This describes TURN CHANNEL-NUMBER attribute. In this library, this attribute is represented with 32bit integer. Application may use PJ_STUN_GET_CH_NB() and PJ_STUN_SET_CH_NB() to extract/set channel number value from the 32bit integral value.
The CHANNEL-NUMBER attribute contains the number of the channel. It is a 16-bit unsigned integer, followed by a two-octet RFFU field which MUST be set to 0 on transmission and ignored on reception.
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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Channel Number | RFFU |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| typedef struct pj_stun_binary_attr pj_stun_data_attr |
This describes the STUN DATA attribute. The DATA attribute is present in Send Indications and Data Indications. It contains raw payload data that is to be sent (in the case of a Send Request) or was received (in the case of a Data Indication)..
| typedef struct pj_stun_uint_attr pj_stun_fingerprint_attr |
This structure describes STUN FINGERPRINT attribute. The FINGERPRINT attribute can be present in all STUN messages. It is computed as the CRC-32 of the STUN message up to (but excluding) the FINGERPRINT attribute itself, xor-d with the 32 bit value 0x5354554e
| typedef struct pj_stun_uint64_attr pj_stun_ice_controlled_attr |
This describes ICE-CONTROLLED attribute.
| typedef struct pj_stun_uint64_attr pj_stun_ice_controlling_attr |
This describes ICE-CONTROLLING attribute.
| typedef struct pj_stun_uint_attr pj_stun_icmp_attr |
This describes TURN ICMP attribute
| typedef struct pj_stun_uint_attr pj_stun_lifetime_attr |
This describes STUN LIFETIME attribute. The lifetime attribute represents the duration for which the server will maintain an allocation in the absence of data traffic either from or to the client. It is a 32 bit value representing the number of seconds remaining until expiration.
| typedef struct pj_stun_sockaddr_attr pj_stun_mapped_addr_attr |
This structure describes STUN MAPPED-ADDRESS attribute. The MAPPED-ADDRESS attribute indicates the mapped transport address.
| typedef struct pj_stun_string_attr pj_stun_nonce_attr |
This describes STUN NONCE attribute. The NONCE attribute is present in requests and in error responses. It contains a sequence of qdtext or quoted-pair, which are defined in RFC 3261 [11]. See RFC 2617 [7] for guidance on selection of nonce values in a server.
| typedef struct pj_stun_string_attr pj_stun_password_attr |
This describes STUN PASSWORD attribute. If the message type is Shared Secret Response it MUST include the PASSWORD attribute.
| typedef struct pj_stun_sockaddr_attr pj_stun_peer_addr_attr |
This describes the STUN PEER-ADDRESS attribute. The PEER-ADDRESS specifies the address and port of the peer as seen from the TURN server. It is encoded in the same way as XOR-MAPPED- ADDRESS.
| typedef struct pj_stun_uint_attr pj_stun_priority_attr |
This describes the PRIORITY attribute from draft-ietf-mmusic-ice-13. The PRIORITY attribute indicates the priority that is to be associated with a peer reflexive candidate, should one be discovered by this check. It is a 32 bit unsigned integer, and has an attribute type of 0x0024.
| typedef struct pj_stun_string_attr pj_stun_realm_attr |
This describes STUN REALM attribute. The REALM attribute is present in requests and responses. It contains text which meets the grammar for "realm" as described in RFC 3261 [11], and will thus contain a quoted string (including the quotes).
| typedef struct pj_stun_sockaddr_attr pj_stun_reflected_from_attr |
This describes the STUN REFLECTED-FROM attribute. The REFLECTED-FROM attribute is present only in Binding Responses, when the Binding Request contained a RESPONSE-ADDRESS attribute. The attribute contains the identity (in terms of IP address) of the source where the request came from. Its purpose is to provide traceability, so that a STUN server cannot be used as a reflector for denial-of-service attacks.
| typedef struct pj_stun_uint_attr pj_stun_refresh_interval_attr |
This describes STUN REFRESH-INTERVAL attribute. The REFRESH-INTERVAL indicates the number of milliseconds that the server suggests the client should use between refreshes of the NAT bindings between the client and server.
| typedef struct pj_stun_sockaddr_attr pj_stun_relayed_addr_attr |
This describes the STUN RELAYED-ADDRESS attribute. The RELAYED-ADDRESS is present in Allocate responses. It specifies the address and port that the server allocated to the client. It is encoded in the same way as XOR-MAPPED-ADDRESS.
| typedef struct pj_stun_uint_attr pj_stun_req_addr_type |
This describes the REQUESTED-ADDRESS-TYPE attribute. The REQUESTED-ADDRESS-TYPE attribute is used by clients to request the allocation of a specific address type from a server. The following is the format of the REQUESTED-ADDRESS-TYPE attribute.
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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Family | Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| typedef struct pj_stun_uint_attr pj_stun_req_props_attr |
This describes the TURN REQUESTED-PROPS attribute, encoded as STUN 32bit integer attribute. Few macros are provided to manipulate the values in this attribute: PJ_STUN_GET_PROP_TYPE(), and PJ_STUN_SET_PROP_TYPE().
This attribute allows the client to request that the allocation have certain properties, and by the server to indicate which properties are supported. The attribute is 32 bits long. Its format is:
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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Prop-type | Reserved = 0 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
The field labeled "Prop-type" is an 8-bit field specifying the desired property. The rest of the attribute is RFFU (Reserved For Future Use) and MUST be set to 0 on transmission and ignored on reception.
The "Prop-type" field is formatted as follows:
0 1 2 3 4 5 6 7
+-+-+-+-+-+-+-+-+
|E|R|P| |
+-+-+-+-+-+-+-+-+
The bits in "Prop-type" are:
E: If 1, the port number for the relayed-transport-address must be even. If 0, the port number can be even or odd.
R: If 1, the server must reserve the next highest port for a subsequent allocation. If 0, no such reservation is requested. If the client sets the R bit to 1, it MUST also set the E bit to 1 (however, the E bit may be 1 when the R bit is 0).
P: If 1, the allocation must be a Preserving allocation. If 0, the allocation can be either Preserving or Non-Preserving.
| typedef struct pj_stun_uint_attr pj_stun_req_transport_attr |
This describes the TURN REQUESTED-TRANSPORT attribute, encoded in STUN generic integer attribute.
This attribute is used by the client to request a specific transport protocol for the allocated transport address. It has the following 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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Protocol | RFFU |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
The Protocol field specifies the desired protocol. The codepoints used in this field are taken from those allowed in the Protocol field in the IPv4 header and the NextHeader field in the IPv6 header [Protocol-Numbers]. This specification only allows the use of codepoint 17 (User Datagram Protocol).
The RFFU field is set to zero on transmission and ignored on receiption. It is reserved for future uses.
| typedef struct pj_stun_uint64_attr pj_stun_res_token_attr |
This describes the TURN RESERVATION-TOKEN attribute. The RESERVATION-TOKEN attribute contains a token that uniquely identifies a relayed transport address being held in reserve by the server. The server includes this attribute in a success response to tell the client about the token, and the client includes this attribute in a subsequent Allocate request to request the server use that relayed transport address for the allocation.
The attribute value is a 64-bit-long field containing the token value.
| typedef struct pj_stun_sockaddr_attr pj_stun_response_addr_attr |
This structure describes STUN RESPONSE-ADDRESS attribute. The RESPONSE-ADDRESS attribute indicates where the response to a Binding Request should be sent. Its syntax is identical to MAPPED- ADDRESS.
Note that the usage of this attribute has been deprecated by the RFC 3489-bis standard.
| typedef struct pj_stun_string_attr pj_stun_software_attr |
This describes STUN SOFTWARE attribute. The SOFTWARE attribute contains a textual description of the software being used by the agent sending the message. It is used by clients and servers. Its value SHOULD include manufacturer and version number.
| typedef struct pj_stun_sockaddr_attr pj_stun_src_addr_attr |
This structure describes STUN SOURCE-ADDRESS attribute. The SOURCE-ADDRESS attribute is present in Binding Responses. It indicates the source IP address and port that the server is sending the response from. Its syntax is identical to that of MAPPED- ADDRESS.
Note that the usage of this attribute has been deprecated by the RFC 3489-bis standard.
| typedef struct pj_stun_uint_attr pj_stun_timer_val_attr |
This describes the STUN TIMER-VAL attribute. The TIMER-VAL attribute is used only in conjunction with the Set Active Destination response. It conveys from the server, to the client, the value of the timer used in the server state machine.
| typedef struct pj_stun_empty_attr pj_stun_use_candidate_attr |
This describes the USE-CANDIDATE attribute from draft-ietf-mmusic-ice-13. The USE-CANDIDATE attribute indicates that the candidate pair resulting from this check should be used for transmission of media. The attribute has no content (the Length field of the attribute is zero); it serves as a flag.
| typedef struct pj_stun_string_attr pj_stun_username_attr |
This describes STUN USERNAME attribute. The USERNAME attribute is used for message integrity. It identifies the shared secret used in the message integrity check. Consequently, the USERNAME MUST be included in any request that contains the MESSAGE-INTEGRITY attribute.
| typedef struct pj_stun_sockaddr_attr pj_stun_xor_mapped_addr_attr |
This describes STUN XOR-MAPPED-ADDRESS attribute (which has the same format as STUN MAPPED-ADDRESS attribute). The XOR-MAPPED-ADDRESS attribute is present in responses. It provides the same information that would present in the MAPPED- ADDRESS attribute but because the NAT's public IP address is obfuscated through the XOR function, STUN messages are able to pass through NATs which would otherwise interfere with STUN.
| typedef struct pj_stun_sockaddr_attr pj_stun_xor_reflected_from_attr |
This describes the XOR-REFLECTED-FROM attribute, as described by draft-macdonald-behave-nat-behavior-discovery-00. The XOR-REFLECTED-FROM attribute is used in place of the REFLECTED- FROM attribute. It provides the same information, but because the NAT's public address is obfuscated through the XOR function, It can pass through a NAT that would otherwise attempt to translate it to the private network address. XOR-REFLECTED-FROM has identical syntax to XOR-MAPPED-ADDRESS.
Enumeration Type Documentation
| enum pj_stun_attr_type |
This enumeration describes STUN attribute types.
- Enumerator:
STUN decoding options
- Enumerator:
-
PJ_STUN_IS_DATAGRAM Tell the decoder that the message was received from datagram oriented transport (such as UDP). PJ_STUN_CHECK_PACKET Tell pj_stun_msg_decode() to check the validity of the STUN message by calling pj_stun_msg_check() before starting to decode the packet. PJ_STUN_NO_AUTHENTICATE This option current is only valid for pj_stun_session_on_rx_pkt(). When specified, it tells the session NOT to authenticate the message. PJ_STUN_NO_FINGERPRINT_CHECK Disable FINGERPRINT verification. This option can be used when calling pj_stun_msg_check() and pj_stun_msg_decode() to disable the verification of FINGERPRINT, for example when the STUN usage says when FINGERPRINT mechanism shall not be used.
| enum pj_stun_method_e |
STUN method constants.
- Enumerator:
| enum pj_stun_msg_class_e |