doc/app_redirect.conf.sample

# This file contains the configuration for the app_redirect extension of freeDiameter.
#
# This extension provides configurable Redirect messages.

# Lines starting with a # are comments and ignored.
# Spaces and newlines are not meaningful, except inside quoted areas.

#########################################################################################
#        See Diameter RFC for a detailed explanation on Redirects semantics             #
#########################################################################################

## default_redirect_cache_time
# Specify the default value for Redirect-Max-Cache-Time.
# This value can be overwritten for each rule as specified below.
# If this value is not specified, the default is:
#default_redirect_cache_time = 86400;  ## => 1 day

# The remaining of this file contains a list of RULE elements.
# Each RULE consists in three parts:
#  - a CRITERIA that specifies which messages the RULE applies to.
#  - a REDIRECT_TYPE that specifies what type of redirect is to be sent, and its duration.
#  - a TARGET_HOSTS list that specifies the host(s) to send the message to.
#
# The rules are matched in the order they appear in this file. Once a rule has matched, the
# remaining rules are not processed.
#
# The basic format of a rule is:
#  REDIRECT_TYPE : CRITERIA to TARGET_HOSTS ;

# These are a few examples. The definition of each term follows.
#
# 1) REALM_AND_APPLICATION : app=3 "Destination-Realm"="myrealm.net" to "aaas://acct1.myrealm.net" "aaas://acct2.myrealm.net";
#  will ask all peers sending a Base Accounting message for realm "myrealm.net" to send
# this message directly to either 'acct1.myrealm.net' or 'acct2.myrealm.net'.
#
# 2) ALL_SESSION 3600 : "Origin-AAA-Protocol"=1 "Destination-Realm"="myrealm.net" to "aaas://raddiam.myrealm.net";
#  Will ask any peer sending messages translated from RADIUS and targeted to this realm
# to address all the messages from the same session to 'raddiam.myrealm.net'. The
# redirect entry should be stored for 1 hour.
#
# 3) ALL_HOST : from.realm=[".*\.(fr|de|es)"] to "aaas://relay-EU.myrealm.net";
#    ALL_HOST : from.realm=[".*\.(cn|jp|vn)"] to "aaas://relay-ASIA.myrealm.net";
#  Redirect messages to different relays depending on where they come from.
#
# 4) ALL_HOST : to "aaas://newserv.myrealm.net";
#  This server was relocated, tell all peers to go directly to the new one.
#  This rule should appear last because it matches all messages, so further rules will never be used.


# 
# REDIRECT_TYPE
#

# The redirect_type is one of the following (see Redirect-Host-Usage AVP definition in RFC for semantics):
# DONT_CACHE
# ALL_SESSION
# ALL_REALM
# REALM_AND_APPLICATION
# ALL_APPLICATION
# ALL_HOST
# ALL_USER

# In addition, an integer can follow. If specified, it overwrites the default_redirect_cache_time
# value for this rule. The value is always specified in seconds.

# 
# CRITERIA
#

# Each RULE can contain 0 or more criteria.
# If no criteria is specified, all messages are assumed to match (wildcard).
# If more than one criteria is specified, an "AND" relationship is assumed.
# If you need to specify "OR", just create separate rules.
#
# In the following definitions, "STR/REG" stands for:
#   - a quoted string "some.peer" that will match exactly this string (case-insensitive), or
#   - a bracket-quoted string ["some regex"] that will be interpreted as a POSIX extended regular expression (case-sensitive), and attempt to match the string.
#
# A criteria is one of the following:
#    from.id="STR/REG"		-> matches messages received from peer with this Diameter Identity.
#    from.realm="STR/REG"	-> matches messages received from peer with this Realm.
#    app=U32_VALUE		-> matches messages with this Diameter Application-Id value in its header.
#    "AVP-name"=U32_VALUE	-> matches messages that contain an avp "AVP-name" (replace with the realm name) with this value.
#    "AVP-name"="STR/REG"	-> matches messages that contain an avp "AVP-name" (replace with the realm name) with this .

# 
# TARGET_HOSTS
#

# This is a simple list of DiameterURI that must be sent back.
# See the RFC for valid format of Diameter URI:
#  "aaa://" FQDN [ port ] [ transport ] [ protocol ]
# "aaas://" FQDN [ port ] [ transport ] [ protocol ]

######################################################################################