OpenID-Bridge Developers Guide
Overview
OpenID-Bridge module provides AutnN and AuthZ related funtionalities.
Below is a list of tools required in OpenID Bridge:
JDK 11
Any IDE (like Eclipse, IntelliJ IDEA)
Apache Maven (zip folder)
PostgreSQL
Any DB client (like DBeaver, pgAdmin)
Postman (any HTTP Client)
Git
Any Editor (like Vscode, Notepad++ etc optional)
lombok.jar (jar file)
settings.xml (document)
Software setup
Download lombok.jar and settings.xml.
Unzip Apache Maven and move
settings.xml
to "conf" folder<apache maven unzip path>\conf
.Install Eclipse, open the
lombok.jar
file and then clickInstall/Update
.Check the Eclipse installation folder to see if the
lombok.jar
is added.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
Open the project folder where
pom.xml
is present.Open the command prompt from the same folder.
Run the command
mvn clean install -Dgpg.skip=true -DskipTests=true
to build the project .After building, open Eclipse and select
Import Projects → Maven → Existing Maven Projects → Next → Browse to project directory → Finish
.After successful importing of project, update the project by right-click on
Project → Maven → Update Project
.
Environment setup
1. Clone mosip-config repository.
2. OpenID Bridge uses two property files, kernel-default
and application-default
, configure them accordingly. For instance,
OpenID bridge connects to an IAM which supports Openid and Oauth. For integration with our keycloak, Please reach out to our team.
Update
mosip.iam.open-id-url
property to update iam url.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)
3. 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}
.
5. 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
Audit REST service consists of
bootstrap.properties
file insrc/main/resources
.Below properties needed to be modified in order to connect to the config server:
Services can be run using
Run As -> Spring Boot App/Java Application
.For API documentation, refer here.
The API's can be tried with the help of Swagger-UI and Postman.
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 instancehttps://dev2.mosip.net/v1/auditmanager/swagger-ui/index.html?configUrl=/v1/auditmanager/v3/api-docs/swagger-config
.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.
Last updated