User's Guide
Whitelist Administration
The following sections describe how to administer whitelists:
About whitelists
Whitelists are used to allow requests from service providers and their applications through the ESPA service capabilities. There is one list for each ESPA service capabilities.
The list entries contain allowed destination addresses and references to a service provider or application. Both the service provider or application level destination addresses are checked for every request. An overview is provided in the below table.
|
Level
|
Destination in whitelist?
|
|
Service Provider
|
Y
|
Y
|
N
|
N
|
|
Application
|
Y
|
N
|
Y
|
N
|
|
Total Result
|
allowed
|
not allowed
|
not allowed
|
not allowed
|
If no whitelist is defined on a level, all destination addresses are allowed on that level.
Destination specification examples
Below follows a number of example destinations address expressions.
|
Route expression
|
Description
|
|
*
|
Specifies a string that matches all destination addresses.
|
|
46*
|
Specifies a string matching all destination addresses starting with 46.
|
|
46????????
|
Specifies a string matching destination addresses starting with 46 containing exactly 10 digits.
|
|
*@*.com
|
Specifies a string matching mail destination addresses in the com domain.
|
In the examples:
* - matches any character 0 or more times.
? - matches any character exactly once.
Adding a list entry
Follow the instruction below to add a list entry to a list.
- Start an Network Gatekeeper Management Tool and log in.
- Double-click the SLEE_list_matcher service.
List available lists
- Double-click the getListEntry method.
All current lists are displayed.
View list description
- Double-click the describeList method.
A description of the lists and the valid entry formats are displayed.
Add new entry
- Double-click the addListEntry method.
- Enter the following list entry data:
|
Parameter
|
Description
|
|
listName
|
The name of the list the entry is specified for.
|
|
id
|
The ID of service provider or application the list entry shall be valid for. Specified as:
|
|
expression
|
The destination address specified according to entry format provided in Step 8. on page 3.
|
All new entry is added to the list.
Viewing list entries
Follow the instruction below to view entries in a list.
- Start an Network Gatekeeper Management Tool and log in.
- Double-click the SLEE_list_matcher service.
List available lists
- Double-click the getListEntry method.
All current lists are displayed.
View entries
- Double-click the listEntries method.
- Enter the following list entry data:
|
Parameter
|
Description
|
|
listName
|
The name of the list the entry is specified for.
|
|
id
|
The ID of service provider or application the list entry shall be valid for. Specified as:
|
|
expression
|
A search criteria according to the following:
* - matches any character 0 or more times
? - matches any character exactly once
|
|
offset
|
The offset from the first hit to the first displayed hit.
|
|
noHits
|
The number of displayed hits.
|
All list entries according to the search criteria, offset and desired number of displayed hits are shown.
Removing a list entry
Follow the instruction below to remove an entry from a list.
- Double-click the removeListEntry method.
- Enter the entry's list name, ID and expression.
The entry is removed from the specified list.
Removing all list entries for an ID (service provider or application)
Follow the instruction below to remove all list entries related to a list and a service provider or application.
- Start an Network Gatekeeper Management Tool and log in.
- Double-click the SLEE_list_matcher service.
- Double-click the removeIDFromList method.
- Enter the list name and the ID. The ID is specified as:
- sp_id for a service provider. For example:
sp1
- sp_idapp_id for an application. For example:
sp1app1
All entries related to the specified ID are removed from the list.
