← Back to plugin index

HTTP SMS Gateway
Description
Generic SMS Gateway implementation based on a simple HTTP request.
Type name
GenericHttpSmsGateway
Class
com.airlock.iam.core.misc.impl.sms.GenericHttpSmsGateway
May be used by
SMS Service Basic mTAN Settings SMS Gateway Selection Option Number-based Selection SMS Gateway MTAN/SMS Settings Failover SMS Gateway Phone Number Verification Step SMS Notifier
Properties
HTTP Method (httpMethod)
Description
HTTP Method used for the request.
Attributes
Enum
Optional
Default value
GET
Service URI (serviceUri)
Description
URI used to send the HTTP request to.
Attributes
String
Mandatory
Message Parameter (messageParameter)
Description
Name of the parameter used to convey the SMS message.
Attributes
String
Mandatory
Example
message
Example
text
Recipient Parameter (recipientParameter)
Description
Name of the parameter used to specify the recipient.
Attributes
String
Mandatory
Example
recipient
Example
phone-number
Originator Parameter (originatorParameter)
Description
Name of the parameter used to specify the originator.
Attributes
String
Optional
Example
originator
Example
sender
Flash Parameter (flashParameter)
Description
Name and value of the parameter to add when a flash message shall be sent.
Attributes
Plugin-Link
Optional
Assignable plugins
Flash Parameter
HTTP Parameters (httpParameters)
Description
List of name-value pairs sent as parameters in the HTTP request.
Attributes
Plugin-List
Optional
Assignable plugins
Sensitive HTTP Parameter Static HTTP Parameter
Successful Response Pattern (successfulResponsePattern)
Description
Specifies the pattern that has to match part of the response body in order to assume successful transmission. Note that responses with status codes other than 2xx are always treated as failure. If no pattern is defined, every response with status code 2xx (e.g. 200, 201, 202, etc.) is assumed successful.
Attributes
RegEx
Optional
Truncate Plus Sign (truncatePlusSign)
Description
Set to true to truncate the + prefix of the recipient number.
Attributes
Boolean
Optional
Default value
false
Basic Auth Username (basicAuthUsername)
Description
The username for HTTP Basic Authentication.
Attributes
String
Optional
Basic Auth Password (basicAuthPassword)
Description
The password for HTTP Basic Authentication.
Attributes
String
Optional
Sensitive
URL Encoding for GET requests (urlEncoding)
Description
The URL-encoding to use for GET requests to append parameters to the Service URI. POST requests ignore this property and always use UTF-8.
Attributes
String
Optional
Default value
UTF-8
Suggested values
UTF-8, ISO-8859-1
Proxy Host (proxyHost)
Description
The hostname of the HTTP proxy server (if any).
Attributes
String
Optional
Example
proxy.company.com
Proxy Port (proxyPort)
Description
The port of the HTTP proxy server (if any).
Attributes
Integer
Optional
Proxy Login User (proxyLoginUser)
Description
Username for the http proxy if proxy authentication is used.
Attributes
String
Optional
Proxy Login Password (proxyLoginPassword)
Description
Password for the http proxy if proxy authentication is used.
Attributes
String
Optional
Sensitive
Allow Only Trusted Certs (allowOnlyTrustedCerts)
Description

Only allow connections to servers whose certificate is trusted. See documentation of property "Trust Store Path" for more information about what certificates are trusted.

Security warning: Trusting all certificates allows connections to adversarial hosts. Only disable this property for testing and integration setups.

Attributes
Boolean
Optional
Default value
true
Verify Server Hostname (verifyServerHostname)
Description

Enables hostname verification, i.e. the actual hostname must be the same as in the server certificate.

Security warning: Not verifying the hostname may allow connections to adversarial hosts, e.g. if they employ DNS spoofing. Only disable this property for testing and integration setups.

Attributes
Boolean
Optional
Default value
true
Trust Store Path (trustStorePath)
Description
Keystore file name containing trusted certificate issuers (and trusted certificates).

If this property is not defined the following certificate issuers are trusted:

  • The list of issuers known to the Java VM if the system property "javax.net.ssl.trustStore" is not defined.
  • The list of issuers in a keystore referenced by system property "javax.net.ssl.trustStore" if defined in instance.properties using iam.java.opts

If this property is defined then the following certificate issuers are trusted:

  • The list of issuers in the referenced truststore file and no others.

This property is only relevant if the property "Allow Only Trusted Certs" is enabled.

Attributes
File/Path
Optional
Trust Store Type (trustStoreType)
Description
Identifies the type of the keystore.
Attributes
String
Optional
Default value
JKS
Allowed values
JKS, PKCS12
Trust Store Password (trustStorePassword)
Description
The password used verify the authenticity of the trust store.

Depending on the keystore type, leaving this property empty (or undefined) has a different effect:

  • JKS: the keystore can be opened and used but the integrity of the keystore is not checked.
  • PKCS12: an error occurs.

Attributes
String
Optional
Sensitive
Connect/Read Timeout [s] (connectTimeout)
Description
The connection and read timeout in seconds.
Attributes
Integer
Optional
Default value
10
Correlation ID Header Name (correlationIdHeaderName)
Description

When configured, all requests sent contain a header with the correlation ID with the configured name. If no value or an empty value is specified, the correlation ID header is not sent.

If the correlation ID is not defined, the correlation ID header is not included in sent requests.

Attributes
String
Optional
Validation RegEx: [a-zA-Z0-9_-]+
Suggested values
X-Correlation-ID
Visible Phone Number Digits In Log (visiblePhoneNumberDigitsInLog)
Description

Defines the number of phone number digits visible in log statements.

Thus, if the value is zero, all digits are masked, if it is large enough, all digits are visible. If set to 3, for example, the logged number looks like ********965.

The default is 100, i.e. showing all digits.

Attributes
Integer
Optional
Default value
100
YAML Template (with default values) 

type: GenericHttpSmsGateway
id: GenericHttpSmsGateway-xxxxxx
displayName: 
comment: 
properties:
  allowOnlyTrustedCerts: true
  basicAuthPassword:
  basicAuthUsername:
  connectTimeout: 10
  correlationIdHeaderName:
  flashParameter:
  httpMethod: GET
  httpParameters:
  messageParameter:
  originatorParameter:
  proxyHost:
  proxyLoginPassword:
  proxyLoginUser:
  proxyPort:
  recipientParameter:
  serviceUri:
  successfulResponsePattern:
  truncatePlusSign: false
  trustStorePassword:
  trustStorePath:
  trustStoreType: JKS
  urlEncoding: UTF-8
  verifyServerHostname: true
  visiblePhoneNumberDigitsInLog: 100