Home

Kannel 1.2.0 User's Guide

Contents

1. Ignored if username is undefined A keepalive command will be sent to the SMSC connection this many seconds after the last message The right value to use depends on how eager the SMSC is to close idle connections 50 seconds is a good guess If you see many unexplained reconnects try lowering this value Set it to 0 to disable this feature A message is resent if the acknowledge from SMSC takes more than this time Defaults to 60 seconds 50 Variable flow control window throughput retry Value number number messages number boolean messages sec Chapter 5 Setting up a SMS Gateway Description This SMSC can support two types of flow control The first type of flow control is a stop and wait protocol when this parameter equals to 1 During the handling of commands no other commands shall be sent before the a response is received Any command that is sent before the reception of the response will be discarded The second type of flow control is windowing when this parameter is unset or equals 0 In this case a maximum of n commands can be sent before a response is received When using 1ow control 0 emi works in windowed flow control mode This variable defines the size of the window used to send messages optional defaults to the maximum 100 If SMSC requires that kannel limits the number of messages per second use this variable optional Assuming that kann
2. It goes without saying that in real systems you must use more complex passwords than bar Table 7 2 PPG user group configuration variables Variable Value Description group wap push user Mandatory value Tells that we are configuring the users group wap push user string More human readable name of an user ppg username string Username for this user ppg password string Password for this user allowed prefix number list Phone number prefixes allowed in pushes coming from this pi These prefixes must conform international phone number format 99 Chapter 7 Setting up Push Proxy Gateway Variable Value Description denied prefix number list Phone number prefixes denied in pushes coming from this pi These prefixes must conform international phone number format white list url Defines an url wherefrom the whitelist can be fetched White list itself contains list of phone numbers accepting pushes from this pi black list url Defines an url wherefrom the blacklist can be fetched Blacklist itself contains list of phone number not accepting pushes from this pi allow ip ip list Defines ips wherefrom this pi can do pushes Adding this list means that ips not mentioned are denied deny ip ip list Defines ips wherefrom this pi cannot do pushes Ips not mentioned in either list are denied too Finishing ppg configuration PPG uses SMS for sending SI to the phone and an IP bearer to fetch content specified by it
3. http proxy port http proxy exceptions http proxy usernam http proxy password ssl client certkey fil c ssl server cert fil c Value filename hostname port number URL list username URL list filename filename Chapter 3 Using the gateway Description A file in which any received SMS messages are stored until they are successfully handled By using this variable no SMS messages are lost in Kannel but theoretically some messages can duplicate when system is taken down violently Enable the use of an HTTP proxy for all HTTP requests A list of excluded hosts from being used via a proxy Separate each entry with space Username for authenticating proxy use for proxies that require this Password for authenticating proxy use for proxies that require this A PEM encoded SSL certificate and private key file to be used with SSL client connections This certificate is used for the HTTPS client side only i e for SMS service requests to SSL enabed HTTP servers A PEM encoded SSL certificate file to be used with SSL server connections This certificate 1s used for the HTTPS server side only i e for the administration HTTP server and the HTTP interface to send SMS messages 32 Chapter 3 Using the gateway Variable Value Description ssl server key file c filename A PEM encoded SSL private key file to be used with SSL server connections This key is associated to th
4. phone c string Phone number to dial to when connecting over a modem to an SMS center our host hostname Optional hostname in which to bind the connection in our end TCP IP connection only our port port number Optional port number in which to bind the connection in our end TCP IP connection only receive port port number Optional port number we listen to and to which the SMS center connects when it has messages to send Required if SMS center needs one connection to send and other to receive TCP IP connection only appname string Name of a Send only service Defaults to send All outgoing messages are routed through this service connect allow ip IP list If set only connections from these IP addresses are accepted to receive port TCP IP connection only 49 Variable idle timeout keepalive wait ack Value number number number seconds seconds seconds Chapter 5 Setting up a SMS Gateway Description If this option is set to a value larger than 0 then the connection will be closed after the configured amount of seconds without activity This option interacts with the keepalive configuration option If keepalive is smaller than idle timeout then the connection will never be idle and those this option has no effect If keepalive is larger than idle timeout than keepalive reopens the connection This allows one to poll for pending mobile originated Short Messages at the SMSC
5. Air confiBUrationis eese tee eee be t uere leet bs nee eee 83 Setting up more complex 1 ener 85 eoe petrae iple e P pee pa trenes 85 Setting up operator specific 1 86 Setting up multi operator Kannel sse 86 Running SMS gateway E 87 Using the HTTP interface to send SMS messages esee 87 Using the HTTP interface to send OTA configuration messages uceenneeneenennennennnenn 92 GET method for the HTTP 92 6 Setting up a SMS amp WAP gateway ccnsonssonsonssosssnensssnsennsennennsnnssonsssnsnnsnnsnnssnnsnnssnnsnnssnnssnennssnnsnnsensnnne 95 SMS amp WAP gateway configuration esee enne nennen enne tente enne enne 95 Running SMS amp WAP gateway isses nennen 95 7 Setting up Push Proxy Gateway cusconsoossonsonssonsnensssnnennsonssnnsnnssonssnnsnnsnnennssnnsnnssonsanssnnssnesnssnnsnnsennsnnne 97 Configuring ppg core group for push initiator PI 97 Configuring PPG user group variables sese enne ener 99 Finishing ppg configuration uuussesseesnesnersnesnesnnennennonnnennensnesnnnnnennennennonnnonsonsnennnennesnensonnnensnnnnenn 100
6. Finding th documentation sure sans tierno er ERE nee 17 Compiling the gateway oet acte retine e eie c gb IR EO Diem 18 Instalhng the irer inerea een pep idee peres 19 Using pre compiled binary eee retener nennen 20 Installing Kannel from RPM packages essere enne 20 Installing Kannel from DEB 21 3 USING the CIA DV AR 25 Configuring the gatew y 2 eneesen sine ans ep oid ette E RUPEE ee Ee ttd eene 25 Configuration file 25 Inclusion of configuration Nessie ea 26 Cor e configuration en pe RU eei eee ore e EROR e ettet ates 27 Runmng Karnnel s eei o e dere e Rid tod t o ete edes 34 Starting the gateWay ve esc sees ren p e net EIS 34 Command line options nii ee tta bs t ueteri ecc 35 Kannel st tuses mei a Re se 35 HITP administration noie tern hie pep sell 36 4 Setting up a WAP gateway RE 39 WAP gateway configuration peser pente net dde ass skin anpassen 39 Wapbox Configuration eene nete enne enne tentent 39 Running WAP gateway emule tees biete elici nenne een 42 Checking whether the WAP gateway is alive eren nennen 42 5 Setting up a SMS Gateway usssssssnsennsonssnnsonssonssnensssnnennssnssnnsnnssonsssnsnnsnnsnnss
7. Running push proxy gateway ennir aa ie nem ba ey de E 101 An example using HTTP SMSC 102 An example push tokenised ST document sees 102 Default network and bearer used by push proxy 102 8 Using SSL for s M M li er cavesteesconsssdvesonas sesvasenasudssasccsdeosdoessosvboansssosous 105 Using SSE client Support tti tte ehe ine 105 Using SSL server support for the administration HTTP interface see 105 Using SSL server support for the sendsms HTTP interface 106 Using SSL server support for PPG HTTPS interface eesessseeeeseee eene 106 9 Delivery Reports erri eterne enki oen toto eek enin ee vo ee Eee Va eae n Srs arse 107 10 Getting help and reporting bugs ccussorsonssossonssnesnssnnsnnsnnnsnnssnnssnensnsnnsnnsnnsnnsnnssonssnssnnsnnnsnsennsnnne 109 A Using the fake WAP sender s ssu0susonsennsnssnnsonssonsnnesnnsnnsnnssnnsnnssonssnssnnsnnssnssnnsnnssnnssnssnssnnssnsnnsnnne 111 B Using the fake SMS center sssssnsonssnnenssennsssssonsnnennnsnnennsonnsnsssnssonssnsennssnennsonnsnnsnonssnssnnssnennsonnensensnnee 113 Setting Up fakesmsC uiietie rerio raor heiter pipe 113 Compiling tite di sr nen 113 Configuring Kannel ge eti eee rea pep Ir el 113 Running Ka
8. Smsbox configuration You must define an smsbox group into the configuration file to be able to use SMS Kannel The simplest working smsbox group looks like this group smsbox bearerbox host localhost but you would most probably want to define sendsms port to be able to use SMS push SMSBox inherits from core the following fields smsbox port http proxy port http proxy host http proxy usernam http proxy password http proxy exceptions ssl certkey file Table 5 4 Smsbox Group Variables Variable Value Description group m smsbox This is a mandatory variable bearerbox host m hostname The machine in which the bearerbox is sendsms port c port number The port in which any sendsms HTTP requests are done As with other ports in Kannel can be set as anything desired sendsms port ssl o bool If set to true the sendsms HTTP interface will use a SSL enabled HTTP server with the specified ssl server cert file and ssl server key file from the core group Defaults to no sendsms url o url URL locating the sendsms service Defaults to cgi bin sendsms 67 Variable sendota url o sendsms chars global sender log file log level access log white list black list Value url string phone number filename number 0 5 filename URL URL Chapter 5 Setting up a SMS Gateway Description URL locating the sendota service Defaults to cgi bin sendo
9. and URL encoding isn t done all others do URL encode words not yet used by 96s e g if the message is FOO BAR FOOBAR BAZ and the has been one 96s Yor will mean FOOBAR BAZ all words of the SMS message including the first one with spaces squeezed to one the original SMS message in a binary form the time the message was sent formatted as YYYY MM DD HH MM e g 1999 09 21 14 18 the phone number of the sender of the SMS message the phone number of the receiver of the SMS message like p but a leading 00 is replaced with 73 Chapter 5 Setting up a SMS Gateway like P but a leading 00 is replaced with oo the smsc id of the connection that received the message oe H oo the delivery report value gt the delivery report SMSC reply if any the sendsms user or sms service name message coding 0 default 7 bits 1 7 bits 2 8 bits or 3 unicode oo 5 oo Q oe a message charset for a normal message it will be gsm coding 1 binary coding 2 or UTF16 BE coding 3 If the message was sucessfully recoded from unicode it will be ISO 8859 1 udh of incoming message oo Some sample sms service groups group sms service keyword nop text You asked nothing and I did it catch all true group sms service keyword complex get url http host service sender 3pstext r accept x kannel
10. infrastructure freely to everyone so that the market potential for WAP services both from wireless operators and specialized service providers will be realized as efficiently as possible Kannel also works as an SMS gateway for GSM networks Almost all GSM phones can send and receive SMS messages so this is a way to serve many more clients than just those using a new WAP phone In addition Kannel operates as Push Proxy Gateway or PPG making possible for content servers to send data to the phones This is a new type of WAP service and have many interesting applications Usually servers know whether some data is new not the users Open Source http www opensource org is a way to formalize the principle of openness by placing the source code of a product under a Open Source compliant software license The BSD license was chosen over other Open Source licenses by the merit of placing the least amount of limitations on what a third party is able to do with the source code In practice this means that Kannel is going to be a fully featured WAP implementation and compatible with the maximum number of bearers with special emphasis on SMSC compatibility The Kannel project was founded by Wapit Ltd in June 1999 Overview of WAP WAP short for Wireless Application Protocol is a collection of various languages and tools and an infrastructure for implementing services for mobile phones Traditionally such services have worked via normal phone call
11. the wapbox connection module will be SSL enabled Your wapboxes will have to connect using SSL to the bearerbox then This is used to secure communication between bearerbox and wapboxes in case they are in seperate networks operated and the TCP communication is not secured on a lower network layer Defaults to no These lists can be used to prevent box connections from given IP addresses Each list can have several addresses separated with semicolons An asterisk can be used as a wildcard in place dba PERG prevent TRE Racha bom given IP addresses thus preventing unwanted use of the WAP gateway Used the same way as box deny ip and box allow ip 29 Variable wdp interface nam c log file log level access log Value IP or filename number 0 5 filename Chapter 3 Using the gateway Description If this is set Kannel listens to WAP UDP packets incoming to ports 9200 9208 bound to given IP If no specific IP is needed use just an asterisk If UDP messages are listened to wapbox port variable MUST be set A file in which to write a log This in addition to stdout and any log file defined in command line Log file in core group is only used by the bearerbox Minimum level of logfile events logged 0 is for debug 1 info 2 warning error and 4 panic see Command Line Options A file in which information about received
12. 0 gt lt DOCTYPE si PUBLIC WAPFORUM DTD SI 1 0 EN http www wapforum org DTD si dtd si indication href http wap iobox fi si id 1 wiral com action signal high created 1999 06 257T15 23 152 si expires 2002 06 30T00 00 002 gt Want to test a fetch lt indication gt lt si gt Note that the date value of the si expires attribute contains trailing zeroes They are OK here because SI tokenizer removes them But phones does not accept them in the final SMS data message You should probably use action signal high for testing purposes for it causes an immediate presentation of the push message Production usage is a quite another matter Another example of push content is Service Loading In principle the phone should fetch immediately content from URL http wap iobox fi when it receives this document This sounds quite unsecure and indeed user invention is probably required before fetching lt xml version 1 0 gt lt DOCTYPE sl PUBLIC WAPFORUM DTD SL 1 0 EN http www wapforum org DTD sl dtd gt lt sl href http wap iobox fi action execute high gt lt sl gt Starting necessary programs PPG test environment contains in addition of wapbox and bearerbox two test programs test_ppg simulating push initiator and test_http_server simulating aSMSC center accepting pushed 118 Appendix C Setting up a test environment for Push Proxy Gateway content sended over SMS
13. Charset of text message Used to convert to a format suitable for 7 bits or to UCS2 Defaults to ISO 8859 1 if coding is 7bits and UTFI6BE if coding is UCS2 Optional User Data Header UDH part of the message Must be URL encoded Optional virtual smsc id from which the message is supposed to have arrived This is used for routing purposes if any denied or preferred SMS centers are set up in SMS center configuration This variable can be overridden with a forced smsc configuration variable Likewise the default smsc variable can be used to set the SMSC if it is not set otherwise Deprecated See mclass Optional Sets the Message Class in DCS Field Accepts values between 1 and 4 for Message Class 0 to 3 A value of 1 sends the message directly to display mclass 2 sends to mobile 3 do SIM and 4 to SIM Toolkit 89 mwi coding validity deferred number number number number minutes minutes Chapter 5 Setting up a SMS Gateway Optional Sets Message Waiting Indicator bits in DCS field If given the message will be encoded as a Message Waiting Indicator The accepted values are 1 2 3 and 4 for activating the voice fax email and other indicator or 5 6 7 8 for deactivating respectivly This option excludes the 1ash option a Optional Sets the coding scheme bits in DCS field Accepts values 1 to 3 for 7bit 8bit or UCS2 If unset defaults to 7 bits unless a udh is defined which s
14. If network and bearer attributes of the pap control document are missing or set any Kannel uses address type for routing purposes if the address type is aphone number TYPE PLMN network defaults to GSM and bearer to SMS if it is a IP address TYPE IPv4 network defaults to GSM and bearer to CSD So following minimal pap document works lt xml version 1 0 gt lt DOCTYPE pap PUBLIC WAPFORUM DTD PAP EN http www wapforum org DTD pap_1 0 dtd gt lt pap gt lt push message push id 9fje039jf 084 pi com gt address address value WAPPUSH 358408676001 TYPE PLMN ppg carrier com gt 102 Chapter 7 Setting up Push Proxy Gateway lt address gt lt push message gt lt pap gt 103 Chapter 7 Setting up Push Proxy Gateway 104 Chapter 8 Using SSL for HTTP This chapter explains how you can use SSL to ensure secure HTTP communication on both client and server side Beware that the gateway is acting in both roles of the HTTP model 1 as HTTP client i e for requesting URLs while acting as WAP gateway and while fetching information for the SMS services 2 as HTTP server i e for the administration HTTP interface the PPG and for the sendsms HTTP interface That is why you can specify seperate certification files within the core group to be used for the HTTP sides You can use one or both sides of the SSL support There is no mandatory to use both if only one is desired Using SSL client s
15. SIM card in the GSM modem You can specify this option if your SIM has never been used before and needs to have the PIN number entered The PIN is usually a four digit number validityperiod integer How long the message will be valid i e how long the SMS center the real one not the phone acting as one for Kannel will try to send the message to the recipient Encoded as per the GSM 03 40 standard section 9 2 3 12 Default is 167 meaning 24 hours alt des boolean When encoding DCS field internally there are two formats with similar functionality The 0x0X alt dcs false or non present or the OxFX alt dcs true If you have a buggy modem like Siemens M20 that don t like to send binary messages try setting alt dcs to true Modem Type Modems wavecom Wavecom premicell Nokia Premicell siemens Siemens M20 this modem have some bugs siemens tc35 Siemens TC35 falcom Falcom nokiaphone Nokia 6210 7110 8210 tested Probably other Nokia phones too ericsson Ericsson 57 GSM modem 2 Chapter 5 Setting up a SMS Gateway This new driver is replacing the old GSM Modem driver from Kannel It allows aGSM Modem or Phone to be connected to Kannel and work as a virtual SMSC group smsc smsc at2 modemtype device dev ttyS0 speed 9600 pin 2345 Variable Value Description modemtype string Modems from different device m speed pin device name serial speed in bps string manu
16. amp password bar amp to 0123456 amp text Hellotworld Thus technically you make an HTTP GET request This means that all the information is stuffed into the URL If you want to use this often via a browser you probably want to make an HTML form for this Table 5 13 SMS Push send sms CGI Variables username or user string Username or account name Must be username of the one sendsms user group in the Kannel configuration or results in Authorization failed reply password or pass string Password associated with given username Must match corresponding field in the sendsms user group of the Kannel configuration or Authorization failed is returned from string Phone number of the sender This field is usually overridden by the SMS Center or it can be overridden by faked sender variable in the sendsms user group If this variable is not set smsbox global sender is used to phone number list Phone number of the receiver To send to multiple receivers separate each entry with space url encoded but note that this can be deactivated via sendsms chars in the smsbox group 88 text charset udh SMSC flash mclass string string string string number number Chapter 5 Setting up a SMS Gateway Contents of the message URL encoded as necessary The content can be more than 160 characters but then sendsms user group must have max messages set more than 1
17. boolean Chapter 5 Setting up a SMS Gateway Description Whether to enable the so called SIM buffering behaviour of the GSM module if assigned a true value the module will query the message storage memory of the modem and will process and delete any messages found there this does not alter normal behaviour but only add the capability of reading messages that were stored in the memory for some reason The type of memory to use can be selected using the message storage parameter of the modem configuration Polling the memory is done at the same interval as keepalive if set or 60 seconds if not set NOTE This behaviour is known to cause minor or major hicups for a few buggy modems A modem known not to like this setting is Siemens M20 A modem known to work with this setting is Wavecom Modem definitions are now multiple groups present in kannel conf either directly or for example by including the example modems conf See Inclusion of configuration files Variable Value Description group modems This is amandatory variable id string This is the the id that should be used in modemt ype variable from AT2 name string The name of this modem configuration Used in logs detect string string String to use when trying to detect the modem See detect string2 60 Chapter 5 Setting up a SMS Gateway Variable Value Description detect string2 string Second string to use to detect the modem For example if t
18. device dev ttyO smsc_nua X121 smsc address home_nua x121 radio pad address wait_report 0 1 0 means false 1 means true Variable Value Description device m device ex dev ttyO smsc nua m X121 smsc address The address of an SMSC for SEMA SMS2000 protocols using an X 28 connection 55 Chapter 5 Setting up a SMS Gateway Variable Value Description home_nua m X121 radio pad address The address of a radio PAD implementing Sema SMS2000 using X 28 connection wait report 0 false 1 true Report indicator used by the Sema SMS2000 protocol Optional group smsc smsc ois host 103 102 101 100 port 10000 receive port 10000 ois debug level 0 Variable Value Description host m ip SMSC Host name or IP port m port number SMSC Port number receive port m port number ois debug level number 0 to 8 GSM modem Kannel can use aGSM modem as an SMS center group smsc smsc at modemtype wavecom dev ttySO 2345 device pin Variable Value The port in which the SMSC will contact extra debug optional see smsc ols c Description modemtype string Modems from different manufacturers have slightly different behaviour We need to know what type of modem is used 56 Chapter 5 Setting up a SMS Gateway Variable Value Description device m device name The device the modem is connected to like dev ttyS0 pin string This is the PIN number of the
19. e g to set anew configuration option run the script with the restart parameter etc init d kannel restart If you want Kannel to run as a daemon you need to add a symbolic link to the Kannel script from the runlevel you want Kannel to run in E g to run Kannel in default runlevel just run update rc d kannel defaults If you don t want Kannel to run as a daemon run update rc d f kannel remove To run Kannel as a SMS gateway you need to edit the configuration file which is at etc kannel kannel conf In usr share docs kannel examples there are example files They have some basic examples of the configuration groups needed to run Kannel as a SMS gateway For more detailed information please read the section SMS gateway configuration later in this same document The logging is disabled by default and you can enable it from the kannel conf file Just add the log file option to the group of which box you want to log The documentation will be installed at usr share doc kannel In the Kannel documentation directory there is a html file called control html It is an example file that shows how to use the Kannel http administration interface It also has a template for sending SMS messages 23 Chapter 2 Installing the gateway 24 Chapter 3 Using the gateway This chapter explains how the gateway core bearerbox is configured and used It covers the configuration file keeping an eye on the gateway while it is running and usi
20. gt lt PARM NAME NAME VALUE WAP Company gt lt PARM NAME URL VALUE http wap company com gt lt CHARACTERISTIC gt lt CHARACTERISTIC LIST gt Document type definition DTD for these documents is not available from Internet you must supply it as a file Kannel gw directory contains an example settings dtd Table 5 14 OTA CGI Variables otaid string Name or ID of the ota setting group in Kannel configuration that should be sent to the phone This variable is optional If it is not given the first ota setting group is sent This is unnecessary when a XML document is sended to the phone username string Username of the sendsms user group in Kannel configuration that has been configured to send OTA messages 93 Chapter 5 Setting up a SMS Gateway password string Password associated with given username Must match corresponding field in sendsms user group in Kannel configuration or Authorization failed is returned to number Number of the phone that is to receive the OTA configuration message from string Phone number of the sender This field is usually overridden by the SMS Center or it can be overridden by faked sender variable in the sendsms user group If this variable is not set smsbox global sender is used smsc string Optional virtual smsc id from which the message is supposed to have arrived This is used for routing purposes if any denied or preferred SMS ce
21. id list Accept ONLY SMS messages arriving from SMSC with matching ID a Separate multiple entries with For example if accepted smsc is RL SON accept messages which originate from SMSC with ID set as RL or SON allowed prefix prefix list A list of phone number prefixes which are accepted to be received by this service Multiple entries are separated with semicolon For example 91 93 selects this service for these prefixes If denied prefix is unset only this numbers are allowed If denied is set number are allowed if present in allowed or not in denied list denied prefix prefix list A list of phone number prefixes which are NOT accepted to be sent through this SMSC 72 Chapter 5 Setting up a SMS Gateway Variable Value Description catch all bool Catch keyword regardless of s parameters in pattern send sender bool Used only with POST If set to true number of the handset is set otherwise not strip keyword bool Used only with POST Remove matched keyword from message text before sending it onward faked sender phone number This number is set as sender Most SMS centers ignore this and use their fixed number instead This option overrides all other sender setting methods max messages number If the message to be sent is longer than maximum length of an SMS it will be split into several parts max messages lets you specify a maximum number of individual SMS messages tha
22. is amandatory variable An optional name or id to identify this MySQL connection for internal reference with other MySQL related configuration groups Any string is acceptable but semicolon may cause problems so avoid it and any other special non alphabet characters Hostname or IP of a server running a MySQL database to connect to User name for connecting to MySQL database 82 Chapter 5 Setting up a SMS Gateway Variable Value Description mysql password m password Password for connecting to MySQL database database m string Name of database in MySQL database server to connect to A sample mysql connection group group mysql connection id dlr db host localhost mysql username foo mysql password bar database dlr In case you use different MySQL connections for several storage issues i e one for DLR and another different one for sms service you may use the include configuration statement to extract the MySQL related configuration groups to a seperate mysqal conf file Over The Air configurations To enable Over The Air configuration of phones or other client devices that support the protocol you need to configure a sendsms user ota setting group is not necessary you can send settings to the phone as a XML document but this method is perhaps more suitable for continous provisioning If you want to send multiple OTA configurations through the smsbox and you do not want to send XML doc
23. no default mapping NOTE the mapping is added with both asterisks as described above for the map url setting Thus the above example line is equivalent to writing map url DEVICE home http some where log file filename As with bearerbox core group log level number 0 5 syslog level number Messages of this log level or higher will also be sent to syslog the UNIX system log daemon The wapbox logs under the daemon category The default is not to use syslog and you can set that explicitly by setting syslog level to force sar bool If set wapbox will force to process WTP SAR connections even while Kannel does not support this feature now Some real phones seem to break connection if fallback to non SAR communication is being tried by the gateway smart errorsr bool If set wapbox will return a valid WML deck describing the eror that occured while processing an WSP request This may be used to have a smarter gateway and let the user know what happend actually 4l Chapter 4 Setting up a WAP gateway Running WAP gateway WAP Gateway is ran as explained in previous chapter Checking whether the WAP gateway is alive You can check whether the WAP gateway both the bearerbox and the wapbox is alive by fetching the URL kannel alive 42 Chapter 5 Setting up a SMS Gateway This chapter is a more detailed guide on how to set up Kannel as an SMS gateway Required components To set u
24. or isolated Password required Bring down the gateway by setting state to shutdown After a shutdown is initiated there is no other chance to resume normal operation However status command still works Password required If shutdown is sent for a second time the gateway is forced down even if it has still messages in queue If Kannel state is suspended this will flush all queued DLR messages in the current storage space Password required 37 Chapter 3 Using the gateway 38 Chapter 4 Setting up a WAP gateway This chapter tells you how to set Kannel up as a WAP gateway WAP gateway configuration To set up a WAP Kannel you have to edit the core group in the configuration file and define the wapbox group You must set following variables for the core group wapbox port and wdp interface name See previous chapter about details of these variables With standard distribution a sample configuration file wapkannel conf is supplied You may want to take a look at that when setting up a WAP Kannel Wapbox configuration If you have set wapbox port variable in the core configuration group you MUST supply a wapbox group The simplest working wapbox group looks like this group wapbox bearerbox host localhost There is however multiple optional variables for the wapbox group Table 4 1 Wapbox Group Variables Variable Value Description group m wapbox This is mandat
25. see chapter Overview of WAP Push This means both wapbox and bearer smsc connections are in use So your push proxy gateway configuration file must contain groups core wapbox smsc and smsbox These are configured normal way only smsc group may have push specific variables Note that following configurations are only an example you may need more complex ones Bearerbox setup does not require any new variables group core admin port 13000 smsbox port 13001 wapbox port 13002 admin password b 100 Chapter 7 Setting up Push Proxy Gateway wdp interface name log file filename log level 1 box deny ip box allow ip 127 0 0 1 unified prefix 00358 0 You mut set up wapbox for pulling fetching the wap data and of course starting the push itself No new variables here either group wapbox bearerbox host localhost log file filename log level 0 syslog level none To set up smsc connections for pushing SI or SL over SMS Here HTTP SMSC is used as an example Variables no sender and no coding simplify HTTP request generated by Kannel Send url specifies content gateway or sendsms service group smsc smsc http smsc id HTTP port 10000 system type kannel smsc username foo smsc password bar no sender true no coding true send url http host port path To set up smsbox This group will eventually disappear use here only necessary configuration variabl
26. sent SMS messages is stored Access log in core group is only used by the bearerbox 30 Variable unified prefix white list black list Value prefix list URL URL Chapter 3 Using the gateway Description String to unify received phone numbers for SMSC routing and to ensure that SMS centers can handle them properly This is applied to sender number when receiving SMS messages from SMS Center and for receiver number when receiving messages from SMSbox either sendsms message or reply to original message Format is that first comes the unified prefix then all prefixes which are replaced by the unified prefix separated with comma For example for Finland an unified prefix 358 00358 0 00 should do the trick If there are several unified prefixes separate their rules with semicolon like 35850 050 35840 040 Note that prefix routing is next to useless now that there are SMSC ID entries To remove prefixes use like 35850 050 35840 040 Load list of accepted senders of SMS messages If a sender of an SMS message is not in this list any message received from the SMS Center is discarded See notes of phone number format from numhash h header file NOTE the system has only a precision of last 9 or 18 digits of phone numbers so beware As white list but SMS messages to these numbers are automatically discarded 3l Variable store file http proxy host
27. to the phone wapuser wappswd 192 168 0 20 Configure your phone this example is for Nokia 7110 homepage http yourhost hello wml connection type continuous connection security off bearer data dial up number your phone number ip address IP of host running bearerbox auth type normal data call type analogue data call speed 9600 username wapuser password wappswd ISDN terminal This section needs to be written 126 Appendix E Log files This appendix describes the log file format Bearerbox Access Log 2001 01 01 12 00 00 Sent SMS SMSC smsc SVC sms from 12345 to 67890 flags 0 1 0 0 0 msg 11 Hello World udh 0 Variable Value Description Date 2001 01 01 12 00 00 Date Result Sent SMS Result Send failed DLR deliver report Received etc SMSC smsc Smsc id smsc id defined in configuration group smsc SVC sms Service name name defined in configuration group sendsms user from 12345 Sender to 67890 Recipient Flags 0 1 0 0 0 Flags MClass Coding MWI Message Text User Data Header 11 Hello World Compress DLRMask Size of message and message dump in text or hex if it s binary Size of UDH and UDH Hex dump 127 Appendix E Log files 128 Glossary M MO Mobile Originated aSMS from mobile to application MT Mobile Terminated aSMS from application to mobile MWI Message Waiting Indicator See BIBLIO 3GPP 23038 MClass Message Class See B
28. your system if the message has arrived on the destination phone There are different things which can happen to a message on the way to the phone which are Message gets rejected by the SMSC unknown subscriber invalid destination number etc Message gets accepted by the SMSC but the phone rejects the message Message gets accepted by the SMSC but the phone is off or out of reach The message gets buffered Message gets successfully delivered When you deliver SMS to Kannel you have to indicate what kind of delivery report messages you would like to receive back from the system The delivery report types currrently implemented are 1 delivery success 2 delivery failure 4 message buffered 8 smsc submit 16 smsc reject If you want multiple report types you simply add the values togeter For example if you want to get delivery success and or failure you set the dlrmask value to 1 2 and so on If you specify dlrmask on the URL you pass on to kannel you also need to specify dlrurl dlrurlshould contain the URL to which kannel should place a HTTP requests once the delivery report is ready to be delivered back to your system An example transaction would work as following 1 you send a message using dlrmaks 7 and dlrurl2www xyz com cgi dlr php type 46d 2 Kannel forwards the message to the SMSC and Keeps track of the message 3 The SMSC can not reach the phone and thus returns a buffered message 4 Kannel c
29. 00358 0 00 white list http localhost whitelist txt Running Kannel To start the gateway you need to start each box you need You always need the bearer box and depending on whether you want WAP and SMS gateways you need to start the WAP and SMS boxes If you want you can run several of them but we ll explain the simple case of only running one each Starting the gateway After you have compiled Kannel and edited configuration file for your taste you can either run Kannel from command line or use supplied start stop daemon and run kannel box programs to use it as a daemon service more documentation about that later If you cannot or do not know how to set up daemon systems or just want to test Kannel you probably want to start it from command line This means that you probably want to have one terminal window for each box you want to start xterm or screen will do fine To start the bearerbox give the following command bearerbox v 1 conffile The v 1 sets the logging level to INFO This way you won t see a large amount of debugging output the default is DEBUG Full explanation of Kannel command line arguments is below conffile is the name of the configuration file you are using with Kannel The basic distribution packet comes with two sample configuration files smskannel conf and wapkannel conf in gw subdirectory of which the first one is for testing out SMS Kannel and the second one for setting up a WAP K
30. 14 C 1 Test ppg s command line options 119 C 2 Test ppg s configuration file directives essere enne enne 122 List of Figures 1 1 Logical position of WAP gateway and PPG between a phone and a content server 12 1 2 Logical position of SMS gateway between a phone and a content 14 10 Chapter 1 Introduction This chapter introduces WAP and SMS in general terms and explains the role of the gateway in WAP and SMS outlining their duties and features It also explains why the Kannel project was started in the first place and why it is open source With hundreds of millions of mobile phones in use all over the world the market for services targeted at mobile users is mind bogglingly immense Even simple services find plenty of users as long as they re useful or fun Being able to get news send e mail or just be entertained wherever you are is extremely attractive to many The hottest technology for implementing mobile services is WAP short for Wireless Application Protocol It lets the phone act as a simple web browser but optimizes the markup language scripting language and the transmission protocols for wireless use The optimized protocols are translated to plain old HTTP by a WAP gateway Kannel is an open source WAP gateway It attempts to provide this essential part of the WAP
31. CT in the log file so it allows you to do some accounting on it if your front end uses the same username for all services but wants to distinguish them in the log In the case of a HTTP SMSC type the account name is prepended with the servicename username and a colon and forwarded to the next insta ce of kannel This allows hierarchical accounting 91 Chapter 5 Setting up a SMS Gateway Notes To set number of messages use mwi 1 4 amp coding 1 amp udh 04 01 02 lt XX gt lt YY gt where YY are then Using the HTTP interface to send OTA configuration messages OTA messages can be sent to mobile phones or devices to auto configure the settings for WAP They are actually complex SMS messages with UDH and sent as concatenated messages if too long and compiled if necessary You may either pass an HTTP request as GET method or POST method to the HTTP interface If you want to send a configuration that is defined within Kannel s configuration file itself you have to pass a valid ota id value otherwise the content of the request will be compiled to as OTA message GET method for the OTA HTTP interface An example URL looks like this OTA configuration defined in the Kannel configuration file http smsbox host name 13013 cgi bin sendota otaid myconfig amp username foo amp password bar amp to 0123456 URL containing XML document looks like this you must URL encode it before sending it over HTTP http smsbox host
32. G number times before discarding the push request Default is 2 pi ssl boolean Mandatory parameter for HTTPS ssl client certkey fil ssl trusted ca fil group connection Does the client use HTTPS connection Default is no filename Mandatory parameter for HTTPS connection File containing the client s ssl certificate and private key filename Mandatory paramenter for HTTPS connection This file contains the certificates test is willing to trust If this directive is not set certificates are not validated and HTTPS would not be tested configuration Mandatory parameter Start of test ppg s test group 122 Directive push url pap file content file username password Appendix C Setting up a test environment for Push Proxy Gateway Value url filename filename string string Description Mandatory value URL locating PPG s services Mandatory value File containing pap request s control document Mandatory value File containing pap request s content document Mandatory value PPG service user s username Mandatory value PPG service user s password 123 Appendix C Setting up a test environment for Push Proxy Gateway 124 Appendix D Setting up a dial up line This appendix explains how to set up a dial up line in Linux for use with the Kannel WAP gateway In order for it to work you need a Linux kernel with PPP capabilities Most distributions provi
33. IBLIO 3GPP 23038 Coding Message Coding See BIBLIO 3GPP 23038 129 Glossary 130 Bibliography RFC 2616 Hypertext Transfer Protocol HTTP 1 1 http www w3 org Protocols rfc2616 rfc2616 html Request for Comments 2616 The Internet Society 1999 3GPP 23 038 http www 3gpp org ftp Specs latest Rel 5 23 series 23038 500 zip 3GPP 3GPP 23 040 http www 3gpp org ftp Specs latest Rel 5 23 series 23040 530 zip 3GPP 131 Bibliography 132
34. Kannel 1 2 0 User s Guide Open Source WAP and SMS gateway Lars Wirzenius Gateway architect Wapit Ltd liw wapit com http www wapit com http www kannel org Kalle Marjola Manager Wapit Ltd rpr wapit com http www wapit com http www kannel org Andreas Fink Open Source Developer Global Networks Inc SMSRELAY andreas fink org http www smsrelay com http www global networks ch Bruno Rodrigues bruno rodrigues litux org http litux org bruno Kannel 1 2 0 User s Guide Open Source WAP and SMS gateway by Lars Wirzenius Kalle Marjola Andreas Fink and Bruno Rodrigues Abstract This document describes how to install and use Kannel the Open Source WAP and SMS Gateway originally developed by Wapit Ltd now out of business and now being developed further by the open source community Revision History Revision 1 2 0 2002 07 04 Table of Contents 1 Introduction eesesossssnssnsnsnrsnsnssnsnssnsnssnsnssnsnsnsnssnsnsnsnnsnsnssnsnnsnssnsnssnsnnsssnnssnnsnsnnsnssssnsnssnssnsnssesansennsnenasnen 11 Overview of WAP iios essen a a His ine CPU e bros etes 11 Overview of WAP Pusb n erp ehe d re ete ge 13 Overview of SMS ise aeg REP Besen PROS Git pd 13 Feat tes eee lien een tote beet etiem e beo aise cet 14 R quifetiehts arce tee ee terere ARE une bis aad Neon ea en Peres 14 2 Installine gateway 17 Getting the Source code uci eee tique td en Dee ans iin ans 17
35. MS Gateway Variable Value Description alt charset number As some SMS Centers do not follow the standards in character coding an alt charset kludge is presented Currently implemented alternative charsets are defined in alt_charsets h and new ones can be added to appropriate smsc code In addition to these common variables there are several variables used by certain SMS center connections Each currently supported SMS center type is explained below with configuration group for each Note that many of them use variables with same name but most also have some specific variables NOTE SMS center configuration variables are a bit incomplete and will be updated as soon as people responsible for the protocols are contacted Meanwhile please have patience Nokia CIMD 1 37 and 2 0 Support for CIMD 1 37 is quite old and will be removed in a future version of Kannel Please let us know if you still need it group smsc smsc cimd host 100 101 102 103 port 600 smsc username foo smsc password bar The driver for CIMD2 is a receiving SME and expects the SMSC to be configured for that It also expects the SMSC to automatically send stored messages as soon as Kannel logs in this is the normal configuration group smsc smsc cimd2 host 100 101 102 103 port 600 smsc username foo smsc password bar keepalive 5 sender prefix 12345 46 Chapter 5 Setting up a SMS Gateway Variable Value Descrip
36. N depending on if you used the RedHat 7 x or 6 x package In the Kannel documentation directory there is a html file called control html It is an example file that shows how to use the Kannel http administration interface It also has a template for sending SMS messages 21 Chapter 2 Installing the gateway Installing Kannel from DEB packages This chapter explains how to install upgrade and remove Kannel binary DEB packages Before you install Kannel check that you have libxml2 installed on your system dpkg 1 libxml2 Installing or upgrading Kannel using APT 1 Log in as root su 3 Install or upgrade the package apt get install kannel Installing or upgrading Kannel from a file 1 Download the binary DEB packet from the Kannel web site 2 Log in as root su 3 Install or upgrade the DEB package dpkg i kannel VERSION deb Removing Kannel 1 Log in as root 2 Remove the package maintaining configuration files dpkg remove kannel 3 Remove the package completely dpkg purge kannel 22 Chapter 2 Installing the gateway After you have installed Kannel from the DEB packages you should now be able to run the Kannel init d script that will start Kannel as aWAP gateway Run the script as root etc init d kannel start To stop the gateway just run the same script with the stop parameter etc init d kannel stop If Kannel is already running and you just want to quickly stop and start the gateway
37. PE IPV4A ppg carrier com gt lt address gt lt quality of service priority low delivery method unconfirmed lt quality of service gt lt push message gt lt pap gt Note address value format It is contains type and value because PAP protocol supports different address formats You must use test_ppg s a and c flags when pushing messages to Toolkit A defines the client application handling pushes right value for it is ua C defines the content type of your push message SI works with all Toolkits wml only with some older versions Testing PAP protocol over HTTPS When testing HTTPS connection to PPG you probably want use test_ppg s configuration file because number of required parameters is quite high Here is a example test_ppg configuration file 121 group test ppg retries 2 pi ssl yes ssl client certkey file group configuration Appendix C Setting up a test environment for Push Proxy Gateway home aarno kannelcvs gateway gw certkey pem push url https localhost 8900 wappush pap file home aarno test ipnoqos txt content file home aarno test si txt username foo password bar With a configuration file you can do a push by typing test test ppg q configuration file Table C 2 Test ppg s configuration file directives Directive Value Description group test ppg Mandatory parameter Start of test ppg s core group retries number The client tries to log in to PP
38. You can find both of these programs in test directory and they both are short and easily editable To set up a test environment you must first configure a push proxy gateway setting flag trusted pi true makes testing easier This explained in Chapter Setting up push proxy gateway Then issue following commands in Kannel s root directory and in separate windows gw bearerbox conffile gw wapbox conffile Of course you can use more complicated wapbox and bearerbox command line options if necessary To run a http smsc start http server simulation test test http server p port You can of course select the port at will Remember though that PPG listens at the port defined in the ppg configuration file Other test http server options are irrelevant here Lastly start making push requests for instance with a test program test Its first argument is a URL specifying location of push services Other arguments are two file names first one push content and second one pap control document For command line options see Table C 1 For example doing one push you can simplify push url by setting a ppg configuration variable see Setting up push proxy gateway q flag here prevents dumping of test ppg program debugging information test test ppg q http ppg host name ppg port ppg url content file control file This presumes that you have set trusted pi true If you want use authentication in a test environment y
39. ackage rpm e kannel After you have installed Kannel from the RPM packages you x should now be able to run the Kannel init d script that will start Kannel as a WAP gateway Run the script as root etc rc d init d kannel start To stop the gateway just run the same script with the stop parameter etc rc d init d kannel stop If Kannel is already running and you just want to quickly stop and start the gateway e g to set a new configuration option run the script with the restart parameter etc rc d init d kannel restart If you want Kannel to run as a daemon you need to add a symbolic link to the Kannel script from the runlevel you want Kannel to run in E g to run Kannel in runlevel 5 add symbolic links to etc rc d rc5 d cd etc rc d rc5 d ln s init d kannel S91kannel ln s init d kannel K91kannel To run Kannel as a SMS gateway you need to edit the configuration file which is at etc kannel kannel conf In the same directory there is an example file called smskannel conf It has some basic examples of the configuration groups needed to run Kannel as a SMS gateway For more detailed information please read the section SMS gateway configuration later in this same document The logging is disabled by default and you can enable it from the kannel conf file Just add the log file option to the group of which box you want to log The documentation will be installed at usr share doc kannel VERSION or usr doc kannel V ERSIO
40. ain text html or text vnd wap wml On application octet stream defaults to 8 bits 2 All other Content Type values are rejected X Kannel Validity X Kannel Deferred X Kannel DLR Mask X Kannel DLR Url X Kannel Account X Kannel PID X Kannel Alt DCS Kannel can do POST if service is contains a post url Table 5 8 X Kannel Post Headers Parameter escape code equivalent X Kannel Header Notes Sp from X Kannel From Only sent if send P to X Kannel To t time X Kannel Time u udh X Kannel UDH in hex format 06 i smsc mclass pid alt dcs mwi c coding compress validity deferred n service name X Kannel SMSC X Kannel MClass X Kannel PID X Kannel Alt DCS X Kannel MWI X Kannel Coding 1 7 Bits 2 28 Bit X Kannel Compress X Kannel Validity Kannel Deferred Kannel Servic 78 Chapter 5 Setting up a SMS Gateway Parameter escape code equivalent X Kannel Header Notes a or r text request body kannel send all we C charset present in Content Type HTTP Example Conter SendSMS user configurations To enable an SMS push you must set sendsms port into the smsbox group and define one or more sendsms user groups Each of these groups define one account which can be used for the SMS push via HTTP interface see below Table 5 9 SendSMS User Group Variables Variable Value Description group m sen
41. alls http www xyz com cgi dlr php type 4 to indicate the message being buffered 5 The phone is switched on and the SMS gets delivered from the SMSC The SMSC reports this to Kannel 4 Kannel calls http www xyz com cgi dlr php type 2 to indicate the final success 107 Chapter 9 Delivery Reports Depending on the SMSC type not all type of messages are supported For example a CIMD SMSC does not support buffered messages Also some SMSC drivers have not implemented all DLR types 108 Chapter 10 Getting help and reporting bugs This chapter explains where to find help with problems related to the gateway and the preferred procedure for reporting bugs and sending corrections to them The Kannel development mailing list is devel kannel 3glab org To subscribe send mail to devel subscribe kannel 3glab org mailto devel subscribe kannel 3glab org This is currently the best location for asking help and reporting bugs Please include configuration file and version number 109 Chapter 10 Getting help and reporting bugs 110 Appendix A Using the fake WAP sender This appendix explains how to use the fake WAP sender to test the gateway 111 Appendix A Using the fake WAP sender 112 Appendix B Using the fake SMS center Fakesmsc is a simple testing tool to test out Kannel and its SMS services It cannot be used to send messages to mobile terminals it is just a simulated SMS center with no connection to real termin
42. als Setting up fakesmsc This section sums up needed steps to set up system for fakesmsc use Compiling fakesmsc The fake SMS center should compile at the same time as main Kannel compiles The outcoming binary fakesmsc is in test directory The source code is quite simple and trivial and is easily edited Configuring Kannel To use akesmsc to test out Kannel you have to add it to main configuration file see above The simplest form for this configuration group is like this group smsc smsc fake port 10000 The fakesmsc configuration group accepts all common smsc configuration group variables like smsc id preferred smsc id or denied smsc id which can be used to test out routing systems and diverted services before setting up real SMS center connections If you include a fakesmsc group when bearerbox is connected to real SMS centers you should add the connect allow ip variable to prevent unauthorized use To set up multiple fakesmsc es just add new groups Remember to put a different port number to each one Running Kannel with fakesmsc connections After configuring Kannel you can start testing it The bearerbox will listen for fakesmsc client connections to the port s specified in the configuration file 113 Appendix B Using the fake SMS center Starting fake SMS center Each fakesmsc is started from command line with all sent messages after command name If any options are used see be
43. annel Feel free to edit those configuration files to set up your own specialized system After the bearer box you can start the WAP box 34 Chapter 3 Using the gateway wapbox v 1 conffile or the SMS box smsbox v 1 conffile or both of course The order does not matter except that you need to start the bearer box before the other boxes Without the bearer box the other boxes won t even start Command line options Bearerbox smsbox and wapbox each accept certain command line options and arguments when they are launched These arguments are Table 3 2 Kannel Command Line Options v level verbosity level D places debug places F lt file name gt logfile lt file name gt V level fileverbosity level S suspended I isolated H tryhttp Set verbosity level for stdout screen logging Default is 0 which means debug is info 2 warning 3 error and 4 panic Set debug places for debug level output Log to file named file name too Does not overrun or affect any logfile defined in configuration file Set verbosity level for that extra logfile default 0 which means debug Does not affect verbosity level of the logfile defined in configuration file not verbosity level of the stdout output Start the system initially at SUSPENDED state see below bearerbox only Start the system initially at ISOLATED state see below beare
44. ariables A variable definition line has the name of the variable and equals sign and the value of the variable The name of the variable can contain any characters except whitespace and equals The value of the variable is a string with or without quotation marks around it Quotation marks are needed if the variable needs to begin or end with whitespace or contain special characters Normal C escape character syntax works inside quotation marks Perhaps an example will make things easier to comprehend A do nothing service group sms service keyword nop text You asked nothing and I did it 25 Chapter 3 Using the gateway Default service group sms service keyword default vor 0 uo text No services defined The above snippet defines the keyword nop for an SMS service and a default action for situation when the keyword in the SMS message does not match any defined service Lines 1 and 6 are comment lines Line 5 separates the two groups The remaining lines define variables The group type is defined by the group variable value The various variables that are understood in each type of configuration group are explained below Some variable values are marked as boo1 The value for variable can be like true false yes no on off O or 1 Other values are treated as true while if the variable is not present at all it is treated as being false Inclusion of configur
45. ateway If you are using Kannel on a supported platform or one that is similar enough to one compiling Kannel is trivial After you have unpacked the source package of your choosing or after you have checked out the source code from CVS enter the following commands configure make The con igure script investigates various things on your computer for the Kannel compilation needs and writes out the Makefile used to compile Kannel make then runs the commands to actually compile Kannel If either command writes out an error message and stops before it finishes its job you have a problem and you either need to fix it yourself if you can or report the problem to the Kannel project See Chapter 10 for details For detailed instruction on using the configuration script see file INSTALL That file is a generic documentation for configure Kannel defines a few additional options with defaults type Set defaults for the other options t ype is either speed or debug The default is debug enable docs default Build documentation b e converting the User Guide and the Architecture Guide from the DocBook markup language to PostScript and HTML disable docs Don t build documentation enable drafts When building documentation include the sections marked as draft disable drafts default When building documentation don t include the sections marked as draft 18 Chapter 2 Installing the gateway enable debu
46. ation files A configuration file may contain a special directive called include to include an other configuration file to the configuration processing This allows to segment the specific configuration groups required for several services and boxes to different files and hence to have more control in larger setups Here is an example that illustrates the include statement group core admin port 13000 wapbox port 13002 admin password bar wdp interface nam log file var log bearerbox log log level 1 box deny ip box allow ip 127 0 0 1 include wapbox conf This is the main kannel conf configuration file that includes the following wapbox conf file with all required directives for the specific box group wapbox bearerbox host localhost 26 Chapter 3 Using the gateway log file var log wapbox log log level 0 syslog level none The above include statement may be defined at any point in the configuration file and at any inclusion depth Hence you can cascade numerious inclusions if necessary snippet defines the keyword nop for an SMS service and a default action for situation when the keyword in the SMS message does not match any defined service At process start time inclusion of configuration files breaks if either the included file can not be opened and processed or the included file has been processed already in the stack and a recursive cycling has been de
47. ded version of the message Space is coded as For udh the next 2 parts are the UDH and main message Both must be in urlcoded form If multiple messages are given fakesmsc randomly chooses one for each sending Fakesmsc command line options Fake SMS center can be started with various optional command line arguments Table B 1 Fakesmsc command line options 114 Appendix B Using the fake SMS center Switch Value Description H host Use host host instead of default localhost p port Use port number port instead of default 10000 i interval Use message interval interval in seconds fractions accepted instead of default interval 1 0 seconds m max Send a maximum of max messages Value 1 means that an unlimited number of messages is sent Default 1 Using 0 can be useful to listen for messages sent via other channels In addition fakesmsc accepts all common Kannel Command line options like verbosity 115 Appendix B Using the fake SMS center 116 Appendix C Setting up a test environment for Push Proxy Gateway This appendix explains how to set a test environment for PPG This contains a simulated SMSC for instance a http server simulation this is used as example because it is simplest and a simulated push initiator Between them there is the push proxy gateway to be tested This means that you must configure HTTP SMSC Creating push content and control document for testing Here is an e
48. des PPP kernel support by default For more information how to compile PPP support into the kernel please read the Linux Kernel HOWTO at http www linuxdoc org Analog modem This section explains how to set up a dial up line with an analog modem Download and install the mgetty package rpm ivh mgetty VERSION rpm To run mgetty as a daemon add the following line to etc inittab Read man inittab for more detailed information In this example we assume your modem is connected to the serial port ttySO COM 1 S0 2345 respawn sbin mgetty ttySO x 6 D dev ttys0 We need to start the pppd automatically when mgetty receives an AutoPPP request Add the next line to letc mgetty sendfax login config AutoPPP usr sbin pppd file etc ppp options server In etc mgetty sendfax mgetty config you might need to change the connect speed between the computer and the modem Note this is not the connect speed between the WAP client and the server modem If you are e g going to use a Nokia 7110 as the server side modem you need to change the speed to 19200 Usually you can just leave the speed to the default value 38400 speed 38400 Add the following lines to etc ppp options server refuse chap require pap lock modem crtscts passive 192 168 1 10 192 168 1 20 125 Appendix D Setting up a dial up line debug In etc ppp pap secrets add the username and password for the ppp account The IP address is the one assigned
49. dsms user This is a mandatory variable username m string Name for the user account password m string Password for the user see HTTP interface below name string As in sms service groups user deny ip IP list As other deny allow IP lists but for this user i e this user is not allowed to do the SMS push HTTP dsdrcullowclP IP list request from other IPs than forced smsc string lowes OEO not seb there AURIS routing see smsc groups default smsc string If no SMSC ID is given with the send sms request see below use this one No idea to use with forced smsc default sender phone number This number is set as sender if not set by rom get post parameter faked sender phone number As in sms service groups max messages number concatenation bool split chars string 79 Variable Value split suffix string omit empty bool header string footer string allowed prefix prefix list denied prefix prefix list white list URL black list URL dlr url URL Some sample sendsms user groups group sendsms user username simpl password elpmis Chapter 5 Setting up a SMS Gateway Description A list of phone number prefixes which are accepted to be sent using this username Multiple entries are separated with semicolon For example 040 050 prevents sending of any SMS message with prefix of 040 or 050 through this SMSC If denied prefix is unset only this numbers are allowed If se
50. e no hard numbers but a reasonably fast PC workstation 400 MHz Pentium II 128 MB RAM should serve several concurrent users or tens of SMS messages per second without problems 15 Chapter 1 Introduction 16 Chapter 2 Installing the gateway This chapter explains how the gateway can be installed either from a source code package or by using a pre compiled binary version The goal of this chapter is to get the gateway compiled and all the files in the correct places the next chapter will explain how the gateway is configured Getting the source code The source code to Kannel is available for download at http www kannel 3glab org download shtml It is available in various formats and you can choose to download either the latest release version or the daily snapshot of the development source tree for the next release version depending on whether you want to use Kannel for production use or to participate in the development If you re serious about development you probably want to use CVS the version control system used by the Kannel project This allows you to participate in Kannel development much more easily than by downloading the current daily snapshot and integrating any changes you ve made every day CVS does that for you See the Kannel web site for more information on how to use CVS Finding the documentation The documentation for Kannel consists of three parts 1 User s Guide i e the one you re reading at the mom
51. e protocol overhead to a few bytes per request instead of the usual hundreds of bytes Thus WAP defines a new protocol stack to be used However to make things simpler also for the people actually implementing the services WAP introduces a gateway between the phones and the servers providing content to the phones Figure 1 1 Logical position of WAP gateway and PPG between a phone and a content server Phone WAP gateway Content server The WAP gateway talks to the phone using the WAP protocol stack and translates the requests it receives 12 Chapter 1 Introduction to normal HTTP Thus content providers can use any HTTP servers and utilize existing know how about HTTP service implementation and administration In addition to protocol translations the gateway also compresses the WML pages into a more compact form to save on the air bandwidth and to further reduce the phone s processing requirements It also compiles WMLScript programs into a bytecode format Kannel is not just a WAP gateway It also works as an SMS gateway Although WAP is the hot and technically superior technology SMS phones exist in huge numbers and SMS services are thus quite useful Therefore Kannel functions simultaneously as both a WAP and an SMS gateway Overview of WAP Push Previous chapter explained pull mode of operation the phone iniatiates the transaction There is however situations when the server called in this context a push init
52. e specified certificate and is used for the HTTPS server side only ssl trusted ca fil filename This file contains the certificates Kannel is willing to trust when working as a HTTPS client If this option is not set certificates are not validated and those the identity of the server is not proven dlr storage type Defines the way DLRs are stored If you have build in external DLR storage support i e using MySQL you may define here the alternative storage type like mysql Supported types are internal mysql By default this is set to internal maximum queue length number of messages Set maximum size of incoming message queue After number of messages has hit this value Kannel began to discard them Value 0 means giving strict priority to outgoing messages 1 default means that the queue of infinite length is accepted This works with any normal input use this variable only when Kannel message queues grow very long A sample more complex core group could be something like this group core admin port 13000 admin password f00bar status password sTat admin deny ip admin allow ip 127 0 0 1 200 100 0 33 Chapter 3 Using the gateway smsbox port 13003 wapbox port 13004 box deny ip box allow ip 127 0 0 1 200 100 0 nw wdp interface nam log file kannel log log level 1 access log kannel access unified prefix 358
53. ed by some protocols concurrent pushes number Number of concurrent pushes expected Note that PPG does work even value is too low it will only be slower Default 100 users number Number of actually configured user accounts Note that PPG does work even value is too low it will only be slower Default 1024 trusted pi boolean If true PI does authentication for PPG Obviously both of them must reside inside same firewall Default true If this variable is true all security variables are ignored even though they may be present ppg deny ip ip list PPG will not accept pushes from these IPs Wildcards are allowed If this attribute is missing no IP is denied by this list 98 Chapter 7 Setting up Push Proxy Gateway Variable Value Description ppg allow ip ip list PPG will accept pushes from these and only these IPs Wildcards are allowed Adding this list means that IPs not mentioned are denied too Configuring PPG user group variables In addition of pi lists similar to the core group ppg configuration spesific to a certain user contains variables used for authentication and enforcing restrictions to phone numbers pi may contact All variables are elaborated in table 7 2 As an example let us see how to configure a ppg user a pi named here picom allowed to send pushes only from a specified ip group wap push user wap push user picom ppg username foo ppg password bar allow ip 62 254 217 163
54. el is well configured and we had one sucessful connection if retry is true kannel will always retry the connection even if some related error ocur 51 Variable Value my number number SMPP 3 4 Chapter 5 Setting up a SMS Gateway Description If the large account number is different from the short number assign it with this variable For example if short number is 12345 and large account is 0100100100101234 IP port set my number to 12345 and every message received will have that receiver This implements Short Message Peer to Peer SMPP Protocol 3 4 in a manner that should also be compatible with 3 3 Sample configuration group smsc smsc smpp host 123 123 123 123 port 600 receive port 700 smsc username STT smsc password foo system type VMA address range Variable Value Description host m hostname Machine that runs SMSC As IP 100 100 100 100 or hostname their machine here port m port number The port number for the TRANSMITTER connection to the SMSC May be the same as receive port Use value 0 to disable this I O thread 52 Variable transceiver mode receive port smsc username m smsc password m system type m Value bool port number string string string Chapter 5 Setting up a SMS Gateway Description Attempt to use a TRANSCEIVER mode connection to the SM SC It uses the standard transmit port there is no need t
55. ent 2 Architecture and Design in doc arch orat http www kannel 3glab org arch shtml http www kannel 3glab org arch shtml 3 The README and various other text files in the source tree We intend to cover everything you need to install and use Kannel is in User s Guide but the guide is still incomplete in this respect Similarly the Architecture and Design document should tell you everything you need to know to dive into the sources and quickly make your own modifications It s not a replacement for actually reading the source code but it should work as a map to the source code The README is not supposed to be very important nor contain much information Instead it will just point at the other documentation You need the following tools to compile Kannel Ccompiler and libraries for ANSI C with normal Unix extensions such as BSD sockets 17 Chapter 2 Installing the gateway An implementation of POSIX threads pthread h GNU Bison 1 28 if you want to modify the WML Script compiler a pre generated parser is included for those who just want to compile Kannel DocBook processing tools DocBook stylesheets jade jadetex etc see README docbook for more information pre formatted versions of the documentation are available and you can compile Kannel itself even without the documentation tools GNU autoconf if you want to modify the configuration script Compiling the g
56. es group smsbox bearerbox host localhost Kannel sources contain a sample push configuration file gw pushkannel conf Running a push proxy gateway Push proxy gateway is started by simply typing using separate windows gw bearerbox conffile 101 Chapter 7 Setting up Push Proxy Gateway gw wapbox conffile You can of course use more complex command line options An example using HTTP SMSC An easy way to test and implement push services is to put ppg in the front of an existing sendsms service capable to send SMS data messages and to to understand HTTP requests generated by HTTP SMSC See next chapter Then you need only configure SMSC configuration send url to point to sendsms service An example push tokenised SI document HTTP SMSC generates a HTTP get request when it get a sendmessage event expressed in unicode The content gateway or the sendsms service must of course understand this URL So here is an example cgi variable text contains the url escaped form of a SI document It is usable for testing prototype phones http matrix 8080 phplib kannelgw php user deleted amp pass deleted to 2B358408676001 amp text 3D 02 06 17 AE 96localhost 3A8080 00 AF 80 8D CF B4 80 02 05j 00E C6 0C 03wap iobox fi 00 11 031 40wiral com 00 07 0A C3 07 19 99 06 25 15 23 15 10 C3 04 02 060 01 03Want to ttest a tfetch 3F 00 01 01 amp udh 06 05 04 0B 84 23 F0 Default network and bearer used by push proxy gateway
57. ets coding to 8bits Optional If given kannel will inform SMS Center that it should only try to send the message for this many minutes If the destination mobile is off other situation that it cannot receive the sms the smsc discards the message Note you must have your kannel box time syncronized with the SMS Center Optional If given the SMS center will postpone the message to be delivered at now plus this many minutes Note you must have your kannel box time syncronized with the SMS Center 90 dlrmask dlrurl pid alt dcs account number bit mask string url byte number string Chapter 5 Setting up a SMS Gateway Optional Request for delivery reports with the state of the sent message The value is a bit mask composed of 1 Delivered to phone 2 Non Delivered to Phone 4 Queued on SMSC 8 Delivered to SMSC 16 Non Delivered to SMSC Must set d1r url on sendsms user group or use the dlrurl CGI variable Optional If dirmask is given this is the url to be fetched Must be urlencoded Optional Sets the PID value See ETSI Documentation Ex SIM Toolkit messages would use something like amp pid 127 amp coding 2 amp alt dcs l amp mclass 3 Optional If unset kannel uses the alt dcs defined on smsc configuration or 0X per default If equals to 1 uses FX If equals to 2 force OX Account name or number to carry forward for billing purposes This field is logged as A
58. ew implementation of the EMI protocol that supports more features and should work more reliably than the old one It is the recommended one to use with TCP IP connections Sample configurations for these are group smsc smsc emi2 smsc emi_ip to use the old implementation host 103 102 101 100 port 600 smsc username foo smsc password bar keepalive 55 our port 600 optional bind in our end receive port 700 the port in which the SMSC will contact idle timeout 30 group smsc smsc emi host 100 102 100 102 phone device dev ttyO smsc username foo smsc password bar Variable Value Description host c hostname Machine that runs SMSC As IP 100 100 100 100 or hostname their machine here port c port number Port number in the SMSC host machine alt host hostname Optional alternate Machine that runs SMSC As IP 100 100 100 100 or hostname their machine here If undef but exists alt port emi2 would try host alt port 48 Chapter 5 Setting up a SMS Gateway Variable Value Description alt port port number Optional alternate Port number in the SMSC host machine If undef but exists alt host emi2 would try alt host port smsc username string Username in the SMSC machine connection account smsc password string Password in the SMSC machine needed to contact SMSC device c device name The device the modem is connected to like dev ttyS0 ISDN connection only
59. f test http server program You cannot use a real phone for testing a push server Sending random messages to a phone does not work because its only feedback if it works properly in error situations is dropping the offending message 120 Appendix C Setting up a test environment for Push Proxy Gateway Nokia Toolkit instead displays push headers decompiles tokenised documents and outputs debugging information It is not of course a carbon copy of a real phone But it is still usefull for checking spec conformance of push servers Toolkit runs on Windows the first thing you must is to install a virtual machine VMWare is one possibility in the machine where Kannel runs Then you must configure Toolkit for working with a push gateway Then start bearerbox and wapbox similar way as told before You must set the correct client address in the push document sended by test ppg program Use IP address of our virtual machine easiest way to get this is to ping your virtual machine name in the dos prompt window Your bearer is in this case IP An example pap document follows xml version 1 0 gt lt DOCTYPE pap PUBLIC WAPFORUM DTD PAP EN http www wapforum org DTD pap 1 0 dtd pap lt push message push id 9fjeo39jf084 ppi com deliver before timestamp 2001 09 28T06 45 002 deliver after timestamp 2001 02 28T06 45 002 progress notes requested false gt lt address address value WAPPUSH 192 168 214 1 TY
60. facturers have slightly different behaviour We need to know what type of modem is used Use auto or omit parameter to have kannel detect the modem type automatically some types should not be autodetected like the Nokia Premicell The device the modem is connected to like dev ttyS0 The speed in bits per second Default value 0 means to try to use speed from modem definition or if it fails try to autodetect This is the PIN number of the SIM card in the GSM modem You can specify this option if your SIM has never been used before and needs to have the PIN number entered The PIN is usually a four digit number 58 Variable validityperiod retry keepalive my number sms center Value integer boolean seconds number number Chapter 5 Setting up a SMS Gateway Description How long the message will be valid i e how long the SMS center the real one not the phone acting as one for Kannel will try to send the message to the recipient Encoded as per the GSM 03 40 standard section 9 2 3 12 Default is 167 meaning 24 hours Assuming that kannel is well configured and we had one sucessful connection if retry is true kannel will always retry the connection even if some related error ocur Kannel would ping the modem for this many seconds If the probe fails try to reconnect to it Optional phone number SMS Center to send messages 59 Variable sim buffering Value
61. first give an unique ID for each SMS center or if you want to treat multiple ones completely identical give them identical ID Then use preferred smsc id and denied smsc id to set up the routing to your taste See also SMS PUSH settings sendsms user groups below Feature checklist Not all of Kannel s SMSC drivers support the same set of features This is because they were written at different times and new features are often only added to drivers that the feature author can test The table in this section is an attempt to show exactly what features to expect from a driver and to help identify areas where drivers need to be updated Currently most of the entries are marked as not tested because the table is still new 64 Chapter 5 Setting up a SMS Gateway Table 5 2 SMSC driver features Featurecimd cimd2 emi emi_ipemi2 smpp sema ois at at2 http fake Can use DLR n y n n y y n n n n n n Can set DCS 2 y 2 y Can set Alt DCS n n n n y n n n n y n n Can set Validity 2 y 2 y Can set Deferred n Can set Pid n n n n y n n n n y n n Can send Unicode y y Can send 8 bits y i y Correctly send GSM alphabet y 7 7 Notes a Touse mclass mwi coding and compress fields Table 5 3 SMSC driver internal features Featurecimd cimd2 emi 2 smpp sema ois at2 at http Can keep idle c
62. g Enable non reentrant development time debugging of WMLScript compiler enable localtime Write log file time stamps in local time not GMT disable assertions Turn off runtime assertion checking This makes Kannel faster but gives less information if it crashes with malloc type Select memory allocation module to use type is native checking the default or s1ow For production use you probably want native The s1ow module is more thorough than checking but much slower nable mutex stats Produce information about lock contention nable start stop daemon Compile the start stop daemon program enable pam Enable using PAM for authentication of sendsms users for smsbox You may need to add compilations flags to configure CFLAGS pthread configure The above for instance seems to be required on FreeBSD If you want to develop Kannel you probably want to add CFLAGS that make your compiler use warning messages For example for GCC CFLAGS Wall 02 g configure You may at your preference use even stricter checking options Installing the gateway After you have compiled Kannel you need to install certain programs in a suitable place This is most easily done by using make again make bindir path to directory install Replace path to directory with the pathname of the actual directory where the programs should be installed The programs that are installed are as filenames from the root of
63. h handles to distinct SMS servers and services group smsc smsc id A denied smsc id B group smsc 86 Chapter 5 Setting up a SMS Gateway smsc id B denied smsc id A group sms service accepted smsc A m get url group sms service accepted smsc B i As be seen the smsc id is used to identify the SMS center from which the message came Then the denied smsc id variable is used to prevent messages originally from the other SMS center from being sent through the other one Finally sms service groups are defined with accepted smsc so that they only accept messages from certain SMS center If you want to use SMS push services requesters should then set the smsc request parameter or sendsms user groups should be defined like this group sendsms user username operator A password foo forced smsc A group sendsms user username operator_B password bar forced smsc B Note that if your SMS centers do not set the sender phone number but rely on number transmitted you should set faked sender to all sendsms user groups Running SMS gateway Using the HTTP interface to send SMS messages After you have configured Kannel to allow the sendsms service you can send SMS messages via HTTP 87 Chapter 5 Setting up a SMS Gateway e g using a WWW browser The URL looks something like this http smsbox host name 13013 cgi bin sendsms username foo
64. he modem replies with SIEMENS MODEM M20 detect string could be SIEMENS and detect strign2 M20 init string string Optional initialization string Defaults to AT CNMI 1 2 0 0 0 speed number Serial port hint speed to use Optional Defaults to smsc group speed or autodetect enable hwhs string Optional AT command to enable hardware handshake Defaults to AT IFC 2 2 need sleep boolean Optional Defaults to false Some modems needs to sleep after opening the serial port and before first command no pin boolean Optional Defaults to false If the modem doesn t support the PIN command enable this no smsc boolean Optional Defaults to false If the modem doesn t support setting the SMSC directly on the pdu enable this Default is to include a 00 at the beginning of the PDU to say it s the default smsc and remove the 00 when receiving sendline sleep number miliseconds Optional defaults to 100 miliseconds The sleep time after sending a AT command 61 Variable keepalive cmd message storag enable mms Fake SMSC Value string string boolean Chapter 5 Setting up a SMS Gateway Description Optional defaults to AT If keepalive is activated in AT2 group this is the command to be sent If your modem supports it for example use AT CBC CSQ and see in logs the reply CBC 0 64 0 On batery 64 full and CSQ 14 99 0 31 0 7 signal strenght and channel bit error
65. headers tru max messages 3 concatenation true group sms service keyword default text No action specified 76 Chapter 5 Setting up a SMS Gateway How sms service interprets the HTTP response When an sms service requests a document via HTTP it will accept one of four types of content types text plain text html text vnd wap wml application octet stream Extended headers Blanks are squeezed into one rest is chopped to fit an SMS message Tags are removed rest is chopped to fit an SMS message Processed like HTML The body will be transmitted as the SMS message as 8 bit data This can be avoided by setting assume plain text variable on for the SMS service Kannel uses and accepts several X Kannel headers to be used with SMS services Table 5 7 X Kannel Headers SMSPush equivalent X Kannel Header username password from to text charset udh smsc flash mclass mwi X Kannel Usernam X Kannel Password X Kannel From X Kannel To request body charset as in Content Type text html charset 180 8859 1 X Kannel UDH X Kannel SMSC X Kannel Flash deprecated see X Kannel MClass X Kannel MClass X Kannel MWI 77 SMSPush equivalent coding validity deferred dlrmask dlrurl account pid alt dcs Kannel POST Chapter 5 Setting up a SMS Gateway X Kannel Header X Kannel Coding If unset defaults to 1 7 bits if Content Type is text pl
66. hort messaging service is a way to send short 160 character messages from one GSM phone to another It can also be used to send operator logos ringing tones business cards and phone configurations 13 Chapter 1 Introduction SMS services are content services initiated by SMS message to certain usually short phone number which then answers with requested content if available When SMS services are used the client mobile terminal sends an SMS message to certain number usually a very short specialized number which points to specific SMS center responsible for that number plus possibly many others This SMS center then sends the message onward to specified receiver in intra or Internet using an SMS center specific protocol For example a Nokia SMS center uses CIMD protocol As practically every different kind of SMS center uses different protocol an SMS gateway is used to handle connections with SMS centers and to relay them onward in an unified form Figure 1 2 Logical position of SMS gateway between a phone and a content server SMSC HTTP 5 wer Content provider SMS Center An SMS gateway can also be used to relay SMS messages from one GSM network to another if the networks do not roam messages normally Kannel works as an SMS gateway talking with many different kind of SMS centers and relaying the messages onward to content providers as HTTP queries Content providers then answer to this HTTP query a
67. iator should be the initiator for instance when it must send a mail notification or a stock quote For this purpose Wapforum defined WAP Push Push is an application level service sitting on the top of existing WAP stack It defines two protocols OTA and PAP OTA is a ligthweigth protocol speaking with WAP stack to be more specific with WSP PAP speaks with the push initiator It defines three kind of XML documents one for the push data itself and another for protocol purposes these are called pap document or push control documents The server does not simply send push content to the phone the user would surely not accept for instance interrupting of a voice call Instead it sends a specific XML document either Service Indication or Service Loading These inform the user about the content becomed available and it is displayed only when it is not interrupting anything It contains an URL specifying the service and a text for user describing the content Then the user can decide does he accept push or not The push content is sended to the phones over SMS but the content is fetched by the phone over IP bearer for instance CSD or GPRS Because Push Proxy Gateway tokenises SI and SL documents it may fit one SMS message if not it is segmented for transfer Using two bearers seems to be an unnecessary complication But quite simply phones currently operate this way Push over GPRS can only simplify matters Overview of SMS SMS s
68. low they are put between the command and the messages The usage is as follows test fakesmsc options messagel message2 Options and messages are explained below but as a quick example a typical startup can go like this test fakesmsc i 0 1 m 100 100 200 text nop 100 300 text echo this This tells fakesmsc to connect to bearerbox at localhost 10000 default and send a hundred messages with an interval of 0 1 seconds Each message is from number 100 and is either to number 200 with message nop or to 300 with message echo this Messages received from bearerbox are shown in the same format described below Fake messages Each message consists of four or five parts sender number receiver number type udh if present and main message itself Sender and receiver numbers do not mean anything except for log files and number based routing in Kannel The parts of a message are separated with spaces As each message is taken as one argument it must be put in quotation marks Message type must be one of the following text data and udh Here s an example of using each test fakesmsc i 0 01 v 1 m 1000 100 300 text echo this message test fakesmsc i 0 01 m 1000 100 300 data echo tthese chars 03 04 7 test fakesmsc m 1 100 500 udh 30eudh stuffthere main message For text the rest of the argument is taken as the literal message For data the next part must be the urlco
69. main port path query we can perform HTTP Basic authentication The simplest service group looks like this group sms service keyword www get url http S This service grabs any SMS with two words and www as the first word and then does an HTTP request to an URL which is taken from the rest of the message Any result is sent back to the phone or requester but is truncated to the 160 characters that will fit into an SMS message naturally Service group default has a special meaning if the incoming message is not routed to any other service default sms service group is used You should always define default service Service group black list has a special meaning if the incoming message is in service s black list this service is used to reply to user If unset message will be discarded Table 5 5 SMS Service Group Variables Variable Value Description group m sms service This is a mandatory variable 70 Variable keyword m aliases name get url c post url c file c Value word word list string URL URL filename Chapter 5 Setting up a SMS Gateway Description Services are identified by the first word in the SMS Each s in the URL corresponds to one word in the SMS message Words are separated with spaces A keyword is matched only if the number of words in the SMS message is the same as the number of s fields in the URL This allows you to co
70. n HTTP server To access the administration pacges you will have to use a HTTP client that is capable of talking to such a server Use the https scheme to access the secured HTTP server Defaults to no Password for HTTP administration commands see below Password to request Kannel status If not set no password is required and if set either this or admin password can be used These lists can be used to prevent connection from given IP addresses Each list can have several addresses separated with semicolons An asterisk can be used as a wildcard in a piis isrhey ey pumbep tp which the smspoiteReif amygonnect As with admin port this can be anything you want Must be set if you want to handle any SMS traffic 28 Variable smsbox port ssl o wapbox port c wapbox port ssl o box deny ip box allow ip udp deny ip udp allow ip Value bool port number bool IP list IP list Chapter 3 Using the gateway Description If set to true the smsbox connection module will be SSL enabled Your smsboxes will have to connect using SSL to the bearerbox then This is used to secure communication between bearerbox and smsboxes in case they are in seperate networks operated and the TCP communication is not secured on a lower network layer Defaults to no Like smsbox port but for wapbox connections If not set Kannel cannot handle WAP traffic If set to true
71. name 13013 cgi bin sendota username foo amp password bar amp to 0123456 amp text MyURLEncodedXMLdocument amp type settings You can send either settings or bookmark set CGI variable type accordingly Default for this variable is settings Here is an example XML document this one contains CSD settings for logging in to a mobile service note that you must store DTD locally xml versionz 1 0 lt DOCTYPE CHARACTERISTIC LIST SYSTEM file gw settings dtd lt CHARACTERISTIC LIST gt lt CHARACTERISTIC TYPE ADDRESS gt lt PARM NAME BEARER VALUE GSM CSD gt lt PARM NAME PROXY VALUE 10 11 12 13 gt lt PARM NAME PORT VALUE 9201 gt lt PARM NAME CSD_DIALSTRING VALUE 12345678 gt lt PARM NAME PPP_AUTHTYPE VALUE PAP gt 92 Chapter 5 Setting up a SMS Gateway lt PARM NAME PPP_AUTHNAME VALUE yourusername gt lt PARM NAME PPP_AUTHSECRET VALUE yourauthsecret gt lt PARM NAME CSD CALLTYPE VALUE ISDN gt lt PARM NAME CSD_CALLSPEED VALUE 9600 gt lt CHARACTERISTIC gt lt CHARACTERISTIC TYPE URL VALUE http wap company com gt lt CHARACTERISTIC TYPE NAME gt lt PARM NAME NAME VALUE Your WAP Company gt lt CHARACTERISTIC gt lt CHARACTERISTIC LIST gt A bookmark document looks like this lt xml version 1 0 gt lt DOCTYPE CHARACTERISTIC LIST SYSTEM file gw settings dtd lt CHARACTERISTIC LIST gt lt CHARACTERISTIC TYPE BOOKMARK
72. nd the answer is sent back to mobile terminal with appropriate SMS center connection using SMS center specific protocol In addition to serving mobile originated MO SMS messages Kannel also works as an SMS push gateway content providers can request Kannel to send SMS messages to terminals Kannel then determines the correct SMS center to relay the SMS message and sends the SMS message to that SMS 14 Chapter 1 Introduction center again using SMS center specific protocol This way the content provider does not need to know any SMS center specific protocol just unified Kannel SMS sending interface Features This section needs to be written Requirements Kannel is being developed on Linux systems Red Hat 6 1 and Debian potato and should be fairly easy to export to other Unix like systems However we don t yet support other platforms due to lack of time Kannel requires the following software environment C compiler development libraries and related tools The Gnome XML library known as gnome xml and libxml version 2 2 5 or newer See http xmlsoft org xml html GNU Make Posix threads pthread h GNU Bison 1 28 if you modify the WMLScript compiler DocBook markup language tools jade jadetex DocBook stylesheets etc see README docbook if you want to format the documentation pre formatted versions are available Hardware requirements are fluffier We haven t benchmarked Kannel yet so there ar
73. nfigure the gateway to use different URLs for the same keyword depending on the number of words the SMS message contains If the service has aliases they are listed as a list with each entry separated with a semicolon Optional name to identify the service in logs If unset keyword is used Requested URL The url can include a list of parameters which are parsed before the url is fetched See below for these parameters Also works with plain url Requested URL As above but request is done as POST not GET Always matches the keyword regardless of pattern matching See notes on POST otherwhere File read from a local disc Use this variable only if no url is set All escape codes parameters in url are supported in filename The last character of the file usually linefeed is removed 71 Chapter 5 Setting up a SMS Gateway Variable Value Description text c string Predefined text answer Only if there is neither url nor file set Escape codes parameters are usable here too exec c string Executes the given shell command as the current UID of the running smsbox user and returns the output to stdout as reply Escape codes parameters are usable here too BEWARE You may harm your system if you use this sms service type without serious caution Make sure anyone who is allowed to use these kind of services is checked using white black list mechanisms for security reasons accepted smsc
74. ng the HTTP interface to control the gateway After this chapter there is distinct chapter for each kind of gateway use WAP gateway SMS gateway and combined gateway These chapters explain the configuration and other aspects of gateway of that type There is only one configuration file for all parts of Kannel although when Kannel is distributed to several hosts some lines from the configuration file can be removed in some hosts Configuring the gateway The configuration file can be divided into three parts bearerbox configurations smsbox configurations and wapbox configurations Bearerbox part has one core group and any used SMS center groups while wapbox part has only one wapbox group In smsbox part there is one smsbox group and then number of sms service and sendsms user groups Details of each part are in an appropriate section of this documentation The core group used by the bearerbox is explained in this chapter while wapbox part is in the next chapter and smsbox smsc SMS center sms service and sendsms user groups are in the SMS Kannel chapter Configuration file syntax A configuration file consists of groups of configuration variables Groups are separated by empty lines and each variable is defined on its own line Each group in Kannel configuration is distinguished with a group variable Comments are lines that begin with a number sign 4 and are ignored they don t for example separate groups of v
75. nnel with fakesmsc connections eese enne nee ementi 113 Starting 5 5 113 Fake messages festen eee e ede evt ee 114 Fakesmsc command line options uursseesssensnnensnessnnnsnnennnnnnnnnnnnnnnnnnensnnnnsonnnnnnon 114 C Setting up a test environment for Push Proxy Gateway cerise esses eene eee een esatta sta stn setae 117 Creating push content and control document for testing sss 117 Starting necessary PLO PTAMIS a nen e rmt petiit A e iens 118 Using Nokia Toolkit as a part of a developing environment 120 Testing PAP protocol over HE ERS sly ebony eie i rh t reve n 121 D Setting up a dial up line eessssnssossonssonsnssosssnennssnssnnsnnnsnnssnssonsssssnnsnnssnssnnsnnssonssnssnnsnnssnssnnsnnssnnsannee 125 Analog Modem Ansehen sense deo pd eisen haben 125 ISDN terminal es mane 126 PAID e 127 Bearerbox Access Eos te te ere ro erp tee tnter e ees ped tote bsp Rte Pr tie e eh ded 127 Dad e n Bibliography List of Tables 3 1 Core Group Variables 022 ortho te tete oe nu RE is so 27 3 2 Kannel Command Line Options sereins ne ierre re ri trennen nennen nne san 35 3 3 Kannel HTTP Administration Command
76. nnsnnssonsanssnsssnssnssnnsnnsennsnnne 43 Required components een 43 SMS Gateway COMMS UTA OM aussah ns dre an deed loe e 43 SMS centers x copes coves tee ERR diu e RBEREI 43 Nokia CIMD 1 37 and 2 0 yes tte belegen 46 CMG UCP EMIEA Q RERO RENE 47 SMPP aee ee dg eredi aee nn et 52 Sema Group SMS2000 OIS 4 0 and 5 0 55 GSM modemissen cete ie Ls nn Dunn 56 GSM modem 2 een pO Red DR PORE 58 Fake SMSC sten EU UH ORDIN RUBROS QUI ERR 62 HTTP based relay and content gateways eese 63 Using multiple SMS centers essere enne 64 Feature Checklist sis rane een eter e PED eie tpe gets 64 Smsbox configuration ent i e se tee aan 66 SMS service configurations ec eie cunei e ate e tete eg cre iet 70 How sms service interprets the HTTP eee 76 Extended headers reete ge di peti dee ER er E aas TT Kannel POST eU ga REDDE OU BUS ge aes 78 SendSMS user configurations sssini eieiei rores isir eee tentent tenente ttem nennen nennen 79 External delivery report DLR storage u020002ensersnesnnennenneenennnennensennennnennennennnennennn en 81 Internal DER Storage eisen ie Des 81 MYSQL DER St ra88 nee ae et ead idet t o t Habs 81 MySQL connection configuration sess nennen nennen etre nennen 82 Over The
77. nters are set up in SMS center configuration This variable can be overridden with a forced smsc configuration variable Likewise the default smsc variable can be used to set the SMSC if it is not set otherwise text XML document An URL encoded XML document containing either settings or bookmarks type string Type of the XML document either settings or bookmarks Default is settings 94 Chapter 6 Setting up a SMS amp WAP gateway This chapter tells you how to set Kannel up as a combined WAP and SMS gateway SMS amp WAP gateway configuration Configuration is done as explained in previous chapters you simply have to include all the data from both chapters into the configuration file Running SMS amp WAP gateway There are no special tricks to this just launch both the smsbox and the wapbox in addition to the bearerbox using multiple hosts if needed 95 Chapter 6 Setting up a SMS amp WAP gateway 96 Chapter 7 Setting up Push Proxy Gateway This chapter explains how to set up a push proxy gateway PPG An example configuration file are given A working push proxy gateway is described Configuring ppg core group for push initiator Pl interface PPG configuration group defines gateway s service interface Configuring a PPG working with a trusted PI is easiest Actually you need no configuration at all in this case a PPG with default values will be set up Do not rely on this default values may change F
78. o Result could not be represented as an SMS message reply requestfailed string If set replaces the SMS message sent back when kannel could not contact http service Defaults to Request Failed reply emptymessag string If set replaces the SMS message sent back when message is empty Set to to enable empty messages Defaults to Empty reply from service provider mo recode boolean If true kannel will try to convert UCS2 messages received to ISO 8859 1 If it s possible the message will have coding equal to 7 bits and charset equal to iso 8859 1 A typical smsbox group could be something like this group smsbox bearerbox host localhost sendsms port 13131 sendsms chars 0123456789 global sender 123456 access log kannel access log file smsbox log log level 0 69 Chapter 5 Setting up a SMS Gateway SMS service configurations Now that you have an SMS center connection to send and receive SMS messages you need to define services for incoming messages This is done via sms service configuration groups These groups define SMS services in the smsbox so they are only used by the smsbox Each service is recognized from the first word in an SMS message and by the number of arguments accepted by the service configuration unless cat ch a11 configuration variable is used By adding a username and password in the URL in the following manner http luser password host do
79. o set receive port This is a SMPP 3 4 only feature and will not work on an earlier SM SC This will try a bind transceiver only and will not attempt to fall back to doing transmit and receive on the same connection The port number for the RECEIVER connection to the SMSC May be the same as port Use value 0 to disable this I O thread The username of the Messaging Entity connecting to the SM SC If the SM SC operator reports that the TELEPATH SYSTEM MANAGER TERMINAL view Control Apps View value Name is SMPP_ZAPVMA_T for the transmitter and SMPP_ZAPVMA_R for the receiver the smsc username value is accordingly SMPP_ZAP Note that this used to be called system id the name in SMPP documentation and has been changed to smsc username to make all Kannel SMS center drivers use the same name The password matching the smsc username your teleoperator provided you with Usually you can get away with VMA which stands for Voice Mail Activation 53 Chapter 5 Setting up a SMS Gateway Variable Value Description interface version number Change the interface version parameter sent from Kannel to a value other then 0x34 for SMPP v3 4 the value entered here should be the hexadecimal representation of the interface version parameter for example the default if not set is 34 which stands for 0x34 for SMPP v3 3 setto 33 address range m string According to the SMPP 3 4 spec this is supposed
80. on Kannel can be controlled via an HTTP administration interface All commands are done as normal HTTP queries so they can be easily done from command line like this lynx dump http localhost 12345 shutdown password bar in which the 12345 is the configured admin port in Kannel configuration file see above For most commands admin password is required as a argument as shown above In addition HTTP administration can be denied from certain IP addresses as explained in configuration chapter Note that you can use these commands with WAP terminal too but if you use it through the same Kannel replies to various suspend commands never arrive nor can you restart it via WAP anymore Table 3 3 Kannel HTTP Administration Commands 36 status or status html status txt status xml suspend isolate resume shutdown flush dlr Chapter 3 Using the gateway Get the current status of the gateway in HTML Tells the current state see above and total number of messages relied and queueing in the system right now Also lists the total number of smsbox and wapbox connections No password required unless status password set in which case either that or main admin password must be supplied Text version of status XML version of status Set Kannel state as suspended see above Password required Set Kannel state as isolated see above Password required Set Kannel state as running if it is suspended
81. onnections alive n y n n y y y Can send octet data without UDH n y y y y n n y y n Can send octet data with UDH N y y y y y n J y y Can send text messages with UDH n y y y y n n ji y n Can receive octet data without UDH 65 Chapter 5 Setting up a SMS Gateway Featurecimd cimd2 emi emi_ipemi2 smpp sema ois at2 at http n y n n y n y y y n Can receive unicode messages n n n n n n n n n n Can receive octet data with UDH n y n n y n n N y y Can receive text messages with UDH n y n n y n n N y n Correctly encodes when sending y y y y y y y Correctly encodes when sending y y y y y y y Correctly encodes when sending n y y y n Nc y Can receive in text messages y y y y 2 y y Can receive in text messages y y y y y y y Can receive in text messages n y y y n y y Can shut down idle connections n n n n y n Notes Does not mark it as octet datab However it looks like the sema driver can t receive text data c Miscalculat Symbol Meaning not yet investigated y driver has this feature and it has been tested y driver probably has this feature has not been tested n driver does not have this feature driver claims to have this feature but it doesn t work feature is not applicable for this driver 66 Chapter 5 Setting up a SMS Gateway
82. or PPG core configuration variables see table 7 1 An example of a core configuration for PPG working only with specific addresses follows Note that ppg deny ip list is not actually necessary but does make configuring simpler IPs here are always denied even when they are mentioned in the allowed IPs list Ppg url is a simple stamp used for routing requests to the right service You can change this stamp by setting push ur1 configuration variable group ppg ppg url wappush ppg port 8080 concurrent pushes 100 users 1024 ppg allow ip 194 100 32 125 127 0 0 1 ppg deny ip 194 100 32 89 194 100 32 103 trusted pi false Table 7 1 PPG core group configuration variables Variable Value Description group ppg Mandatory value Tells that we are configuring the PPG group ppg port number The port PPG is listening at Default 8080 97 Chapter 7 Setting up Push Proxy Gateway Variable Value Description ppg ssl port o number Mandatory value for PPG HTTPS support The port at which PPG listens for HTTPS requests There are no defaults you must set the value separately ssl server cert fil string Mandatory value for PPG HTTPS support The file containing server s ssl certificate ssl server key fil string Mandatory value for PPG HTTPS support The file containing server s 851 private key ppg url url URL locating PPG services Default wappush global sender string Sender phone number requir
83. ory variable bearerbox host m hostname The machine in which the bearerbox is timer freq value in seconds The frequency of how often timers are checked out Default is 1 39 Variable map url map url max map url 0 Value URL pair number URL pair Chapter 4 Setting up a WAP gateway Description The pair is separated with space Adds a single mapping for the left side URL to the given destination If you append an asterisk to the left side URL its prefix Is matched against the incoming URL Whenever the prefix matches the URL will be replaced completely by the right side In addition if if you append an asterisk to the right side URL the part of the incoming URL coming after the prefix will be appended to the right side URL Thus for a line map url http source http destination and an incoming URL of http source some path the result will be http destination some path If you need more than one mapping set this to the highest number mapping you need The default gives you 10 mappings numbered from 0 to 9 Default 9 Adds a mapping for the left side URL to the given destination URL Repeat these lines with 0 replaced by a number up to map url max if you need several mappings 40 Chapter 4 Setting up a WAP gateway Variable Value Description device home URL Adds a mapping for the URL DEVICE home as sent by Phone com browsers to the given destination URL There is
84. ou can pass username and password either using headers setting flag b or url you must have set trusted pi false and added wap push user configuration group test test ppg q http ppg host name ppg port username ppg username amp password ppg password content file control file Table C 1 Test ppg s command line options Switch Value Description 119 Appendix C Setting up a test environment for Push Proxy Gateway Switch Value Description c string a string e string b boolean i number r number t number Use content qualifier string instead of default si service indication Allowed values are wml si sl sia multipart nil and scrap Nil and scrap are used for debugging purposes Wml does work with some older phone simulators Use application id string instead of default any Application identifies the application in the phone that should handle the push request Sia ua mms nil and scrap are accepted Nil and scrap are used for debugging purposes Use tranfer encoding when sending a push content Only base64 is currently supported Use headers for authentication instead of url Default off Wait interval number instead of default 0 between pushes Do number requests instead of default 1 Use number threads instead of default 1 Using Nokia Toolkit as a part of a developing environment This chapter describes a developing environment using Nokia Toolkit instead o
85. p an SMS gateway you need in addition to a machine running Kannel access to an operator s SMS center or possibly to multiple ones The list of supported SMS centers and their configuration variables is below If you do not have such access you can still use Kannel as an SMS gateway via phone as SMSC feature by using a GSM phone as a virtual SMS center In addition to an SMS center real or virtual you need some server to handle any SMS requests received This server then has simple or more complex cgi bins programs or scripts to serve HTTP requests generated by Kannel in response to received SMS messages These services can also initiate SMS push via Kannel smsbox HTTP sendsms interface SMS gateway configuration To set up a SMS Kannel you have to edit the core group in the configuration file and define an smsbox group plus one or more sms service groups plus possibly one or more sendsms user groups For the core group you must set the following variable smsbox port In addition you may be interested to set unified prefix white list and or black list variables See above for details of these variables A sample configuration file smskannel conf is supplied with the standard distribution You may want to take a look at that when setting up an SMS Kannel SMS centers To set up the SMS center at Kannel you have to add a smsc group into configuration file This group must include all the data needed to connect
86. rate 99 for unknown See 3GPP 27007 Message storage memory type to enable for SIM buffering Possible values are SM SIM card memory or ME Mobile equipment memory may not be suppoerted by your modem check your modem s manual for more types By default if the option is not set no message storage command will be sent to the modem and the modem s default message storage will be used usually SM Optional defaults to false If enabled kannel would send an AT CMMS 2 if it have more than one message on queue and hopefully will be quickier sending the messages Fake SMSC is a simple protocol to test out Kannel It is not a real SMS center and cannot be used to send or receive SMS messages from real phones So it is ONLY used for testing purposes group smsc smsc fake 62 Chapter 5 Setting up a SMS Gateway port 10000 connect allow ip 127 0 0 1 Variable Value Description host m hostname Machine that runs the SMSC As IP 100 100 100 100 or hostname their machine here port m port number Port number in smsc host machine connect allow ip IP list If set only connections from these IP addresses are accepted HTTP based relay and content gateways This special SMSC is used for HTTP based connections with other gateways and various other relay services when direct SMSC is not available group smsc smsc http system type kannel smsc username nork smsc password
87. rbox only Only try to open HTTP sendsms interface if it fails only warn about that do not exit smsbox only 35 Chapter 3 Using the gateway Kannel statuses In Kannel there are four states for the program which currently directly only apply to bearerbox a Running The gateway accepts proceeds and relies messages normally This is the default state for the bearerbox b Suspended The gateway does not accept any new messages from SMS centers nor from UDP ports Neither does it accept new sms and wapbox connections nor sends any messages already in the system onward Isolated In this state the gateway does not accept any messages from external message providers which means SMS Centers and UDP ports It still processes any messages in the system and can accept new messages from sendsms interface in smsbox e e Full Gateway does not accept any messages from SMS centers because maximum queue length is achieved Shutdown When the gateway is brought down it does not accept any new messages from SMS centers and UDP ports but processes all systems already in the system As soon as any queues are emptied the system exits o The state can be changed via HTTP administration interface see below and shutdown can also be initiated via TERM or INT signal from terminal In addition the bearerbox can be started already in suspended or isolated state with S or I command line option see above HTTP administrati
88. re any special configuration In order to configure bearerbox to use internal DLR storage use dlr storage internal in the core group MySQL DLR storage To store DLR information into a MySQL database you may use dir storage mysql configuration directive in the core group In addition to that you must have a d1r mysq1 group defined that specifies the table field names that are used to the DLR attributes and amysql connection group that defines the connection to the MySQL server itself Here is the example configuration from doc dlr mysql conf group mysql connection id dlr db host localhost mysql username foo mysql password bar 81 database dlr group dlr mysql mysql id dlr db table dlr field smsc smsc field timestamp ts field destination destination servic field servic field url url field mask mask field status status MySQL connection configuration Chapter 5 Setting up a SMS Gateway For several reasons external storage may be required to handle dynamical issues i e DLRs sms service sendsms user ota setting ota bookmark definitions and so on To define a MySQL database connection you simple need to specify amysql connection group as follows Table 5 10 MySQL Connection Group Variables Variable Value Description group id m host m mysql username m mysql connection string hostname or IP username This
89. ring is automatically added to each SMS sent with this service If the message is split it is added to each part As header but not inserted into head but appended to end Stuff in answer that is cut away only things between prefix and suffix is left Not case sensitive Matches the first prefix and then the first suffix These are only used for ur1 type services and only if both are specified 74 Variable Value white list URL black list URL Chapter 5 Setting up a SMS Gateway Description Load a list of accepted senders of SMS messages If a sender of an SMS message is not in this list any message received from the SMSC is rejected unless a black list service is defined See notes of phone number format from numhash h header file As white list but SMS messages from these numbers are automatically discarded Notes a Even if this service is denied kannel still searches for other service which accepts the message or default servic Table 5 6 Parameters Escape Codes ok oe un un oe H oe w o ct Q the keyword in the SMS request i e the first word in the SMS message next word from the SMS message starting with the second one i e the first word the keyword is not included problematic characters for URLs are encoded e g becomes 2B same as s but is converted to useful when user enters a URL
90. s eese rennen nennen nennen 36 4 1 Wapbox Group Vatiables o ete peine p ture rp ter or 39 35 1 SMSC Group Variables ac de eerte t de e iecore he ELI ins 44 5 2 SMSC driver features roo eoo Dp ERR ter e PEDI eite tpe tete 64 5 3 SMSC driver internal features eese ehe t tr e rte eene ses sn 65 5 4 Smsbox Group Variables coeunt eee e ei pep reitera 67 5 5 SMS Service Group Variables isisisi ceecee enne ethernet teint entente nnne 70 326 Parameters Escape Codes ace ptr RT EN AR a en 75 527 X Kannel Headers iii toU SU RER QUEE Irene TT 5 8 X Kannel Post Headers ntur e etenim eg te epe pie 78 5 9 SendSMS User Group 1 ener tren 79 5 10 MySQL Connection Group Variables nennen 82 5 11 Setting Group eene 83 5 12 OTA Bookmark Group Variables essere enne nennen enne nennen 85 5 13 SMS Push send sms Variables sess eene ener enne nennen nnns 88 2214 OTA CGI Variables nen epe e Bun He 93 7 1 PPG core group configuration variables eese eren een enne nennen 97 7 2 PPG user group configuration variables sss eene eren 99 B 1 Fakesmsc command line options recesii ki a a a 1
91. s or short textual messages e g SMS messages in GSM networks Neither are very 11 Chapter 1 Introduction efficient to use nor very user friendly WAP makes it possible to implement services similar to the World Wide Web Unlike marketers claim WAP does not bring the existing content of the Internet directly to the phone There are too many technical and other problems for this to ever work properly The main problem is that Internet content is mainly in the form of HTML pages and they are written in such way that they require fast connections fast processors large memories big screens audio output and often also fairly efficient input mechanisms That s OK since they hopefully work better for traditional computers and networks that way However portable phones have very slow processors very little memory abysmal and intermittent bandwidth and extremely awkward input mechanisms Most existing HTML pages do not work on mobiles phones and never will WAP defines a completely new markup language the Wireless Markup Language WML which is simpler and much more strictly defined than HTML It also defines a scripting language WMLScript which all browsers are required to support To make things even simpler for the phones it even defines its own bitmap format Wireless Bitmap or WBMP HTTP is also too inefficient for wireless use However by using a semantically similar binary and compressed format it is possible to reduce th
92. server needs to send something to other terminals or delay the answer To create such systems an SMS push is used The idea is to get the initial request but then send no reply Instead the reply if any is sent via HTTP sendsms interface as SMS Push This way the service application has full control of the return content and can do all needed formatting beforehand Note that when no reply is wanted remember to set the variable max messages to zero 0 so that no reply is sent unless an error occurs Simple sample group sms service keyword talk get url http my applet machine Servlet talk sender p amp text r max messages 0 Setting up operator specific services Those running Kannel with several SMS centers might need to define services according to the relying SMS center To achieve this first you need to give an ID name for SMS center connections see above Then use the accepted smsc variable to define which messages can use that service group sms service keyword weather accepted smsc SOL get url http my applet machine Servlet weather sender p amp operator SOL amp text r Setting up multi operator Kannel Sometimes there is a need for Kannel to listen to two or more distinct SMS centers and messages must be routed to services according to where they came from and replies likewise must return to same SMSC This is done via smsc id magic Here is a shortened sample configuration whic
93. t denied smsc id id list SMS messages with SMSC ID equal to any of the IDs in this list are never routed to this SMSC Multiple entries are separated with semicolons 44 Chapter 5 Setting up a SMS Gateway Variable Value Description allowed smsc id id list This list is opposite to previous only SMS messages with SMSC ID in this list are ever routed to this SMSC Multiple entries are separated with semicolons preferred smsc id id list SMS messages with SMSC ID from this list are sent to this SMSC instead than to SMSC without that ID as preferred Multiple entries are separated with semicolons allowed prefix prefix list A list of phone number prefixes which are accepted to be sent through this SMSC Multiple entries are separated with semicolon For example 040 050 prevents sending of any SMS message with prefix of 040 or 050 through this SMSC If denied prefix is unset only this numbers are allowed If set number are allowed if present in allowed or not in denied list denied prefix prefix list A list of phone number prefixes which are NOT accepted to be sent through this SMSC preferred prefix prefix list As denied prefix but SMS messages with receiver starting with any of these prefixes is preferably sent through this SMSC In a case of multiple preferences one is selected at random also if there are preferences SMSC is selected randomly 45 Chapter 5 Setting up a S
94. t number are allowed if present in allowed or not in denied list A list of phone number prefixes which are NOT accepted to be sent using this username Load a list of accepted destinations of SMS messages If a destination of an SMS message is not in this list any message received from the HTTP interface is rejected See notes of phone number format from numhash h header file As white list but SMS messages from these numbers are automatically rejected URL to be fetched if a dlrmask CGI parameter is present 80 Chapter 5 Setting up a SMS Gateway group sendsms user username complex password 76ftY user deny ip user allow ip 123 234 123 234 max messages 3 concatenation true forced smsc SOL The second one is very limited and only allows a user from IP 123 234 123 234 On the other hand the user can send a longer message up to 3 SMSes long which is sent as concatenated SMS External delivery report DLR storage Delivery reports are supported by default internaly which means all DLRs are stored in the memory of the bearerbox process This is problematic if bearerbox crashes or you take the process down in a controlled way but there are still DLRs open Therefore you may use external DLR storage places i e a MySQL database Following are the supported DLR storage types and how to use them Internal DLR storage This is the default way in handling DLRs and does not requi
95. t can be used If max messages Is set to 0 no reply is sent except for error messages accept x kannel headers bool Request reply can include special X Kannel headers but these are only accepted if this variable is set to true See Extended headers assume plain text bool If client does not set Content Type for reply it is normally application octet stream which is then handled as data in kannel This can be forced to be plain text to allow backward compatibility when data was not expected 73 Variable concatenation split chars split suffix omit empty header footer prefix suffix Value bool string string bool string string string string Chapter 5 Setting up a SMS Gateway Description Long messages can be sent as independent SMS messages with concatenation false oras concatenated messages with concatenation true Concatenated messages are reassembled into one long message by the receiving device Allowed characters to split the message into several messages So with the message is split from last or which is included in the previous part If the message is split into several ones this string is appended to each message except the last one Normally Kannel sends a warning to the user if there was an empty reply from the service provider If omit empty is set to true Kannel will send nothing at all in such a case If specified this st
96. ta Only these characters are allowed in to field when send SMS service is requested via HTTP Naturally you should allow at least 0123456789 The space character has special meaning it is used to separate multiple phone numbers from each other in multi send To disable this feature do not have it as an accepted character If this variable is not set the default set 0123456789 is used If set all sendsms originators are set as these before proceeding Note that in a case of most SMS centers you cannot set the sender number but it is automatically set as the number of SMSC As with the bearerbox core group Access log is used to store information about MO and send sms requests Can be named same as the main access log in bend accepted destinations of SMS messages If a destination of an SMS message is not in this list any message received from the HTTP interface is rejected See notes of phone number format from numhash h header file As white list but SMS messages to these numbers are automatically discarded 68 Chapter 5 Setting up a SMS Gateway Variable Value Description reply couldnotfetch string If set replaces the SMS message sent back to user when kannel could not fetch content Defaults to Could not fetch content sorry reply couldnotrepresent string If set replaces the SMS message sent back when kannel could not represent the result as a SMS message Defaults t
97. tected Core configuration Configuration for Kannel MUST always include a group for general bearerbox configuration This group is named as core in configuration file and should be the first group in the configuration file As its simplest form core group looks like this group core admin port 13000 admin password f00bar Naturally this is not sufficient for any real use as you want to use Kannel as an SMS gateway or WAP gateway or both Thus one or more of the optional configuration variables are used In following list as in any other similar lists all mandatory variables are marked with m while conditionally mandatory variables which must be set in certain cases are marked with c Table 3 1 Core Group Variables Variable Value Description group m core This is a mandatory variable admin port m port number The port number in which the bearerbox listens to HTTP administration commands It is NOT the same as the HTTP port of the local www server just invent any port but it must be over 1023 unless you are running Kannel as a root process not recommended 27 Variable admin port ssl o admin password m status password admin deny ip admin allow ip smsbox port c Value bool string string IP list port number Chapter 3 Using the gateway Description If set to true a SSL enabled administration HTTP server will be used instead of the default unsecure plai
98. that SMS center You may also want to define an ID identification name for the SMSC for logging and routing purposes SMSC ID is an abstract name for the connection It can be anything you like but you should avoid any special characters You do not need to use ID but rely on SMS center IP address and other information 43 Chapter 5 Setting up a SMS Gateway However if you use the ID you do not need to re define sms services nor routing systems if the IP of the SMS Center is changed for example Common smsc group variables are defined in the following table The first two group and smsc are mandatory but rest can be used if needed Table 5 1 SMSC Group Variables Variable Value Description group m smsc This is amandatory variable smsc m string Identifies the SMS center type See below for a complete list smsc id string An optional name or id for the smsc Any string is acceptable but semicolon may cause problems so avoid it and any other special non alphabet characters This id is written into log files and can be used to route SMS messages and to specify the used SMS service Several SMSCs can have the same id The name is case insensitive Note that if SMS Center connection has an assigned SMSC ID it does NOT automatically mean that messages with identical SMSC ID are routed to it instead configuration variables denied smsc id allowed smsc id and preferred smsc idis used for tha
99. the source directory gw bearerbox gw smsbox gw wapbox The version number of the gateway is added to the file names during installation This makes it easier to have several versions installed and makes it easy to go back to an older version if the new version proves 19 Chapter 2 Installing the gateway problematic Kannel consists of three programs called boxes the bearer box is the interface towards the phones It accepts WAP and SMS messages from the phones and sends them to the other boxes The SMS box handles SMS gateway functionality and the WAP box handles WAP gateway functionality There can be several SMS boxes and several WAP boxes running and they don t have to run on the same host This makes it possible to handle much larger loads Using pre compiled binary packages Installing Kannel from RPM packages This chapter explains how to install upgrade and remove Kannel binary RPM packages Before you install Kannel check that you have libxml2 installed on your system rpm q libxml2 Installing Kannel 1 Download the binary RPM packet from the Kannel web site 2 Log in as root su 3 Install the RPM package rpm ivh kannel VERSION i386 rpm Upgrading Kannel 1 Download the binary RPM packet from the Kannel web site 2 Log in as root 3 Upgrade the RPM package rpm Uvh kannel VERSION i386 rpm Removing Kannel 20 Chapter 2 Installing the gateway 1 Log in as root 2 Remove the RPM p
100. tication if set to on PAP otherwise normal or secure Indicates wether WTLS should be used or not Defaults to normal Login name Login password 84 Chapter 5 Setting up a SMS Gateway And a sendsms user to use with it With concatenation enabled group sendsms user username otauser password foo max messages 2 concatenation 1 Table 5 12 OTA Bookmark Group Variables Variable Value Description group ota bookmark This is amandatory variable ota id string An optional name or id for the ota bookmark Any string is acceptable but semicolon may cause problems so avoid it and any other special non alphabet characters url URL The address of the HTTP server for your WAP services i e http wap company com name string Description of the service A sample ota bookmark group group ota bookmark ota id wap link url http wap company com service Our company s WAP site And a sendsms user to use with it with the same conditions as for the ota setting group Setting up more complex services The basic service system is very limited it can only answer to original requester and it cannot send UDH data for example This chapter explains some more sophisticated and complex SMS service setups 85 Chapter 5 Setting up a SMS Gateway Redirected replies The basic service system always sends the answer back to original requester but sometimes the content
101. tion host m hostname Machine that runs the SMSC As IP 100 100 100 100 or hostname their machine here port m port number Port number in the smsc host machine smsc username m string Username in the SMSC machine connection account smsc password m string Password in the SMSC machine needed to contact SMSC keepalive number SMSC connection will not be left idle for longer than this many minutes The right value to use depends on how eager the SMSC is to close idle connections 5 minutes is a good guess If you see many unexplained reconnects try lowering this value Set it to O to disable this feature sender prefix string The number that the SMSC will add in front of the sender number of all messages sent from Kannel If Kannel is asked to send a message it will remove this prefix from the sender number so that the SMSC will add it again If the prefix was not present Kannel will log a warning and will not send the sender number If sender prefix is not set or is set to never then Kannel will not send the sender number to the SMSC at all If you want Kannel to pass all sender numbers to the SMSC unchanged then just set sender prefix to the empty string 47 Chapter 5 Setting up a SMS Gateway CMG UCP EMI 4 0 Kannel supports two types of connections with CMG SMS centers direct TCP IP connections emi ip or emi2 and ISDN modem X 25 over D channel ISDN is called X 31 connection emi emi2 is a n
102. to affect which MS s can send messages to this account Doesn t seem to work though our host string Specicy the outgoing IP address for connections from a multi homed machine If this is not defined the default device of the machine will be used my number number Optional smsc short number Should be set if smsc sends a different one nquire link interval number Optional the time lapse allowed between operations after which an SMPP entity should interrogate whether it s peer still has an active session The default is 30 seconds 54 Chapter 5 Setting up a SMS Gateway Variable Value Description max pending submits number Optional the maximum number of outstanding i e acknowledged SMPP operations between an ESME and SMSC This number is not specified explicity in the SMPP Protocol Specification and will be goverened by the SMPP implementation on the SMSC As a guideline it is recommended that no more than 10 default SMPP messages are outstanding at any time reconnect delay number Optional the time between attemps to connect an ESME to an SMSC having failed to connect initating or during an SMPP session The default is 10 seconds Sema Group SMS2000 OIS 4 0 and 5 0 The 4 0 implementation is over Radio PAD X 28 Following configuration variables are needed and if you find out the more exact meaning please send a report The 5 0 implementation uses X 25 access gateway group smsc smsc sema
103. uments you will have to declare a ota id string to the different ota setting groups Table 5 11 OTA Setting Group Variables Variable Value Description group ota setting This is a mandatory variable ota id string An optional name or id for the ota setting Any string is acceptable but semicolon may cause problems so avoid it and any other special non alphabet characters 3 Variable location service ipaddress phonenumber speed bearer calltype connection pppsecurity authentication login secret A sample ota setting group group ota setting Value URL string IP phone number number string string string on or off string string location http wap company com service Our company s WAP site ipaddress 10 11 12 13 phonenumber bearer data calltype connection pppsecurity authentication login wapusr secret thepasswd Chapter 5 Setting up a SMS Gateway Description The address of the HTTP server for your WAP services i e http wap company com Description of the service IP address of your WAP gateway Phone number used to establish the PPP connection Connection speed 9600 or 14400 Defaults to 9600 Bearer type data or sms Defaults to data Call type isdn or analog Defaults to isdn Connection type cont or temp Cont uses TCP port 9201 and Temp uses UDP port 9200 Defaults to cont Enable CHAP authen
104. upport To use the client support please use the following configuration directive within the core group group core asi clientcHertkeysfila filename Now you are able to use https scheme URLs within your WML decks and SMS services Using SSL server support for the administration HTTP interface To use the SSL enabled HTTP server please use the following configuration directive within the core group group core admin port ssl true ssl server cert file filename 105 Chapter 8 Using SSL for HTTP ssl server key file filenane Using SSL server support for the sendsms HTTP interface To use the SSL enabled HTTP server please use the following configuration directive within the core and smsbox groups group core ssl server cert file filename ssl server key file filenane group smsbox sendsms port ssl true Using SSL server support for PPG HTTPS interface If you want use PAP over HTTPS it is a https scheme add following directives to the ppg core group group ppg 8090 Ssl server cert file home aarno kannelcvs gateway gw certl pem ssl server key file home aarno kannelcvs gateway gw keyl pem PPG uses a separate port for HTTPS traffic so so you must define it This means that you can use both HTTP and HTTPS when needed 106 Chapter 9 Delivery Reports This chapter explains how to set up kannel to deliver delivery reports Delivery reports are a method to tell
105. xample of a push control document which gives PPG instructions how to do the pushing lt xml version 1 0 gt lt DOCTYPE pap PUBLIC WAPFORUM DTD PAP EN http www wapforum org DTD pap 1 0 dtd pap lt push message push id 9fjeo39jf084 pi com deliver before timestamp 2001 09 28T06 45 002 deliver after timestamp 2001 02 28T06 45 002 progress notes requested false gt lt address address value WAPPUSH 358408676001 TYPE PLMN ppg carrier com gt lt address gt lt quality of service priority low delivery method unconfirmed network required true network GSM bearer required true bearer SMS gt lt quality of service gt lt push message gt lt pap gt Because the push content is sended to the phone over SMS rigth value for network required and bearer required is true for network GSM and for bearer SMS However you can omit these values alltogether if you use a phone number as an address Address value is international phone number and it must start with plus It is used here as an unique identifier SMSC or sendsms script must transform it to an usable phone number 117 Appendix C Setting up a test environment for Push Proxy Gateway Here is an example of Service Indication a type of push content Essentially the phone displays when it receives this SI the text Want to test a fetch and if the user wants fetches the content located by URL http wap iobox fi xml version 1
106. zOrK port 13015 send url http localhost 20022 Variable Value Description system type m string Type of HTTP connection kannel is only system currently supported send url m url Location to send MT messages This URL is expanded by used system if need to no sender boolean Do not add variable sender to the send url no coding boolean Do not add variable coding to the send url 63 Chapter 5 Setting up a SMS Gateway Variable Value Description no sep boolean Represent udh and text as a numeric string containing the hexdump For instance text 2b123 is represented as text 2b313233 port m port number Port number in which Kannel listens to MO messages from other gateway connect allow ip IP list IPs allowed to use this interface If not set 127 0 0 1 localhost is the only host allowed to connect smsc username string Username associated to connection if needed kannel requires this and it is the same as send sms username at other end smsc password string Password for username if needed Using multiple SMS centers If you have several SMS center connections multiple operators or a number of GSM modems you need to configure one smsc group per SMS center or GSM modem When doing this you might want to use routing systems to rout messages to specific centers for example you have 2 operator SMS centers and the other is much faster and cheaper to use To set up routing systems

Download Pdf Manuals

Related Search

Related Contents

User guide for TF5200PVRc  MANUEL D`UTILISA TION    KR21E KEY CHAIN REMOTE  Samsung VC-MB755W User Manual  VEHICLE MAINTENANCE SYSTEM USER MANUAL  CopperHead FS-790    Alcom SN100(Black) Manual_042209.cdr  [MANUAL DO UTILIZADOR]  

Copyright © All rights reserved. Failed to retrieve file