4S stands for “snom soft switch for small and medium enterprises“. That means, the snom 4S proxy was designed for environments handling up to 1000 users with normal traffic. In environments where you need more features and better scalability, we would be happy to refer you to other companies offering carrier grade and feature-rich proxies that solve these problems.
Table of Contents Welcome to snom 4S ! ..........5 Voice over Internet Protocol ........ 11 Why SIP?................11 Open Standards ..............12 What You Can Expect and What Not ........12 The SIP Architecture ..........15 User Agents ................. 15 Registrars ................
Page 7
4S SIP Registrar Proxy 2.12 User Manual Configuration ............53 Licensing ................53 Hostnames ..........................IP Addresses ..................................................License Key General Settings ..............55 SIP Port ............................Proxy realm ..................................................TCP threshold Log Level ........................... HTTP port ..........................
Page 8
Registered Users ..............75 Call Logs ................76 .................... Condition for Logging a Call Call Logs in the Web Interface ..................Call Log File Format ......................SIP Message Flow ..............78 Logging ................80 More Information ..........83 Release Notes ..............83 Standards................
SIP, telephony being just one of them. So far more than 150 drafts have been proposed for extending the SIP protocol. All kinds of solutions are being addressed in these documents, snom technology AG • 11...
and the highly dynamic field of this new real time communication technology is resulting in evolutionary pressure to find the best common denominator. Most of the “big players” have jumped on the SIP train. Microsoft Messenger is based on SIP and industry giant Cisco offers SIP extensions to most of their products.
4S SIP Registrar Proxy 2.12 User Manual and does not always necessarily support the quality of transport telephony requires. If you are placing a phone call over the public Internet, there is no guarantee that a packet will be transported within a reasonable time. Usually there is acceptable quality, but it may happen that calls suddenly break off, that there is significant delay, or that packet loss causes stuttering.
(somebody being the user agent client, UAC and somebody the user agent server, UAS). In SIP, there is no conceptual difference between a hard phone and a soft phone. The snom 100 VoIP phone or Microsoft Messenger are examples of this kind of system.
The conference server also checks the credentials of participants joining the conference. The snom 4s is an example of this technology. Gateways From a SIP perspective, the gateway is also just a user agent.
Page 17
SIP gateways. Examples of such gateways are manufactured by Cisco, Mediatrix, Sonus and Vegastream. The snom 4s gateway is a SIP NAT gateway software enabling Linux computers to be SIP-aware. snom technology AG • 17...
® Linux computers. The registar proxy is the core part of this framework. Proxy The snom 4S registrar proxy is a SIP registrar and proxy with the following features: • Stateful forking. Requests are forked to one or more destinations and the responses are filtered before passing them back to the user agent client.
SIP NAT Gateway The snom 4S Network Address Translation (NAT) gateway is a stateless proxy that transports SIP messages between private and public networks. This makes it possible to share one public Internet address amongst several SIP elements.
Page 21
4S SIP Registrar Proxy 2.12 User Manual • Mailbox. When nobody picks up a call, the caller can leave a message on a mailbox. The owner of the mailbox receives notification on his phones and an email with voice mail as an attachment.
After double clicking on the setup executable, the installations program starts up (see fig. 2-1). Press Next to begin the installation. FIGURE: 4-1 Installation Program At the beginning of the installation the setup program asks you to snom technology AG • 23...
Page 24
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. FIGURE: 4-2 License Agreement 24 • Installation...
Page 25
4S SIP Registrar Proxy 2.12 User Manual After accepting the license agreement, the next screen asks you to enter your personal information. Enter your name and the name of organization. FIGURE: 4-3 Customer Information snom technology AG • 25...
Page 26
You can then select the location where the proxy’s files 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 registration information will be put.
Page 27
4S SIP Registrar Proxy 2.12 User Manual In the next step you can select the installation type. We recommend using the Typical installation. If you select Minimal, the documentation is not installed. FIGURE: 4-5 Set up type snom technology AG • 27...
Page 28
FIGURE: 4-6 Confirmation Screen Before the installation finishes, you need to define on which ports the proxy will operate. This is important because otherwise it will be hard for you to find the right port. The http port defines where the web server of the proxy can be accessed.
Page 29
4S SIP Registrar Proxy 2.12 User Manual The SIP port defines where the SIP traffic is expected. This will be port 5060 in most cases and you should change this port only if you know exactly how the proxy can be addressed with a different port number.
Page 30
Installation Completed Check that the installation has been successful by checking the Services field of Windows. Open the services Window and look for “snom 4S SIP Proxy/Registrar”. 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.
Page 31
4S SIP Registrar Proxy 2.12 User Manual FIGURE: 4-9 Service Window 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://127.0.0.1:8080 if you are running the web browser...
User Manual Uninstalling in Windows To uninstall the proxy, first stop it in the services window. Then go to the Software Window and click on “remove” for snom 4S proxy Server. FIGURE: 4-11 Uninstalling in Windows snom technology AG • 33...
This directory will have subdirectories for the different proxy versions and for registrations. It typically also contains the configuration information. cd /usr/local mkdir snom-proxy cd /usr/local/snom-proxy Extract the files from the tarball: su - cd /usr/local tar xvfz ~/snom_sip_proxy-i386-linux-2.12.tgz...
4S SIP Registrar Proxy 2.12 User Manual check whether the sip proxy was started automatically after the reboot. You can then continue with the installation using the web browser. Stop and restart the proxy with the rcsip-proxy command to check whether the configuration has been saved.
Registering Phones As an example, we show you here how to register a snom 100 VoIP phone and a Microsoft Messenger with the proxy. Important: Before you can try this on your proxy, you need to set up the proxy. See Chapter 6 on how doing this.
Date: Sun, 9 Jun 2002 18:19:54 GMT Expires: 3600 Content-Length: 0 Microsoft Messenger Registration Microsoft Messenger supports SIP from Version 4.6 ongoing. To register the messenger with a snom proxy, you need to carry out the following 38 • Registering Phones...
Page 39
4S SIP Registrar Proxy 2.12 User Manual steps: • Open Microsoft Messenger • Go to Extras/Options • In the Tab Accounts select communication services and enter the URL that you want to be registered with, e.g. fred.feuerstein@snomag.de. snom technology AG • 39...
Page 40
FIGURE: 5-2 Microsoft Messenger Registration • If you need an outbound proxy, you can enter this information when you click on Advanced. Select UDP transport mechanism and set the Servername of IP address to the address of the outbound proxy. 40 •...
Page 41
4S SIP Registrar Proxy 2.12 User Manual FIGURE: 5-3 Outbound Proxy snom technology AG • 41...
Page 42
If you go to the trace page of the proxy, you can see the registration messages: REGISTER sip:snomag.de SIP/2.0 Path: <sip:217.88.123.51;lr> Max-Forwards: 70 Via: SIP/2.0/UDP 217.88.123.51;branch=7bd0c34ce79c7c00ac6f2 9345595fd6a Via: SIP/2.0/UDP 192.168.0.182:10379 From: <sip:str@snomag.de>;tag=494c7662-e8dd-4358-95e1- 2721f10cee48 To: <sip:str@snomag.de> Call-ID: 2cfe99b4-3e65-42c0-b87a-465a7a04069d@192.168.0.182 CSeq: 1 REGISTER Contact: <sip:192.168.0.182:10379>;methods=”INVITE, MESSAGE, INFO, SUBSCRIBE, OPTIONS, BYE, CANCEL, NOTIFY, ACK”...
Page 43
User Manual You then can make your first test call. The snom 4S Proxy/Registrar supports presence and instant messaging with the Microsoft Messenger. Just enter the contact that you would like to see; the proxy will handle the traffic to the registered Microsoft Messenger client.
• The proxy checks if the answer is correct and corresponds to an open question. If that is the case, the request passes; if not the proxy generates another question. snom technology AG • 45...
The answer depends on the realm, the username and the password stored in the proxy and in the user agent. By looking at the answer, it is not possible to find out anything about the password or username. The setup process is important in ensuring security. When you use a web browser to set up usernames and passwords, this information is transported without security over the network.
To avoid this, the latest SIP standard recommends using a different transport layer for this, TCP. The snom 4S proxy supports both transport layers and automatically detects whether an old SIP device cannot handle TCP packets.
There are several solutions available here, and the snom 4S builds upon these mechanisms. Registrations may be stored in a safe place, and stateful information may be recovered by reading it from the file system. Other stateful information is less critical. When forking a request, there needs to be some state information about the fork.
4S SIP Registrar Proxy 2.12 User Manual Sequential Forking Forking means that a user may be registered several times and the proxy searches the user on all locations. For non-INVITE requests (not initiating a call), the proxy just sends the packet to all destinations and waits until all parties have sent a response or a success response arrives.
Network Address Translation One of the biggest problems with the Internet version 4 is that it has a limited address range. IP V4 defines 32 bits for addresses, which were distributed according to a geographic scheme at a time when the success of the Internet protocol was hard to envision.
IP addresses of the proxy (if not proposed correctly) and the license key that you received with the software. If you don’t have a license key, contact mailto:support@snom.de for one. After saving this page, the license type and the number of currently registered users is displayed on top of the page.
FIGURE: 7-1 Licensing Hostnames You need to enter a list of names that the proxy feels responsible for. When a packet arrives at the proxy, the proxy checks the given hostname against the list you enter in this field. Typically, this name contains a list of all fully qualified DNS names for the host (e.g.
4S SIP Registrar Proxy 2.12 User Manual Using the local host name (like tango) is normally not helpful as this hostname cannot be resolved by DNS. If you do not plan to locate the SIP server via DNS, you should just put in your IP address here.
If there is only proxy, the default value should be set to “snom”, but if packets might run over several proxies, you should choose a more unique value like “SIP proxy on mycompany.com”.
TCP threshold SIP uses both reliable and non-reliable transport layers. The snom proxy version 2.12 supports UDP and TCP transport layers. When the proxy needs to send a request, it has to make a decision which transport layer to use.
Registration FIGURE: 7-3 Registration Screen Require Authorization If the flag is set to “on”, all registration requests for the proxy are challenged for authentication. This means that unknown users can not register on the proxy. If the flag is set to “off”, only known users are challenged, that means the proxy is open for registration.
4S SIP Registrar Proxy 2.12 User Manual directory (see crash recovery above). The directory name is set up during installation. Min and Max registration time User agents register for a specific amount of time. If a user agent does not refresh a registration before this time, the registration is silently discarded.
Routing FIGURE: 7-4 Routing Screen Protected Destinations When the proxy needs to forward a request, it first checks this field for protected destinations. If one of the destinations match the requested URL, the proxy first challenges the client for authentication. The protected destinations are seperated by space and contain a pattern according to the rules described in the Dial Plan (see below).
4S SIP Registrar Proxy 2.12 User Manual If you leave the field blank, the proxy will forward any packet without challenging. If you enter just „*“, the proxy will challenge every request. Max Forwards Messages in SIP may hop over a number of proxies, and sometimes the path contains loops.
Remove Tags on 18x Some equipment cannot handle different To-tags coming from forking INVITE requests. If you turn this flag on, the To-tags on 18x replies are removed before they are passed down to the user agent client. Typically you will not need to turn this flag on.
Page 63
4S SIP Registrar Proxy 2.12 User Manual FIGURE: 7-5 User Account To load a large number of users at one, you may use the “Load from File” feature. The file that you select there needs to be in a simple ASCII format as follows.
by whitespace. Comment lines can be set up by using a ‚#‘ at the beginning of the line. Loading accounts from a file erases all accounts that have been set up so far. FIGURE: 7-6 Load Accounts Dial Plan How it works The dial plan is a flexible way to tell the proxy what to do with calls that do not go to a registered user.
Page 65
4S SIP Registrar Proxy 2.12 User Manual The matching process is done using the following “wildcards”: • ‘?’ matches any character as long as there is one. • ‘$’ matches a E164 number (0-9, #, * and also + and -).
port: The port of the destination. If no port is available, the default port (5060) is used. cport: The port of the destination preceded wit a colon. If no port is present, this variable returns the empty string. parm: The parameter list of the destination. head: The headers of the destination.
4S SIP Registrar Proxy 2.12 User Manual Example 2: North American Dial Plan This example is suitable for a proxy located in the USA. Rule Mode User/ Pattern Destination Group Incomplete Use Gateway sip:911*@~* sip:911@gw1 Use Gateway sip:[1-9]$$$$$$@~* sip:{user}@gw2...
Mode User/Group Pattern Destination Incomplete sip:$@~* Incomplete sip:$$@~* sip:$$$%@~* sip:{user}@gw Gateway Deny sip:01$$$$$$$$$%@~* sip:4$$@~* sip:01$$$$$$$$$%@~* sip:{user}@gw Gateway sip:101@~* sip:01$$$$$$$$$%@~* sip:{user}@gw Gateway Rules 1-3 redirects call to the gateway if at least three digits are available. Rule 4 defines an exception to this rule if the number starts with 01 and has at least 11 digits (like 01721234567).
Page 69
4S SIP Registrar Proxy 2.12 User Manual FIGURE: 7-8 Error Information You can simple set up the error information redirection by selecting the approriate error type and enter the destination that should be put into the response. If you leave the destination empty, there will be no error indication for this code.
Page 70
416 Unsupported URI The destination is not able to handle the Scheme requested URI scheme, e.g. sips: 420 Bad Extension The caller requested a feature not available at the destination. 421 Extension Required The destination needs a feature not supported by the caller.
What is DNS? The domain name system (DNS) is a powerful mechanism to make internet addresses human-readable. “www.snom.de” is much easier to remember than 192.67.198.4. But there are also other reasons to use DNS: snom technology AG • 71...
“_sip._tcp” for your domain and assign weights and probabilities to the different hosts that serve these services. A configuration file for Linux might look like this: $TTL 1D anycom.de. IN SOA fox.anycom.de. hostmaster.snom.de. ( 2002050111 ; serial ; refresh ; retry ; expiry 1D ) ;...
Page 73
4S SIP Registrar Proxy 2.12 User Manual 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. localhost IN A 127.0.0.1 IN A 232.145.142.95 anycom.de.
The path is optional. • User-Agent: The user agent identification tells the proxy if a license is required. • Probability: The probability of the registration. Users are searched according to their probability. snom technology AG • 75...
• Expires: The expiry time in seconds. If you click on the link behind this number, you get to the SIP message trace that is associated with the registration. • Delete: If you click on the symbol, the registration is removed. This is helpful if you want to manually remove a registration (otherwise you would have to wait until it expired).
4S SIP Registrar Proxy 2.12 User Manual a call and the call will not appear in the call log. This is to limit the amount of memory used for call logging. Call Logs in the Web Interface To see the calls that went through the proxy you can go to the call log page.
The call log stores only the last 100 calls and discards older calls. The call log is only reliable in so far as the involved network elements follow the loose routing of the proxy. If network elements violate this rule, the packets do not flow through the proxy and the proxy is not able to determine the length of the call.
Page 79
4S SIP Registrar Proxy 2.12 User Manual address of the source or destination, and the port that was involved. • Header: Here you can see the first line of the SIP message. FIGURE: 8-3 Trace Web Page By clicking on the header line, you get the whole packet:...
FIGURE: 8-4 Trace Whole Packet The proxy actually keeps more messages than are displayed on this list. This is necessary because it may take some time until the user clicks on a specific packet and the proxy does not know when the old packets are no longer needed.
Page 81
4S SIP Registrar Proxy 2.12 User Manual FIGURE: 8-5 Logging snom technology AG • 81...
• License checking sometimes generated „unlicensed“ in demo mode Version 2.01 • Linux version now spawns process if in daemon mode • Parsing of SIP URLs without angle brackets sometimes gave problems, the assignment of parameters has been clarified according to RFC. snom technology AG • 83...
Standards The standards used for this proxy are open in the sense than not only snom is using them. Feel free to take a look at the underlying standards. General web page for standards: http://www.ietf.org/internet-drafts SIP working group drafts: http://www.softarmor.com/sipwg/drafts and...
4S SIP Registrar Proxy 2.12 User Manual snom home page: http://www.snom.de Footnotes This standard is now obsolete. Many products currently on the market are compatible with this obsolete RFC. You should be aware of this when buying SIP technology.
Need help?
Do you have a question about the 4S and is the answer not in the manual?
Questions and answers