Transport Configuration
From Swivel Knowledgebase Wiki
Contents |
Overview
A transport is a method of delivering security strings and other information to users. The type of transport to be used is configurable. Transports are defined by a users group membership from the Repository/Groups menu. A user should only belong to one group. A group may be made up of several repositories, each with differing data sources and data fields, for information on configuring these see Transport_Attribute.
Users can send security strings by dual channel, single channel and mobile phone client, and one dual channel transport for alerts. PINsafe can work with multiple delivery mechanisms for the Security Strings and Alert Messages.
Graphical Single Channel Image see Single Channel How To Guide and Taskbar How to Guide
Mobile Phone Client see the Mobile Phone Client guide
Dual Channel, can be one of SMS, SMTP, see the below guide
Prerequisites
PINsafe 3.x configured with a data store.
Transport Types
Some of the transport types are not listed, but are contained within the PINsafe code if the java class name is known. Specific custom solutions have also been developed but are not listed below.
| ADPTransport.class | ADP |
| AlertsOnlineTransport.class | Alerts Online |
| AqlTransport.class | AQL |
| AqlVoiceTransport.class | AQL |
| ArrayTransport.class | Array |
| AspiroTransport.class | Aspiro |
| AvivaTransport.class | Aviva |
| BTSMSTransport.class | BT |
| CarrefourTransport.class | Carrefour |
| ClickatellTransport.class | Clickatell |
| GsmTransport.class | GSM Modem |
| InpocTransport.class | Inpoc |
| ITaggTransport.class | Itagg |
| KapowTransport.class | Kapow |
| KPNTransport2.class | KPN |
| MacrokioskTransport.class | Macrokiosk |
| MBloxTransport.class | Mblox |
| MobillionTransport.class | Mobillion |
| MollieTransport.class | Mollie |
| MoretextTransport.class | Moretext |
| MovensisTransport.class | Movensis |
| NHSMailTransport.class | NHSMail |
| PSWinTransport.class | PSWIN |
| SixtTransport.class | Sixt |
| SmileTransport.class | Smile |
| SMPPTransport.class | SMPP |
| SmsSubjectTransport.class | SMS |
| SmtpHtmlGateway.class | SMTP HTML to SMS |
| SmtpSmsGateway.class | SMTP to SMS |
| SmtpTransport.class | SMTP |
| txtToolsTransport.class | TXT Tools |
| ValueFirstTransport.class | Value First |
| VodafoneBulkTransport.class | Vodafone |
| VoiceSageTransport.class | VoiceSage |
| WinTransport.class | WIN |
Additional transport classes may be written either by system integrators or by Swivel Secure. Contact Swivel if an integration is required. An API is available for those wishing to write their own transport class. For further information and location of transports see below under Custom Transports.
Note: When upgrading or moving a PINsafe server, remember to include any custom transport classes.
Using a Transport Class
The transport class, without the .class extension is added to the end of: com.swiveltechnologies.pinsafe.server.transport.transport_name
Example: com.swiveltechnologies.pinsafe.server.transport.SmtpTransport
This is added to the required Class on the transport
Transport values
Transport General Settings
Identifier:
A name for the Transport, this will appear in the PINsafe Management Console under Transport, and will allow the transport to be configured. This can be up to 32 characters.
Class:
The java class that this transport uses
Strings per message:
Number of security strings per message. From version 3.6 this uses a referrer to make tracking of security strings possible so that the login can tell the user which security string to use.
Destination attribute:
The attribute that is read from the data source, see Transport_Attribute.
Strings Repository Group: previously called Group
Security strings are sent here, and is the group of users that will use this Transport
Alert repository group:
The group of users that will use this Transport for alert information, such as PIN number, account lockout notification, Pin change notification.
Copy security strings to Alert:
This allows a copy of each dual channel security string to be sent to the users alert transport.
Transport Formatting
The text in the transports can be configured as required. There are a number of variables that can be used within the transport. PINsafe 3.6 onwards also supports the use of HTML see below.
:%CR Carriage Return (a new line)
%LF Line Feed (a new line)
%NAME The username
%PIN The PIN number
%PASSWORD PINsafe password where used
%NUMBER Number of the security string sent out
%STRING The Security String
%DAYS Number of days, used for PIN expiry
%TIME The time which a PIN was changed
%DATE The fate which a PIN was changed or warning for inactive accounts
%CODE A code used for reset PIN
%KEY Device Key for PositiveID
HTML in Transports
PINsafe 3.6 allows HTML to be used in the transports. Use the appropriate <a ...> tags.
Transport Settings
These vary according to the transport type, some are given below for clarification
One Time Code message subject is for on-demand messages.
Security String message subject is for normal security strings.
Creating multiple transports of the same type/Creating New Transports
Multiple transports that use the same transport method can be created by creating a new Identifier (Name) for the transport. Creating multiple transports allows groups of users to have:
- Different numbers of security strings
- The same transport types for multiple groups
- Differing transport text or language for different groups of users
Copy the required transport class and remember to set the destination attribute.
The below example shows an second SMTP transport created with the Identifier of SMTP2, the class has been copied from the original version of the SMTP transport
Custom Transports
Transports can be created and uploaded to the PINsafe server. The locations for uploading the classes is different for PINsafe 3.5 and earlier systems see Java_Class. WinSCP is a useful too for copying files, see WinSCP How To Guide.
PINsafe 3.5 and earlier
<Path to Tomcat>webapps/pinsafe/WEB-INF/classes/com/swiveltechnologies/pinsafe/transport
PINsafe 3.6, 3.7, 3.8 onwards
<Path to Tomcat>webapps/pinsafe/WEB-INF/classes/com/swiveltechnologies/pinsafe/server/transport
When uploading custom transports to the PINsafe server ensure the file ownerships are correct. For the PINsafe appliance go to to the folder of the uploaded transport and ensure they are correct, to change them use the following command:
chown swivel:swivel *.class
A guide for creating custom transports is available from Swivel Secure Support.
SMTP to SMS
Email with Phone number in email address Mobile_number@domain_name.com use the SmtpSmsGateway
Email with the phone number in the email subject use the SmsSubjectTransport
Additional Configuration options are:
SMTP Server: The SMTP gateway
Domain: the domain is appended to the email address such as Mobile_number@domain_name
SMTP From: Email from address
Username: Username of the SMS account
Password Password of the SMS account
Domain SMS account domain
Subject Email Subject, for the SmsSubjectTransport this is ignored
SMS Additional Options
Message Overwrite or Replace previous message is supported by some SMS providers.
Flash SMS is also supported by some SMS providers.
Troubleshooting
If the transport is not correctly formatted
- check the transport text for errors
- For SMS gateways, check the service provider does not reformat or ignore certain parameters or apply filters
Additional information on PINsafe Transport:
Removing messages from the message queue, see: Message Queue Removal
Resolving Security String Issues
SMS messages are not being sent
Security Strings are not being sent
User does not have an associated alert transport
Security String missing place holder 1234567890
Turn off Replace Message or Message Overwrite or Flash SMS and test to see if transport functions
Error Messages
Loading transport class "com.swiveltechnologies.pinsafe.server.transport.TransportName" failed, error: java.lang.ClassNotFoundException: com.swiveltechnologies.pinsafe.server.transport.TransportName
The java class cannot be found. Possible causes of this error are:
Misspelling of the class name on the transport->general screen
Class file not being in the correct location on the appliance
Class file not having the correct ownership or file permissions
Tomcat has not been restarted
