MDC Configuration for provider MessageBird on IDENTIKEY Server 3.5. Creation date: 07/02/2014 Last Review: 7/02/2014 Revision number: 1

Transcription

1 KB MDC Configuration for provider MessageBird on IDENTIKEY Server 3.5. Creation date: 07/02/2014 Last Review: 7/02/2014 Revision number: 1 Document type: How To Security status: EXTERNAL Summary This document describes how to configure the Message Delivery Component (MDC) for SMS gateway provider MessageBird and contains a sample MDC configuration file for that provider. The configuration as presented in this document is compliant with IDENTIKEY Authentication Server (IAS) 3.5 and the SMS gateway provider MessageBird. Details. One type of DIGIPASS is the Virtual DIGIPASS. A Virtual DIGIPASS can use an SMS to deliver a One Time Password (OTP) to a User s mobile phone. The User then authenticates against IDENTIKEY Authentication Server using this Virtual OTP. There are 2 kinds of VIRTUAL DIGIPASS: The Primary and Backup VIRTUAL DIGIPASS. Both require a configured MDC component. The MDC component requires an SMS Gateway to deliver the OTP to a mobile phone. MessageBird is such an SMS Gateway provider: Start the MDC configuration via Start Programs Vasco IDENTIKEY Authentication Server MDC Configuration Utility. Open the SMS Delivery tab to configure the MDC for SMS delivery. There are two possible ways to configure the MDC for MessageBird: 1. Manually 2. Import the parameters from an MDC configuration file 1. Manually Configure MDC Settings. Press the Button Add HTTP Gateway, and add a display name. Page 1 of 6

2 Use the following parameters in the Connection Settings: o URL: o Port: 80 OR o URL: o Port: 443 In the SMS Gateway Account Settings, enter the User Name and Password that you chose during signup with MessageBird Page 2 of 6

3 Select the Query and Result tab and use the Query String below: username=[acc_user]&password=[acc_pwd]&destination=[otp_dest]& body=[otp_msg]&sender=otp IDENTIKEY Authentication Server Parameters: acc_user The user of the SMS gateway account. (Entered on the Gateway Settings TAB) acc_pwd Password for the SMS Gateway account ((Entered on the Gateway Settings TAB) otp_dest the mobile phone number when using AD integration = Mobile number of the AD useraccount when using an ODBC database = the Mobile number configured in the IDENTIKEY User properties otp_msg the OTP sent as a message (this value is generated by IDENTIKEY) Form Method can be POST or GET; MessageBird supports both. PS: Message Bird expects the Mobile number in MSISDN numerical format. This is the International format without + or without 00 e.g. if your mobile number in Belgium is ; the MSISDN numerical format is Add matching rules for success and failure returncodes from the SMS provider. It is important to define a success rule. Only when a returncode from the SMS provider is received that matches a success rule; the IAS will consider the Virtual OTP delivery as successful. In the example below; the success matching rule for MessageBird is shown. Also define the matching failure rules that are applicable for you. The returncodes from MessageBird are documented here: Page 3 of 6

4 2. MDC Configuration by importing a configuration File This configuration file, in XML format, contains all the settings as described above. The file can be imported in the MDC through the Import button in the Gateway Settings tab of the MDC configuration Tool. To create the XML file, select the text on the next pages, copy and paste it in a text editor (e.g.notepad) and save the file as MessageBird.mdc. Once you have imported the XML file; change the user name and the password in the SMS Gateway Account Settings section. Warning The configuration file is UTF8 encoded. Non-UTF8 encoded characters should not be added to the configuration file, or it will not load. For more information about UTF8 please visit In general is it not recommended to edit the XML file. Sample MDC file for SMS provider MessageBird <?xml version="1.0"?> <VASCO> <SMS-Servers> <ServerList> <HTTPServer0> <ProfileName type="string" data=""/> <Description type="string" data="messagebird"/> Page 4 of 6

5 <Enabled type="bool" data="true"/> <Backup type="bool" data="false"/> <URL type="string" data="api.messagebird.com/api/sms"/> <Protocol type="string" data="http"/> <Username type="string" data="xxxxxxx"/> <Password type="string" data="avzjoodzbssf"/> <Port type="unsigned" data="80"/> <PoolSize type="unsigned" data="10"/> <Timeout type="unsigned" data="5"/> <Priority type="unsigned" data="1"/> <Weight type="unsigned" data="1"/> <SSL> <CertFile type="string" data="c:\program Files\VASCO\Identikey 3.5\bin\curl-ca-bundle.crt"/> </SSL> <HTTPQuery type="string" data="username=[acc_user]&password=[acc_pwd]&destination=[otp_dest]&body=[otp_msg]&sender=otp"/> <HTTPMethod type="string" data="get"/> <Results> <Result0> <Name type="string" data="success"/> <Pagematch type="string" data="01"/> <MsgType type="unsigned" data="0"/> <Message type="string" data="message delivered to SMS Gateway for [otp_dest] (Code 01)"/> </Result0> <Result1> <Name type="string" data="message not allowed"/> <Pagematch type="string" data="69"/> <Message type="string" data="message cannot be planned for this date (errorcode 69)"/> </Result1> <Result2> <Name type="string" data="wrong timestamp"/> <Pagematch type="string" data="70"/> <Message type="string" data="an incorrect timestamp notation has been used (code 70)"/> </Result2> <Result3> <Name type="string" data="timestamp in the past"/> <Pagematch type="string" data="71"/> <Message type="string" data="timestamp is in the past (code 71)"/> </Result3> <Result4> <Name type="string" data="long message"/> <Pagematch type="string" data="72"/> <Message type="string" data="message is too long (code 72)"/> </Result4> <Result5> <Name type="string" data="invalid sender"/> <Pagematch type="string" data="89"/> <Message type="string" data="invalid sender of the message (code 89)"/> </Result5> <Result6> <Name type="string" data="incorrect destination"/> <Pagematch type="string" data="93"/> <Message type="string" data="1 or more correct destinations for the SMS (code 93)"/> </Result6> <Result7> <Name type="string" data="missing message"/> <Pagematch type="string" data="95"/> <Message type="string" data="no message or empty message received (code 95)"/> </Result7> <Result8> <Name type="string" data="no credits"/> <Pagematch type="string" data="96"/> <Message type="string" data="unsufficient credits to send the SMS (code 96)"/> </Result8> <Result9> <Name type="string" data="account problem"/> <Pagematch type="string" data="97"/> <Message type="string" data="incorrect username/password (code 97)"/> </Result9> <Result10> <Name type="string" data="incorrect IP"/> <Pagematch type="string" data="98"/> <Message type="string" data="ip address not allowed with your account"/> </Result10> <Result11> <Name type="string" data="connection problem"/> <Pagematch type="string" data="99"/> Page 5 of 6

6 <Message type="string" data="cannot connect with server (Code 99)"/> </Result11> </Results> </HTTPServer0> </ServerList> </SMS-Servers> </VASCO> Page 6 of 6