Snom 4S SIP Proxy Administrator's Manual

Brand: Snom

Model: 4S SIP Proxy

Type: Administrator's Manual

Administrator‘s

Manual

snom 4S

SIP Proxy

Version 2.44

snom 4S Proxy Version 2.44 Administrator Manual

3. Edition 2005 (Version 2.44.6)

This document is supplied by snom technology AG for information purposes only to licensed

users of the snom 4S Proxy and is supplied on an “AS IS” basis, that is, without any warranties

whatsoever, express or implied.

Information in this document is subject to change without notice and does not represent any

commitment on the part of snom technology AG. The software described in this document

is furnished under a license agreement and may be used only in accordance with the terms

of that license agreement. It is against the law to copy or use this software except as

speciﬁcally allowed in the license. No part of this document may be reproduced, republished

or retransmitted in any form or by any means whatsoever, whether electronically or

mechanically, including, but not limited to, by way of photocopying, recording, information

recording or through retrieval systems, without the express written permission of snom

technology AG.

snom technology AG • 3

Table of Contents

1 Foreword .......................................................7

1.1 Software Updates from 2.42 ............................................ 7

1.2 Software Updates from 2.2x ............................................ 8

1.3 Additional Information .................................................... 8

2 Installation ...................................................9

2.1 Windows ....................................................................... 9

2.1.1 Installation .............................................................................................................................................................................. 9

2.1.2 Uninstalling in Windows ................................................................................................................................... 13

2.2 Linux .......................................................................... 13

2.3 Command Line Options ................................................. 14

2.4 Migrating 2.42 Files ...................................................... 15

2.7 DNS Setup .................................................................. 15

2.7.1 DNS Example .................................................................................................................................................................. 16

2.7.2 Using the Proxy without DNS ................................................................................................................... 17

3 Domains ......................................................19

3.1 Creating a domain ....................................................... 20

3.2 Deleting a domain ........................................................ 20

3.3 Edit a domain .............................................................. 21

3.4 Going to a domain context ............................................ 21

3.5 Determining the Domain Context ................................... 21

3.5.1 Purpose .................................................................................................................................................................................... 21

3.5.2 Usage .......................................................................................................................................................................................... 22

3.6 Backup ....................................................................... 22

4 Login ...........................................................25

4.1 Sessions ..................................................................... 25

4.2 Login .......................................................................... 25

4.3 Creation of Accounts .................................................... 26

4.4 Logout ........................................................................ 27

5 System Settings ..........................................29

4 • Table of Contents

[ S N O M 4S PR O X Y M A N U A L ]

5.1 License ....................................................................... 29

5.2 Port Bindings ............................................................... 30

5.2.1 Binding to the right address ...................................................................................................................... 30

5.2.2 Receiving forwarded packets .................................................................................................................... 31

5.2.3 SIP, HTTP and RADIUS Port ....................................................................................................................... 32

5.2.4 STUN Settings ................................................................................................................................................................ 32

5.3 System Settings .......................................................... 33

5.3.1 Logging .................................................................................................................................................................................... 33

5.3.2 Caches ....................................................................................................................................................................................... 34

5.3.3 Subscription Size ....................................................................................................................................................... 35

5.3.4 Unavailable Hosts ..................................................................................................................................................... 35

5.3.5 Agents ....................................................................................................................................................................................... 36

5.3.6 Number Guessing ..................................................................................................................................................... 36

5.3.7 Directories ........................................................................................................................................................................... 36

5.3.8 Email ............................................................................................................................................................................................ 37

5.3.9 Conﬁguration in XML ............................................................................................................................................ 38

5.4 Security Settings ......................................................... 38

5.4.1 https/http Access ...................................................................................................................................................... 38

5.4.2 Administrator Access ........................................................................................................................................... 40

5.4.3 Importing Certiﬁcates ......................................................................................................................................... 40

5.5 Billing Settings ............................................................ 41

5.5.1 RADIUS Settings ........................................................................................................................................................ 42

5.5.2 RADIUS Scripting ...................................................................................................................................................... 43

5.6 Domain Determination/Administration ............................ 45

5.7 Routing Settings .......................................................... 45

5.7.1 Max Forwards ................................................................................................................................................................. 45

5.7.2 ENUM Sufﬁx ...................................................................................................................................................................... 46

5.7.3 Route Other Requests ........................................................................................................................................ 46

5.7.4 Loose Routing ................................................................................................................................................................. 46

5.7.5 Loose Routing Flag .................................................................................................................................................. 47

5.7.6 Always Record-Route ........................................................................................................................................... 47

5.7.7 Record-Route for SUBSCRIBE ................................................................................................................. 47

5.7.8 Symmetric Responses ........................................................................................................................................ 48

5.8 Redundancy ................................................................ 48

5.8.1 Shutting servers down ....................................................................................................................................... 49

5.8.2 DNS considerations ................................................................................................................................................ 49

5.8.3 Refresh rate considerations ........................................................................................................................ 50

5.8.4 How Replication Works ...................................................................................................................................... 50

5.8.5 Exceptions ........................................................................................................................................................................... 51

5.8.6 Settings ................................................................................................................................................................................... 51

5.8.7 Security ................................................................................................................................................................................... 52

snom technology AG • 5

[ S N O M 4S PR O X Y M A N U A L ]

5.9 Appearance ................................................................. 52

6 System Status .............................................55

6.1 Server Log .................................................................. 55

6.2 Call Log ...................................................................... 55

6.3 Current Calls ............................................................... 56

6.4 SIP Trace .................................................................... 57

6.5 Replication Trace .......................................................... 58

6.6 Unavailable Hosts ........................................................ 58

6.7 Memory Usage ............................................................ 58

6.8 System Information ..................................................... 59

7 Domain Settings ..........................................61

7.1 Settings ...................................................................... 61

7.1.1 Similar Settings ........................................................................................................................................................... 61

7.1.2 Emergency Location Information ....................................................................................................... 61

7.1.3 Authorization ................................................................................................................................................................... 62

7.1.4 Canonical Names ....................................................................................................................................................... 63

7.2 Registration Preferences ............................................... 63

7.2.1 Self-Setup ............................................................................................................................................................................ 63

7.2.2 Min/Max Registry Time ..................................................................................................................................... 64

7.2.3 Default Probability ................................................................................................................................................... 64

7.3 Dial Plan ..................................................................... 64

7.3.1 How it works .................................................................................................................................................................... 64

7.3.2 Call Pickup ........................................................................................................................................................................... 67

7.3.4 DND Feature Codes ................................................................................................................................................ 67

7.3.5 Example 1: North American Dial Plan ......................................................................................... 68

7.3.6 Example 2: Do not allow cell phone numbers to certain users ............... 68

7.4 Controlling .................................................................. 69

7.4.1 Deﬁning Rates ............................................................................................................................................................... 69

7.4.2 Deﬁning Groups ........................................................................................................................................................... 70

7.4.3 Controlling Data .......................................................................................................................................................... 70

7.5 Address Books ............................................................. 71

7.5.1 Number Guessing ..................................................................................................................................................... 71

7.5.2 Deﬁning Address Book Groups .............................................................................................................. 71

7.5.3 Setting Up an Address Book ...................................................................................................................... 72

7.6 Error-Information ......................................................... 72

7.7 Script ......................................................................... 73

7.8 Account Administration ................................................. 73

7.8.1 Purpose .................................................................................................................................................................................... 73

7.8.2 Setting up an account from the web interface ............................................................... 74

6 • Table of Contents

[ S N O M 4S PR O X Y M A N U A L ]

7.8.3 Setting up a hunt group and pickup group .......................................................................... 76

7.8.4 Changing Normal User Settings ........................................................................................................... 77

7.8.4.1 Authentication Name ............................................................................................................................................ 77

7.8.4.2 Single Registration .................................................................................................................................................. 77

7.8.4.3 3rd Party Registration ........................................................................................................................................ 77

7.8.4.3 User-Visible Settings ............................................................................................................................................ 78

7.8.5 Importing a list of users .................................................................................................................................. 78

7.8.6 Account List ....................................................................................................................................................................... 80

7.8.7 Storing information ................................................................................................................................................ 80

7.9 Plug and Play .............................................................. 81

7.9.1 Server Detection ........................................................................................................................................................ 81

7.9.2 Setting Groups .............................................................................................................................................................. 82

7.9.3 MAC Addresses ............................................................................................................................................................. 83

7.9.4 Settings ................................................................................................................................................................................... 83

7.9.5 Software Version ........................................................................................................................................................ 84

7.10 Registered Users .......................................................... 84

7.11 Other Status Information .............................................. 85

7.12 LED Notiﬁcations .......................................................... 85

7.12.1 Dialog-State Notiﬁcations ............................................................................................................................. 86

7.12.2 Domain State Notiﬁcation ............................................................................................................................. 88

7.12.3 Call Pickup and Takeover ................................................................................................................................. 89

8 Call Hunting ................................................91

8.1 Deﬁning Stages ........................................................... 91

8.2 Deﬁning the Algorithm .................................................. 92

8.3 Default Actions ............................................................ 93

snom technology AG • 7

1 Foreword

Before you start using the proxy and continue with the rest of this

manual please read the following important notes.

1.1 Software Updates from 2.42

There are some important changes in version 2.44 that you

should consider when updating the software version.

First of all, the license model has changed. Instead of keeping the

number of currently registered users, the proxy now counts the number of

known users. The number of registrations does not matter. This reduces

the load for license counting on the proxy signiﬁcantly and solves many

problems that we had with the old license model.

Second, we decided to remove the double-directory mechanism

that was found in the 2.42 version. This double-layered directory

structure caused many problems in the scanning of the directory and the

programmability of the ﬁrst directory layer caused problems when the

program was changed.

Several features were removed. This step simpliﬁed the proxy

signiﬁcantly and increased its stability. For example, the welcome message

is not supported in the default conﬁguration of the proxy. Message store-

and-forward has also been removed.

On the other hand, the 2.44 version of the proxy comes with a

scriptable RADIUS support at its core and a simple hot-standby support

without the need to a redundant ﬁle system. Compared with the 2.42

version, there are several new features like pickup groups. Detailed

information about the changes between the release can be found in the

proxy release notes.

8 • Foreword

[ S N O M 4S PR O X Y M A N U A L ]

1.2 Software Updates from 2.2x

The 2.3x edition of the proxy uses the same license keys as the

previous versions. However, because of the domain concept, the license

checking algorithm had to be changed and the new proxy now checks

the hostnames directly against the found IP address. Therefore, the list

of hostnames should now include the IP address of the host. If you have

problems with this, please contact mailto:[email protected], please include

the old license information. We will give you a new license key in this

case.

The proxy keeps many of the proven concepts of the previous

versions, however introduces scripting and domains which makes it hard

for the installation process to automatically convert the conﬁguration data

from the 2.2x proxy versions into the new version. Some of the settings

need manual update.

Therefore, if you update the proxy, we ask you to save old

conﬁguration information for later reference. You can do this easily by

storing the web content of the relevant conﬁguration pages to a ﬁle (the

downloading of XML-Files is described below).

You can always ﬁnd information about the changes at our web

site, http://snom.com/download/proxy-release-notes.pdf.

1.3 Additional Information

This manual does not cover all topics that are related to the

usage of the proxy. We keep a list of frequently asked questions (FAQ) on

our website at http://snom.com/white_papers.html for specialized topics

such as remote management via shell script. They also contain topics that

affect other SIP components like the media server or the phones. These

FAQ will be kept up-do-date on a higher frequency than this manual.

We also keep a list of bug ﬁxes in the release notes, which is

available at the software download site at http://snom.com/down4s.html.

Before you make a software update, you may check this document if the

update is necessary or not.

snom technology AG • 9

2 Installation

2.1 Windows

2.1.1 Installation

Tip: If you are doing an update, you need to stop and uninstall

the old proxy ﬁrst (see below on how to do this).

After double clicking on the setup executable, the installations

program starts up. Press Next to begin the installation.

10 • Installation

[ S N O M 4S PR O X Y M A N U A L ]

At the beginning of the installation the setup program asks you to

accept the license conditions. Please read them carefully, then select the

“accept” button and press “next” to accept the conditions. If you decline,

the installation will be aborted.

After accepting the license agreement, the next screen asks you

to enter a few basic installation settings. You should have received the list

of the hostnames and the matching license code with the purchase of this

product, please enter this into the respective ﬁelds.

You need to deﬁne on which ports the proxy will operate. This is

important because otherwise it will be hard for you to ﬁnd the right port.

The http port deﬁnes where the web server of the proxy can

be accessed. The default port for web servers is 80, and if you are not

running any other web services on the computer, port 80 is a good choice.

Otherwise, choose a free port and write the port number down somewhere

so you don’t have to search for it. If you don’t ﬁll in any data or cancel the

snom technology AG • 11

[ S N O M 4S PR O X Y M A N U A L ]

dialog, port 80 will be used. From a service perspective, it is ok to choose

a different port than port 80.

The SIP port deﬁnes where the SIP trafﬁc is expected. The default

port is 5060, but in case you are running a proxy on the same host you

will probably have to choose a different port. If you are using DNS SRV to

locate the proxy, choosing a different port than port 5060 reduces the risk

of attacks on the proxy.

The settings in this mask can be changed later. You can continue

installation even if some information is missing; however you should

remember the http port, because otherwise you will have a hard time

locating the web server of the product.

You can then select the location where the proxy’s ﬁles will be

put. The installation program proposes a reasonable location but if you

want to you can change it. After this, the installation asks you for the

location where the proxy information will be put. This directory needs

write access and will contain the information for registered users. The

12 • Installation

[ S N O M 4S PR O X Y M A N U A L ]

installation program proposes a location relative to the proxy installation

directory, but it might be useful to specify a different location for this, e.g.

a temporary directory. It is important that the directory exists; the proxy

will not create this directory.

The installation process is then ready to start. Usually it will take

only a few seconds to copy the necessary ﬁles. At the end of the installation

process you are asked if you want to start the proxy immediately. If you

do so, the program will be started as a regular program and will not be

visible in the services dialog of the operating system until you reboot the

machine.

After ﬁnishing the setup wizard, check that the proxy is running.

If you do not want to reboot your system (because it is running other

critical applications), you can also manually start the service in the services

section of the Windows control interface.

Check that the installation has been successful by checking the

Services ﬁeld of Windows. Open the services Window and look for “snom

snom technology AG • 13

[ S N O M 4S PR O X Y M A N U A L ]

4S Proxy”. The status should be “Started”. If this is not the case you

should invoke the proxy by selecting “start”. In this case, we recommend

rebooting the system to make sure that the proxy is running after the

reboot.

After making sure the proxy is running, you should connect to

the proxy to a web browser. In order to do this, you can connect to the

address of the local computer (http://localhost:8080 if you are running the

web browser on the same machine). If the http port is already occupied

by other programs, the proxy will try to use ports 5068, 5069, 5070 and

so on. It is important that you connect to the proxy to a web browser,

because that is the only way to control the proxy.

If you have trouble locating the http port, you can use the netstat

command (netstat –b for Windows). You should then see the proxy process

running on the local machine.

2.1.2 Uninstalling in Windows

To uninstall the proxy, ﬁrst stop it in the services window. Then

go to the Software Window and click on “remove” for snom 4S Proxy.

2.2 Linux

After you downloaded the RPM from our web site you can either

install it via the graphical administration frontend of your Linux distribution

or you can use the command line interface (CLI).

For the graphical installation please consult the documentation of

your Linux distribution for details how to install 3rd party software.

If you use the CLI you need to be root to install the software.

Please go the directory where you saved the RPM after downloading. If

this is the ﬁrst installation of the snom 4S proxy on this host from a RPM

package please use the following command to install the software:

rpm -ihv snomproxy-2.44.*.rpm

If you already installed an older RPM version of the proxy please

use the following command instead:

rpm -Uhv snomproxy-2.44.*.rpm

14 • Installation

[ S N O M 4S PR O X Y M A N U A L ]

The output of both commands will just show some hashes (#)

and then return to the command prompt without any message if no error

occurred.

After you installed the software please load the ﬁle /etc/sysconﬁg/

snomproxy in your favorite editor and verify that you are satisﬁed with the

default settings (SIP port: 5060, HTTP port: 80, Conﬁguration directory:

/var/lib/snomproxy).

Note: during the installation values from /etc/rc.conﬁg or /etc/

snomproxy.conf if they exists will be copied to /etc/sysconﬁg/snomproxy.

The usage of /etc/rc.conﬁg or /etc/snomproxy.conf is deprecated and

only the values from /etc/sysconﬁg/snomproxy will be considered for the

future.

When you are satisﬁed with the conﬁguration values please start

the proxy with the following command:

/etc/init.d/snomproxy start

Note: the process will not be started automatically any more like

it was with the old snom tarball installation, because user interactions

are not possible during a RPM installation, but the port settings should be

veriﬁed by the user before starting the process.

2.3 Command Line Options

--log n: Specify the log level between 0 and 9. 9 means as much

messages as possible, 0 means only the most important messages.

--http-port n: Explicitly specify the http port number. The old

name –html-port can also be used.

--https-port n: Explicitly specify the https port number.

--sip-port n: Explicitly specify the sip port number.

--dir d: Specify the root directory for the proxy. This is important

as the proxy will search ﬁles in this directory.

--no-daemon: Don’t run the process as daemon in the background,

run it as normal process.

--version: Print the version number and exit.

snom technology AG • 15

[ S N O M 4S PR O X Y M A N U A L ]

--license-hostname: Explicitly set the license hostname or

hostnames (use quotes to allow space between the hostnames). This can

be used to override the settings in the settings.

--license-code: Explicitly set the license code. This can be used

to override the settings in the settings.

2.4 Migrating 2.42 Files

If you want to use the ﬁles that you used from the 2.42 or

previous versions, you need to move some ﬁles. You can do this relatively

easy in Linux. The following shell script should do the job for you if you

are moving to ﬂat directory structures.

cp –R runtime runtime-old; cd runtime

for i in *; do if [ -d $i ]; then pushd $i; for j in *; do if [ -d $j ];

then pushd $j; cp -R * ..; popd; rm -Rf $j; fi; done; popd; fi; done

2.7 DNS Setup

After you install the proxy, you need to make sure it can be found.

Depending on the sophistication of your installation, you need to set up

some DNS entries. This manual does not describe how you change the

DNS entries; for this purpose, please consult the manual of the DNS tool

that you are using.

As long as you are using plain IP Version 4 addresses, you

don’t need to change anything with DNS. This might be appropriate

in a completely private network with only one proxy server at a ﬁxed

address.

SIP uses several DNS levels. The ﬁrst level is called NAPTR and

this is a way to determine on a ﬂexible way where a service can be found.

ENUM is built upon this level. If you want to locate your proxy using

ENUM, you will probably need the support of additional tools. DNS SRV

is a way to specify addresses for a speciﬁc service. Using this level, you

can specify several servers for one address. This enables redundancy and

scalability. DNS SRV is also a way to specify other port numbers than

the default port number for a service. DNS A is the simple DNS address

resolution mechanism we know from the old days that resolves exactly

one address.

16 • Installation

[ S N O M 4S PR O X Y M A N U A L ]

We recommend setting up DNS SRV so that you can redirect the

SIP services to a different host than your main server. This way, you can

use the same email addresses for a user as the sip address.

2.7.1 DNS Example

To use the DNS SRV support, you need to deﬁne entries for “_sip._

udp” and “_sip._tcp” for your domain and assign weights and probabilities

to the different hosts that serve these services. A conﬁguration ﬁle for

Linux might look like this:

$TTL 1D

anycom.de. IN SOA fox.anycom.de. hostmaster.anycom.de. (

2002050111 ; serial

1D ; refresh

2H ; retry

1W ; expiry

1D ) ; minimum

IN NS fox

IN NS ns2.anycomns.de.

MX 10 mail.anycom.de.

_sip._tcp.anycom.de. IN SRV 0 5 5060 sip-server.anycom.de.

IN SRV 0 1 5060 test.anycom.de.

IN SRV 1 5 5060 www.anycom.de.

_sip._udp.anycom.de. IN SRV 0 5 5060 sip-server.anycom.de.

IN SRV 0 1 5060 test.anycom.de.

IN SRV 1 5 5060 www.anycom.de.

_stun._udp.anycom.de. IN SRV 0 5 3478 sip-server.anycom.de.

localhost IN A 127.0.0.1

ns IN A 232.145.142.95

anycom.de. IN A 232.145.142.95

sip IN A 232.145.142.97

In this example, there are three choices for accessing the proxies

for anycom.de. The ﬁrst two, (sip-server.anycom.de and test.anycom.de)

have the weight 0, and as long as one of them is up they will be contacted.

Only if both of them are down, will the service go to www.anycom.de. The

probability of contacting sip-server is 5/6, the probability of contacting

1/6, as the preference sum is 6. That means that most of the load goes

to sip-server.

snom technology AG • 17

[ S N O M 4S PR O X Y M A N U A L ]

2.7.2 Using the Proxy without DNS

In small installation, you may not have access to DNS or you

simple don’t want to spend time on setting up DNS. If you decide to

use this approach, you must set the outbound proxy of all user agents

in your system to the address of the proxy. This applies to the phones;

it also applies to other user agents like the media server and the PSTN

gateway.

This also means that you will not be able to have a redundant

system setup. Because of this and for the sake of simple system extension,

we recommend to use DNS setup.

18 • Installation

[ S N O M 4S PR O X Y M A N U A L ]

snom technology AG • 19

3 Domains

The snom 4S proxy supports multiple domains on one proxy. This

is a powerful feature that allows a proper routing or requests according to

the SIP and IETF paradigm of DNS domains.

A domain deﬁnes a speciﬁc view on the proxy. Each domain

has its own log, its own user list, its own dial plan, its own registration

policy, its own password, its own welcome message policy, and so on. This

concept is sometimes called “hoteling” as it makes the proxy look like a

hotel where guest can rent a room.

This makes it very easy to host separate domains with only one

proxy process and only one proxy port. This is important for ITSP; however

it is also helpful to set up a productive system and a testing system for

customers who have only one primary domain.

Domains have a primary name and alias names. The primary

name is used to identify the domain while the alias names are used to

redirect requests to the primary domain. This is useful when a host can

be found in different ways, for example by its DNS SRV name, by its DNS

A name, or by its IP address. In this case, you would use the DNS SRV

name as a primary domain name and the DNS A name and the IP address

as alias.

In order to make the domain matching processing deterministic,

domain and alias names must be unique. It is not allowed to use the same

name as alias for different domains.

You can use as many domains as you want. It does not affect a

number of licences counted by the licensing part of the proxy. In contrast,

when you‘re planning to register a large number of user agents, the

domain concept helps balancing the load. Therefore, you should consider

separating your customer base in separate domains, if possible.

20 • Domains

[ S N O M 4S PR O X Y M A N U A L ]

3.1 Creating a domain

To create a domain, you must log on with the administrative

account of the proxy. Go to the domain administration web page and

enter the primary name of the domain. If you wish to assign alias names

for the domain, you may enter them in the alias ﬁeld. Press the Add

button to add the domain.

If the domain already exists (the primary domain names match)

the alias names are modiﬁed. Please notice that you can not change the

primary name after the domain has been created. However, you can

change the alias names for the domain.

You should enter any DNS name or IP address under which that

domain can be found by clients. If the proxy receives a request with a

domain name in the request URI domain that is not in the list, it will

not process it in a domain context. If you want to use the conﬁguration

features, you should also consider using the “sip” plus domain name DNS

name.

3.2 Deleting a domain

If you want to remove a domain, click on the delete symbol next

to the domain list entry. The domain data will actually not be removed; it

will be renamed to a different name in the same directory. That means if

you want to recover the domain settings, you have to manipulate the ﬁle

in your ﬁle system.

However, we strongly recommend thinking twice before removing

a domain.

Page is loading ...

Snom 4S SIP Proxy Administrator's Manual

Snom 4S SIP Proxy Administrator's Manual

Snom 4S SIP Proxy Administrator's Manual

Related papers

Other documents