1.1. Overview

Enum module implements [i_]enum_query functions that make an enum query based on the user part of the current Request-URI. These functions assume that the user part consists of an international phone number of the form +decimal-digits, where the number of digits is at least 2 and at most 15. Out of this number enum_query forms a domain name, where the digits are in reverse order and separated by dots followed by domain suffix that by default is "e164.arpa.". For example, if the user part is +35831234567, the domain name will be "7.6.5.4.3.2.1.3.8.5.3.e164.arpa.". i_enum_query operates in a similar fashion. The only difference is that it adds a label (default "i") to branch off from the default, user-ENUM tree to an infrastructure ENUM tree.

After forming the domain name, enum_query queries DNS for its NAPTR records. From the possible response enum_query chooses those records, whose flags field has string value "u", and whose services field has string value "e2u+[service:]sip" or "e2u+type[:subtype][+type[:subtype]...]" (case is ignored in both cases), and whose regexp field is of the form !pattern!replacement!.

Then enum_query sorts the chosen NAPTR records based on their <order, preference>. After sorting, enum_query replaces the current Request URI by applying regexp of the most preferred NAPTR record its user part and appends to the request new branches by applying regexp of each remaining NAPTR record to the user part of the current Request URI. If a new URI is a tel URI, enum_query appends to it as tel URI parameters the value of tel_uri_params module parameter. Finally, enum_query associates a q value with each new URI based on the <order, preference> of the corresponding NAPTR record.

When using enum_query without any parameters, it searches for NAPTRs with service type "e2u+sip" in the default enum tree. When using enum_query with a single parameter, this parameter will be used as enum tree. When using enum_query with two parameters, the functionality depends on the first letter in the second parameter. When the first letter is not a '+' sign, the second parameter will be used to search for NAPTRs with service type "e2u+parameter:sip". When the second parameter starts with a '+' sign, the ENUM lookup also supports compound NAPTRs (e.g. "e2u+voice:sip+video:sip") and searching for multiple service types within one lookup. Multiple service types must be separeted by a '+' sign.

Most of the time you want to route based on the RURI. On rare occasions you may wish to route based on the user part of the "From:" tag, analogous to source based policy routing in the ip world. The function enum_fquery mimics the behaviour of the enum_query function except the user part of the "From:" is used for the enum lookup instead of the user part of the RURI. Obviously the user part of the RURI is still used in the naptr regexp.

Enum query returns 1 if the current Request URI was replaced and -1 if not.

Enum module also implements is_from_user_enum function. This function does an enum lookup on the from user and returns true if found, false otherwise.

1.2. Dependencies

The module depends on the following modules (in the other words the listed modules must be loaded before this module):

• No dependencies.

1.3. Exported Parameters

modparam("enum", "domain_suffix", "e1234.arpa.")

---

1.3.2. tel_uri_params (string)

A string whose contents is appended to each new tel URI in the request as tel URI parameters.

Currently OpenSER does not support tel URIs. This means that at present tel_uri_params is appended as URI parameters to every URI.

Default value is ""

Example 1-2. Setting tel_uri_params module parameter

modparam("enum", "tel_uri_params", ";npdi")

modparam("enum", "i_enum_suffix", "e1234.arpa.")

modparam("enum", "branchlabel", "i")

i.1.e164.arpa.                     IN TXT   "4"
9.9.9.8.7.6.5.i.4.3.2.1.e164.arpa. IN NAPTR "naptr content for  +1 234 5678 999"

i.1.e164.arpa.     TYPE65300  \# 14 (
                              04    ; position
                              01 69 ; separator
                              04 65 31 36 34 04 61 72 70 61 00 ; e164.arpa
;                               )
9.9.9.8.7.6.5.i.4.3.2.1.e164.arpa. IN NAPTR "naptr content for  +1 234 5678 999"

modparam("enum", "bl_algorithm", "txt")

1.4. Exported Functions

...
# search for "e2u+sip" in freenum.org 
enum_query("freenum.org.");
...
# search for "e2u+sip" in default tree (configured as parameter)
enum_query();
...
# search for "e2u+voice:sip" in e164.arpa
enum_query("e164.arpa.","voice");
...
# search for service type "sip" or "voice:sip" or "video:sip"
# note the '+' sign in front of the second parameter
enum_query("e164.arpa.","+sip+voice:sip+video:sip");
...
# quering for service sip and voice:sip
enum_query("e164.arpa.");
enum_query("e164.arpa.","voice");
# or use instead
enum_query("e164.arpa.","+sip+voice:sip");
...

...
# search for "e2u+sip" in freenum.org 
enum_fquery("freenum.org.");
...
# search for "e2u+sip" in default tree (configured as parameter)
enum_fquery();
...
# search for "e2u+voice:sip" in e164.arpa
enum_fquery("e164.arpa.","voice");
...
# search for service type "sip" or "voice:sip" or "video:sip"
# note the '+' sign in front of the second parameter
enum_fquery("e164.arpa.","+sip+voice:sip+video:sip");
...
# quering for service sip and voice:sip
enum_fquery("e164.arpa.");
enum_fquery("e164.arpa.","voice");
# or use instead
enum_fquery("e164.arpa.","+sip+voice:sip");
...

...
if (is_from_user_enum()) {
	....
};
...