> On-Premise Platform
The Protectimus On-Premise Two-Factor Authentication Platform can be installed on your private servers or in your private cloud.
To ensure uninterrupted operation of your multi-factor authentication server, deploy it to a cluster of several servers (we recommend using at least three nodes). Use a load balancer to distribute the load among them.
- Private server installation requirements: Java (JDK version 8); PostgreSQL DBMS, version 10 or later.
- Private cloud installation requirements: CPU: 2 cores, memory: 8 GB; OS: Linux; cloud disk: 100 GB; load balancer.
To install the Protectimus On-Premise Platform, you can use the installer for Windows or create a Docker Image.
1. Protectimus Platform Installation Using a Docker Image
- To start installing the Protectimus On-Premise Platform, first of all, download and install docker and docker-compose:
- Docker: https://docs.docker.com/engine/install/
- Docker-compose: https://docs.docker.com/compose/install/
- Then clone the git repository: https://github.com/protectimus/platform-linux.git
- Go to the platform-linux/platform directory and run:
docker-compose up -d
- You can monitor the process of platform deployment using the command:
docker-compose logs -f
- After the deployment process is complete, the platform will be available at: https://localhost:8443
2. Protectimus Platform Installation on Windows
- Download and run the Protectimus Platform installer. Check the Platform box and click Next.
If you are going to use DSPA or RADIUS integrations, and/or OTP delivery via chat-bots in messaging apps Telegram, Facebook Messenger, or Viber, also check the appropriate boxes.
- Before deploying the Protectimus Platform, Java must be installed on your server. Click the Install button to check for Java. If it’s not installed yet, the latest JDK version will be installed automatically.
- Also, database management system PostgreSQL (version 9.2 and above) must be installed on your server. Click the Install button to check for PostgreSQL. If it’s not installed yet, the latest PostgreSQL version will be installed automatically.
ATTENTION: You will need to set a superuser name and password during installation. You’ll need this password to login to PostgreSQL later.
Please, remember your superuser name (postgres) and the password you’ll add on this step. This name and password will be required to login to PostgreSQL later.
- Login to PostgreSQL Database. Enter the superuser name and password you specified during the PostgreSQL installation and click LogIn. Then click Next to continue the installation.
- Create and Select the database you will use for Protectimus On-Premise Platform.
- Create a new database. Enter the desired database name and click Create.
- Check whether it is created or not using the button List.
- Click the Select button, choose the database you’ve just created, and click Next.
- Initiate the database. Click Init to execute SQL scripts and initiate your database. This may take some time.
- Select the folder to install the Protectimus Platform and click Install.
3. How to Pay and Activate the LicenseAfter testing the Protectimus Platform successfully, you’ll need to get a license. To do so, go to http://platform_path/licensing, select the option you require and get the license key.
Using the key you received, you can pay for and download your license online. To do so:
- Go to https://service.protectimus.com/en/platform and click Purchase License.
- Enter your license key into the Licensing Key field and click Submit.
- On the next step, click on the Pay button.
- Choose a payment method. If you require an alternate payment method, contact Protectimus customer support.
- After successful payment click on the Issue Platform License button.
You can also do this on the page https://service.protectimus.com/en/platform by clicking the Issue License button.
- Enter the key into the Licensing Key field and click Submit. After that, the license file will be downloaded.
- After receiving the license file, download it to the server and provide the path to the license file in the licence.file.path parameter, in the file named protectimus.platform.properties.
4. How to Get Registered in Protectimus SystemThe installer will automatically open the registration form at http://localhost:8080.
Please, create an account and log in to configure the necessary settings.
5. How to Enable Users Synchronization With Your User Directory
- Login to your Protectimus account, and click: Users – Synchronization – Add LDAP user provider
- Fill in the details about your user directory.
|Urls||URL to connect to your LDAP server|| Example: ldaps://dc1.domain.local:636
For DSPA, you need to use the LDAP connection, and you also need to import the SSL certificate.A standard way:
|Base DN||Full DN of the directory in which your users are stored|| Example:
|User DN||DN or userPrincipalName of the administrator or user who has access to user information|| Example:
For DSPA, the user must have rights to change passwords
|Password||The password of the specified user|
|Filter||A filter to be applied during synchronization|| Use this filter to select only the users you want to synchronize
To import users from a specific group
To import only those users who have the mail attribute specified
- After successfully adding the user provider, you need to synchronize the users in Protectimus system with your user directory. This can be done in three ways:
- Using the ‘Synchronize now’ button to synchronize all the users at once.
- Using the “synchronize individuals” feature to synchronize only the selected users from your user directory.
- Enabling automatic user synchronization, to do this activate the “Enabled” option at the top of the page.
6. How to Configure SSL Certificate, Mail and SMS Tokens, and Specify the Path to the License FileOnce you’ve successfully installed the platform, it will generate a configuration file named protectimus.platform.properties. The protectimus.platform.properties file must be located in the same directory as the executable.
This file allows you to customize the following settings:
- Add SSL certificate for the Protectimus Platform. Different SSL certificate formats are supported, including .pkcs12, .pem, .der, .pfx.
- Configure delivery of messages via email;
- Configure SMPP server connection to add your SMS provider to deliver one-time passwords via SMS.
- Specify the path to the license file. Please note that the path to the license file should be indicated with double backslashes
Available properties that you can add to the protectimus.platform.properties file include:
6.1. SSL Certificate Configuration
|PROPERTY NAME||PROTERTY STANDS FOR|
||Port on which your application listens for HTTPS requests. Typically, platform uses port 8443 by default.|
|Type of keystore used to store SSL certificates and private keys. Types: JKS, PKCS12.|
|Password required to access the keystore.|
|Full path to the keystore file containing SSL certificates and private keys.
Please note that the keystore file should be located in the ..\\Protectimus\\Platform folder, in the same place as the .war and .properties files. The path should be indicated with double backslashes, for example C:\\Program Files\\Protectimus\\Platform\\keystore.jks.
https.port = 8443 https.keystore.type = JKS https.keystore.password = ********** https.keystore = C:\\Program Files\\Protectimus\\Platform\\keystore.jks
6.2. Email Message Delivery Configuration
|PROPERTY NAME||PROTERTY STANDS FOR|
||SMTP server’s hostname or IP address.|
|Port number for SMTP server.|
|Username or email account for authentication.|
|Password associated with the username or email account.|
|Allows you to set the address from which emails will be sent to the user.|
smtp.host = smtp-server.com smtp.port = 25 smtp.user = [email protected] smtp.password = **********
6.3. SMPP Server Connection Configuration
|PROPERTY NAME||PROTERTY STANDS FOR|
||SMPP server login.|
|SMPP server password.|
|Host or IP address of the SMPP server.|
|Port for the SMPP server.|
|Encoding for SMPP messages.|
|Source or sender address for SMPP messages.|
smpp.server.login = login smpp.server.password = ********** smpp.server.host = smpp.example.com smpp.server.port = 12000 smpp.message.encoding = UTF-8 smpp.from.address = Protectimus
7. How to Import Trusted SSL CertificateBy default, a self-signed SSL certificate is used for the SSL connections with the Protectimus On-Premise Platform. If you would like to import your own trusted SSL certificate, follow the instructions below.
To import the SSL certificate, you will need the SSL certificate itself, the keytool, and openssl utilities.
Different SSL certificate formats are supported, including .pkcs12, .pem, .der, .pfx.
- Import the certificate as trusted into the keystore:
keytool -keystore ___.jks -import -alias ___ -file ___.crt -trustcacerts Example: keytool -keystore publicStore.jks -import -alias protectimus -file protectimus.crt -trustcacerts
- Convert the certificate to PKCS12 format:
openssl pkcs12 -inkey ___.key -in ___.crt -export -out certificate.pkcs12 Example: openssl pkcs12 -inkey privateKey.key -in protectimus_2020-2022.crt -export -out certificate.pkcs12
- Import the certificate to the keystore:
keytool -importkeystore -srckeystore certificate.pkcs12 -srcstoretype PKCS12 -destkeystore ___.jks Example: keytool -importkeystore -srckeystore certificate.pkcs12 -srcstoretype PKCS12 -destkeystore publicStore.jks
8. How To Integrate and Configure the Protectimus On-Premise PlatformIntegrate the Protectimus On-Premise Platform with the system you plan to protect with two-factor authentication and configure the necessary settings. To do this, download the instructions for the integration component you require on the Integrations page.
Last updated on 2023-11-06