aboutsummaryrefslogtreecommitdiffstats
path: root/lib/diameter/src/dict/base_rfc3588.dia
blob: 4f287845aec7d434afb858fad9334902298143c2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
;;
;; %CopyrightBegin%
;;
;; Copyright Ericsson AB 2010-2011. All Rights Reserved.
;;
;; The contents of this file are subject to the Erlang Public License,
;; Version 1.1, (the "License"); you may not use this file except in
;; compliance with the License. You should have received a copy of the
;; Erlang Public License along with this software. If not, it can be
;; retrieved online at http://www.erlang.org/.
;;
;; Software distributed under the License is distributed on an "AS IS"
;; basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
;; the License for the specific language governing rights and limitations
;; under the License.
;;
;; %CopyrightEnd%
;;

@id 0
@name   diameter_gen_base_rfc3588
@prefix diameter_base
@vendor 0 IETF

@avp_types

   Acct-Interim-Interval             85    Unsigned32    M
   Accounting-Realtime-Required     483    Enumerated    M
   Acct-Multi-Session-Id             50    UTF8String    M
   Accounting-Record-Number         485    Unsigned32    M
   Accounting-Record-Type           480    Enumerated    M
   Acct-Session-Id                   44   OctetString    M
   Accounting-Sub-Session-Id        287    Unsigned64    M
   Acct-Application-Id              259    Unsigned32    M
   Auth-Application-Id              258    Unsigned32    M
   Auth-Request-Type                274    Enumerated    M
   Authorization-Lifetime           291    Unsigned32    M
   Auth-Grace-Period                276    Unsigned32    M
   Auth-Session-State               277    Enumerated    M
   Re-Auth-Request-Type             285    Enumerated    M
   Class                             25   OctetString    M
   Destination-Host                 293     DiamIdent    M
   Destination-Realm                283     DiamIdent    M
   Disconnect-Cause                 273    Enumerated    M
   E2E-Sequence                     300       Grouped    M
   Error-Message                    281    UTF8String    -
   Error-Reporting-Host             294     DiamIdent    -
   Event-Timestamp                   55          Time    M
   Experimental-Result              297       Grouped    M
   Experimental-Result-Code         298    Unsigned32    M
   Failed-AVP                       279       Grouped    M
   Firmware-Revision                267    Unsigned32    -
   Host-IP-Address                  257       Address    M
   Inband-Security-Id               299    Unsigned32    M
   Multi-Round-Time-Out             272    Unsigned32    M
   Origin-Host                      264     DiamIdent    M
   Origin-Realm                     296     DiamIdent    M
   Origin-State-Id                  278    Unsigned32    M
   Product-Name                     269    UTF8String    -
   Proxy-Host                       280     DiamIdent    M
   Proxy-Info                       284       Grouped    M
   Proxy-State                       33   OctetString    M
   Redirect-Host                    292       DiamURI    M
   Redirect-Host-Usage              261    Enumerated    M
   Redirect-Max-Cache-Time          262    Unsigned32    M
   Result-Code                      268    Unsigned32    M
   Route-Record                     282     DiamIdent    M
   Session-Id                       263    UTF8String    M
   Session-Timeout                   27    Unsigned32    M
   Session-Binding                  270    Unsigned32    M
   Session-Server-Failover          271    Enumerated    M
   Supported-Vendor-Id              265    Unsigned32    M
   Termination-Cause                295    Enumerated    M
   User-Name                          1    UTF8String    M
   Vendor-Id                        266    Unsigned32    M
   Vendor-Specific-Application-Id   260       Grouped    M

@messages

      CER ::= < Diameter Header: 257, REQ >
              { Origin-Host }
              { Origin-Realm }
           1* { Host-IP-Address }
              { Vendor-Id }
              { Product-Name }
              [ Origin-State-Id ]
            * [ Supported-Vendor-Id ]
            * [ Auth-Application-Id ]
            * [ Inband-Security-Id ]
            * [ Acct-Application-Id ]
            * [ Vendor-Specific-Application-Id ]
              [ Firmware-Revision ]
            * [ AVP ]

      CEA ::= < Diameter Header: 257 >
              { Result-Code }
              { Origin-Host }
              { Origin-Realm }
           1* { Host-IP-Address }
              { Vendor-Id }
              { Product-Name }
              [ Origin-State-Id ]
              [ Error-Message ]
            * [ Failed-AVP ]
            * [ Supported-Vendor-Id ]
            * [ Auth-Application-Id ]
            * [ Inband-Security-Id ]
            * [ Acct-Application-Id ]
            * [ Vendor-Specific-Application-Id ]
              [ Firmware-Revision ]
            * [ AVP ]

      DPR ::= < Diameter Header: 282, REQ >
              { Origin-Host }
              { Origin-Realm }
              { Disconnect-Cause }

      DPA ::= < Diameter Header: 282 >
              { Result-Code }
              { Origin-Host }
              { Origin-Realm }
              [ Error-Message ]
            * [ Failed-AVP ]

      DWR ::= < Diameter Header: 280, REQ >
              { Origin-Host }
              { Origin-Realm }
              [ Origin-State-Id ]

      DWA ::= < Diameter Header: 280 >
              { Result-Code }
              { Origin-Host }
              { Origin-Realm }
              [ Error-Message ]
            * [ Failed-AVP ]
              [ Origin-State-Id ]

   answer-message ::= < Diameter Header: code, ERR [PXY] >
                  0*1 < Session-Id >
                      { Origin-Host }
                      { Origin-Realm }
                      { Result-Code }
                      [ Origin-State-Id ]
                      [ Error-Reporting-Host ]
                      [ Proxy-Info ]
                    * [ AVP ]

      RAR ::= < Diameter Header: 258, REQ, PXY >
              < Session-Id >
              { Origin-Host }
              { Origin-Realm }
              { Destination-Realm }
              { Destination-Host }
              { Auth-Application-Id }
              { Re-Auth-Request-Type }
              [ User-Name ]
              [ Origin-State-Id ]
            * [ Proxy-Info ]
            * [ Route-Record ]
            * [ AVP ]

      RAA ::= < Diameter Header: 258, PXY >
              < Session-Id >
              { Result-Code }
              { Origin-Host }
              { Origin-Realm }
              [ User-Name ]
              [ Origin-State-Id ]
              [ Error-Message ]
              [ Error-Reporting-Host ]
            * [ Failed-AVP ]
            * [ Redirect-Host ]
              [ Redirect-Host-Usage ]
              [ Redirect-Max-Cache-Time ]
            * [ Proxy-Info ]
            * [ AVP ]

      STR ::= < Diameter Header: 275, REQ, PXY >
              < Session-Id >
              { Origin-Host }
              { Origin-Realm }
              { Destination-Realm }
              { Auth-Application-Id }
              { Termination-Cause }
              [ User-Name ]
              [ Destination-Host ]
            * [ Class ]
              [ Origin-State-Id ]
            * [ Proxy-Info ]
            * [ Route-Record ]
            * [ AVP ]

      STA ::= < Diameter Header: 275, PXY >
              < Session-Id >
              { Result-Code }
              { Origin-Host }
              { Origin-Realm }
              [ User-Name ]
            * [ Class ]
              [ Error-Message ]
              [ Error-Reporting-Host ]
            * [ Failed-AVP ]
              [ Origin-State-Id ]
            * [ Redirect-Host ]
              [ Redirect-Host-Usage ]
              [ Redirect-Max-Cache-Time ]
            * [ Proxy-Info ]
            * [ AVP ]

      ASR ::= < Diameter Header: 274, REQ, PXY >
              < Session-Id >
              { Origin-Host }
              { Origin-Realm }
              { Destination-Realm }
              { Destination-Host }
              { Auth-Application-Id }
              [ User-Name ]
              [ Origin-State-Id ]
            * [ Proxy-Info ]
            * [ Route-Record ]
            * [ AVP ]

      ASA ::= < Diameter Header: 274, PXY >
              < Session-Id >
              { Result-Code }
              { Origin-Host }
              { Origin-Realm }
              [ User-Name ]
              [ Origin-State-Id ]
              [ Error-Message ]
              [ Error-Reporting-Host ]
            * [ Failed-AVP ]
            * [ Redirect-Host ]
              [ Redirect-Host-Usage ]
              [ Redirect-Max-Cache-Time ]
            * [ Proxy-Info ]
            * [ AVP ]

      ACR ::= < Diameter Header: 271, REQ, PXY >
              < Session-Id >
              { Origin-Host }
              { Origin-Realm }
              { Destination-Realm }
              { Accounting-Record-Type }
              { Accounting-Record-Number }
              [ Acct-Application-Id ]
              [ Vendor-Specific-Application-Id ]
              [ User-Name ]
              [ Accounting-Sub-Session-Id ]
              [ Acct-Session-Id ]
              [ Acct-Multi-Session-Id ]
              [ Acct-Interim-Interval ]
              [ Accounting-Realtime-Required ]
              [ Origin-State-Id ]
              [ Event-Timestamp ]
            * [ Proxy-Info ]
            * [ Route-Record ]
            * [ AVP ]

      ACA ::= < Diameter Header: 271, PXY >
              < Session-Id >
              { Result-Code }
              { Origin-Host }
              { Origin-Realm }
              { Accounting-Record-Type }
              { Accounting-Record-Number }
              [ Acct-Application-Id ]
              [ Vendor-Specific-Application-Id ]
              [ User-Name ]
              [ Accounting-Sub-Session-Id ]
              [ Acct-Session-Id ]
              [ Acct-Multi-Session-Id ]
              [ Error-Reporting-Host ]
              [ Acct-Interim-Interval ]
              [ Accounting-Realtime-Required ]
              [ Origin-State-Id ]
              [ Event-Timestamp ]
            * [ Proxy-Info ]
            * [ AVP ]

@enum Disconnect-Cause

   REBOOTING                      0
   BUSY                           1
   DO_NOT_WANT_TO_TALK_TO_YOU     2

@enum Redirect-Host-Usage

   DONT_CACHE                     0
   ALL_SESSION                    1
   ALL_REALM                      2
   REALM_AND_APPLICATION          3
   ALL_APPLICATION                4
   ALL_HOST                       5
   ALL_USER                       6

@enum Auth-Request-Type

   AUTHENTICATE_ONLY              1
   AUTHORIZE_ONLY                 2
   AUTHORIZE_AUTHENTICATE         3

@enum Auth-Session-State

   STATE_MAINTAINED               0
   NO_STATE_MAINTAINED            1

@enum Re-Auth-Request-Type

   AUTHORIZE_ONLY                 0
   AUTHORIZE_AUTHENTICATE         1

@enum Termination-Cause

   DIAMETER_LOGOUT                1
   DIAMETER_SERVICE_NOT_PROVIDED  2
   DIAMETER_BAD_ANSWER            3
   DIAMETER_ADMINISTRATIVE        4
   DIAMETER_LINK_BROKEN           5
   DIAMETER_AUTH_EXPIRED          6
   DIAMETER_USER_MOVED            7
   DIAMETER_SESSION_TIMEOUT       8

@enum Session-Server-Failover

   REFUSE_SERVICE                 0
   TRY_AGAIN                      1
   ALLOW_SERVICE                  2
   TRY_AGAIN_ALLOW_SERVICE        3

@enum Accounting-Record-Type

   EVENT_RECORD                   1
   START_RECORD                   2
   INTERIM_RECORD                 3
   STOP_RECORD                    4

@enum Accounting-Realtime-Required

   DELIVER_AND_GRANT              1
   GRANT_AND_STORE                2
   GRANT_AND_LOSE                 3

@define Result-Code

;; 7.1.1.  Informational
   DIAMETER_MULTI_ROUND_AUTH          1001

;; 7.1.2.  Success
   DIAMETER_SUCCESS                   2001
   DIAMETER_LIMITED_SUCCESS           2002

;; 7.1.3.  Protocol Errors
   DIAMETER_COMMAND_UNSUPPORTED       3001
   DIAMETER_UNABLE_TO_DELIVER         3002
   DIAMETER_REALM_NOT_SERVED          3003
   DIAMETER_TOO_BUSY                  3004
   DIAMETER_LOOP_DETECTED             3005
   DIAMETER_REDIRECT_INDICATION       3006
   DIAMETER_APPLICATION_UNSUPPORTED   3007
   DIAMETER_INVALID_HDR_BITS          3008
   DIAMETER_INVALID_AVP_BITS          3009
   DIAMETER_UNKNOWN_PEER              3010

;; 7.1.4.  Transient Failures
   DIAMETER_AUTHENTICATION_REJECTED   4001
   DIAMETER_OUT_OF_SPACE              4002
   DIAMETER_ELECTION_LOST             4003

;; 7.1.5.  Permanent Failures
   DIAMETER_AVP_UNSUPPORTED           5001
   DIAMETER_UNKNOWN_SESSION_ID        5002
   DIAMETER_AUTHORIZATION_REJECTED    5003
   DIAMETER_INVALID_AVP_VALUE         5004
   DIAMETER_MISSING_AVP               5005
   DIAMETER_RESOURCES_EXCEEDED        5006
   DIAMETER_CONTRADICTING_AVPS        5007
   DIAMETER_AVP_NOT_ALLOWED           5008
   DIAMETER_AVP_OCCURS_TOO_MANY_TIMES 5009
   DIAMETER_NO_COMMON_APPLICATION     5010
   DIAMETER_UNSUPPORTED_VERSION       5011
   DIAMETER_UNABLE_TO_COMPLY          5012
   DIAMETER_INVALID_BIT_IN_HEADER     5013
   DIAMETER_INVALID_AVP_LENGTH        5014
   DIAMETER_INVALID_MESSAGE_LENGTH    5015
   DIAMETER_INVALID_AVP_BIT_COMBO     5016
   DIAMETER_NO_COMMON_SECURITY        5017

@grouped 

      Proxy-Info ::= < AVP Header: 284 >
                     { Proxy-Host }
                     { Proxy-State }
                   * [ AVP ]

      Failed-AVP ::= < AVP Header: 279 >
                  1* {AVP}

      Experimental-Result ::= < AVP Header: 297 >
                              { Vendor-Id }
                              { Experimental-Result-Code }

  Vendor-Specific-Application-Id ::= < AVP Header: 260 >
                                  1* { Vendor-Id }
                                     [ Auth-Application-Id ]
                                     [ Acct-Application-Id ]

;; The E2E-Sequence AVP is defined in RFC 3588 as Grouped, but 
;; there is no definition of the group - only an informal text stating
;; that there should be a nonce (an OctetString) and a counter
;; (integer)
;;
      E2E-Sequence ::= <AVP Header: 300 >
                   2* { AVP }