Using Interactive Connectivity Establishment (ICE) with Session Description Protocol (SDP) offer/answer and Session Initiation Protocol (SIP)Impedance Mismatchmarc@petit-huguenin.orgEricssonJorvas02420Finlandari.keranen@ericsson.comCisco Systems707 Tasman DrMilpitas95035USAsnandaku@cisco.com
RAI
MMUSIC
This document describes how Interactive Connectivity Establishment
(ICE) is used with Session Description Protocol (SDP) offer/answer
and Session Initiation Protocol (SIP).
This document describes how Interactive Connectivity Establishment (ICE)
is used with Session Description Protocol (SDP) offer/answer
and Session Initiation Protocol (SIP). The ICE
specification describes procedures that are
common to all usages of ICE and this document gives the additional
details needed to use ICE with SDP offer/answer and SIP.
Note that ICE is not intended for NAT traversal for SIP, which is
assumed to be provided via another mechanism .
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
RFC 2119 .
Readers should be familiar with the terminology defined in
, in and the
following:
The default destination for a component of a media stream is the
transport address that would be used by an agent that is not ICE aware.
A default candidate for a component is one whose transport address
matches the default destination for that component. For the RTP component,
the default IP address is in the "c=" line of the SDP, and the port
is in the "m=" line.For the RTCP component, it is in the rtcp attribute
when present, and when not present, the IP address is in the "c=" line
and 1 plus the port is in the "m=" line.
defines ICE candidate exchange as the process
for ICE agents (Initiator and Responder) to exchange their candidate
information required for ICE processing at the agents. For the purposes
of this specification, the candidate exchange process corresponds to
the Offer/Answer protocol and the terminologies
offerer and answerer correspond to the initiator and responder
terminologies from the respectively.
The offerer shall follow the procedures defined in section 4 of to gather, prioritize and eliminate the redundant
candidates. It then chooses the default candidates and encodes them
in the SDP to be sent to its peer, the answerer.
A candidate is said to be default if it would be the target of media
from a non-ICE peer; that target is called the DEFAULT DESTINATION.
If the default candidates are not selected by the ICE algorithm when communicating with an ICE-aware peer, an updated offer/answer will
be required after ICE processing completes in order to "fix up" the
SDP so that the default destination for media matches the candidates
selected by ICE. If ICE happens to select the default candidates,
no updated offer/answer is required.
An agent MUST choose a set of candidates, one for each component of
each in-use media stream, to be default. A media stream is in-use if
it does not have a port of zero (which is used in RFC 3264 to reject
a media stream). Consequently, a media stream is in-use even if it
is marked as a=inactive or has a bandwidth
value of zero.
It is RECOMMENDED that default candidates be chosen based on the
likelihood of those candidates to work with the peer that is being
contacted if ICE is not being used. It is RECOMMENDED that the
default candidates are the relayed candidates (if relayed
candidates are available), server reflexive candidates (if server
reflexive candidates are available), and finally host candidates.
The process of encoding the SDP is identical between full and lite implementations.
The agent will include an "m=" line for each media stream it wishes
to use. The ordering of media streams in the SDP is relevant for
ICE. ICE will perform its connectivity checks for the first
"m=" line first, and consequently media will be able to flow for
that stream first. Agents SHOULD place their most important media
stream, if there is one, first in the SDP.
There will be a candidate attribute for each candidate for a
particular media stream. provides
detailed rules for constructing this attribute.
STUN connectivity checks between agents are authenticated using the
short-term credential mechanism defined for STUN .
This mechanism relies on a username and password that are exchanged
through protocol machinery between the client and server. The
username fragment and password are exchanged in the ice-ufrag and
ice-pwd attributes, respectively.
If an agent is a lite implementation, it MUST include an "a=ice-lite" session-level attribute in its SDP to indicate this. If an agent
is a full implementation, it MUST NOT include this attribute.
Section 7 of defines a new ICE option, 'ice2'.
This option is used by ICE Agents to indicate their compliancy with
specification as compared to the
. If the Offering agent is a
compliant implementation, a session level
ICE option to indicate the same (via the "a=ice-options:ice2" SDP line)
MUST be included.
The default candidates are added to the SDP as the default
destination for media. For streams based on RTP, this is done by
placing the IP address and port of the RTP candidate into the
"c=" and "m=" lines, respectively. If the agent is utilizing RTCP
and if RTCP candidate is present and is not equal to the same address
and the next higher port number of the RTP candidate, the agent MUST
encode the RTCP candidate using the a=rtcp attribute as defined in
. If RTCP is not in use, the agent MUST
signal that using b=RS:0 and b=RR:0 as defined in
The transport addresses that will be the default destination for
media when communicating with non-ICE peers MUST also be present
as candidates in one or more a=candidate lines.
ICE provides for extensibility by allowing an offer or answer to
contain a series of tokens that identify the ICE extensions used
by that agent. If an agent supports an ICE extension, it MUST
include the token defined for that extension in the ice-options
attribute.
The following is an example SDP message that includes ICE
attributes (lines folded for readability):
Once an agent has sent its offer or its answer, that agent MUST
be prepared to receive both STUN and media packets on each candidate.
As discussed in section 9.1 of , media
packets can be sent to a candidate prior to its appearance as
the default destination for media in an offer or answer.
On receiving the offer, the answerer verifies the support for ICE
(section 5.1.1 of ), determines its role
(section 5.1.2 of ), gathers candidates
(section 4 of ), encodes the candidates in
an SDP answer and sends it to its peer, the offerer. The answerer
shall then follow the steps defined in sections 5.1.3 and 5.1.4 of
to schedule the ICE connectivity checks.
The below sub-sections provide additional requirements associated with
the processing of the offerer's SDP pertaining to this specification.
If the SDP offer contains a session level ICE option, "ice2" , and
if the answering ICE Agent is also an
compliant implementation, then the generated SDP answer MUST include
the session level "a=ice-options:ice2" SDP line.
The process for selecting default candidates at the answerer is
identical to the process followed by the offerer, as described in for full implementations in this specification
and section 4.2 of
for lite implementations.
The agent will proceed with the ICE procedures defined in and this specification if, for each media stream
in the SDP it received, the default destination for each component
of that media stream appears in a candidate attribute. For example,
in the case of RTP, the IP address and port in the "c=" and "m=" lines, respectively, appear in a candidate attribute and the value in the
rtcp attribute appears in a candidate attribute.
If this condition is not met, the agent MUST process the SDP based
on normal RFC 3264 procedures, without using any of the ICE
mechanisms described in the remainder of this specification with
the following exceptions:
The agent MUST follow the rules of section
8 of , which describe keepalive
procedures for all agents.
If the agent is not proceeding with ICE because there were
a=candidate attributes, but none that matched the default
destination of the media stream, the agent MUST include an
a=ice-mismatch attribute in its answer.
If the default candidates were relayed candidates learned
through a TURN server, the agent MUST create permissions in
the TURN server for the IP addresses learned from its peer in
the SDP it just received. If this is not done, initial packets
in the media stream from the peer may be lost.
In unusual cases, described in , it is
possible for both agents to mistakenly believe they are controlled
or controlling. To resolve this, each agent MUST select a
random number, called the tie-breaker, uniformly distributed
between 0 and (2**64) - 1 (that is, a 64-bit positive integer).
This number is used in connectivity checks to detect and repair
this case, as described in
section 6.1.2.3 of .
When ICE is used with SIP, forking may result in a single offer
generating a multiplicity of answers. In that case, ICE proceeds
completely in parallel and independently for each answer, treating
the combination of its offer and each answer as an independent
offer/answer exchange, with its own set of pairs, check lists,
states, and so on. The only case in which processing of one pair
impacts another is freeing of candidates, discussed below in .
On receiving the SDP answer , the offerer performs steps similar to
answerer's processing of the offer. The offerer verifies the
answerer's ICE support, determines its role and processes the
answerer's candidates to schedule the connectivity checks (section 6
of ).
If the offerer had included the "ice2" ICE Option in the offer and
the SDP answer also includes a similar session level ICE option,
then the peers are complaint
implementations. On the other hand, if the SDP Answer lacks such a
ICE option, the offerer defaults to the procedures that are backward
compatible with the specification.
The logic at the offerer is identical to that of the answerer as
described in section 5.1.1 of ,
with the exception that an offerer would not ever generate a=ice-mismatch attributes in an SDP.
In some cases, the answer may omit a=candidate attributes for the
media streams, and instead include an a=ice-mismatch attribute for
one or more of the media streams in the SDP. This signals to the
offerer that the answerer supports ICE, but that ICE processing was
not used for the session because a signaling intermediary modified
the default destination for media components without modifying the
corresponding candidate attributes. See
for a discussion of cases where this can happen. This specification
provides no guidance on how an agent should proceed in such a
failure case.
The possibility for role conflicts described in section 6.1.3.1.1 of applies
to this usage and hence all full agents MUST implement the role
conflict repairing mechanism. Also both full and lite agents MUST
utilize the ICE-CONTROLLED and ICE-CONTROLLING attributes as
described in
section 6.1.2.3 of .
Once all of the media streams are completed, the controlling
endpoint sends an updated offer if the transport destination in the
"m=" and "c=" lines for the media stream
(called the DEFAULT CANDIDATES) don't match ICE's selected
candidates.
Once the state of each check list is Completed, If an agent is
controlling, it examines the highest-priority nominated candidate
pair for each component of each media stream. If any of those
candidate pairs differ from the default candidate pairs in the
most recent offer/answer exchange, the controlling agent MUST generate an updated offer as described in .
When ICE is used with SIP, and an offer is forked to multiple
recipients, ICE proceeds in parallel and independently with
each answerer, all using the same local candidates. Once ICE
processing has reached the Completed state for all peers for
media streams using those candidates, the agent SHOULD wait
an additional three seconds, and then it MAY cease responding
to checks or generating triggered checks on that candidate.
It MAY free the candidate at that time. Freeing of server
reflexive candidates is never explicit; it happens by lack of a
keepalive. The three-second delay handles cases when aggressive
nomination is used, and the selected pairs can quickly change
after ICE has completed.
Either agent MAY generate a subsequent offer at any time allowed
by . The rules in
will cause the controlling agent to send an updated offer at the
conclusion of ICE processing when ICE has selected different candidate
pairs from the default pairs. This section defines rules for construction
of subsequent offers and answers.
Should a subsequent offer be rejected, ICE processing continues as if
the subsequent offer had never been made.
An agent MAY restart ICE processing for an existing media stream
as defined in section 6.3 of .
The rules govering the ICE restart imply that setting the IP
address in the "c=" line to 0.0.0.0 will cause an ICE restart.
Consequently, ICE implementations MUST NOT utilize this mechanism
for call hold, and instead MUST use a=inactive and a=sendonly as
described in .
To restart ICE, an agent MUST change both the ice-pwd and the
ice-ufrag for the media stream in an offer. Note that it is
permissible to use a session-level attribute in one offer, but to
provide the same ice-pwd or ice-ufrag as a media-level attribute
in a subsequent offer. This is not a change in password, just a
change in its representation, and does not cause an ICE restart.
An agent sets the rest of the fields in the SDP for this media
stream as it would in an initial offer of this media stream
(see ). Consequently, the set of
candidates MAY include some, none, or all of the previous
candidates for that stream and MAY include a totally new set
of candidates.
If an agent removes a media stream by setting its port to zero,
it MUST NOT include any candidate attributes for that media
stream and SHOULD NOT include any other ICE-related attributes
defined in for that media stream.
If an agent wishes to add a new media stream, it sets the fields
in the SDP for this media stream as if this was an initial offer
for that media stream (see ).
This will cause ICE processing to begin for this media stream.
This section describes additional procedures for full
implementations, covering existing media streams.
The username fragments, password, and implementation level MUST
remain the same as used previously. If an agent needs to change
one of these, it MUST restart ICE for that media stream.
Additional behavior depends on the state ICE processing for
that media stream.
If an agent generates an updated offer including a media stream
that was previously established, and for which ICE checks are
in the Running state, the agent follows the procedures defined
here.
An agent MUST include candidate attributes for all local
candidates it had signaled previously for that media stream.
The properties of that candidate as signaled in SDP -- the
priority, foundation, type, and related transport address --
SHOULD remain the same. The IP address, port, and transport
protocol, which fundamentally identify that candidate, MUST
remain the same (if they change, it would be a new candidate).
The component ID MUST remain the same. The agent MAY include
additional candidates it did not offer previously, but which it
has gathered since the last offer/answer exchange, including
peer reflexive candidates.
The agent MAY change the default destination for media. As with
initial offers, there MUST be a set of candidate attributes in
the offer matching this default destination.
If an agent generates an updated offer including a media stream
that was previously established, and for which ICE checks are
in the Completed state, the agent follows the procedures
defined here.
The default destination for media (i.e., the values of the
IP addresses and ports in the "m=" and "c=" lines used for
that media stream) MUST be the local candidate from the
highest-priority nominated pair in the valid list for each component.
This "fixes" the default destination for media to equal the
destination ICE has selected for media.
The agent MUST include candidate attributes for candidates
matching the default destination for each component of the media
stream, and MUST NOT include any other candidates.
In addition, if the agent is controlling, it MUST include the a=remote-candidates attribute for each media stream whose check
list is in the Completed state. The attribute contains the
remote candidates from the highest-priority nominated pair in
the valid list for each component of that media stream. It is
needed to avoid a race condition whereby the controlling agent
chooses its pairs, but the updated offer beats the connectivity
checks to the controlled agent, which doesn't even know these
pairs are valid, let alone selected.
See for elaboration on this
race condition.
This section describes procedures for lite implementations for
existing streams for which ICE is running.
A lite implementation MUST include all of its candidates for
each component of each media stream in an a=candidate attribute
in any subsequent offer. These candidates are formed identically
to the procedures for initial offers, as described in section 4.2 of .
A lite implementation MUST NOT add additional host candidates
in a subsequent offer. If an agent needs to offer additional
candidates, it MUST restart ICE.
The username fragments, password, and implementation level
MUST remain the same as used previously. If an agent needs to
change one of these, it MUST restart ICE for that media stream.
If ICE has completed for a media stream, the default destination
for that media stream MUST be set to the remote candidate of
the candidate pair for that component in the valid list. For a lite implementation, there is always just a single candidate pair in
the valid list for each component of a media stream. Additionally,
the agent MUST include a candidate attribute for each default
destination.
Additionally, if the agent is controlling (which only happens
when both agents are lite), the agent MUST include the
a=remote-candidates attribute for each media stream. The attribute
contains the remote candidates from the candidate pairs in the
valid list (one pair for each component of each media stream).
When receiving a subsequent offer within an existing session, an
agent MUST reapply the verification procedures in
without regard to the results of
verification from any previous offer/answer exchanges.
Indeed, it is possible that a previous offer/answer exchange
resulted in ICE not being used, but it is used as a consequence
of a subsequent exchange.
If the offer contained a change in the a=ice-ufrag or a=ice-pwd
attributes compared to the previous SDP from the peer, it
indicates that ICE is restarting for this media stream.
If all media streams are restarting, then ICE is restarting
overall.
If ICE is restarting for a media stream:
The agent MUST change the a=ice-ufrag and a=ice-pwd
attributes in the answer.
The agent MAY change its implementation level in the answer.
An agent sets the rest of the fields in the SDP for this media
stream as it would in an initial answer to this media stream
(see ). Consequently, the set of
candidates MAY include some, none, or all of the previous
candidates for that stream and MAY include a totally new set of
candidates.
If the offer contains a new media stream, the agent sets the
fields in the answer as if it had received an initial offer
containing that media stream (see ).
This will cause ICE processing to begin for this media stream.
If an offer contains a media stream whose port is zero, the agent
MUST NOT include any candidate attributes for that media stream
in its answer and SHOULD NOT include any other ICE-related
attributes defined in for that
media stream.
Unless the agent has detected an ICE restart from the offer,
the username fragments, password, and implementation level MUST
remain the same as used previously. If an agent needs to change
one of these it MUST restart ICE for that media stream by
generating an offer; ICE cannot be restarted in an answer.
Additional behaviors depend on the state of ICE processing for
that media stream.
If ICE is running for a media stream, and the offer for that
media stream lacked the remote-candidates attribute, the rules
for construction of the answer are identical to those for the
offerer as described in .
If ICE is Completed for a media stream, and the offer for that
media stream lacked the remote-candidates attribute, the rules
for construction of the answer are identical to those for the
offerer as described in , except
that the answerer MUST NOT include the a=remote-candidates
attribute in the answer.
A controlled agent will receive an offer with the a=remote-candidates attribute for a media stream when its peer has concluded ICE
processing for that media stream. This attribute is present in
the offer to deal with a race condition between the receipt of
the offer, and the receipt of the Binding Response that tells
the answerer the candidate that will be selected by ICE.
See for an explanation of this
race condition. Consequently, processing of an offer with this
attribute depends on the winner of the race.
The agent forms a candidate pair for each component of the media
stream by:
Setting the remote candidate equal to the offerer's default
destination for that component (e.g., the contents of the
"m=" and "c=" lines for RTP, and the a=rtcp attribute for
RTCP)
Setting the local candidate equal to the transport address
for that same component in the a=remote-candidates attribute
in the offer.
The agent then sees if each of these candidate pairs is present
in the valid list. If a particular pair is not in the valid list,
the check has "lost" the race. Call such a pair a "losing pair".
The agent finds all the pairs in the check list whose remote
candidates equal the remote candidate in the losing pair:
If none of the pairs are In-Progress, and at least one is
Failed, it is most likely that a network failure, such as a
network partition or serious packet loss, has occurred.
The agent SHOULD generate an answer for this media stream as
if the remote-candidates attribute had not been present, and
then restart ICE for this stream.
If at least one of the pairs is In-Progress, the agent SHOULD
wait for those checks to complete, and as each completes,
redo the processing in this section until there are no
losing pairs.
Once there are no losing pairs, the agent can generate the answer.
It MUST set the default destination for media to the candidates
in the remote-candidates attribute from the offer (each of which
will now be the local candidate of a candidate pair in the
valid list). It MUST include a candidate attribute in the answer
for each candidate in the remote-candidates attribute in the
offer.
If the received offer contains the remote-candidates attribute
for a media stream, the agent forms a candidate pair for each
component of the media stream by:
Setting the remote candidate equal to the offerer's default
destination for that component (e.g., the contents of the
"m=" and "c=" lines for RTP, and the a=rtcp attribute for
RTCP).
Setting the local candidate equal to the transport address
for that same component in the a=remote-candidates attribute
in the offer.
It then places those candidates into the Valid list for the
media stream. The state of ICE processing for that media stream
is set to Completed.
Furthermore, if the agent believed it was controlling, but the
offer contained the remote-candidates attribute, both agents
believe they are controlling. In this case, both would have sent
updated offers around the same time. However, the signaling
protocol carrying the offer/answer exchanges will have resolved
this glare condition, so that one agent is always the 'winner'
by having its offer received before its peer has sent an offer.
The winner takes the role of controlling, so that the
loser (the answerer under consideration in this section) MUST
change its role to controlled. Consequently, if the agent was
going to send an updated offer since, based on the rules in section 6.2 of , it was
controlling, it no longer needs to.
Besides the potential role change, change in the Valid list,
and state changes, the construction of the answer is performed i
dentically to the construction of an offer as described in .
Some deployments of ICE include e.g. SDP-Modifying Signaling-only Back-to-Back User Agents (B2BUAs) that
modify the SDP body during the subsequent offer/answer exchange.
With the B2BUA being ICE-unaware a subsequent answer might be
manipulated and might not include ICE candidates although the
initial answer did.
An example of a situation where such an "unexpected" answer might
be experienced appears when such a B2BUA introduces a media server
during call hold using 3rd party call-control procedures. Omitting
further details how this is done this could result in an answer being
received at the holding UA that was constructed by the B2BUA.
With the B2BUA being ICE-unaware that answer would not include
ICE candidates.
Receiving an answer without ICE attributes in this situation might
be unexpected, but would not necessarily impair the user
experience.
In addition to procedures for the expected answer, the following
sections advice on how to recover from the unexpected situation.
When receiving an answer within an existing session for a
subsequent offer as specified in ,
an agent MUST verify ICE support as specified in
.
If ICE support is indicated in the SDP answer, the agent MUST
perform ICE restart procedures as specified in
.
If ICE support is no longer indicated in the SDP answer, the
agent MUST fall-back to RFC 3264 procedures and SHOULD NOT
drop the dialog just because of missing ICE support. If the agent
sends a new offer later on it SHOULD perform an ICE restart as
specified in .
If ICE support is indicated in the SDP answer, the agent MUST
continue ICE procedures as specified in
.
If ICE support is no longer indicated in the SDP answer, the
agent MUST abort the ongoing ICE processing and fall-back to RFC 3264 procedures. The agent SHOULD NOT drop the dialog just because of
missing ICE support. If the agent sends a new offer later on,
it SHOULD perform an ICE restart as specified in .
If ICE support is indicated in the SDP answer and if the answer
conforms to , the agent MUST
remain in the ICE Completed state.
If ICE support is no longer indicated in the SDP answer, the
agent MUST fall-back to RFC 3264 procedures and SHOULD NOT
drop the dialog just because of this unexpected answer.
Once the agent sends a new offer later on it MUST perform an
ICE restart.
The agent MUST remember the highest-priority nominated pairs in
the Valid list for each component of the media stream, called
the previous selected pairs, prior to the restart. The agent will
continue to send media using these pairs, as described in . Once these destinations are noted,
the agent MUST flush the valid and check lists, and then
recompute the check list and its states as described in section 5.1.3 of .
If the offer/answer exchange added a new media stream, the agent
MUST create a new check list for it (and an empty Valid list to
start of course), as described in section 5.1.3
of .
If the offer/answer exchange removed a media stream, or an answer
rejected an offered media stream, an agent MUST flush the Valid
list for that media stream. It MUST terminate any STUN transactions
in progress for that media stream. An agent MUST remove the check
list for that media stream and cancel any pending ordinary checks
for it.
The valid list is not affected by an updated offer/answer exchange
unless ICE is restarting.
If an agent is in the Running state for that media stream, the
check list is updated (the check list is irrelevant if the state is completed). To do that, the agent recomputes the check list
using the procedures described in section 5.1.3 of . If a pair on the new check list was also
on the previous check list, and its state was Waiting,
In-Progress, Succeeded, or Failed, its state is copied over.
Otherwise, its state is set to Frozen.
If none of the check lists are active (meaning that the pairs
in each check list are Frozen), the full-mode agent sets the
first pair in the check list for the first media stream to
Waiting, and then sets the state of all other pairs in that
check list for the same component ID and with the same
foundation to Waiting as well.
Next, the agent goes through each check list, starting with the highest-priority pair. If a pair has a state of Succeeded, and
it has a component ID of 1, then all Frozen pairs in the same
check list with the same foundation whose component IDs are not
1 have their state set to Waiting. If, for a particular check
list, there are pairs for each component of that media stream
in the Succeeded state, the agent moves the state of all Frozen
pairs for the first component of all other media streams
(and thus in different check lists) with the same foundation
to Waiting.
If ICE is restarting for a media stream, the agent MUST start a
new Valid list for that media stream. It MUST remember the pairs
in the previous Valid list for each component of the media stream,
called the previous selected pairs, and continue to send media
there as described in .
The state of ICE processing for each media stream MUST change to
Running, and the state of ICE processing MUST change to Running.
This specification defines eight new SDP attributes -- the "candidate", "remote-candidates", "ice-lite", "ice-mismatch", "ice-ufrag", "ice-pwd", "ice-pacing", and "ice-options" attributes.The candidate attribute is a media-level attribute only. It contains a transport address for a candidate that can be used for connectivity checks.The syntax of this attribute is defined using Augmented BNF as defined in :This grammar encodes the primary information about a candidate: its IP address, port and transport protocol, and its properties: the foundation, component ID, priority, type, and related transport address:
is taken from RFC 4566 . It is the IP address of the candidate, allowing for IPv4 addresses, IPv6 addresses, and fully qualified domain names (FQDNs).
When parsing this field, an agent can differentiate an IPv4 address and an IPv6 address by presence of a colon in its value -- the presence of a colon indicates IPv6. An agent MUST ignore candidate lines that include candidates with IP address versions that are not supported or recognized.
An IP address SHOULD be used, but an FQDN MAY be used in place of an IP address.
In that case, when receiving an offer or answer containing an FQDN in an a=candidate attribute, the FQDN is looked up in the DNS first using an AAAA record (assuming the agent supports IPv6), and if no result is found or the agent only supports IPv4, using an A.
If the DNS query returns more than one IP address, one is chosen, and then used for the remainder of ICE processing.
is also taken from RFC 4566 .
It is the port of the candidate.
indicates the transport protocol for the candidate.
This specification only defines UDP.
However, extensibility is provided to allow for future transport protocols to be used with ICE, such as TCP or the Datagram Congestion Control Protocol (DCCP) .
is composed of 1 to 32 <ice-char>s.
It is an identifier that is equivalent for two candidates that are of the same type, share the same base, and come from the same STUN server.
The foundation is used to optimize ICE performance in the Frozen algorithm.
is a positive integer between 1 and 256 that identifies the specific component of the media stream for which this is a candidate.
It MUST start at 1 and MUST increment by 1 for each component of a particular candidate.
For media streams based on RTP, candidates for the actual RTP media MUST have a component ID of 1, and candidates for RTCP MUST have a component ID of 2.
See section 10 in for additional discussion on extending ICE to new media streams.
is a positive integer between 1 and (2**31 - 1).
encodes the type of candidate.
This specification defines the values "host", "srflx", "prflx", and "relay" for host, server reflexive, peer reflexive, and relayed candidates, respectively.
The set of candidate types is extensible for the future.
convey transport addresses related to the candidate, useful for diagnostics and other purposes.
<rel-addr> and <rel-port> MUST be present for server reflexive, peer reflexive, and relayed candidates.
If a candidate is server or peer reflexive, <rel-addr> and <rel-port> are equal to the base for that server or peer reflexive candidate.
If the candidate is relayed, <rel-addr> and <rel-port> is equal to the mapped address in the Allocate response that provided the client with that relayed candidate (see section Appendix B.3 of for a discussion of its purpose).
If the candidate is a host candidate, <rel-addr> and <rel-port> MUST be omitted.
In some cases, e.g., for privacy reasons, an agent may not want to reveal the related address and port. In this case the address MUST be set to "0.0.0.0" (for IPv4 candidates) or "::" (for IPv6 candidates) and the port to zero.
The candidate attribute can itself be extended.
The grammar allows for new name/value pairs to be added at the end of the attribute.
An implementation MUST ignore any name/value pairs it doesn't understand.
The syntax of the "remote-candidates" attribute is defined using Augmented BNF as defined in RFC 5234.
The remote-candidates attribute is a media-level attribute only.
The attribute contains a connection-address and port for each component.
The ordering of components is irrelevant.
However, a value MUST be present for each component of a media stream.
This attribute MUST be included in an offer by a controlling agent for a media stream that is Completed, and MUST NOT be included in any other case.
The syntax of the "ice-lite" and "ice-mismatch" attributes, both of which are flags, is:
"ice-lite" is a session-level attribute only, and indicates that an agent is a lite implementation.
"ice-mismatch" is a media-level attribute only, and when present in an answer, indicates that the offer arrived with a default destination for a media component that didn't have a corresponding candidate attribute.
The "ice-ufrag" and "ice-pwd" attributes convey the username fragment and password used by ICE for message integrity. Their syntax is:
The "ice-pwd" and "ice-ufrag" attributes can appear at either the session-level or media-level.
When present in both, the value in the media-level takes precedence.
Thus, the value at the session-level is effectively a default that applies to all media streams, unless overridden by a media-level value.
Whether present at the session or media-level, there MUST be an ice-pwd and ice-ufrag attribute for each media stream.
If two media streams have identical ice-ufrag's, they MUST have identical ice-pwd's.
The ice-ufrag and ice-pwd attributes MUST be chosen randomly at the beginning of a session.
The ice-ufrag attribute MUST contain at least 24 bits of randomness, and the ice-pwd attribute MUST contain at least 128 bits of randomness.
This means that the ice-ufrag attribute will be at least 4 characters long, and the ice-pwd at least 22 characters long, since the grammar for these attributes allows for 6 bits of randomness per character.
The attributes MAY be longer than 4 and 22 characters, respectively, of course, up to 256 characters.
The upper limit allows for buffer sizing in implementations.
Its large upper limit allows for increased amounts of randomness to be added over time.
For compatibility with the 512 character limitation for the STUN username attribute value and for bandwidth conservation considerations, the ice-ufrag attribute MUST NOT be longer than 32 characters when sending, but an implementation MUST accept up to 256 characters when receiving.
The "ice-pacing" attribute indicates the desired connectivity check pacing, in milliseconds, for this agent (see section 11 of ). The syntax is:
The "ice-options" attribute is a session- and media-level attribute.
It contains a series of tokens that identify the options supported by the agent.
Its grammar is:
The existence of an ice-option can indicate that a certain extension is supported by the agent and will be used or that the extension is used only if the other agent is willing to use it too. In order to avoid ambiguity, documents defining new options must indicate which case applies to the defined extensions.
The procedures defined in section 8 of MUST be followed. The keepalives MUST be sent regardless of whether the media stream is currently inactive, sendonly, recvonly, or sendrecv, and regardless of the presence or value of the bandwidth attribute.
An agent can determine that its peer supports ICE by the presence of a=candidate attributes for each media session.
Note that the selected pair for a component of a media stream may not
equal the default pair for that same component from the most recent
offer/answer exchange. When this happens, the selected pair is used
for media, not the default pair. When ICE first completes, if the
selected pairs aren't a match for the default pairs, the controlling
agent sends an updated offer/answer exchange to remedy this
disparity. However, until that updated offer arrives, there will not
be a match. Furthermore, in very unusual cases, the default
candidates in the updated offer/answer will not be a match.
section 9.1.3 of defines procedures for
sending media common across Full and Lite implementations.
See section 9.2 of for procedures on
receiving media.
ICE requires a series of STUN-based connectivity checks to take place between endpoints.
These checks start from the answerer on generation of its answer, and start from the offerer when it receives the answer.
These checks can take time to complete, and as such, the selection of messages to use with offers and answers can affect perceived user latency.
Two latency figures are of particular interest.
These are the post-pickup delay and the post-dial delay.
The post-pickup delay refers to the time between when a user "answers the phone" and when any speech they utter can be delivered to the caller.
The post-dial delay refers to the time between when a user enters the destination address for the user and ringback begins as a consequence of having successfully started ringing the phone of the called party.
Two cases can be considered -- one where the offer is present in the initial INVITE and one where it is in a response.
To reduce post-dial delays, it is RECOMMENDED that the caller begin gathering candidates prior to actually sending its initial INVITE.
This can be started upon user interface cues that a call is pending, such as activity on a keypad or the phone going off-hook.
If an offer is received in an INVITE request, the answerer SHOULD begin to gather its candidates on receipt of the offer and then generate an answer in a provisional response once it has completed that process.
ICE requires that a provisional response with an SDP be transmitted reliably.
This can be done through the existing Provisional Response Acknowledgment (PRACK) mechanism or through an optimization that is specific to ICE.
With this optimization, provisional responses containing an SDP answer that begins ICE processing for one or more media streams can be sent reliably without RFC 3262.
To do this, the agent retransmits the provisional response with the exponential backoff timers described in RFC 3262.
Retransmits MUST cease on receipt of a STUN Binding request for one of the media streams signaled in that SDP (because receipt of a Binding request indicates the offerer has received the answer) or on transmission of the answer in a 2xx response.
If the peer agent is lite, there will never be a STUN Binding request.
In such a case, the agent MUST cease retransmitting the 18x after sending it four times (ICE will actually work even if the peer never receives the 18x; however, experience has shown that sending it is important for middleboxes and firewall traversal).
If no Binding request is received prior to the last retransmit, the agent does not consider the session terminated.
Despite the fact that the provisional response will be delivered reliably, the rules for when an agent can send an updated offer or answer do not change from those specified in RFC 3262.
Specifically, if the INVITE contained an offer, the same answer appears in all of the 1xx and in the 2xx response to the INVITE.
Only after that 2xx has been sent can an updated offer/answer exchange occur.
This optimization SHOULD NOT be used if both agents support PRACK.
Note that the optimization is very specific to provisional response carrying answers that start ICE processing; it is not a general technique for 1xx reliability.
Alternatively, an agent MAY delay sending an answer until the 200 OK; however, this results in a poor user experience and is NOT RECOMMENDED.
Once the answer has been sent, the agent SHOULD begin its connectivity checks.
Once candidate pairs for each component of a media stream enter the valid list, the answerer can begin sending media on that media stream.
However, prior to this point, any media that needs to be sent towards the caller (such as SIP early media ) MUST NOT be transmitted.
For this reason, implementations SHOULD delay alerting the called party until candidates for each component of each media stream have entered the valid list.
In the case of a PSTN gateway, this would mean that the setup message into the PSTN is delayed until this point.
Doing this increases the post-dial delay, but has the effect of eliminating 'ghost rings'.
Ghost rings are cases where the called party hears the phone ring, picks up, but hears nothing and cannot be heard.
This technique works without requiring support for, or usage of, preconditions , since it's a localized decision.
It also has the benefit of guaranteeing that not a single packet of media will get clipped, so that post-pickup delay is zero.
If an agent chooses to delay local alerting in this way, it SHOULD generate a 180 response once alerting begins.
In addition to uses where the offer is in an INVITE, and the answer is in the provisional and/or 200 OK response, ICE works with cases where the offer appears in the response.
In such cases, which are common in third party call control , ICE agents SHOULD generate their offers in a reliable provisional response (which MUST utilize RFC 3262), and not alert the user on receipt of the INVITE.
The answer will arrive in a PRACK. This allows for ICE processing to take place prior to alerting, so that there is no post-pickup delay, at the expense of increased call setup delays.
Once ICE completes, the callee can alert the user and then generate a 200 OK when they answer.
The 200 OK would contain no SDP, since the offer/answer exchange has completed.
Alternatively, agents MAY place the offer in a 2xx instead (in which case the answer comes in the ACK).
When this happens, the callee will alert the user on receipt of the INVITE, and the ICE exchanges will take place only after the user answers.
This has the effect of reducing call setup delay, but can cause substantial post-pickup delays and media clipping.
specifies a SIP option tag and media feature tag for usage with ICE.
ICE implementations using SIP SHOULD support this specification, which uses a feature tag in registrations to facilitate interoperability through signaling intermediaries.
ICE interacts very well with forking. Indeed, ICE fixes some of the problems associated with forking.
Without ICE, when a call forks and the caller receives multiple incoming media streams, it cannot determine which media stream corresponds to which callee.
With ICE, this problem is resolved.
The connectivity checks which occur prior to transmission of media carry username fragments, which in turn are correlated to a specific callee.
Subsequent media packets that arrive on the same candidate pair as the connectivity check will be associated with that same callee.
Thus, the caller can perform this correlation as long as it has received an answer.
Quality of Service (QoS) preconditions, which are defined in RFC 3312 and RFC 4032 , apply only to the transport addresses listed as the default targets for media in an offer/answer.
If ICE changes the transport address where media is received, this change is reflected in an updated offer that changes the default destination for media to match ICE's selection.
As such, it appears like any other re-INVITE would, and is fully treated in RFCs 3312 and 4032, which apply without regard to the fact that the destination for media is changing due to ICE negotiations occurring "in the background".
Indeed, an agent SHOULD NOT indicate that QoS preconditions have been met until the checks have completed and selected the candidate pairs to be used for media.
ICE also has (purposeful) interactions with connectivity preconditions .
Those interactions are described there.
Note that the procedures described in describe their own type of "preconditions", albeit with less functionality than those provided by the explicit preconditions in .
ICE works with Flows I, III, and IV as described in .
Flow I works without the controller supporting or being aware of ICE.
Flow IV will work as long as the controller passes along the ICE attributes without alteration.
Flow II is fundamentally incompatible with ICE; each agent will believe itself to be the answerer and thus never generate a re-INVITE.
The flows for continued operation, as described in Section 7 of RFC 3725, require additional behavior of ICE implementations to support.
In particular, if an agent receives a mid-dialog re-INVITE that contains no offer, it MUST restart ICE for each media stream and go through the process of gathering new candidates.
Furthermore, that list of candidates SHOULD include the ones currently being used for media.
RFC 4091 , the Alternative Network Address Types (ANAT) Semantics for the SDP grouping framework, and RFC 4092 , its usage with SIP, define a mechanism for indicating that an agent can support both IPv4 and IPv6 for a media stream, and it does so by including two "m=" lines, one for v4 and one for v6.
This is similar to ICE, which allows for an agent to indicate multiple transport addresses using the candidate attribute.
However, ANAT relies on static selection to pick between choices, rather than a dynamic connectivity check used by ICE.
This specification deprecates RFC 4091 and RFC 4092. Instead, agents wishing to support dual-stack will utilize ICE.
During the gathering phase of ICE (section 4.1.1 )
and while ICE is performing connectivity checks (section 6 ),
an agent sends STUN and TURN transactions. These transactions are paced at a
rate of one every Ta milliseconds, and utilize a specific RTO. See Section 11 of
for details on how the values of Ta and RTO are computed
with a real-time media stream of known maximum bandwidth to rate-control the ICE exchanges.
An attacker that can modify or disrupt the offer/answer exchanges themselves can readily launch a variety of attacks with ICE.
They could direct media to a target of a DoS attack, they could insert themselves into the media stream, and so on.
These are similar to the general security considerations for offer/answer exchanges, and the security considerations in RFC 3264 apply.
These require techniques for message integrity and encryption for offers and answers, which are satisfied by the SIPS mechanism when SIP is used.
As such, the usage of SIPS with ICE is RECOMMENDED.
In addition to attacks where the attacker is a third party trying to insert fake offers, answers, or stun messages, there are several attacks possible with ICE when the attacker is an authenticated and valid participant in the ICE exchange.
The voice hammer attack is an amplification attack.
In this attack, the attacker initiates sessions to other agents, and maliciously includes the IP address and port of a DoS target as the destination for media traffic signaled in the SDP.
This causes substantial amplification; a single offer/answer exchange can create a continuing flood of media packets, possibly at high rates (consider video sources).
This attack is not specific to ICE, but ICE can help provide remediation.
Specifically, if ICE is used, the agent receiving the malicious SDP will first perform connectivity checks to the target of media before sending media there.
If this target is a third-party host, the checks will not succeed, and media is never sent.
Unfortunately, ICE doesn't help if its not used, in which case an attacker could simply send the offer without the ICE parameters.
However, in environments where the set of clients is known, and is limited to ones that support ICE, the server can reject any offers or answers that don't indicate ICE support.
Application Layer Gateways (ALGs) are functions present in a NAT device that inspect the contents of packets and modify them, in order to facilitate NAT traversal for application protocols.
Session Border Controllers (SBCs) are close cousins of ALGs, but are less transparent since they actually exist as application layer SIP intermediaries.
ICE has interactions with SBCs and ALGs.
If an ALG is SIP aware but not ICE aware, ICE will work through it as long as the ALG correctly modifies the SDP.
A correct ALG implementation behaves as follows:
The ALG does not modify the "m=" and "c=" lines or the rtcp attribute if they contain external addresses.If the "m=" and "c=" lines contain internal addresses, the modification depends on the state of the ALG:
If the ALG already has a binding established that maps an external port to an internal IP address and port matching the values in the "m=" and "c=" lines or rtcp attribute, the ALG uses that binding instead of creating a new one.If the ALG does not already have a binding, it creates a new one and modifies the SDP, rewriting the "m=" and "c=" lines and rtcp attribute.
Unfortunately, many ALGs are known to work poorly in these corner cases.
ICE does not try to work around broken ALGs, as this is outside the scope of its functionality.
ICE can help diagnose these conditions, which often show up as a mismatch between the set of candidates and the "m=" and "c=" lines and rtcp attributes.
The ice-mismatch attribute is used for this purpose.
ICE works best through ALGs when the signaling is run over TLS.
This prevents the ALG from manipulating the SDP messages and interfering with ICE operation.
Implementations that are expected to be deployed behind ALGs SHOULD provide for TLS transport of the SDP.
If an SBC is SIP aware but not ICE aware, the result depends on the behavior of the SBC.
If it is acting as a proper Back-to-Back User Agent (B2BUA), the SBC will remove any SDP attributes it doesn't understand, including the ICE attributes.
Consequently, the call will appear to both endpoints as if the other side doesn't support ICE.
This will result in ICE being disabled, and media flowing through the SBC, if the SBC has requested it.
If, however, the SBC passes the ICE attributes without modification, yet modifies the default destination for media (contained in the "m=" and "c=" lines and rtcp attribute), this will be detected as an ICE mismatch, and ICE processing is aborted for the call.
It is outside of the scope of ICE for it to act as a tool for "working around" SBCs.
If one is present, ICE will not be used and the SBC techniques take precedence.
Original ICE specification defined seven new SDP attributes per the procedures of Section 8.2.4 of .
The registration information is reproduced here.
Jonathan Rosenberg, jdrosen@jdrosen.net.candidatecandidatemedia-levelThe attribute is not subject to the charset attribute.
This attribute is used with Interactive Connectivity Establishment (ICE), and provides one of many possible candidate addresses for communication.
These addresses are validated with an end-to-end connectivity check using Session Traversal Utilities for NAT (STUN).
See of RFC XXXX.Jonathan Rosenberg, jdrosen@jdrosen.net.remote-candidatesremote-candidatesmedia-levelThe attribute is not subject to the charset attribute.This attribute is used with Interactive Connectivity Establishment (ICE), and provides the identity of the remote candidates that the offerer wishes the answerer to use in its answer. See of RFC XXXX.Jonathan Rosenberg, jdrosen@jdrosen.net.ice-liteice-litesession-levelThe attribute is not subject to the charset attribute.This attribute is used with Interactive Connectivity Establishment (ICE), and indicates that an agent has the minimum functionality required to support ICE inter-operation with a peer that has a full implementation.See of RFC XXXX.Jonathan Rosenberg, jdrosen@jdrosen.net.ice-mismatchice-mismatchsession-levelThe attribute is not subject to the charset attribute.This attribute is used with Interactive Connectivity Establishment (ICE), and indicates that an agent is ICE capable, but did not proceed with ICE due to a mismatch of candidates with the default destination for media signaled in the SDP.See of RFC XXXX.Jonathan Rosenberg, jdrosen@jdrosen.net.ice-pwdice-pwdsession- or media-levelThe attribute is not subject to the charset attribute.This attribute is used with Interactive Connectivity Establishment (ICE), and provides the password used to protect STUN connectivity checks.See of RFC XXXX.Jonathan Rosenberg, jdrosen@jdrosen.net.ice-ufragice-ufrag session- or media-level The attribute is not subject to the charset attribute.This attribute is used with Interactive Connectivity Establishment (ICE), and provides the fragments used to construct the username in STUN connectivity checks.See of RFC XXXX.Jonathan Rosenberg, jdrosen@jdrosen.net.ice-pacingice-pacing session-level The attribute is not subject to the charset attribute.This attribute is used with Interactive Connectivity Establishment (ICE) to indicate desired connectivity check pacing values.See of RFC XXXX.Jonathan Rosenberg, jdrosen@jdrosen.net.ice-optionsice-optionssession- or media-levelThe attribute is not subject to the charset attribute.This attribute is used with Interactive Connectivity Establishment (ICE), and indicates the ICE options or extensions used by the agent.See of RFC XXXX.IANA maintains a registry for ice-options identifiers under the Specification Required policy as defined in "Guidelines for Writing an IANA Considerations Section in RFCs".
ICE options are of unlimited length according to the syntax in ; however, they are RECOMMENDED to be no longer than 20 characters.
This is to reduce message sizes and allow for efficient parsing.
In RFC 5245 ICE options could only be defined at the session level.
ICE options can now also be defined at the media level.
This can be used when aggregating between different ICE agents in the same endpoint, but future options may require to be defined at the media-level.
To ensure compatibility with legacy implementation, the media-level ICE options MUST be aggregated into a session-level ICE option.
Because aggregation rules depend on the specifics of each option, all new ICE options MUST also define in their specification how the media-level ICE option values are aggregated to generate the value of the session-level ICE option.
defines "rtp+ecn" ICE option. The aggregation
rule for this ICE option is that if all aggregated media using ICE contain a media-level "rtp+ecn" ICE option then an "rtp+ecn" ICE option MUST be inserted at the session-level. If one of the media does not contain the option,
then it MUST NOT be inserted at the session-level.
Section 7 of defines "ice2" ICE option. Since "ice2" is a
session level ICE option, no aggregation rules apply.
A registration request MUST include the following information:
The ICE option identifier to be registeredName, Email, and Address of a contact person for the registrationOrganization or individuals having the change controlShort description of the ICE extension to which the option relatesReference(s) to the specification defining the ICE option and the related extensionsA large part of the text in this document was taken from RFC 5245, authored by Jonathan Rosenberg.Some of the text in this document was taken from RFC 6336, authored by Magnus Westerlund and Colin Perkins.Thanks to Thomas Stach for the text in and
Roman Shpount for suggesting RTCP candidate handling in Thanks to following experts for their review and constructive feedback:
Christer Holmberg. Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal for Offer/Answer Protocols
This document describes a protocol for Network Address Translator (NAT) traversal for UDP-based multimedia sessions established with the offer/answer model.
This protocol is called Interactive Connectivity Establishment (ICE).
ICE makes use of the Session Traversal Utilities for NAT (STUN) protocol and its extension, Traversal Using Relay NAT (TURN).
ICE can be used by any protocol utilizing the offer/answer model, such as the Session Initiation Protocol (SIP).
For the example shown in section 12 of the resulting offer (message 5) encoded in SDP looks like:The offer, with the variables replaced with their values, will look like (lines folded for clarity):The resulting answer looks like:With the variables filled in:
The a=remote-candidates attribute exists to eliminate a race condition between the updated offer and the response to the STUN Binding request that moved a candidate into the Valid list.
This race condition is shown in .
On receipt of message 4, agent L adds a candidate pair to the valid list.
If there was only a single media stream with a single component, agent L could now send an updated offer.
However, the check from agent R has not yet generated a response, and agent R receives the updated offer (message 7) before getting the response (message 9).
Thus, it does not yet know that this particular pair is valid.
To eliminate this condition, the actual candidates at R that were selected by the offerer (the remote candidates) are included in the offer itself, and the answerer delays its answer until those pairs validate.
When ICE runs between two peers, one agent acts as controlled, and the other as controlling.
Rules are defined as a function of implementation type and offerer/answerer to determine who is controlling and who is controlled.
However, the specification mentions that, in some cases, both sides might believe they are controlling, or both sides might believe they are controlled.
How can this happen?
The condition when both agents believe they are controlled shows up in third party call control cases. Consider the following flow:
This flow is a variation on flow III of RFC 3725 .
In fact, it works better than flow III since it produces fewer messages.
In this flow, the controller sends an offerless INVITE to agent A, which responds with its offer, SDP1.
The agent then sends an offerless INVITE to agent B, which it responds to with its offer, SDP2.
The controller then uses the offer from each agent to generate the answers.
When this flow is used, ICE will run between agents A and B, but both will believe they are in the controlling role.
With the role conflict resolution procedures, this flow will function properly when ICE is used.
At this time, there are no documented flows that can result in the case where both agents believe they are controlled.
However, the conflict resolution procedures allow for this case, should a flow arise that would fit into this category.
Section 11.1 describes rules for sending media.
Both agents can send media once ICE checks complete, without waiting for an updated offer.
Indeed, the only purpose of the updated offer is to "correct" the SDP so that the default destination for media matches where media is being sent based on ICE procedures (which will be the highest-priority nominated candidate pair).
This begs the question -- why is the updated offer/answer exchange needed at all?
Indeed, in a pure offer/answer environment, it would not be.
The offerer and answerer will agree on the candidates to use through ICE, and then can begin using them.
As far as the agents themselves are concerned, the updated offer/answer provides no new information.
However, in practice, numerous components along the signaling path look at the SDP information.
These include entities performing off-path QoS reservations, NAT traversal components such as ALGs and Session Border Controllers (SBCs), and diagnostic tools that passively monitor the network.
For these tools to continue to function without change, the core property of SDP -- that the existing, pre-ICE definitions of the addresses used for media -- the "m=" and "c=" lines and the rtcp attribute -- must be retained.
For this reason, an updated offer must be sent.