annotate doc/echodrop.rgwx.conf.sample @ 1562:6219359a36a9 default tip

Merge latest changes from proposed branch
author Sebastien Decugis <sdecugis@freediameter.net>
date Mon, 21 Jun 2021 19:08:18 +0800
parents 4c935aecee6c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
269
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
1 # Sample configuration file for the echodrop.rgwx plugin of RADIUS/Diameter translation agent.
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
2 #
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
3 # This plugin allows to easily specify the following handling of RADIUS attributes
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
4 # received in a RADIUS request:
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
5 # - ECHO: the attribute will be copied verbatim in the RADIUS answer.
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
6 # - DROP: the attribute is discarded.
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
7 #
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
8 # In both cases, the attribute is NOT translated in Diameter message.
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
9 #
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
10 # The format of this file is:
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
11 # <action> CODE <code> [ VENDOR <vid> [ TLV <type> | EXT <ext-type> ] ];
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
12 # Where:
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
13 # <action>: is either DROP or ECHO.
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
14 # <code> : is a (decimal) integer between 0 and 255, and designates the type of the attribute.
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
15 #
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
16 # The remaining of the line is optional, and should only be used
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
17 # with lines containing "CODE 26" (Vendor-Specific Attribute)
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
18 # <vid> : a Vendor value (32 bit), see RFC2865 section 5.26 for detail.
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
19 #
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
20 # <type> : The attribute is interpreted as TLV (rfc3865, section 5.26)
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
21 # and we match only this "vendor type" value (8 bits).
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
22 #
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
23 # <ext-type>: NOTE: THIS OPTION IS NOT SUPPORTED PROPERLY YET!!!!
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
24 # The attribute is interpreted as extended attribute (draft-ietf-radext-extended-attributes-08)
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
25 # and we match only this "Ext-Type" value (16 bits).
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
26 # This option should only be used with "CODE 26 VENDOR 0".
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
27 #
550
4c935aecee6c Hide and automate the Proxy-State attributes management in RADIUS gateway
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 272
diff changeset
28 # Note that the Proxy-State (code 33) attribute is handled directly as an ECHO parameter by the gateway core.
269
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
29
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
30 # Examples:
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
31 # DROP code 18 ; # Reply-Message attribute, should not be included in requests
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
32 # DROP code 26 vendor 9 ; # Drop any Cisco-specific attribute
c78f623c702d Ported the Echo/Drop plugin from waaad (missing files)
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
33 # ECHO code 26 vendor 0 ext 256 ; # Echo any extended attribute with the type 256.
"Welcome to our mercurial repository"