On-Premise Platform

The Protectimus On-Premise Two-Factor Authentication Platform can be installed on your private servers or in your private cloud.

• 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 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.

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

1. 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/

2. Then clone the git repository: https://github.com/protectimus/platform-linux.git

3. Go to the platform-linux/platform directory and run:

docker-compose up -d

4. You can monitor the process of platform deployment using the command:

docker-compose logs -f

5. After the deployment process is complete, the platform will be available at: https://localhost:8443

2. Protectimus Platform Installation on Windows

1. 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.

2. 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.

3. 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.

4. 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.

5. 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.

6. Initiate the database. Click Init to execute SQL scripts and initiate your database. This may take some time.

7. Select the folder to install the Protectimus Platform and click Install.

3. How to Pay and Activate the License

1. Go to https://service.protectimus.com/en/platform and click Purchase License.

2. Enter your license key into the Licensing Key field and click Submit.

3. On the next step, click on the Pay button.

4. Choose a payment method. If you require an alternate payment method, contact Protectimus customer support.

5. 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.

6. Enter the key into the Licensing Key field and click Submit. After that, the license file will be downloaded.

7. 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 System

5. How to Enable Users Synchronization With Your User Directory

1. Login to your Protectimus account, and click: Users – Synchronization – Add LDAP user provider

2. Fill in the details about your user directory.

keytool -import -alias ___ -file '___.cer' -keystore 'C:\Program Files\Java\jre___\lib\security\cacerts' -storepass changeit

DC=domain,DC=local

CN=Administrator, CN=Users, DC=demo, DC=domain, DC=local

[email protected]

(memberOf=CN=DSPA Group, DC=domain, DC=local)

(mail=*)

3. 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 File

• 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
  (eg. C:\\some\\path\\file).

6.1. SSL Certificate Configuration

https.port

https.keystore.type

https.keystore.password

https.keystore

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

smtp.host

smtp.port

smtp.user

smtp.password

default.from.address

smtp.host = smtp-server.com
smtp.port = 25
smtp.user = [email protected]
smtp.password = **********

6.3. SMPP Server Connection Configuration

smpp.server.login

smpp.server.password

smpp.server.host

smpp.server.port

smpp.message.encoding

smpp.from.address

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 Certificate

1. 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

2. 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

3. 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 Platform