From 2810e848c24d93b2292a08f2df0293166cf32ee6 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 22 Nov 2012 17:49:08 +0100 Subject: Update doc for RFC 6733 --- lib/diameter/doc/src/diameter.xml | 14 +++++++------- lib/diameter/doc/src/diameter_app.xml | 2 +- lib/diameter/doc/src/diameter_dict.xml | 22 ++++++++++------------ lib/diameter/doc/src/diameter_intro.xml | 11 +++++++---- lib/diameter/doc/src/diameter_soc.xml | 30 ++++++++---------------------- lib/diameter/doc/src/diameter_tcp.xml | 2 +- lib/diameter/doc/src/seealso.ent | 2 ++ 7 files changed, 36 insertions(+), 47 deletions(-) (limited to 'lib') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 3ad06156a2..b7669b760b 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -56,7 +56,7 @@ under the License.

This module provides the interface with which a user can implement a Diameter node that sends and receives messages using the -Diameter protocol as defined in RFC 3588.

+Diameter protocol as defined in &the_rfc;.

Basic usage consists of creating a representation of a @@ -73,7 +73,7 @@ Beware the difference between diameter (not capitalised) and Diameter (capitalised). The former refers to the Erlang application named diameter whose main api is defined here, the latter to Diameter protocol in the sense of -RFC 3588.

+&the_rfc;.

The diameter application must be started before calling most functions @@ -97,7 +97,7 @@ in this module.

UTF8String()

-Types corresponding to RFC 3588 AVP Data Formats. +Types corresponding to &the_rfc; AVP Data Formats. Defined in &dict_data_types;.

@@ -318,7 +318,7 @@ returns an address list.

Origin-State-Id is optional but will be included in outgoing messages sent by diameter itself: CER/CEA, DWR/DWA and DPR/DPA. Setting a value of 0 (zero) is equivalent to not setting a -value as documented in RFC 3588. +value as documented in &the_rfc;. The function &origin_state_id; can be used as to retrieve a value that is computed when the diameter application is started.

@@ -753,7 +753,7 @@ as follows.

(H bsl N) bor (Id band ((1 bsl N) - 1))

-Note that RFC 3588 requires that End-to-End identifiers remain unique +Note that &the_rfc; requires that End-to-End identifiers remain unique for a period of at least 4 minutes and that this and the call rate places a lower bound on the appropriate values of N: at a rate of R requests per second an N-bit counter @@ -955,7 +955,7 @@ Tc = &dict_Unsigned32;

-For a connecting transport, the RFC 3588 Tc timer, in milliseconds. +For a connecting transport, the &the_rfc; Tc timer, in milliseconds. Note that this timer determines the frequency with which a transport will attempt to establish a connection with its peer only before an initial connection is established: once there is an initial @@ -1622,7 +1622,7 @@ Return the list of started services.

Return a value for a Session-Id AVP.

-The value has the form required by section 8.8 of RFC 3588. +The value has the form required by section 8.8 of &the_rfc;. Ident should be the Origin-Host of the peer from which the message containing the returned value will be sent.

diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml index d1fbb9ba31..f4db625c71 100644 --- a/lib/diameter/doc/src/diameter_app.xml +++ b/lib/diameter/doc/src/diameter_app.xml @@ -558,7 +558,7 @@ where Avps sets the Origin-Host, Origin-Realm, the specified Result-Code and (if the request sent one) Session-Id AVP's.

-Note that RFC 3588 mandates that only answers with a 3xxx series +Note that &the_rfc; mandates that only answers with a 3xxx series Result-Code (protocol errors) may set the E bit. Returning a non-3xxx value in a protocol_error tuple will cause the request process in question to fail.

diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml index eb6cf9ba86..8b0687a22e 100644 --- a/lib/diameter/doc/src/diameter_dict.xml +++ b/lib/diameter/doc/src/diameter_dict.xml @@ -77,7 +77,7 @@ AVPs of type Enumerated.

The diameter application includes three dictionary modules -corresponding to applications defined in section 2.4 of RFC 3588: +corresponding to applications defined in section 2.4 of &the_rfc;: diameter_gen_base_rfc3588 for the Diameter Common Messages application with application identifier 0, diameter_gen_accounting for the Diameter Base Accounting @@ -258,7 +258,7 @@ is equivalent to using @avp_vendor_id with a copy of the dictionary's definitions but the former makes for easier reuse.

-All dictionaries should typically inherit RFC3588 AVPs from +All dictionaries should typically inherit &the_rfc; AVPs from diameter_gen_base_rfc3588.

@@ -299,9 +299,7 @@ Requested-Information 353 Enumerated V

-The P flag has been deprecated by the Diameter Maintenance -and Extensions Working Group of the IETF and should be omitted -to conform to the current draft standard.

+The P flag has been deprecated by &the_rfc;.

 @@ -355,7 +353,7 @@ Framed-IP-Address

Defines the messages of the application. The section content consists of definitions of the form specified in -section 3.2 of RFC 3588, "Command Code ABNF specification".

+section 3.2 of &the_rfc;, "Command Code Format Specification".

@@ -403,7 +401,7 @@ RTA ::= < Diameter Header: 287, PXY >
 Defines the contents of the AVPs of the application having type
 Grouped.
 The section content consists of definitions of the form specified in
-section 4.4 of RFC 3588, "Grouped AVP Values".

+section 4.4 of &the_rfc;, "Grouped AVP Values".

 
 

 Example:

@@ -507,7 +505,7 @@ type and number of times the AVP can occur.
 In particular, an AVP which is specified as occurring exactly once is
 encoded as a value of the AVP's type while an AVP with any other
 specification is encoded as a list of values of the AVP's type.
-The AVP's type is as specified in the AVP definition, the RFC 3588
+The AVP's type is as specified in the AVP definition, the &the_rfc;
 types being described below.

 
 
@@ -520,7 +518,7 @@ types being described below.

 
 

 The data formats defined in sections 4.2 ("Basic AVP Data
-Formats") and 4.3 ("Derived AVP Data Formats") of RFC 3588 are encoded
+Formats") and 4.3 ("Derived AVP Data Formats") of &the_rfc; are encoded
 as values of the types defined here.
 Values are passed to &mod_call;
 in a request record when sending a request, returned in a resulting
@@ -595,8 +593,8 @@ where
 
 

 Additionally, values that can be encoded are
-limited by way of their encoding as four octets as required by RFC
-3588 with the required extension from RFC 2030.
+limited by way of their encoding as four octets as required by
+&the_rfc; with the required extension from RFC 2030.
 In particular, only values between {{1968,1,20},{3,14,8}}
 and {{2104,2,26},{9,42,23}} (both inclusive) can be encoded.

 
@@ -640,7 +638,7 @@ where
 On encode, fields port, transport and protocol default to 3868, sctp
 and diameter respectively.
 The grammar of an OctetString-valued DiameterURI() is as specified in
-section 4.3 of RFC 3588.
+section 4.3 of &the_rfc;.
 The record representation is used on decode.

 
 
diff --git a/lib/diameter/doc/src/diameter_intro.xml b/lib/diameter/doc/src/diameter_intro.xml
index bc2afbd453..fd578ccf45 100644
--- a/lib/diameter/doc/src/diameter_intro.xml
+++ b/lib/diameter/doc/src/diameter_intro.xml
@@ -1,5 +1,8 @@
 
-
+
+  %also;
+]>
 
 
 

@@ -35,7 +38,7 @@ under the License.
 
 

 The diameter application is an implementation of the Diameter protocol
-as defined by RFC 3588.
+as defined by &the_rfc;.
 It supports arbitrary Diameter applications by way of a
 dictionary interface that allows messages and AVP's to be
 defined and input into diameter as configuration.
@@ -86,9 +89,9 @@ dictionary module
 that provide encode/decode functionality for outgoing/incoming
 Diameter messages belonging to the application.
 A dictionary module is generated from a specification file using the dictionary file using the diameterc utility.
-Dictionaries for the RFC 3588 Diameter Common Messages, Base
+Dictionaries for the &the_rfc; Diameter Common Messages, Base
 Accounting and Relay applications are provided with the diameter
 application.

 
diff --git a/lib/diameter/doc/src/diameter_soc.xml b/lib/diameter/doc/src/diameter_soc.xml
index 6b9ef9f756..16f6b9d5bb 100644
--- a/lib/diameter/doc/src/diameter_soc.xml
+++ b/lib/diameter/doc/src/diameter_soc.xml
@@ -1,11 +1,15 @@
 
-
+
+  %also;
+]>
 
 
 
 

 
 2011
+2012
 Ericsson AB. All Rights Reserved.
 
 
@@ -41,38 +45,20 @@ Known points of questionable or non-compliance.

 
 
 

-RFC 3588
+&the_rfc;
 
 
 
 
 

-The End-to-End Security framework (section 2.9) isn't implemented
-since it is largely unspecified.
-The document that was to describe it
-(reference [AAACMS]) was abandoned in an uncompleted state several
-years ago and the current draft RFC deprecates the framework,
-including the P Flag in the AVP header.

-
-
-
-

-There is no TLS support over SCTP.
-RFC 3588 requires that a Diameter server support TLS but in
-practise this seems to mean TLS over SCTP since there are limitations
-with running over SCTP: see RFC 6083 (DTLS over SCTP), which is a
-response to RFC 3436 (TLS over SCTP).
-The current RFC 3588 draft acknowledges this by equating
-TLS with TLS/TCP and DTLS/SCTP but we do not yet support DTLS.

+There is no support for DTLS over SCTP.

 
 
 
 

 There is no explicit support for peer discovery (section 5.2).
 It can possibly be implemented on top of diameter as is but this is
-probably something that diameter should do.
-The current draft deprecates portions of the original RFC's mechanisms
-however.

+probably something that diameter should do.

 
 
 
diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml
index 901fce32c3..e3b8c733b7 100644
--- a/lib/diameter/doc/src/diameter_tcp.xml
+++ b/lib/diameter/doc/src/diameter_tcp.xml
@@ -66,7 +66,7 @@ It can be specified as the value of a transport_module option to
 and implements the behaviour documented in
 &man_transport;.
 TLS security is supported, both as an upgrade following
-capabilities exchange as specified by RFC 3588 and
+capabilities exchange as specified by &the_rfc; and
 at connection establishment as in the current draft standard.

 
 

diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent
index 435dfda326..4647c42f85 100644
--- a/lib/diameter/doc/src/seealso.ent
+++ b/lib/diameter/doc/src/seealso.ent
@@ -32,6 +32,8 @@ significant.
 
 -->
 
+
+
 
 
 diameter:add_transport/2'>
-- 
cgit v1.2.3