SMS OTP

Select the connection type

In registry

1. Open Registry Editor on the Core Server.
2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP section.
3. Create the SmsSenderType parameter of the DWORD type with one of the following values:
   • 0 — Smpp
   • 1 — Megafon
   • 2 — OneGate
   • 3 — Kafka
   • 4 — MFM Solutions
   • 5 — SMS Proxy
   • 6 — Messages Proxy

In Group Policy Editor

The policy is applied to Core Servers and is intended for selecting the Sender of the SMS OTP provider.

Not Configured or Disabled — the SMPP connection is used.

Enabled — the connection through the specified provider is used.

Service Configurations SMPP

Service Configurations SMPP

In registry

1. Open Registry Editor on the Core Server.

2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP section.

3. Create the following parameters:

   • enableTls (DWORD) — the use of encryption (1 or 0)

   • srvAddr (string parameter) — the address for connecting to the server

   • srvPort (DWORD) — the port for connecting to the server

   • srvSystemId (REG_SZ) — the account name for connecting to the server

   • srvPassword (REG_SZ) — the account password for connecting to the server

   • srvSysType (REG_SZ) — the PDU field of the BIND_TRANSCEIVER operation of the SMPP protocol

   • senderName (REG_SZ) — the sender name that is displayed when the SMS is received

   • messageOTP (REG_MULTI_SZ) — an arbitrary message text preceding the one-time password. By default, only the OTP is sent; for additional configuration, use the following parameters:

     • <app> — the name of the application that sent the authorization request

     • <requestLocalServerTime> — the local server time when the request was received

     • <requestComputerDns> — the DNS name of the computer that sent the request

     • <requestComputerIp> — the IP address of the computer that sent the request

   • SMPPServerTimeoutSec (DWORD) — the waiting time for receiving the status of the sent SMS from the server

   • MessageStatusPDU (DWORD) — the PDU in which the server sends the status of the sent message. 0 — SUBMIT_SM_RESP; 1 — DELIVER_SM

   • BindTransmitter (DWORD). 1 — Transmitter — sending the BIND_TRANSMITTER packet at connection; 0 — Transceiver — sending the BIND_TRANSCEIVER packet at connection. When connecting as Transmitter, the server sends the status of the sent SMS message only in the SUBMIT_SM_RESP packet

   • sourceAddrTon (DWORD) — the Type of Number for the source address

   • sourceAddrNpi (DWORD) — the Numbering Plan Indicator for the source address

   • destAddrTon (DWORD) — the Type of Number for the destination

   • destAddrNpi (DWORD) — the Numbering Plan Indicator for the destination

   • esmClass — specifies the Message Mode & Message Type

   • registeredDelivery — the indicator specifying that an SMS delivery receipt or an SME acknowledgement is requested

   • dataCoding — defines the encoding scheme of the short message user data

In Group Policy Editor

The policy is applied to Core Servers and defines the following settings for the SMPP service:

• Use tls — the use of encryption

• URL (IP address) — the address for connecting to the server

• Port — the port for connecting to the server

• SystemId (Login) — the account name for connecting to the server

• Password — the account password for connecting to the server

• SystemType — the PDU field of the BIND_TRANSCEIVER operation of the SMPP protocol

• Sender — the sender name that is displayed when the SMS is received

• Additional text before the OTP — an arbitrary message text preceding the one-time password. By default, only the OTP is sent; for additional configuration, use the following parameters:

  • <app> — the name of the application that sent the authorization request

  • <requestLocalServerTime> — the local server time when the request was received

  • <requestComputerDns> — the DNS name of the computer that sent the request

  • <requestComputerIp> — the IP address of the computer that sent the request

    Important

    The display of the OTP code is not configurable; the OTP is always displayed at the end of the message.

    To add line breaks to the message being sent, you must modify the registry at HKLM/SOFTWARE/Policies/Axidian-ID/BSPs/SMSOTP. Change the value of the old messageOTP parameter of the REG_SZ type to messageOTP of the REG_MULTI_SZ type.

• SMS status waiting time — the waiting time for receiving the status of the sent SMS from the server

• PDU with the SMS status — the PDU in which the server sends the status of the sent message

• Connect as:

  • Transmitter — sending the BIND_TRANSMITTER packet at connection

  • Transceiver — sending the BIND_TRANSCEIVER packet at connection

    When connecting as Transmitter, the server sends the status of the sent SMS message only in the SUBMIT_SM_RESP packet.

• source_addr_ton — the Type of Number for the source address

• source_addr_npi — the Numbering Plan Indicator for the source address

• dest_addr_ton — the Type of Number for the destination

• dest_addr_npi — the Numbering Plan Indicator for the destination

• esm_class — specifies the Message Mode & Message Type

• registered_delivery — the indicator specifying that an SMS delivery receipt or an SME acknowledgement is requested

• data_coding — defines the encoding scheme of the short message user data

Backup SMPP service settings

Backup SMPP service settings

In the SMPP service settings (backup) policy, you can configure the backup SMPP service through which SMS messages are sent if the main service is unavailable.

When sending an SMS, Core Server checks the availability of the main SMPP service. If the main service is available, the SMS is sent through the main gateway. If the main service is unavailable, the SMS is sent through the backup gateway.

The service is considered unavailable if Core Server receives the following errors:

• SMS sending service address unavailable
• SMPP Error Bind
• SMPP Error SubmitS

The backup SMPP service policy is configured in the same way as the main SMPP service.

If a backup service is configured, the switch to it when the main service is unavailable occurs automatically.

Service Configurations Megafon

Service Configurations Megafon

In registry

1. Open Registry Editor on the Core Server.
2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP\Megafon section.
3. Create the following parameters:
   • ServerUrl (REG_SZ) — the address for connecting to the server
   • Login (REG_SZ) — the account name for connecting to the server
   • Password (REG_SZ) — the account password for connecting to the server
   • From (REG_SZ) — the sender name that is displayed when the SMS is received
   • messageOTP (REG_SZ) — an arbitrary message text preceding the one-time password

In Group Policy Editor

The policy is applied to Core Servers and defines the settings for Megafon, an SMS sending service:

• URL — the address for connecting to the server
• Login — the account name for connecting to the server
• Password — the account password for connecting to the server
• Sender — the sender name that is displayed when the SMS is received
• Additional text before the OTP — an arbitrary message text preceding the one-time password

Service Configurations OneGate

Service Configurations OneGate

In registry

1. Open Registry Editor on the Core Server.
2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP\OneGate section.
3. Create the following parameters:
   • ServerUrl (REG_SZ) — the address for connecting to the server
   • Login (REG_SZ) — the account name for connecting to the server
   • Password (REG_SZ) — the account password for connecting to the server
   • NameSender (REG_SZ) — displayed as the sender name on the recipient device
   • NameSystem (REG_SZ) — the combination of Sender system name and Sender name defines the login used to address the separator
   • messageOTP (REG_SZ) — an arbitrary message text preceding the one-time password

In Group Policy Editor

The policy is applied to Core Servers and defines the settings for OneGate, an SMS sending service:

• URL — the address for connecting to the server
• Login — the account name for connecting to the server
• Password — the account password for connecting to the server
• Sender name — displayed as the sender name on the recipient device
• Sender system name — the combination of Sender system name and Sender name defines the login used to address the separator
• Additional text before the OTP — an arbitrary message text preceding the one-time password

Service Configurations MFMSolution

Service Configurations MFMSolution

In registry

1. Open Registry Editor on the Core Server.
2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP\MFM section.
3. Create the following parameters:
   • ServerUrl (REG_SZ) — the address for connecting to the server
   • Login (REG_SZ) — the account name for connecting to the server
   • Password (REG_SZ) — the account password for connecting to the server
   • From (REG_SZ) — displayed as the sender name on the recipient device
   • MessageOTP (REG_SZ) — an arbitrary message text preceding the one-time password

In Group Policy Editor

The policy is applied to Core Servers and defines the settings for MFMSolution, an SMS sending service:

• URL — the address for connecting to the server
• Login — the account name for connecting to the server
• Password — the account password for connecting to the server
• Sender name — displayed as the sender name on the recipient device
• Additional text before the OTP — an arbitrary message text preceding the one-time password

Apache Kafka service settings

Apache Kafka service settings

In registry

1. Open Registry Editor on the Core Server.

2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP section.

3. Create the following parameters:

   • SmsSenderType (DWORD) — the SMS sender type (for Apache Kafka, set the value 3)
   • ParsePhone (DWORD) — enables phone number parsing
   • PhonePrefix (REG_SZ) — the phone number prefix (if you have enabled phone number parsing)
   • PhoneLength (DWORD) — the phone number length (if you have enabled phone number parsing)

4. In the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP\Kafka section, create the following parameters:

   • messageOTP (REG_SZ) — an arbitrary message text preceding the one-time password
   • MessageFormatPath (REG_SZ) — the path to the json file with the message format
   • MessageDateFormat (REG_SZ) — the date format in the message fields
   • ServerUrl (REG_SZ) — the Apache Kafka server address
   • MessageTimeoutSec (REG_DWORD) — the local message waiting time. This value is applied only locally and limits the time during which the message being created waits for successful delivery. If you specify the value 0 sec, the waiting time is infinite
   • TopicName (REG_SZ) — the name of the Apache Kafka topic the messages are published to
   • UseSerialization (REG_DWORD) — enables or disables serialization
   • SchemaRegistryUrl — the address for connecting to the Schema Registry
   • RecordSchemaPath (REG_SZ) — the path to the json file with the serialization schema

   If you use authorization in Apache Kafka, add the following parameters:

   • SecurityProtocol (REG_SZ) — the protocol used for communication with brokers
   • SaslMechanism (REG_SZ) — the SASL mechanism for authentication

In Group Policy Editor

The policy is applied to Core Servers and defines the settings for Apache Kafka, an SMS sending service:

• URL — the address for connecting to the server
• Server timeout — the local message waiting time. This value is applied only locally and limits the time during which the message being created waits for successful delivery. If you specify the value 0 sec, the waiting time is infinite
• Enable message serialization — the flag enables or disables message serialization
• Schema registry URL — the address for connecting to the Schema Registry
• Path to the serialization schema — the path to the json file with the serialization schema
• Security protocol — the protocol used for communication with brokers
• SASL mechanism — the SASL mechanism for authentication
• Topic name — the name of the topic the messages are published to
• Message date format — the date format in the message fields
• Additional text before the OTP — an arbitrary message text preceding the one-time password
• Path to the message format — the path to the json file with the message format

SMS Proxy settings

SMS Proxy settings

In registry

1. Open Registry Editor on the Core Server.
2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP\SMSProxy section.
3. Create the following parameters:
   • ServerUrl — the address for connecting to SMS Proxy
   • From (REG_SZ) — the sender name that is displayed when the message is received
   • messageOTP (REG_SZ) — an arbitrary message text preceding the one-time password
   • ClientCertificateThumbprint (REG_SZ) — defines the certificate that is added to the client certificate list when requesting SMS Proxy (the certificate itself must be located in the LocalMachine/LocalComputer certificate store and meet the SMS Proxy requirements)
   • ServerCertificateThumbprint (REG_SZ) — defines the server certificate that is recognized as valid

In Group Policy Editor

The policy is applied to Core Servers:

• URL — the address for connecting to SMS Proxy
• Sender — the sender name that is displayed when the SMS is received
• Additional text before sending the OTP — an arbitrary message text preceding the one-time password
• Client certificate thumbprint — defines the certificate that is added to the client certificate list when requesting SMS Proxy (the certificate itself must be located in the LocalMachine/LocalComputer certificate store and meet the SMS Proxy requirements)
• Server certificate thumbprint — defines the server certificate that is recognized as valid

Messages Proxy settings

Messages Proxy settings

In registry

1. Open Registry Editor on the Core Server.
2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP\MessagesProxy section.
3. Create the following parameters:

• ServerUrl — the address for connecting to the server
• From (REG_SZ) — the sender name that is displayed when the message is received
• messageOTP (REG_SZ) — an arbitrary message text preceding the one-time password
• ClientCertificateThumbprint (REG_SZ) — defines the certificate that is added to the client certificate list when requesting Messages Proxy (the certificate itself must be located in the LocalMachine/LocalComputer certificate store and meet the Messages Proxy requirements)
• ServerCertificateThumbprint (REG_SZ) — defines the server certificate that is recognized as valid

In Group Policy Editor

The policy is applied to Core Servers:

• URL — the address for connecting to the server
• Sender — the sender name that is displayed when the message is received
• Additional text before sending the OTP — an arbitrary message text preceding the one-time password
• Client certificate thumbprint — defines the certificate that is added to the client certificate list when requesting Messages Proxy (the certificate itself must be located in the LocalMachine/LocalComputer certificate store and meet the Messages Proxy requirements)
• Server certificate thumbprint — defines the server certificate that is recognized as valid

Message format settings

In registry

1. Open Registry Editor on the Core Server.
2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP section.
3. Create the following parameters:
   • SMSOTP (DWORD) with the value 1
   • dateFormat (REG_SZ) — allows you to set the date display format. You can find format examples in the Microsoft article

In Group Policy Editor

The policy allows you to set the date display format. You can find format examples in the Microsoft article.

Enabled — the date is displayed according to the format specified in the policy.

One-time password settings

In registry

1. Open Registry Editor on the Core Server.
2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP section.
3. Create the following parameters:
   • OTPGeerator (DWORD) — enables this setting
   • OneTimePasswordLength (DWORD) — the one-time password length
   • AllowDigitsChGr (DWORD) — use digits in the OTP
   • AllowLatinsLowerChGr (DWORD) — use lowercase Latin letters in the OTP
   • AllowLatinsUpperChGr (DWORD) — use uppercase Latin letters in the OTP
   • AllowSpecialChGr (DWORD) — use special characters in the OTP

In Group Policy Editor

The policy is applied to Core Servers and allows you to set the length and the character group occurrence when generating the one-time password.

• Not Configured — the one-time password consists of digits and lowercase Latin letters and is 6 characters long.
• Enabled — the one-time password is generated according to the rules specified in the policy. The password length must be at least 4 and no more than 24 characters.
• Disabled — the one-time password consists of digits and lowercase Latin letters and is 6 characters long.

Phone number format settings

In registry

1. Open Registry Editor on the Core Server.
2. Open the HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Axidian-ID\BSPs\SMSOTP section.
3. Create the following parameters:
   • ParsePhone (DWORD) — enables phone number parsing
   • PhoneLength (DWORD) — the phone number length
   • PhonePrefix (string parameter) — the phone number prefix

In Group Policy Editor

The policy is applied to Core Servers and allows you to configure the phone number format. Enabling this policy enables phone number normalization. This means the following:

• Spaces, tabs, brackets, and hyphens are removed.
• If several numbers are written in the string and separated by a comma or a semicolon, the first number in the string up to the separator is taken.
• 8 is replaced with +7.
• If +7 or 8 is missing at the beginning of the string, +7 is added before the number.
• If the letter O is specified in the number instead of the digit 0, it is replaced back with the digit.

Note

Due to the REST request format requirements, the phone number for Megafon must be of the long type. The + sign is not taken into account during normalization.

Concurrent connection to the SMPP server settings

The policy is applied to Core Servers and defines the processing order of requests to the SMPP server. Enabling the policy may be necessary if the SMPP server does not support several simultaneous connections from one user (the account specified in the SMPP service settings policy).

Not Configured or Disabled — the connection to the SMPP server and the message sending requests are performed in parallel.

Enabled — the connection to the SMPP server and the message sending requests are performed sequentially.