In this manual, we will guide you through the update procedure updating SenseID from V1.7.0 to V1.8.0.

As a preparation, unzip and place the V1.8.0 package 1v1-private-cloud-v1.8.tgz in the same directory where V1.7.0 is installed.

$ tar -xvzf 1v1-private-cloud-v1.8.tgz

1v1-private-cloud-v1.7/
1v1-private-cloud-v1.8/

4.1 Stop Ruby-Cloud-API service (old version)

Change the directory to the old version folder, and stop the Ruby-Cloud-API service.

$ cd 1v1-private-cloud-v1.7
$ sudo ./docker-compose stop

4.2 Updated configuration file (new version)

Refer to Section 4.2.1 Adjust CPU cores, Section 4.3.2 Set Go-Workers address, Section 4.3.3 Adjust CPU cores in the Installation Manual, set the number of CPUs and the address of Go-Workers in the new version's configuration file as in the old version.

4.3 Load service images (new version)

Change the directory to the new version folder, and load the Ruby-Cloud-API image file.

$ cd 1v1-private-cloud-v1.8
$ sudo ./load_image.sh

4.4 Start Ruby-Cloud-API service (new version)

Start the Ruby-Cloud-API service of the new version.

$ sudo ./docker-compose up -d

4.5 Stop Go-Workers service (old version)

Change the directory to the old version folder, and stop the Go-Workers service.

$ cd 1v1-private-cloud-v1.7/go-workers
$ sudo ./stop.sh

4.6 Copy the license files

Copy the license files from the old version to specified folders of the new version.

$ cp 1v1-private-cloud-v1.7/go-workers/fixture/lisense/senseid_face/senseid_face.lic 1v1-private-cloud-v1.8/go-workers/fixture/lisense/senseid_face
$ cp 1v1-private-cloud-v1.7/go-workers/fixture/lisense/senseid_liveness/senseid_liveness.lic 1v1-private-cloud-v1.8/go-workers/fixture/lisense/senseid_liveness

After receiving senseid_kestrel.lic, copy it to the specified folder of the new version with the following command.

$ cp {file_path}/senseid_kestrel.lic {installation_path}/1v1-private-cloud-v1.8/go-worker/fixture/license/senseid_kestrel

4.7 Start Go-Workers service (new version)

Change the directory to the new version folder, and start the Go-Workers service.

$ cd 1v1-private-cloud-v1.8/go-workers
$ sudo ./start.sh

4.8 Check services (new version)

Check if services started normally.

• Ruby-Cloud-API

$ sudo ./docker-compose ps

• Go-Workers

$ tail -f tmp/worker.log.0

This manual describes each operation procedure required for SenseID.

This manual is intended for customers who belong to the IT department and have experience using and operating Linux, Kubernetes, Docker, and cloud.

3.1 Input photo standards

1. The photo format should be one of the following. JPG (JPEG) ,BMP, PNG, GIF, TIFF The recommended format is JPG (JPEG).

2. The width and height of the photo should be at least 32 pixels and no more than 5,000 pixels. The recommended size is 640*480 pixels.

3. The size of the photo file must be 5MB or less. The larger the size, the more the processing performance will be affected. We recommend compressing the photo file to 100KB.

3.2 Input video standards

1. Most common video formats are supported. Include but not restrict to MP4, AVI, FLV, WMV, MOV, RM

   The recommended format is MP4.

2. The width and height of the video should be at least 8 pixels and no more than 5,000px. The recommended size is 640*480 pixels.

3. The size of the video file must be 16MB or less. The larger the size, the more the processing performance will be affected. We recommend compressing the video file to about 500KB to 1MB.

2.1 Customize the encryption key and IV

SenseID requires that personal data (photos and videos) must be encrypted before being uploaded via APIs. AES-256-GCM is adopted as the encryption algorithm. The key and IV required for encryption are set as follows by default.

PARAM_DECRYPT_KEY = dcbbad6765e14139a07d34b92292a672
PARAM_DECRYPT_IV = df25d188a061

To customize the key and the IV, update the environment variables PARAM_DECRYPT_KEY and PARAM_DECRYPT_IV. The key is 32 characters and the IV is 12 characters.

$ cd 1v1-private-cloud-v1.8/
$ vi .env

2.2 Encryption method

1. Load the photo or video file.

2. Encrypt the data with AES-256-GCM.

3. Encode the above result with Base64.

import javax.crypto.Cipher;
import javax.crypto.spec.GCMParameterSpec;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.Charset;
import java.util.Base64;


public class AESCipher {
    private String key;
    private String iv;

    public AESCipher(String key, String iv) {
        this.key = key;
        this.iv = iv;
    }

    String encrypt(byte[] data) throws Exception{
        SecretKeySpec keySpec = new SecretKeySpec(key.getBytes(Charset.forName("UTF-8")), "AES");
        Cipher cipher = Cipher.getInstance("AES/GCM/NoPadding");
        cipher.init(Cipher.ENCRYPT_MODE, keySpec, new GCMParameterSpec(128, iv.getBytes(Charset.forName("UTF-8"))));
        byte[] result = cipher.doFinal(data);
        return Base64.getEncoder().encodeToString(result);
    }

    byte[] decrypt(String data) throws Exception {
        SecretKeySpec keySpec = new SecretKeySpec(key.getBytes(Charset.forName("UTF-8")), "AES");
        Cipher cipher = Cipher.getInstance("AES/GCM/NoPadding");
        cipher.init(Cipher.DECRYPT_MODE, keySpec, new GCMParameterSpec(128, iv.getBytes(Charset.forName("UTF-8"))));
        byte[] result = cipher.doFinal(Base64.getDecoder().decode(data));
        return result;
    }

    public static void main(String[] args) throws Exception{
        String key = "dcbbad6765e14139a07d34b92292a672"; //key 32 bits
        String iv = "df25d188a061"; // iv 12 bits
        String data = "hello world";

        AESCipher cipher = new AESCipher(key, iv);
        String encryptedData = cipher.encrypt(data.getBytes());
        System.out.println("encrypted data: " + encryptedData);

        String decryptedData = new String(cipher.decrypt(encryptedData));
        System.out.println("decrypted data: " + decryptedData);
    }
}

To change or renew the license files, overwrite the new license files from the old licenses file and place them in the specified directories. Refer to Chapter 3 License Activation in the Installation Manual for details.

After replacing the license files, restart the service.

$ cd 1v1-private-cloud-v1.8/go-worker
$ sudo ./stop.sh
$ sudo ./start.sh