diff --git a/README.md b/README.md index 8d2f02cdf7..b3806e7356 100644 --- a/README.md +++ b/README.md @@ -10,20 +10,47 @@ This repository contains source code and design documents for MOSIP ID Authentic Refer to [SQL scripts](db_scripts). ## Build & run (for developers) -The project requires JDK 1.21. +The project requires JDK 21.0.3 +and mvn version - 3.9.6 + +### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration + ``` + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + ``` +This is for better compatibility with future PostgreSQL versions. + +### Configure ANT Path Matcher for Spring Boot 3.x compatibility. + ``` + spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER + ``` +This is to maintain compatibility with existing ANT-style path patterns. + 1. Build and install: ``` - $ cd kernel + $ cd authentication $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true ``` -1. Build Docker for a service: +2. Build Docker for a service: ``` $ cd $ docker build -f Dockerfile ``` +### Add auth-adapter in a class-path to run a services + ``` + + io.mosip.kernel + kernel-auth-adapter + ${kernel.auth.adapter.version} + + ``` ## Configuration -Refer to the [configuration guide](docs/configuration.md). +[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and +[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and +[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and +[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/master/id-authentication-otp-default.properties) and +[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here. + ## Deployment in K8 cluster with other MOSIP services: ### Pre-requisites @@ -48,7 +75,7 @@ Refer to the [configuration guide](docs/configuration.md). ``` ## Test -Automated functional tests available in [Functional Tests repo](https://github.com/mosip/mosip-functional-tests). +Automated functional tests available in [api-test folder](api-test). ## APIs API documentation is available [here](https://mosip.github.io/documentation/). diff --git a/authentication/authentication-internal-service/README.md b/authentication/authentication-internal-service/README.md index 19fcf32a4c..94a4d48c7c 100644 --- a/authentication/authentication-internal-service/README.md +++ b/authentication/authentication-internal-service/README.md @@ -8,7 +8,8 @@ Any combination of the supported [authentication types](https://docs.mosip.io/1. ## Modalities * Refer [biometric modalities](https://docs.mosip.io/1.2.0/biometrics#modalities). -* Above authentication types can be allowed/disallowed/mandated by the [configuraion](../../docs/configuration.md#allowed-authentication-types) and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md). +* Above authentication types can be allowed/disallowed/mandated by the [configuration](../../docs/configuration.md) + and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md). ## Endpoints * Internal Authentication - used by Internal MOSIP modules for authenticating an individual's UIN/VID @@ -40,3 +41,81 @@ GET /idauthentication/v1/internal/authTransactions/individualId/{ID} * Bio-SDK HTTP service - for biometric authentication * HSM - for retrieving encryption/decryption keys. +## Overview +This repository contains source code and design documents for MOSIP ID Authentication internal service which is the server-side module to manage [ID Authentication](https://docs.mosip.io/1.2.0/modules/id-authentication-services). The modules exposes API endpoints. + +## Databases +Refer to [SQL scripts](../../db_scripts). + +## Build & run (for developers) +The project requires JDK 21.0.3 +and mvn version - 3.9.6 + +### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration + ``` + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + ``` +This is for better compatibility with future PostgreSQL versions. + +### Configure ANT Path Matcher for Spring Boot 3.x compatibility. + ``` + spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER + ``` +This is to maintain compatibility with existing ANT-style path patterns. + +1. Build and install: + ``` + $ cd authentication/authentication-internal-service + $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true + ``` +2. Build Docker for a service: + ``` + $ cd + $ docker build -f Dockerfile + ``` +### Add auth-adapter in a class-path to run a services + ``` + + io.mosip.kernel + kernel-auth-adapter + ${kernel.auth.adapter.version} + + ``` + +## Configuration +[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and +[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and +[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and +[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here. + + +## Deployment in K8 cluster with other MOSIP services: +### Pre-requisites +* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file: + ``` + export KUBECONFIG=~/.kube/ + ``` +### Install + ``` + $ cd deploy + $ ./install.sh + ``` +### Delete + ``` + $ cd deploy + $ ./delete.sh + ``` +### Restart + ``` + $ cd deploy + $ ./restart.sh + ``` + +## Test +Automated functional tests available in [Functional Tests](../../api-test). + +## APIs +API documentation is available [here](https://mosip.github.io/documentation/). + +## License +This project is licensed under the terms of [Mozilla Public License 2.0](../../LICENSE). diff --git a/authentication/authentication-otp-service/README.md b/authentication/authentication-otp-service/README.md index 33c20adfe6..c3127f44d4 100644 --- a/authentication/authentication-otp-service/README.md +++ b/authentication/authentication-otp-service/README.md @@ -27,3 +27,82 @@ POST /idauthentication/v1/otp/{MISP-LicenseKey}/{Auth-Partner-ID}/{Partner-Api-K * WebSub: for getting events for Credential data/ IDentity data/ Partner data/ Master data updates. * HSM: for retrieving encryption/decryption keys. +## Overview +This repository contains source code and design documents for MOSIP ID Authentication OTP service which is the server-side module to manage [ID Authentication](https://docs.mosip.io/1.2.0/modules/id-authentication-services). The modules exposes API endpoints. + +## Databases +Refer to [SQL scripts](../../db_scripts). + +## Build & run (for developers) +The project requires JDK 21.0.3 +and mvn version - 3.9.6 + +### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration + ``` + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + ``` +This is for better compatibility with future PostgreSQL versions. + +### Configure ANT Path Matcher for Spring Boot 3.x compatibility. + ``` + spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER + ``` +This is to maintain compatibility with existing ANT-style path patterns. + +1. Build and install: + ``` + $ cd authentication/authentication-otp-service + $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true + ``` +2. Build Docker for a service: + ``` + $ cd + $ docker build -f Dockerfile + ``` +### Add auth-adapter in a class-path to run a services + ``` + + io.mosip.kernel + kernel-auth-adapter + ${kernel.auth.adapter.version} + + ``` + +## Configuration +[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and +[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and +[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and +[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/master/id-authentication-otp-default.properties) and +[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here. + + +## Deployment in K8 cluster with other MOSIP services: +### Pre-requisites +* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file: + ``` + export KUBECONFIG=~/.kube/ + ``` +### Install + ``` + $ cd deploy + $ ./install.sh + ``` +### Delete + ``` + $ cd deploy + $ ./delete.sh + ``` +### Restart + ``` + $ cd deploy + $ ./restart.sh + ``` + +## Test +Automated functional tests available in [api-test folder](../../api-test). + +## APIs +API documentation is available [here](https://mosip.github.io/documentation/). + +## License +This project is licensed under the terms of [Mozilla Public License 2.0](../../LICENSE). diff --git a/authentication/authentication-service/README.md b/authentication/authentication-service/README.md index 254ea0649c..2870279bd2 100644 --- a/authentication/authentication-service/README.md +++ b/authentication/authentication-service/README.md @@ -10,7 +10,7 @@ Any combination of the supported [authentication types](https://docs.mosip.io/1. ## Modalities * Refer [biometric modalities](https://docs.mosip.io/1.2.0/biometrics#modalities). -* Above authentication types can be allowed/disallowed/mandated by the [configuraion](../../docs/configuration.md#allowed-authentication-types) and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md). +* Above authentication types can be allowed/disallowed/mandated by the [configuration](../../docs/configuration.md) and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md). ## Partner/MISP validation * Below partner/MISP data are validated before processing the authentication request: @@ -42,3 +42,82 @@ POST /idauthentication/v1/kyc/{MISP-LicenseKey}/{Auth-Partner-ID}/{Partner-Api-K * Bio:SDK HTTP service: For biometric authentication * HSM: For retrieving encryption/decryption keys. +## Overview +This repository contains source code and design documents for MOSIP ID Authentication service which is the server-side module to manage [ID Authentication](https://docs.mosip.io/1.2.0/modules/id-authentication-services). The modules exposes API endpoints. + +## Databases +Refer to [SQL scripts](../../db_scripts). + +## Build & run (for developers) +The project requires JDK 21.0.3 +and mvn version - 3.9.6 + +### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration + ``` + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + ``` +This is for better compatibility with future PostgreSQL versions. + +### Configure ANT Path Matcher for Spring Boot 3.x compatibility. + ``` + spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER + ``` +This is to maintain compatibility with existing ANT-style path patterns. + +1. Build and install: + ``` + $ cd authentication/authentication-service + $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true + ``` +2. Build Docker for a service: + ``` + $ cd + $ docker build -f Dockerfile + ``` +### Add auth-adapter in a class-path to run a services + ``` + + io.mosip.kernel + kernel-auth-adapter + ${kernel.auth.adapter.version} + + ``` + +## Configuration +[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and +[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and +[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and +[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/master/id-authentication-otp-default.properties) and +[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here. + + +## Deployment in K8 cluster with other MOSIP services: +### Pre-requisites +* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file: + ``` + export KUBECONFIG=~/.kube/ + ``` +### Install + ``` + $ cd deploy + $ ./install.sh + ``` +### Delete + ``` + $ cd deploy + $ ./delete.sh + ``` +### Restart + ``` + $ cd deploy + $ ./restart.sh + ``` + +## Test +Automated functional tests available in [api-test folder](../../api-test). + +## APIs +API documentation is available [here](https://mosip.github.io/documentation/). + +## License +This project is licensed under the terms of [Mozilla Public License 2.0](../../LICENSE). \ No newline at end of file