Key Manager Developers Guide

Overview

To get an overview of Key Manager, refer Key Manager.

Below is a list of tools required in Key Manager:

1. JDK 11

2. Any IDE (like Eclipse, IntelliJ IDEA)

3. Apache Maven (zip folder)

4. PostgreSQL

5. Any DB client (like DBeaver, pgAdmin)

6. Postman (any HTTP Client)

7. Git

8. Any Editor (like Vscode, Notepad++ etc optional)

9. lombok.jar (jar file)

10. settings.xml (document)

Software setup

1. Download lombok.jar and settings.xml.

2. Unzip Apache Maven and move settings.xml to "conf" folder <apache maven unzip path>\conf.

3. Install Eclipse, open the lombok.jar file and then click Install/Update.

4. Check the Eclipse installation folder to see if the lombok.jar is added.

5. Configure the JDK (Standard VM) with your Eclipse by traversing through Preferences → Java → Installed JREs.

Source code setup

For the code setup, clone the repository and follow the guidelines mentioned in the Code Contributions.

Importing and building

1. Open the project folder where pom.xml is present.

2. Open the command prompt from the same folder.

3. Run the command mvn clean install -Dgpg.skip=true -DskipTests=true to build the project.

4. After building, open Eclipse and select Import Projects → Maven → Existing Maven Projects → Next → Browse to project directory → Finish.

5. After successful importing of project, update the project by right-click on Project → Maven → Update Project.

Environment setup

1. Download Auth adapter and add to project Libraries → Classpath → Add External JARs → Select Downloaded JAR → Add → Apply and Close.

1. Clone mosip-config repository.

2. Refer KeyManager-DB-deploy to deploy local DB.

3. Key Manager uses two property files, kernel-default and application-default, configure them accordingly. For instance,

• Key Manager needs a Keystore to store keys. Supported Keystore types: PKCS11, PKCS12, Offline, JCE.

  # For PKCS11 provide Path of config file.
  # For PKCS12 keystore type provide the p12/pfx file path. P12 file will be created internally so provide only file path and file name.
  # For Offline & JCE property can be left blank, specified value will be ignored.
  mosip.kernel.keymanager.hsm.config-path=/config/softhsm-application.conf
  # Passkey of keystore for PKCS11, PKCS12
  # For Offline & JCE property can be left blank. JCE password use other JCE specific properties.
  mosip.kernel.keymanager.hsm.keystore-pass={cipher}2d6aa328be521b2be6f33f476f7df2ea39c7ae1a3e2146ec169c5fac3225da3f

• Secrets can be encrypted using config server.

• Update URL's in property files.(It can be either pointed to any remotely or locally deployed services)

1. Download kernel-config-server.jar. For Windows, download config-server-start.bat, Linux users can run java -jar -Dspring.profiles.active=native -Dspring.cloud.config.server.native.search-locations=file:{mosip-config-mt_folder_path}/config -Dspring.cloud.config.server.accept-empty=true -Dspring.cloud.config.server.git.force-pull=false -Dspring.cloud.config.server.git.cloneOnStart=false -Dspring.cloud.config.server.git.refreshRate=0 {jarName} .

2. Run the server by opening the config-server-start.bat file.

   
3. To verify the config-server, hit the below URL:

http://localhost:51000/config/{spring.profiles.active}/{spring.cloud.config.name}/{spring.cloud.config.label} for instance http://localhost:51000/config/kernel/env/master.

Initialization and utilization of module

1. Key Manager REST service consists of bootstrap.properties file in src/main/resources.

2. Below properties needed to be modified in order to connect to the config server:

   spring.cloud.config.uri=<config server uri>
   spring.cloud.config.label=<branch of config repo>
   spring.profiles.active=default

3. Services can be run using Run As -> Spring Boot App/Java Application.

4. For API documentation, refer here.

5. The API's can be tried with the help of Swagger-UI and Postman.

6. Swagger-UI service can be accessed from (https/http)://(<domain>/<host>:<port>)/<context-path>/swagger-ui/index.html?configUrl=<contect-path>/v3/api-docs/swagger-config for instance https://dev2.mosip.net/v1/auditmanager/swagger-ui/index.html?configUrl=/v1/keymanager/v3/api-docs/swagger-config.

7. The API's can be tried using Postman. URLs and Body structures can be found in swagger or curl command can be copied and imported in Postman.