Nokia WAP and SMS gateway User Manual

Kannel 1.3.1 User’s GuideOpen Source WAP and SMS gatewayLars WirzeniusGateway architectWapit [email protected]://www.wapit.comhttp://www.kannel.org

Chapter 1. Introductioninstance, when it must send a mail notification or a stock quote. For this purpose Wapforum definedWAP Push.Push is an applicatio

Chapter 10. Getting help and reporting bugsThis chapter explains where to find help with problems related to the gateway, and the preferredprocedure fo

Appendix A. Using the fake WAP senderThis appendix explains how to use the fake WAP sender to test the gateway.94

Appendix B. Using the fake SMS centerFakesmsc is a simple testing tool to test out Kannel and its SMS services. It cannot be used to sendmessages to m

Appendix B. Using the fake SMS centerOptions and messages are explained below, but as a quick example, a typical startup can go like this:test/fakesms

Appendix B. Using the fake SMS centerSwitch Value Description-m maxSend a maximum of maxmessages. Value -1 means that anunlimited number of messages i

Appendix C. Setting up a test environment forPush Proxy GatewayThis appendix explains how to set a test environment for PPG. This contains a simulated

Appendix C. Setting up a test environment for Push Proxy Gatewaysi-expires="2002-06-30T00:00:00Z">Want to test a fetch?</indication>

Appendix C. Setting up a test environment for Push Proxy Gatewaysecond one pap control document. (For command line options, see Table C.1.). For examp

Appendix C. Setting up a test environment for Push Proxy GatewayUsing Nokia Toolkit as a part of a developingenvironmentThis chapter describes a devel

Appendix C. Setting up a test environment for Push Proxy Gatewaygroup = test-ppgretries = 2pi-ssl = yesssl-client-certkey-file = /home/aarno/kannelcvs

Chapter 1. IntroductionFigure 1-2. Logical position of SMS gateway between a phone and a content server.An SMS gateway can also be used to relay SMS m

Appendix C. Setting up a test environment for Push Proxy GatewayDirective Value Descriptioncontent-file filenameMandatory value. Filecontaining pap req

Appendix D. Setting up a dial-up lineThis appendix explains how to set up a dial-up line in Linux for use with the Kannel WAP gateway. Inorder for it

Appendix D. Setting up a dial-up lineIn /etc/ppp/pap-secrets add the username and password for the ppp account. The IP address is the oneassigned to t

Appendix E. Log filesThis appendix describes the log file format.Bearerbox Access Log2001-01-01 12:00:00 Sent SMS [SMSC:smsc] [SVC:sms] [from:12345][to:

Appendix E. Log filesdailymissingokrotate 365compressdelaycompressnotifemptycreate 640 kannel admsharedscriptspostrotatekillall -HUP bearerbox smsbox w

GlossaryMMOMobile Originated - a SMS from mobile to applicationMTMobile Terminated - a SMS from application to mobileMWIMessage Waiting Indicator (See

BibliographyRFC 2616 - Hypertext Transfer Protocol -- HTTP/1.1,http://www.w3.org/Protocols/rfc2616/rfc2616.html, Request for Comments: 2616, The Inter

Chapter 1. Introduction• The Gnome XML library (known as gnome-xml and libxml), version 2.2.5 or newer. Seehttp://xmlsoft.org/xml.html.• GNU Make.• Po

Chapter 2. Installing the gatewayThis chapter explains how the gateway can be installed, either from a source code package or by using apre-compiled b

Chapter 2. Installing the gateway• GNU autoconf, if you want to modify the configuration script.Compiling the gatewayIf you are using Kannel on a suppo

Chapter 2. Installing the gatewayYou may need to add compilations flags to configure:CFLAGS=’-pthread’ ./configureThe above, for instance, seems to be r

Chapter 2. Installing the gatewayInstalling Kannel1. Download the binary RPM packet from the Kannel web site.2. Log in as root:su -3. Install the RPM

Chapter 2. Installing the gatewaycd /etc/rc.d/rc5.d/ln -s ../init.d/kannel S91kannelln -s ../init.d/kannel K91kannelTo run Kannel as a SMS gateway you

Chapter 2. Installing the gateway3. Install or upgrade the DEB package:dpkg -i kannel-VERSION .debRemoving Kannel1. Log in as root:2. Remove the packa

Chapter 2. Installing the gatewayThe documentation will be installed at /usr/share/doc/kannel/.In the Kannel documentation directory there is a html fi

andreas@fink.orghttp://www.smsrelay.comhttp://www.gni.chBruno [email protected]://litux.org/brunoStipe ToljCTO & CIOWapme Syst

Chapter 3. Using the gatewayThis chapter explains how the gateway core, bearerbox, is configured and used. It covers theconfiguration file, keeping an ey

Chapter 3. Using the gatewayLines 1 and 6 are comment lines. Line 5 separates the two groups. The remaining lines define variables.The group type is de

Chapter 3. Using the gatewayCore configurationConfiguration for Kannel MUST always include a group for general bearerbox configuration. This groupis name

Chapter 3. Using the gatewayVariable Value Descriptionadmin-deny-ip IP-listThese lists can be used toprevent connection from given IPaddresses. Each l

Chapter 3. Using the gatewayVariable Value Descriptionbox-deny-ip IP-listThese lists can be used toprevent box connections fromgiven IP addresses. Eac

Chapter 3. Using the gatewayVariable Value Descriptionunified-prefix prefix-listString to unify received phonenumbers, for SMSC routing andto ensure th

Chapter 3. Using the gatewayVariable Value Descriptionstore-file filenameA file in which any receivedSMS messages are stored untilthey are successfully

Chapter 3. Using the gatewayVariable Value Descriptionssl-trusted-ca-file filenameThis file contains the certificatesKannel is willing to trust whenworki

Chapter 3. Using the gatewayRunning KannelTo start the gateway, you need to start each box you need. You always need the bearer box, anddepending on w

Chapter 3. Using the gateway--verbosity <level>-D <places>Set debug-places for ’debug’ level output.--debug <places>-F <file-name

Kannel 1.3.1 User’s Guide: Open Source WAP and SMS gatewayby Lars Wirzenius, Kalle Marjola, Andreas Fink, Bruno Rodrigues, Stipe Tolj, and Aarno Syvän

Chapter 3. Using the gatewayThe state can be changed via HTTP administration interface (see below), and shutdown can also beinitiated via TERM or INT

Chapter 3. Using the gatewayshutdownBring down the gateway, by setting state to’shutdown’. After a shutdown is initiated, there isno other chance to r

Chapter 4. Setting up a WAP gatewayThis chapter tells you how to set Kannel up as a WAP gateway.WAP gateway configurationTo set up a WAP Kannel, you ha

Chapter 4. Setting up a WAP gatewayVariable Value Descriptionmap-url URL-pairThe pair is separated with space.Adds a single mapping for theleft side U

Chapter 4. Setting up a WAP gatewayVariable Value Descriptionlog-file filenameAs with bearerbox ’core’ group.log-level number 0..5syslog-level numberMe

Chapter 5. Setting up a SMS GatewayThis chapter is a more detailed guide on how to set up Kannel as an SMS gateway.Required componentsTo set up an SMS

Chapter 5. Setting up a SMS GatewayVariable Value Descriptiongroup (m) smsc This is a mandatory variablesmsc (m) stringIdentifies the SMS center type.S

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionallowed-prefix prefix-listA list of phone number prefixeswhich are accepted to be sentthro

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionunified-prefix prefix-listString to unify received phonenumbers, for SMSC routing andto en

Chapter 5. Setting up a SMS Gatewaygroup = smscsmsc = cimdhost = 100.101.102.103port = 600smsc-username = foosmsc-password = barThe driver for CIMD2 i

Table of Contents1. Introduction...

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionsender-prefix stringThe number that the SMSC willadd in front of the sender numberof all

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionhost (c) hostnameMachine that runs SMSC. As IP(100.100.100.100) or hostname(their.machine

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionconnect-allow-ip IP-listIf set, only connections fromthese IP addresses are acceptedto re

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionwait-ack-expire numberDefines what kind of actionshould be taken if the the ack ofa messag

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionmy-number numberIf the large account number isdifferent from the short number,assign it w

Chapter 5. Setting up a SMS GatewayVariable Value Descriptiontransceiver-mode boolAttempt to use aTRANSCEIVER modeconnection to the SM-SC. It usesthe

Chapter 5. Setting up a SMS GatewayVariable Value Descriptioninterface-version numberChange the "interface version"parameter sent from Kanne

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionreconnect-delay numberOptional the time betweenattemps to connect an ESME toan SMSC havin

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionmsg-id-type numberOptional, specifies whichnumber base the SMSC is usingfor the message ID

Chapter 5. Setting up a SMS Gatewayyou find out the more exact meaning, please send a report.The 5.0 implementation uses X.25 access gateway.group = sm

Smsbox configuration...51Smsbox routing insid

Chapter 5. Setting up a SMS Gatewaysmsc-username = foosmsc-password = fooVariable Value Descriptionhost (m) hostnameMachine that runs SMSC. As IP(10.1

Chapter 5. Setting up a SMS Gatewaypin = 2345Variable Value Descriptionmodemtype stringModems from differentmanufacturers have slightlydifferent behav

Chapter 5. Setting up a SMS GatewayModem Type ModemsnokiaphoneNokia 6210, 7110, 8210 (tested).Probably other Nokia phonestoo.ericsson EricssonGSM mode

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionvalidityperiod integerHow long the message will bevalid, i.e., how long the SMScenter (th

Chapter 5. Setting up a SMS GatewayModem definitions are now multiple groups present in kannel.conf, either directly or, for example, byincluding the e

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionsendline-sleep number (miliseconds)Optional, defaults to 100miliseconds. The sleep time a

Chapter 5. Setting up a SMS Gatewaygroup = smscsmsc = fakeport = 10000connect-allow-ip = 127.0.0.1Variable Value Descriptionhost (m) hostnameMachine t

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionport (m) port-numberPort number in which Kannellistens to (MO) messages fromother gateway

Chapter 5. Setting up a SMS GatewayFeaturecimdcimd2emiemi_ipemi2smppsema ois at at2 http faken n n n y n n n n y n nCan set Validity? ? ? ? y ? ? ? ?

Chapter 5. Setting up a SMS GatewayFeaturecimdcimd2emiemi_ipemi2smppsema ois at2 at http fakeCorrectly encodes @ when sendingy? y? ? ? y y? ? y? y? ?

Running Kannel with fakesmsc connections ...94Starting fake SMS center

Chapter 5. Setting up a SMS GatewaySMSBox inherits from core the following fields:smsbox-porthttp-proxy-porthttp-proxy-hosthttp-proxy-usernamehttp-prox

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionsendsms-chars stringOnly these characters areallowed in ’to’ field whensend-SMS service is

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionreply-couldnotrepresent stringIf set, replaces the SMS messagesent back when kannel could

Chapter 5. Setting up a SMS Gatewaylog-level = 0Smsbox routing inside bearerboxThe communication link between bearerbox and smsbox has been designed f

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionsmsc-ids word-listIf set, specifies from whichsmsc-ids all inbound messagesshould be route

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionkeyword (m) wordServices are identified by thefirst word in the SMS Each ‘%s’in the URL cor

Chapter 5. Setting up a SMS GatewayVariable Value Descriptiontext (c) stringPredefined text answer. Only ifthere is neither url nor file set.Escape cod

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionallowed-receiver-prefix prefix-listA list of phone number prefixesof the receiver number w

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionassume-plain-text boolIf client does not setContent-Type for reply, it isnormallyapplicat

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionsuffix stringwhite-list URLLoad a list of accepted sendersof SMS messages. If a sender of

List of Tables3-1. Core Group Variables ...

Chapter 5. Setting up a SMS Gateway%P the phone number of the receiver of the SMSmessage%q like %p, but a leading ‘00’ is replaced with ‘+’%Q like %P,

Chapter 5. Setting up a SMS Gatewaytext/html Tags are removed, rest is chopped to fit an SMSmessage.text/vnd.wap.wml Processed like HTML.text/xml Proce

Chapter 5. Setting up a SMS GatewayKannel POSTKannel can do POST if service is contains a post-url="...".Table 5-9. X-Kannel Post HeadersPar

Chapter 5. Setting up a SMS Gateway<alt-dcs>alt-dcs</alt-dcs></dcs><pid>pid</pid><statusrequest><dlr-mask>dl

Chapter 5. Setting up a SMS GatewaySendSMS-user configurationsTo enable an SMS push, you must set sendsms-port into the ’smsbox’ group and define one or

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionallowed-prefix prefix-listA list of phone number prefixeswhich are accepted to be sentusin

Chapter 5. Setting up a SMS GatewayExternal delivery report (DLR) storageDelivery reports are supported by default internaly, which means all DLRs are

Chapter 5. Setting up a SMS GatewayIn addition to that you must have a dlr-db group defined that specifies the table field names that areused to the DLR

Chapter 5. Setting up a SMS GatewayVariable Value Descriptionfield-timestamp (m) stringThe table field that is used forthe timestamp data.field-destina

Chapter 5. Setting up a SMS GatewayMySQL connection configurationFor several reasons external storage may be required to handle dynamical issues, i.e.

Chapter 1. IntroductionThis chapter introduces WAP and SMS in general terms, and explains the role of the gateway in WAPand SMS, outlining their dutie

Chapter 5. Setting up a SMS Gatewayphone as a XML document, but this method is perhaps more suitable for continous provisioning.If you want to send mu

Chapter 5. Setting up a SMS Gatewayphonenumber = 013456789bearer = datacalltype = analogconnection = contpppsecurity = offauthentication = normallogin

Chapter 5. Setting up a SMS GatewayRedirected repliesThe basic service system always sends the answer back to original requester, but sometimes the co

Chapter 5. Setting up a SMS Gatewayaccepted-smsc = Bget-url = "..."As can be seen, the smsc-id is used to identify the SMS center from which

Chapter 5. Setting up a SMS Gatewaypassword (or pass) stringPassword associated with givenusername. Must matchcorresponding field in the’sendsms-user’

Chapter 5. Setting up a SMS Gatewaysmsc stringOptional virtual smsc-id fromwhich the message is supposedto have arrived. This is used forrouting purpo

Chapter 5. Setting up a SMS Gatewayvalidity number (minutes)Optional. If given, kannel willinform SMS Center that it shouldonly try to send the messag

Chapter 5. Setting up a SMS Gatewayaccount stringAccount name or number tocarry forward for billingpurposes. This field is logged asACT in the log file

Chapter 5. Setting up a SMS GatewayYou can send either settings or bookmark, set CGI variable type accordingly. Default for this variable issettings.H

Chapter 5. Setting up a SMS Gatewayotaid stringName or ID of the ’ota-setting’group in Kannel configurationthat should be sent to the phone.This variab

Chapter 1. Introductionintermittent bandwidth, and extremely awkward input mechanisms. Most existing HTML pages do notwork on mobiles phones, and neve

Chapter 6. Setting up a SMS&WAP gatewayThis chapter tells you how to set Kannel up as a combined WAP and SMS gateway.SMS&WAP gateway configurat

Chapter 7. Setting up Push Proxy GatewayThis chapter explains how to set up a push proxy gateway (PPG). An example configuration file aregiven. A workin

Chapter 7. Setting up Push Proxy GatewayVariable Value Descriptionssl-server-key-file stringMandatory value for PPGHTTPS support. The filecontaining se

Chapter 7. Setting up Push Proxy Gatewayvariables are elaborated in table 7.2.As an example, let us see how to configure a ppg user (a pi, named here ’

Chapter 7. Setting up Push Proxy GatewayVariable Value Descriptiondeny-ip ip-listDefines ips wherefrom this picannot do pushes. Ips notmentioned in eit

Chapter 7. Setting up Push Proxy Gatewaysmsc = httpsmsc-id = HTTPport = 10000system-type = kannelsmsc-username = foosmsc-password = barno-sender = tru

Chapter 7. Setting up Push Proxy GatewayDefault network and bearer used by push proxy gatewayIf network and bearer attributes of the pap control docum

Chapter 8. Using SSL for HTTPThis chapter explains how you can use SSL to ensure secure HTTP communication on both, client andserver side.Beware that

Chapter 8. Using SSL for HTTPUsing SSL ser ver support for the sendsms HTTPinterfaceTo use the SSL-enabled HTTP server please use the following configu

Chapter 9. Delivery ReportsThis chapter explains how to set up kannel to deliver delivery reports.Delivery reports are a method to tell your system if