StoneGate SSL VPN Technical Note 2084

Configuring SMPP

Table of Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 3 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 3 Configuring SMPP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 3 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 8 Feedback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . page 8

Table of Contents

Introduction
This technical note describes how to configure the short message peer-to-peer protocol (SMPP) for use with StoneGate SSL VPN. This technical note assumes a thorough understanding of StoneGate SSL VPN administration and SMPP Use the . further reading to gain the required knowledge.

Further Reading
More information on StoneGate SSL VPN administration can be found in the StoneGate SSL VPN Administrators Guide, the Online Help, and the Technical Note repository provided with the product. Another source of information is the Stonesoft Support site, which can be found at http://www.stonesoft.com/support/. For more information on related subjects, visit http://smsforum.net.

Overview
The short message peer-to-peer protocol (SMPP) is a telecommunications industry protocol for exchanging SMS messages between SMS peer entities such as short message service centres. It is often used to allow third parties (e.g. value-added service providers like news organizations) to submit messages, often in bulk. SMPP was originally designed by Aldiscon, a small Irish company that was later bought by Logica. In 1999, SMPP was formally handed over to the SMPP Developers Forum, later renamed as The SMS Forum. The protocol is based on pairs of request/response PDUs (protocol data units, or packets) exchanged over OSI layer 4 (TCP/IP session or X.25 SVC3) connections. PDUs are binary encoded for efficiency. The most commonly used versions of SMPP are v3.3, the most widely supported standard, and v3.4, which adds transceiver support (single connections that can send and receive messages). Data exchange may be synchronous, where each peer must wait for a response for each PDU being sent, and asynchronous, where receiving and transmitting go in independent threads with the use of buffers and timers. The latest version of SMPP is v5.0. StoneGate SSL VPN currently supports v3.4.

Configuring SMPP
The SMPP parameters are configured by adding Additional Configuration in Manage System/Notification Settings/SMS Channel. Click Add Additional Configuration for the SMS channel and insert the key name and appropriate value from the table below or as supplied by your SMS provider. Table 1 below lists relevant SMPP keys that can be used to configure your StoneGate SSL VPN setup. Table 2 on page 6 contains error codes.
TABLE 1 SMPP Keys

Key

Used at

Possible Values
51 3.3 52 3.4

Default Value

Description
This parameter is used to indicate the version of the SMPP protocol. The following interface version values are defined, 051 (0x00-0x33) Indicates that the EMSE supports version 3.3 or earlier of the SMPP protocol. 52 (0x34) Indicates that the ESME is supporting SMPP version 3.4 Timeout used when trying to communicate with SMPP server. Defined in milliseconds.

smpp-version

Bind

51

smpp-timeout

Connect

Integer

10000

Introduction

TABLE 1 SMPP Keys (Continued)

Key

Used at

Possible Values

Default Value

Description
The system_type parameter is used to categorize the type of ESME that is binding to the SMSC. Examples include VMS (voice mail system) and OTA (over-the-air activation system). Specification of the system_type is optional - some SMSCs may not require ESMEs to provide this detail. In this case, the ESME can set the system_type to NULL.

smpp-bindsystem-type

Bind

String

smpp-bindaddr-ton

Bind

0 Unknown 1 International 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 - Abbreviated 0 Unknown 1 ISDN 3 Data 4 Telex 6 Land Mobile 8 National 9 Private 10 ERMES 14 Internet 18 WAP Client Id

Indicates Type of Number of the ESME address. If not known set to Unknown.

smpp-bindaddr-npi

Bind

Numbering Plan Indicator for ESME address. If not known set to Unknown.

smpp-submitservice-type

Submit

String

The service_type parameter can be used to indicate the SMS Application service associated with the message. (NULL) Default, CMT Cellular Messaging, CPT Cellular Paging, VMN Voice Mail Notification, VMA Voice Mail Alerting, WAP Wireless Application Protocol, USSD Unstructured Supplementary Services Data

smpp-submitdest-addr-ton

Submit

0 Unknown 1 International 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 - Abbreviated

Destination Address TON. Type of Number for destination.

Configuring SMPP

TABLE 1 SMPP Keys (Continued)

Key

Used at

Possible Values
0 Unknown 1 ISDN 3 Data 4 Telex 6 Land Mobile 8 National 9 Private 10 ERMES 14 Internet 18 WAP Client Id Integer

Default Value

Description

smpp-submitdest-addr-npi

Submit

Destination Address NPI. Numbering Plan Indicator for destination.

smpp-submitesm-class

Submit

The esm_class parameter is used to indicate special message attributes associated with the short message. GSM: Set according to GSM 03.40 [GSM 03.40], ANSI-136 (TDMA): For mobile terminated messages, this field is not used and is therefore ignored by the SMSC. For ANSI-136 mobile originated messages, the SMSC should set this value to NULL. IS-95 (CDMA): For mobile terminated messages, this field is not used and is therefore ignored by the SMSC. For IS95 mobile originated messages, the SMSC should set this value to NULL.

smpp-submitprotocol-id

Submit

Integer

smpp-submitsource-addrton

Submit

0 Unknown 1 International 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 - Abbreviated 0 Unknown 1 ISDN 3 Data 4 Telex 6 Land Mobile 8 National 9 Private 10 ERMES 14 Internet 18 WAP Client Id

Source Address TON. Type of Number for source address. If not known, set to 0 (Unknown).

smpp-submitsource-addrnpi

Submit

Source Address NPI. Numbering Plan Indicator for source address. If not known, set to 0 (Unknown).

smpp-submitsource-addr

Submit

Specifies the address of SME which originated this message. An ESME which is implemented as a single SME address, may set this field to NULL to allow the SMSC to default the source address of the submitted message.

Configuring SMPP

TABLE 1 SMPP Keys (Continued)

Key

Used at

Possible Values

Default Value

Description
Encoding of data according the SMPP 3.4 specification, section 5.2.19. Example data encodings are SMSC Default Alphabet (0), IA5/ASCII (1), Octet unspecified (2), Latin 1/ ISO-8859-1 (3), Cyrllic/ISO-8859-5 (6), Latin/Hebrew/ISO8859-8 (7). Character set to use in conjunction with Data Coding when converting from Unicode to output format.

smpp-submitdata-coding

Submit

Integer

smpp-submitdata-charset

Submit

String

ISO8859-1

TABLE 2 SMPP Error Codes

Error
ESME_ROK ESME_RINVMSGLEN ESME_RINVCMDLEN ESME_RINVCMDID ESME_RINVBNDSTS ESME_RALYBND ESME_RINVPRTFLG ESME_RINVREGDLVFLG ESME_RSYSERR Reserved ESME_RINVSRCADR ESME_RINVDSTADR ESME_RINVMSGID ESME_RBINDFAIL ESME_RINVPASWD ESME_RINVSYSID Reserved ESME_RCANCELFAIL Reserved ESME_RREPLACEFAIL ESME_RMSGQFUL ESME_RINVSERTYP Reserved ESME_RINVNUMDESTS

Error Code
0x00000000 0x00000001 0x00000002 0x00000003 0x00000004 0x00000005 0x00000006 0x00000007 0x00000008 0x00000009 0x0000000A 0x0000000B 0x0000000C 0x0000000D 0x0000000E 0x0000000F 0x00000010 0x00000011 0x00000012 0x00000013 0x00000014 0x00000015 0x00000016-0x00000032 0x00000033 No Error

Description

Message Length is invalid Command Length is invalid Invalid Command ID Incorrect BIND Status for given command ESME Already in Bound State Invalid Priority Flag Invalid Registered Delivery Flag System Error Reserved Invalid Source Address Invalid Dest Addr Message ID is invalid Bind Failed Invalid Password Invalid System ID Reserved Cancel SM Failed Reserved Replace SM Failed Message Queue Full Invalid Service Type Reserved Invalid number of destinations

Configuring SMPP

TABLE 2 SMPP Error Codes (Continued)

Error
ESME_RINVDLNAME Reserved ESME_RINVDESTFLAG Reserved ESME_RINVSUBREP ESME_RINVESMCLASS ESME_RCNTSUBDL ESME_RSUBMITFAIL Reserved ESME_RINVSRCTON ESME_RINVSRCNPI ESME_RINVDSTTON ESME_RINVDSTNPI Reserved ESME_RINVSYSTYP ESME_RINVREPFLAG ESME_RINVNUMMSGS Reserved ESME_RTHROTTLED Reserved ESME_RINVSCHED ESME_RINVEXPIRY ESME_RINVDFTMSGID ESME_RX_T_APPN ESME_RX_P_APPN ESME_RX_R_APPN ESME_RQUERYFAIL Reserved ESME_RINVOPTPARSTREAM ESME_ROPTPARNOTALLWD ESME_RINVPARLEN ESME_RMISSINGOPTPARAM

Error Code
0x00000034 0x00000035-0x0000003F 0x00000040 0x00000041 0x00000042 0x00000043 0x00000044 0x00000045 0x00000046-0x00000047 0x00000048 0x00000049 0x00000050 0x00000051 0x00000052 0x00000053 0x00000054 0x00000055 0x00000056-0x00000057 0x00000058 0x00000059-0x00000060 0x00000061 0x00000062 0x00000063 0x00000064 0x00000065 0x00000066 0x00000067 0x00000068-0x000000BF 0x000000C0 0x000000C1 0x000000C2 0x000000C3

Description
Invalid Distribution List name Reserved Destination flag is invalid (submit_multi) Reserved Invalid submit with replace request (i.e. submit_sm with replace_if_present_flag set) Invalid esm_class field data Cannot Submit to Distribution List submit_sm or submit_multi failed Reserved Invalid Source address TON Invalid Source address NPI Invalid Destination address TON Invalid Destination address NPI Reserved Invalid system_type field Invalid replace_if_present flag Invalid number of messages Reserved Throttling error (ESME has exceeded allowed message limits) Reserved Invalid Scheduled Delivery Time Invalid message validity period (Expiry time) Predefined Message Invalid or Not Found ESME Receiver Temporary App Error Code ESME Receiver Permanent App Error Code ESME Receiver Reject Message Error Code query_sm request failed Reserved Error in the optional part of the PDU Body. Optional Parameter not allowed Invalid Parameter Length. Expected Optional Parameter missing

Configuring SMPP

TABLE 2 SMPP Error Codes (Continued)

Error
ESME_RINVOPTPARAMVAL Reserved ESME_RDELIVERYFAILURE ESME_RUNKNOWNERR Reserved for SMPP extension Reserved for SMSC vendor specific errors Reserved

Error Code
0x000000C4 0x000000C5-0x000000FD 0x000000FE 0x000000FF 0x00000100-0x000003FF 0x00000400-0x000004FF 0x00000500-0xFFFFFFFF

Description
Invalid Optional Parameter Value Reserved Delivery Failure (used for data_sm_resp) Unknown Error Reserved for SMPP extension Reserved for SMSC vendor specific errors Reserved

Troubleshooting
To see what packets are sent to and received from the SMPP gateway, enable debug logging (Monitor System/ Logging/Manage Global Logging Settings/Enable debug logging) and search the debug log for SMPP. When an error occurs during communication the System log may echo something like: SMPP command failed with error code 0xd. The error codes are explained in the SMPP Error Codes table above.

Feedback
Stonesoft is always interested in feedback from our users. For comments regarding Stonesofts products, contact feedback@stonesoft.com. For comments regarding this technical note, contact documentation@stonesoft.com.

Troubleshooting

Trademarks and Patents Stonesoft, the Stonesoft logo and StoneGate are all trademarks or registered trademarks of Stonesoft Corporation. Multi-link technology, multi-link VPN, and the StoneGate clustering technology-as well as other technologies included in StoneGate-are protected by patents or pending patent applications in the U.S. and other countries. All other trademarks or registered trademarks are property of their respective owners. SSL VPN Powered by PortWise Copyright and Disclaimer Copyright 20002007 Stonesoft Corporation. All rights reserved. These materials, Stonesoft products and related documentation are protected by copyright and other laws, international treaties and conventions. All rights, title and interest in the materials, Stonesoft products and related documentation shall remain with Stonesoft and its licensors. All registered or unregistered trademarks in these materials are the sole property of their respective owners. No part of this document or related Stonesoft products may be reproduced in any form, or by any means without written authorization of Stonesoft Corporation. Stonesoft provides these materials for informational purposes only. They are subject to change without notice and do not represent a commitment on the part of Stonesoft. Stonesoft assumes no liability for any errors or inaccuracies that may appear in these materials or for incompatibility between different hardware components, required BIOS settings, NIC drivers, or any NIC configuration issues. Use these materials at your own risk. Stonesoft does not warrant or endorse any third party products described herein. THESE MATERIALS ARE PROVIDED "AS-IS." STONESOFT MAKES NO WARRANTIES, EXPRESS OR IMPLIED, AS TO, THE INFORMATION CONTAINED HEREIN. IN ADDITION, STONESOFT MAKES NO EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE WITH RESPECT THE INFORMATION CONTAINED IN THESE MATERIALS. IN NO EVENT SHALL STONESOFT BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL OR INCIDENTAL DAMAGES, INCLUDING, BUT NOT LIMITED TO, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING FROM THE USE OF THESE MATERIALS, EVEN IF ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH DAMAGES. SG_SVTN_2084_20070625

Stonesoft Corp. Itlahdenkatu 22a FIN-00210 Helsinki Finland tel. +358 9 4767 11 www.stonesoft.com fax +358 9 4767 1234

Stonesoft Inc. 1050 Crown Pointe Parkway Suite 900 Atlanta, GA 30338 USA tel. +1 770 668 1125 fax +1 770 668 1131