From 01b81640fefd380d982fc44ec0576d6fcab8c4f5 Mon Sep 17 00:00:00 2001 From: Puneet Joshi Date: Tue, 9 Jan 2024 12:31:34 +0000 Subject: [PATCH] GITBOOK-90: No subject --- SUMMARY.md | 4 ---- developer-zone/repositories/openg2p-auth.md | 17 +++++++++------ .../openg2p-erp-community-addon.md | 2 -- .../repositories/openg2p-erp-docker.md | 2 -- developer-zone/repositories/openg2p-erp.md | 2 -- .../repositories/openg2p-voucher.md | 2 -- developer-zone/repositories/server-auth.md | 21 ++++++++++++------- .../openg2p-e-signet-integration.md | 11 ++++------ 8 files changed, 29 insertions(+), 32 deletions(-) delete mode 100644 developer-zone/repositories/openg2p-erp-community-addon.md delete mode 100644 developer-zone/repositories/openg2p-erp-docker.md delete mode 100644 developer-zone/repositories/openg2p-erp.md delete mode 100644 developer-zone/repositories/openg2p-voucher.md diff --git a/SUMMARY.md b/SUMMARY.md index 67b26fe1..2c1506c9 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -78,7 +78,6 @@ * [openg2p-theme](developer-zone/repositories/openg2p-theme.md) * [openg2p-portal-api](developer-zone/repositories/openg2p-portal-api.md) * [openg2p-mosip](developer-zone/repositories/openg2p-mosip.md) - * [openg2p-erp](developer-zone/repositories/openg2p-erp.md) * [openg2p-notifications](developer-zone/repositories/openg2p-notifications.md) * [openg2p-packaging](developer-zone/repositories/openg2p-packaging.md) * [openg2p-importers](developer-zone/repositories/openg2p-importers.md) @@ -95,9 +94,6 @@ * [server-auth](developer-zone/repositories/server-auth.md) * [openg2p-data](developer-zone/repositories/openg2p-data.md) * [openg2p-esignet](developer-zone/repositories/openg2p-esignet.md) - * [openg2p-erp-docker](developer-zone/repositories/openg2p-erp-docker.md) - * [openg2p-erp-community-addon](developer-zone/repositories/openg2p-erp-community-addon.md) - * [openg2p-voucher](developer-zone/repositories/openg2p-voucher.md) * [Testing](developer-zone/testing/README.md) * [Automation Framework](developer-zone/testing/automation-framework.md) * [Upcoming Features](developer-zone/upcoming-features/README.md) diff --git a/developer-zone/repositories/openg2p-auth.md b/developer-zone/repositories/openg2p-auth.md index 102a5998..5f1e7b93 100644 --- a/developer-zone/repositories/openg2p-auth.md +++ b/developer-zone/repositories/openg2p-auth.md @@ -1,11 +1,16 @@ -# [openg2p-auth](https://github.com/OpenG2P/openg2p-auth.git) +# openg2p-auth -openg2p-auth is an extension to server-auth to setup further parameters and facilitate further functionalities required for OpenG2P. The settings for openG2P-auth in included in the same page as server-auth. Below are the parameters available for openg2p-auth +## Contents -* **Allowed in Self Service Portal : Wether or not the login option will be visible for self service portal login page** +This repository contains <> + +## eSignet integration + +openg2p-auth is an extension to server-auth to setup further parameters and facilitate further functionalities required for OpenG2P. The settings for openG2P-auth in included in the same page as server-auth. Below are the parameters available for openg2p-auth + +* **Allowed in Self Service Portal : Wether or not the login option will be visible for self service portal login page** * **Use G2P Reg ID Type :** What would be the Registry ID Type used to store the token received * **Partner Creation Call Validate Url :** -* **Partner Creation Validate Response Mapping :** Mapping the fields for registry record creation -* **Default Group User Creation :** Default user group to be created when the user log in to self service portal through eSignet for the first time. +* **Partner Creation Validate Response Mapping :** Mapping the fields for registry record creation +* **Default Group User Creation :** Default user group to be created when the user log in to self service portal through eSignet for the first time. * **Login Attribute Mapping On User Creation : What would be the login attribute connected with the user after the user is created for first time** - diff --git a/developer-zone/repositories/openg2p-erp-community-addon.md b/developer-zone/repositories/openg2p-erp-community-addon.md deleted file mode 100644 index e3ea4808..00000000 --- a/developer-zone/repositories/openg2p-erp-community-addon.md +++ /dev/null @@ -1,2 +0,0 @@ -# openg2p-erp-community-addon - diff --git a/developer-zone/repositories/openg2p-erp-docker.md b/developer-zone/repositories/openg2p-erp-docker.md deleted file mode 100644 index 45613af9..00000000 --- a/developer-zone/repositories/openg2p-erp-docker.md +++ /dev/null @@ -1,2 +0,0 @@ -# openg2p-erp-docker - diff --git a/developer-zone/repositories/openg2p-erp.md b/developer-zone/repositories/openg2p-erp.md deleted file mode 100644 index dc70f40d..00000000 --- a/developer-zone/repositories/openg2p-erp.md +++ /dev/null @@ -1,2 +0,0 @@ -# openg2p-erp - diff --git a/developer-zone/repositories/openg2p-voucher.md b/developer-zone/repositories/openg2p-voucher.md deleted file mode 100644 index c8a08ecd..00000000 --- a/developer-zone/repositories/openg2p-voucher.md +++ /dev/null @@ -1,2 +0,0 @@ -# openg2p-voucher - diff --git a/developer-zone/repositories/server-auth.md b/developer-zone/repositories/server-auth.md index 97beaa28..a1719829 100644 --- a/developer-zone/repositories/server-auth.md +++ b/developer-zone/repositories/server-auth.md @@ -1,26 +1,33 @@ # server-auth + + Branch: [15.0](https://github.com/OpenG2P/server-auth/tree/15.0) -eSignet integration from OpenG2P uses the [auth\_oidc](https://github.com/OCA/server-auth/tree/15.0/auth\_oidc) package of odoo which is further extended to use [private\_key\_jwt ](https://openid.net/specs/openid-connect-core-1\_0-15.html#ClientAuthentication)assertion at the client side. To configure eSignet a new oAuth provider is added in OpenG2P. This can be done by entering into debug mode and going to "Settings" page and click on "OAuth Providers" under the menu "Users & Companies". +## Contents + +This repository contains <> + +## eSignet integration + +eSignet integration from OpenG2P uses the [auth\_oidc](https://github.com/OCA/server-auth/tree/15.0/auth\_oidc) package of odoo which is further extended to use [private\_key\_jwt ](https://openid.net/specs/openid-connect-core-1\_0-15.html#ClientAuthentication)assertion at the client side. To configure eSignet a new oAuth provider is added in OpenG2P. This can be done by entering into debug mode and going to "Settings" page and click on "OAuth Providers" under the menu "Users & Companies". Following are the parameter setting for [server-auth](https://github.com/OpenG2P/server-auth/tree/15.0) * **Provider name : A name for the configuration** -* **Auth Flow : "**OpenID Connect (authorization code flow)" can be used to connect OIDC IdP provider. -* **Token Map:** sub:user\_id +* \*\*Auth Flow : "\*\*OpenID Connect (authorization code flow)" can be used to connect OIDC IdP provider. +* **Token Map:** sub:user\_id * **Redirect Url :** URL where IdP would redirect to after successful login, where in the user sign in process inside OpenG2P will happen. * **Client ID :** Client Id created at IdP against OpenG2P * **Client Authentication :** The client authentication method for eSignet. eSignet uses "Private Key JWT" -* **Private Key :** Private key pem file has to be uploaded here. +* **Private Key :** Private key pem file has to be uploaded here. * **Grant Type :** Type of grant, which need to be "JWT Bearer" here. * **Allowed ​:** Whether or not the login method is enabled in the login page * **Login button label :** Button label visible in the login page. -* **CSS class :** CSS Class to get applied on the login button +* **CSS class :** CSS Class to get applied on the login button * **Authorization URL:** Authorization URL * **Scope:** Provide the value "openid profile email" * **UserInfo URL:** URL to fetch the User Info -* **Token URL :** Token end point to get the authorisation token +* **Token URL :** Token end point to get the authorisation token * **JWKS URL :** The JSON Web Key Set (JWKS) endpoint * **Data Endpoint :** Data end point - diff --git a/platform/integrations/openg2p-e-signet-integration.md b/platform/integrations/openg2p-e-signet-integration.md index b5f8a4ec..e9205a53 100644 --- a/platform/integrations/openg2p-e-signet-integration.md +++ b/platform/integrations/openg2p-e-signet-integration.md @@ -2,11 +2,11 @@ ## Introduction -OpenG2P can use [e-Signet](https://docs.esignet.io/) for authentication. e-Signet provides an [OIDC](https://openid.net/connect/) interface for authentication while connecting to the MOSIP's IDA services on the backend. +OpenG2P can use [e-Signet](https://docs.esignet.io/) for authentication. e-Signet provides an [OIDC](https://openid.net/connect/) interface for authentication while connecting to the MOSIP's IDA services on the backend.
-Here, OpenG2P is a Relying Party and the Authentication System is MOSIP. Learn [more](https://docs.esignet.io/integration-guides/authentication-system-integration). +Here, OpenG2P is a Relying Party and the Authentication System is MOSIP. Learn [more](https://docs.esignet.io/integration-guides/authentication-system-integration). ## Configure OpenG2P for e-Signet @@ -16,10 +16,7 @@ Refer to the guide [Integrate MOSIP e-Signet](../../guides/user-guides/integrate [eSignet](https://docs.esignet.io) is a [OpenID Connect](https://openid.net/connect/) implementation which aims to offer a simple yet powerful mechanism for end users to identify themselves to avail of online services and also share their profile information. -OpenG2P integrates with MOSIP IdP over eSignet for the Self Service portal registration and login. This enables any MOSIP Id holders can easily use the service of OpenG2P through the secure bio-metric and other means of authentication. +OpenG2P integrates with MOSIP IdP over eSignet for the Self Service portal registration and login. This enables any MOSIP Id holders can easily use the service of OpenG2P through the secure bio-metric and other means of authentication. -Following are the dependent modules in openG2P to integrate eSignet - -* server-auth -* openg2p-auth +For further details refer to openg2p-auth.