← Back to plugin index

Swissphone SMS Gateway
Description
SMS gateway implementation used to send SMS messages over the highly secured Swissphone IMASYS XML gateway.

The URL configured in this plugin (Portal List Distribution URL) is called to get a list of available gateways.

Type name
SwissphoneSmsGateway
Class
com.airlock.iam.core.misc.impl.sms.SwissphoneSmsGateway
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
Portal List Distribution URL (portalListDistributionUrl)
Description
URL of the portal list distribution host. This server provides a constantly updated list of ISPortals, i.e. the message gateways used to submit SMS messages.
Attributes
String
Mandatory
Suggested values
https://imasys1.swissphone-gateway.com/IS/GetPortalList.aspx
Portal List Distribution Port (portalListDistributionPort)
Description
The port of the portal list distribution server.
Attributes
Integer
Optional
Default value
443
Username (username)
Description
Username used to access the IMASYS XML gateway functions.
Attributes
String
Mandatory
Example
user1234
Password (password)
Description
Password used to accesss to IMASYS XML gateway functions.
Attributes
String
Mandatory
Sensitive
Long Sms Option Enabled (longSmsOptionEnabled)
Description
Long SMS option is enabled.
Attributes
Boolean
Optional
Default value
false
Priority (priority)
Description
The priority of the message.
Attributes
Enum
Optional
Default value
high
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: SwissphoneSmsGateway
id: SwissphoneSmsGateway-xxxxxx
displayName: 
comment: 
properties:
  allowOnlyTrustedCerts: true
  connectTimeout: 10
  correlationIdHeaderName:
  longSmsOptionEnabled: false
  password:
  portalListDistributionPort: 443
  portalListDistributionUrl:
  priority: high
  proxyHost:
  proxyLoginPassword:
  proxyLoginUser:
  proxyPort:
  trustStorePassword:
  trustStorePath:
  trustStoreType: JKS
  username:
  verifyServerHostname: true
  visiblePhoneNumberDigitsInLog: 100