From 529810f0f4da1db1f755aa5045322474d5bf5398 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 23 Oct 2024 12:03:40 +0530 Subject: [PATCH 01/31] Update concepts_onboarding_checklist.md added Instruction to replace actual GPG Key Id in gpg --armor --export command added Instruction - Howto Set env varibale in window PowerShell script --- .../concepts_onboarding_checklist.md | 24 +++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 7b17b2174..ced6ac5ee 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -95,7 +95,7 @@ This repository contains the template for building [onboarding](https://github.c ``` Shell - gpg --armor --export 3AA5C34371567BD2 + gpg --armor --export << replace you actual GPG key ID >> # Prints the GPG key ID, in ASCII armor format ``` - Copy your GPG key, beginning with -----BEGIN PGP PUBLIC KEY BLOCK----- and ending with -----END PGP PUBLIC KEY BLOCK-----. @@ -118,7 +118,7 @@ This repository contains the template for building [onboarding](https://github.c - You must adapt the following default certificate parameter of [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file which will used in gen_all_certs.sh to your needs: - Configuration Template for Certificate Generation, Modify for your own needs in DN_template.cnf file as it will be - used as argument while running the script "gen_all_certs.sh". + used as argument while running the shell script "gen_all_certs.sh". ``` export OSSL_COUNTRY_NAME="XC" @@ -127,6 +127,26 @@ This repository contains the template for building [onboarding](https://github.c export OSSL_ORGANIZATION_NAME="WHO" export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" ``` + **Windows PowerShell Script** [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) + +Here’s how you would set those environment variables in Windows PowerShell. The Windos PowerShell script is [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) + +1.Open PowerShell on your Windows machine. + +2.Paste the below code into the PowerShell window. + +3.These variables will now be available as environment variables for the current PowerShell session. + + ``` + $env:OSSL_COUNTRY_NAME="XC" + $env:OSSL_STATE_NAME="Test State" + $env:OSSL_LOCALITY_NAME="TEST" + $env:OSSL_ORGANIZATION_NAME="WHO" + $env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" + ``` + + + > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. From c48fe1ee323cb50d42ba7c36d9504441620bdf71 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 23 Oct 2024 12:59:50 +0530 Subject: [PATCH 02/31] Update concepts_onboarding_checklist.md correciton in Windows PowerShell Script section --- input/pagecontent/concepts_onboarding_checklist.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index ced6ac5ee..96096bf8f 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -130,6 +130,8 @@ This repository contains the template for building [onboarding](https://github.c **Windows PowerShell Script** [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) Here’s how you would set those environment variables in Windows PowerShell. The Windos PowerShell script is [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) + +**Note**: You can either modify **gen_all_certs.ps1** directly or set environment variables for your current PowerShell session as mentioned in the steps below. 1.Open PowerShell on your Windows machine. From 7a9bc30d64f36088b7f876035e185d9c2ee1c65f Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 6 Nov 2024 19:03:15 +0530 Subject: [PATCH 03/31] Update concepts_onboarding_checklist.md - Updated certificate generation steps for Unix and windows Platform --- .../concepts_onboarding_checklist.md | 34 +++++++++---------- 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 96096bf8f..866276769 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -112,13 +112,18 @@ This repository contains the template for building [onboarding](https://github.c #### Certificate Preparation for DEV and UAT -> Disclaimer: The script generates self-signed certificates not intended to be used on production environments. -> for DEV and UAT environments you may use the conf files and the [certgen bash script](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) as a guideline according to the [Certificate Preparation](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/README.md) - -- You must adapt the following default certificate parameter of [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file which will used in gen_all_certs.sh to your needs: - -- Configuration Template for Certificate Generation, Modify for your own needs in DN_template.cnf file as it will be - used as argument while running the shell script "gen_all_certs.sh". +> **Disclaimer**: This script is designed to create self-signed certificates solely for non-production environments, such as DEV and UAT, not intended to be used on production environments. To use it, **choose the appropriate script for your operating system**: +> +>**Unix/Linux:** Use the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) bash script. +> +>**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script. +> +> These scripts, along with the provided configuration files, serve as guidelines for [certificate preparation](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/README.md) . +> +**If your Operating Sysems is Unix/Linux:** +> +- To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. +- Modify the following default certificate parameters as needed: ``` export OSSL_COUNTRY_NAME="XC" @@ -127,18 +132,14 @@ This repository contains the template for building [onboarding](https://github.c export OSSL_ORGANIZATION_NAME="WHO" export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" ``` - **Windows PowerShell Script** [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) - -Here’s how you would set those environment variables in Windows PowerShell. The Windos PowerShell script is [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) +**If your Operating Systems is Windows** + +For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script. You can modify the environment variables directly within the script or set them in your current PowerShell session: -**Note**: You can either modify **gen_all_certs.ps1** directly or set environment variables for your current PowerShell session as mentioned in the steps below. - 1.Open PowerShell on your Windows machine. -2.Paste the below code into the PowerShell window. +2.Set the required environment variables. -3.These variables will now be available as environment variables for the current PowerShell session. - ``` $env:OSSL_COUNTRY_NAME="XC" $env:OSSL_STATE_NAME="Test State" @@ -147,9 +148,6 @@ Here’s how you would set those environment variables in Windows PowerShell. Th $env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" ``` - - - > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. - Then execute the script. It will generate all certificates and keys in a subfolder named by current datetime. From 5d97d4aed9554642e9cc33f6d3c87ee7accbdd60 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 6 Nov 2024 19:39:04 +0530 Subject: [PATCH 04/31] Update concepts_onboarding_checklist.md - Updated steps to generate certificate on DEV/UAT enviornment by using unix script and powershell script on repective Unix and Windows operating system. --- .../concepts_onboarding_checklist.md | 29 +++++++++---------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 866276769..50b864add 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -132,6 +132,8 @@ This repository contains the template for building [onboarding](https://github.c export OSSL_ORGANIZATION_NAME="WHO" export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" ``` +> Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. +> **If your Operating Systems is Windows** For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script. You can modify the environment variables directly within the script or set them in your current PowerShell session: @@ -149,32 +151,29 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat ``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. - -- Then execute the script. It will generate all certificates and keys in a subfolder named by current datetime. -- While execution of the "gen_all_certs.sh" script, Please provide script argument "DN_template.cnf" file - which consists of country related information to generate all required certificates (TLS,SCA,UP) + +Please note that you need to have [OpenSSL installed](https://slproweb.com/products/Win32OpenSSL.html) (e.g. Win64 OpenSSL v3.3.0 Light) and added to your PATH environment variable. Also you may need allow the execution by setting an execution policy. + + ``` + Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process + ``` +**How to Run Script** +- Once you execute the script. It will generate all certificates and keys in a subfolder named by current datetime. +- **Notes**: While execution of "gen_all_certs.sh" script on **Unix/Linux Operating System,** Please provide script argument "DN_template.cnf" file which consists of country related information to generate all required certificates (TLS,SCA,UP) - ``` - For Mac/Unix + **For Mac/Unix** cd scripts/certgen ./gen_all_certs.sh DN_template.cnf zsh ./gen_all_certs.sh DN_template.cnf ## If you are using Ubuntu OS - For Windows: + **For Windows:** cd scripts/certgen ./gen_all_certs.ps1 ``` - -**Execution On Windows** - -Windows platform you can use [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) instead. Please note that you need to have [OpenSSL installed](https://slproweb.com/products/Win32OpenSSL.html) (e.g. Win64 OpenSSL v3.3.0 Light) and added to your PATH environment variable. Also you may need allow the execution by setting an execution policy. - - ``` - Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process - ``` +This setup generates all required certificates (TLS, SCA, UP) and keys in a timestamped subfolder, based on the configuration specified in DN_template.cnf for Unix/Linux and the environment variables set in the current PowerShell session for Windows. **Prepare Folders** From 4cd8bdfef22522537adb741896ea49b0567994c5 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 6 Nov 2024 19:54:21 +0530 Subject: [PATCH 05/31] Update concepts_onboarding_checklist.md --- input/pagecontent/concepts_onboarding_checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 50b864add..83e4bd73f 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -134,7 +134,7 @@ This repository contains the template for building [onboarding](https://github.c ``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. > -**If your Operating Systems is Windows** +**If your Operating Systems is Windows:** For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script. You can modify the environment variables directly within the script or set them in your current PowerShell session: @@ -157,7 +157,7 @@ Please note that you need to have [OpenSSL installed](https://slproweb.com/prod ``` Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process ``` -**How to Run Script** +**How to Run Script :** - Once you execute the script. It will generate all certificates and keys in a subfolder named by current datetime. - **Notes**: While execution of "gen_all_certs.sh" script on **Unix/Linux Operating System,** Please provide script argument "DN_template.cnf" file which consists of country related information to generate all required certificates (TLS,SCA,UP) From 9948d47d97ccbdcff6dd3b0f1edff8d4439e36a7 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 13 Nov 2024 18:22:17 +0530 Subject: [PATCH 06/31] Update concepts_onboarding_checklist.md - Modification in scripts/certgen script for windows - created jump seciton - added pre-requisite section for toolsets used by country representative --- .../concepts_onboarding_checklist.md | 57 +++++++++++++++++-- 1 file changed, 53 insertions(+), 4 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 83e4bd73f..e7fd9e963 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -1,6 +1,54 @@ This repository contains the template for building [onboarding](https://github.com/WorldHealthOrganization/smart-trust/blob/main/input/pagecontent/concepts_onboarding.md) information for the Smart Trust Network Attendees. This includes CSCAs, Auth information, signing information and other relevant files for onboarding a participant. Videos guides to the steps described here are available on this [page](video_tutorial.html). {% include img.html img="Onboarding%20Process.drawio.png" caption="Onboarding Process" width ="60%" %} +### Prerequisites for Onboarding + +Before beginning the onboarding process, please ensure the following tools, permissions, and environment configurations are in place. This checklist is crucial for a seamless setup experience. + +1. **GitHub Account** + - Ensure you have an active **GitHub account** with access to the relevant repositories. + - **Permissions**: Confirm the necessary repository permissions (read/write access if required for pushing commits). + + +2. **OpenSSL** + - Required for generating and managing digital certificates. + - **Minimum Version**: 1.1.1 or higher. + - Verify installation with `openssl version`. + - **Path Configuration**: Ensure OpenSSL is correctly added to the system path for command-line access. + - [Download OpenSSL](https://www.openssl.org/source/) + +3. **cURL** + - Necessary for command-line data transfers, especially useful for API requests. + - **Minimum Version**: 7.68.0 or higher. + - Verify with `curl --version`. + - [Download cURL](https://curl.se/download.html) + +4. **Git** + - Essential for version control and interacting with GitHub repositories. + - **Minimum Version**: 2.28.0 or higher (this version or newer is recommended for improved configuration capabilities). + - Confirm installation with `git --version`. + - [Download Git](https://git-scm.com/downloads) + +5. **Text Editor or IDE** (Optional) + - Use a reliable text editor or IDE such as **Visual Studio Code**, **Sublime Text**, or **Notepad++** for editing files. + - **Extensions**: If using VS Code, consider adding extensions for **Markdown** and **GitHub integration** to ease editing and committing changes. + - [Download Visual Studio Code](https://code.visualstudio.com/) +6. **Network and Firewall Permissions** + - **Network Access**: Ensure network settings allow access to GitHub and other required external resources (e.g., API endpoints). + - **Firewall Permissions**: Verify firewall permissions to avoid connectivity issues during cloning or pushing repositories. + +7. **CLI Tools and Path Configuration** + - Confirm that all tools (e.g., `openssl`, `curl`, `git`) are available in the **system PATH** for easy command-line access. + - **OS Compatibility**: These instructions are applicable for major operating systems (Linux, macOS, Windows). Check OS-specific installation guidelines if needed. + +8. **Environment Configuration** + - **Scripting Language**: If there are any scripts in the onboarding process, ensure the appropriate language interpreter (e.g., **Python** for Python scripts) is installed and configured. + - **Environment Variables**: Set any required environment variables as specified in the onboarding documentation. These might include variables for API keys, tokens, or paths. + +9. **Additional Resources and Documentation** + - Familiarize yourself with any supplementary documentation provided, including **API references**, **security guidelines**, and **data handling policies** as needed for the onboarding process. + +Refer to the [onboarding documentation](https://github.com/WorldHealthOrganization/smart-trust/blob/onboarding_checklist_enhancement/input/pagecontent/concepts_onboarding_checklist.md) for step-by-step instructions and further setup details. @@ -114,13 +162,13 @@ This repository contains the template for building [onboarding](https://github.c > **Disclaimer**: This script is designed to create self-signed certificates solely for non-production environments, such as DEV and UAT, not intended to be used on production environments. To use it, **choose the appropriate script for your operating system**: > ->**Unix/Linux:** Use the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) bash script. +>**Unix/Linux:** Use the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) bash script on [Linux/Unix/MAC](#if-your-operating-systems-is-unixlinuxmac) operating system. > ->**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script. +>**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script on [Windows](#if-your-operating-system-is-windows) operating system. > > These scripts, along with the provided configuration files, serve as guidelines for [certificate preparation](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/README.md) . > -**If your Operating Sysems is Unix/Linux:** +**If your Operating Systems is Unix/Linux/Mac:** > - To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. - Modify the following default certificate parameters as needed: @@ -148,6 +196,7 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat $env:OSSL_LOCALITY_NAME="TEST" $env:OSSL_ORGANIZATION_NAME="WHO" $env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" + $env:OSSL_COMMON_NAME="NationXC_TNP" ``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. @@ -164,7 +213,7 @@ Please note that you need to have [OpenSSL installed](https://slproweb.com/prod ``` - **For Mac/Unix** + **For Mac/Linux/Unix** cd scripts/certgen ./gen_all_certs.sh DN_template.cnf zsh ./gen_all_certs.sh DN_template.cnf ## If you are using Ubuntu OS From a4660c926e54b86e3a3b90017281507bb6c05ccc Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 13 Nov 2024 18:31:04 +0530 Subject: [PATCH 07/31] Update concepts_onboarding_checklist.md correcton in jump section --- input/pagecontent/concepts_onboarding_checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index e7fd9e963..bbc3b8036 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -162,7 +162,8 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati > **Disclaimer**: This script is designed to create self-signed certificates solely for non-production environments, such as DEV and UAT, not intended to be used on production environments. To use it, **choose the appropriate script for your operating system**: > ->**Unix/Linux:** Use the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) bash script on [Linux/Unix/MAC](#if-your-operating-systems-is-unixlinuxmac) operating system. +>**Unix/Linux:** Use the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) bash script on [Linux/Unix/Mac OS](#if-your-operating-systems-is-unixlinuxmac) operating system. +> operating system. > >**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script on [Windows](#if-your-operating-system-is-windows) operating system. > From b8fb97196b72743648dda0751095cfc8578b68fc Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 13 Nov 2024 18:35:37 +0530 Subject: [PATCH 08/31] Update concepts_onboarding_checklist.md correction jump seciton if os is unix/mac --- input/pagecontent/concepts_onboarding_checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index bbc3b8036..05e0b4e81 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -169,7 +169,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati > > These scripts, along with the provided configuration files, serve as guidelines for [certificate preparation](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/README.md) . > -**If your Operating Systems is Unix/Linux/Mac:** +**If your Operating Systems is Unix/Linux/Mac** > - To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. - Modify the following default certificate parameters as needed: @@ -183,7 +183,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati ``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. > -**If your Operating Systems is Windows:** +**If your Operating Systems is Windows** For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script. You can modify the environment variables directly within the script or set them in your current PowerShell session: From c5363aa120b119250f1d89a09e86ee5f9c9e5705 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 13 Nov 2024 18:47:30 +0530 Subject: [PATCH 09/31] Update concepts_onboarding_checklist.md --- input/pagecontent/concepts_onboarding_checklist.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 05e0b4e81..9542f98bb 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -163,13 +163,12 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati > **Disclaimer**: This script is designed to create self-signed certificates solely for non-production environments, such as DEV and UAT, not intended to be used on production environments. To use it, **choose the appropriate script for your operating system**: > >**Unix/Linux:** Use the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) bash script on [Linux/Unix/Mac OS](#if-your-operating-systems-is-unixlinuxmac) operating system. -> operating system. > >**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script on [Windows](#if-your-operating-system-is-windows) operating system. > > These scripts, along with the provided configuration files, serve as guidelines for [certificate preparation](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/README.md) . > -**If your Operating Systems is Unix/Linux/Mac** +#### If your Operating Systems is Unix/Linux/Mac > - To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. - Modify the following default certificate parameters as needed: @@ -183,7 +182,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati ``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. > -**If your Operating Systems is Windows** +#### If your Operating Systems is Windows For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script. You can modify the environment variables directly within the script or set them in your current PowerShell session: From 44757db962314d87794bade466cd1ff97697fef5 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 13 Nov 2024 19:07:29 +0530 Subject: [PATCH 10/31] Update concepts_onboarding_checklist.md Unix script DN_Template.conf parameter updated for export OSSL_COMMON_NAME="NationXC_TNP" --- input/pagecontent/concepts_onboarding_checklist.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 9542f98bb..252cf5d58 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -162,7 +162,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati > **Disclaimer**: This script is designed to create self-signed certificates solely for non-production environments, such as DEV and UAT, not intended to be used on production environments. To use it, **choose the appropriate script for your operating system**: > ->**Unix/Linux:** Use the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) bash script on [Linux/Unix/Mac OS](#if-your-operating-systems-is-unixlinuxmac) operating system. +>**Unix/Linux:** Use the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) bash script on [Linux/Unix/Mac](#if-your-operating-systems-is-unixlinuxmac) operating system. > >**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script on [Windows](#if-your-operating-system-is-windows) operating system. > @@ -179,6 +179,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati export OSSL_LOCALITY_NAME="TEST" export OSSL_ORGANIZATION_NAME="WHO" export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" + export OSSL_COMMON_NAME="NationXC_TNP" ``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. > @@ -196,7 +197,7 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat $env:OSSL_LOCALITY_NAME="TEST" $env:OSSL_ORGANIZATION_NAME="WHO" $env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" - $env:OSSL_COMMON_NAME="NationXC_TNP" + $env:OSSL_COMMON_NAME="NationXC_TNP" ``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. From 679368215b206c18918ec2b9d177c9628a68aa36 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 13 Nov 2024 19:18:36 +0530 Subject: [PATCH 11/31] Update concepts_onboarding_checklist.md - correction in script jump sections - correction in Unix DN_Template.conf for country common name --- input/pagecontent/concepts_onboarding_checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 252cf5d58..d3bea55d3 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -164,7 +164,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati > >**Unix/Linux:** Use the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) bash script on [Linux/Unix/Mac](#if-your-operating-systems-is-unixlinuxmac) operating system. > ->**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script on [Windows](#if-your-operating-system-is-windows) operating system. +>**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script on [Windows](#if-your-operating-systems-is-windows) operating system. > > These scripts, along with the provided configuration files, serve as guidelines for [certificate preparation](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/README.md) . > @@ -179,7 +179,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati export OSSL_LOCALITY_NAME="TEST" export OSSL_ORGANIZATION_NAME="WHO" export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" - export OSSL_COMMON_NAME="NationXC_TNP" + export OSSL_COMMON_NAME="NationXC_TNP" ``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. > From 283e02dbe901a43687bbea0e96f5f742516b1507 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 13 Nov 2024 20:06:02 +0530 Subject: [PATCH 12/31] Update concepts_onboarding_checklist.md - Added > **Save For Later:** for GPG keys , Github Username , GIT repo url , PAT Tocken --- input/pagecontent/concepts_onboarding_checklist.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index d3bea55d3..f1f5e03be 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -2,6 +2,7 @@ This repository contains the template for building [onboarding](https://github.c {% include img.html img="Onboarding%20Process.drawio.png" caption="Onboarding Process" width ="60%" %} ### Prerequisites for Onboarding +> **Save For Later:** Be sure to securely save items like **GPG Keys, Secrets, GitHub usernames**, and **other configurations** as they will be needed in upcoming steps. Before beginning the onboarding process, please ensure the following tools, permissions, and environment configurations are in place. This checklist is crucial for a seamless setup experience. @@ -42,13 +43,11 @@ Before beginning the onboarding process, please ensure the following tools, perm - **OS Compatibility**: These instructions are applicable for major operating systems (Linux, macOS, Windows). Check OS-specific installation guidelines if needed. 8. **Environment Configuration** - - **Scripting Language**: If there are any scripts in the onboarding process, ensure the appropriate language interpreter (e.g., **Python** for Python scripts) is installed and configured. - **Environment Variables**: Set any required environment variables as specified in the onboarding documentation. These might include variables for API keys, tokens, or paths. 9. **Additional Resources and Documentation** - Familiarize yourself with any supplementary documentation provided, including **API references**, **security guidelines**, and **data handling policies** as needed for the onboarding process. -Refer to the [onboarding documentation](https://github.com/WorldHealthOrganization/smart-trust/blob/onboarding_checklist_enhancement/input/pagecontent/concepts_onboarding_checklist.md) for step-by-step instructions and further setup details. @@ -61,6 +60,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati - Click on New - Enter Repository name, follow the convention, it has to contain the ISO 3 letter. All the rest is optional - Click on Create Repository +> **Save For Later:** Be sure to securely save items like **GitHub usernames**, and **Repository Name, URL** as they will be needed in upcoming steps. **Create PAT (Personal Access Token) for Github account if not created already** @@ -69,6 +69,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati - Click on Generate New Token button (Generate New Token classic) - Use Authentication code - Add Note, Expiration, 'Repo' as a scope and click ‘Generate Token’ +> **Save For Later:** Be sure to securely save the **GitHub PAT (Personal Access Token)**, as it will be needed in upcoming steps. ### Local Repository @@ -99,7 +100,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati - Open Git Bash - Generate a GPG key pair. Since there are multiple versions of GPG, you may need to consult the relevant man page to find the appropriate key generation command - If you are on version 2.1.17 or greater, paste the text below to generate a GPG key pair. - + ``` Shell @@ -146,6 +147,7 @@ Refer to the [onboarding documentation](https://github.com/WorldHealthOrganizati gpg --armor --export << replace you actual GPG key ID >> # Prints the GPG key ID, in ASCII armor format ``` + > **Save For Later:** Be sure to securely save the **GPG Key**, as it will be needed in upcoming steps. - Copy your GPG key, beginning with -----BEGIN PGP PUBLIC KEY BLOCK----- and ending with -----END PGP PUBLIC KEY BLOCK-----. - Add the GPG key to your GitHub account. > Please check [Adding GPG key to repository](https://github.com/WorldHealthOrganization/smart-trust/releases/download/v1.1.1/1.3.full-video.v2.mp4) video for reference From f108b201266b80ef796e83b4ecbf1dd1d8b5281a Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:47:32 +0530 Subject: [PATCH 13/31] Update concepts_onboarding_checklist.md - Added pre-requisite table for tools and their requirement prior onboarding process start at country side. - Certificate Generation script(s) correction /enhancement - other small corrections. --- .../concepts_onboarding_checklist.md | 55 +++++-------------- 1 file changed, 13 insertions(+), 42 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index f1f5e03be..39e8f6b64 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -2,54 +2,25 @@ This repository contains the template for building [onboarding](https://github.c {% include img.html img="Onboarding%20Process.drawio.png" caption="Onboarding Process" width ="60%" %} ### Prerequisites for Onboarding -> **Save For Later:** Be sure to securely save items like **GPG Keys, Secrets, GitHub usernames**, and **other configurations** as they will be needed in upcoming steps. Before beginning the onboarding process, please ensure the following tools, permissions, and environment configurations are in place. This checklist is crucial for a seamless setup experience. -1. **GitHub Account** - - Ensure you have an active **GitHub account** with access to the relevant repositories. - - **Permissions**: Confirm the necessary repository permissions (read/write access if required for pushing commits). - - -2. **OpenSSL** - - Required for generating and managing digital certificates. - - **Minimum Version**: 1.1.1 or higher. - - Verify installation with `openssl version`. - - **Path Configuration**: Ensure OpenSSL is correctly added to the system path for command-line access. - - [Download OpenSSL](https://www.openssl.org/source/) - -3. **cURL** - - Necessary for command-line data transfers, especially useful for API requests. - - **Minimum Version**: 7.68.0 or higher. - - Verify with `curl --version`. - - [Download cURL](https://curl.se/download.html) - -4. **Git** - - Essential for version control and interacting with GitHub repositories. - - **Minimum Version**: 2.28.0 or higher (this version or newer is recommended for improved configuration capabilities). - - Confirm installation with `git --version`. - - [Download Git](https://git-scm.com/downloads) - -5. **Text Editor or IDE** (Optional) - - Use a reliable text editor or IDE such as **Visual Studio Code**, **Sublime Text**, or **Notepad++** for editing files. - - **Extensions**: If using VS Code, consider adding extensions for **Markdown** and **GitHub integration** to ease editing and committing changes. - - [Download Visual Studio Code](https://code.visualstudio.com/) -6. **Network and Firewall Permissions** - - **Network Access**: Ensure network settings allow access to GitHub and other required external resources (e.g., API endpoints). - - **Firewall Permissions**: Verify firewall permissions to avoid connectivity issues during cloning or pushing repositories. - -7. **CLI Tools and Path Configuration** - - Confirm that all tools (e.g., `openssl`, `curl`, `git`) are available in the **system PATH** for easy command-line access. - - **OS Compatibility**: These instructions are applicable for major operating systems (Linux, macOS, Windows). Check OS-specific installation guidelines if needed. - -8. **Environment Configuration** - - **Environment Variables**: Set any required environment variables as specified in the onboarding documentation. These might include variables for API keys, tokens, or paths. - -9. **Additional Resources and Documentation** - - Familiarize yourself with any supplementary documentation provided, including **API references**, **security guidelines**, and **data handling policies** as needed for the onboarding process. +| **Tools/Requirement** | **Description** | +|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **GitHub Account** | - Ensure you have an active GitHub account with access to the relevant repositories.
- **Permissions**: Confirm the necessary repository permissions (read/write access if required for pushing commits). | +| **OpenSSL** | - Required for generating and managing digital certificates.
- **Minimum Version**: 1.1.1 or higher.
- **Verify**: `openssl version`.
- **Path Configuration**: Ensure OpenSSL is correctly added to the system path.
- [Download OpenSSL](https://www.openssl.org/source/) | +| **cURL** | - Necessary for command-line data transfers, especially useful for API requests.
- **Minimum Version**: 7.68.0 or higher.
- **Verify**: `curl --version`.
- [Download cURL](https://curl.se/download.html) | +| **Git** | - Essential for version control and interacting with GitHub repositories.
- **Minimum Version**: 2.28.0 or higher (recommended for improved configuration capabilities).
- **Verify**: `git --version`.
- [Download Git](https://git-scm.com/downloads) | +| **Text Editor or IDE (Optional)** | - Use a reliable text editor or IDE such as **Visual Studio Code**, **Sublime Text**, or **Notepad++** for editing files.
- **Extensions**: If using VS Code, consider adding extensions for Markdown and GitHub integration.
- [Download Visual Studio Code](https://code.visualstudio.com/) | +| **Network and Firewall Permissions** | - **Network Access**: Ensure network settings allow access to GitHub and other required external resources (e.g., API endpoints).
- **Firewall Permissions**: Verify firewall permissions to avoid connectivity issues. | +| **CLI Tools and Path Configuration** | - Confirm that all tools (e.g., `openssl`, `curl`, `git`) are available in the **system PATH** for easy command-line access.
- **OS Compatibility**: These instructions are applicable for Linux, macOS, and Windows. | +| **Environment Configuration** | - **Scripting Language**: Ensure the appropriate language interpreter (e.g., **Python** for Python scripts) is installed and configured.
- **Environment Variables**: Set required environment variables (e.g., API keys, tokens, or paths) as specified. | +| **Additional Resources and Documentation** | - Familiarize yourself with supplementary documentation, including API references, security guidelines, and data handling policies needed for the onboarding process. | +> **Save For Later:** Be sure to securely save items like **GPG Keys, Secrets, GitHub usernames, GitHub Repository URL, GitHub PAT (Personal Access Token)**, and **other configurations** as they will be needed in upcoming steps. +### Steps to Follow: ### Git Repository From e7c4c0bb5b5582cdaaf5a142fcde963843861319 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Thu, 14 Nov 2024 15:07:06 +0530 Subject: [PATCH 14/31] Update concepts_onboarding_checklist.md --- input/pagecontent/concepts_onboarding_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 39e8f6b64..8c640a0ff 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -14,7 +14,7 @@ Before beginning the onboarding process, please ensure the following tools, perm | **Text Editor or IDE (Optional)** | - Use a reliable text editor or IDE such as **Visual Studio Code**, **Sublime Text**, or **Notepad++** for editing files.
- **Extensions**: If using VS Code, consider adding extensions for Markdown and GitHub integration.
- [Download Visual Studio Code](https://code.visualstudio.com/) | | **Network and Firewall Permissions** | - **Network Access**: Ensure network settings allow access to GitHub and other required external resources (e.g., API endpoints).
- **Firewall Permissions**: Verify firewall permissions to avoid connectivity issues. | | **CLI Tools and Path Configuration** | - Confirm that all tools (e.g., `openssl`, `curl`, `git`) are available in the **system PATH** for easy command-line access.
- **OS Compatibility**: These instructions are applicable for Linux, macOS, and Windows. | -| **Environment Configuration** | - **Scripting Language**: Ensure the appropriate language interpreter (e.g., **Python** for Python scripts) is installed and configured.
- **Environment Variables**: Set required environment variables (e.g., API keys, tokens, or paths) as specified. | +| **Environment Configuration** | - **Environment Variables**: Set required environment variables (e.g., API keys, tokens, or paths) as specified. | | **Additional Resources and Documentation** | - Familiarize yourself with supplementary documentation, including API references, security guidelines, and data handling policies needed for the onboarding process. | > **Save For Later:** Be sure to securely save items like **GPG Keys, Secrets, GitHub usernames, GitHub Repository URL, GitHub PAT (Personal Access Token)**, and **other configurations** as they will be needed in upcoming steps. From adff37c455bc07ac8c5bad51b7fee31cf6b05ff0 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Fri, 15 Nov 2024 15:29:01 +0530 Subject: [PATCH 15/31] Update concepts_onboarding_checklist.md Prerequisite type changed to HTML format to support on smart-trust site --- .../concepts_onboarding_checklist.md | 92 ++++++++++++++++--- 1 file changed, 81 insertions(+), 11 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 8c640a0ff..6d08ea339 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -5,17 +5,87 @@ This repository contains the template for building [onboarding](https://github.c Before beginning the onboarding process, please ensure the following tools, permissions, and environment configurations are in place. This checklist is crucial for a seamless setup experience. -| **Tools/Requirement** | **Description** | -|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **GitHub Account** | - Ensure you have an active GitHub account with access to the relevant repositories.
- **Permissions**: Confirm the necessary repository permissions (read/write access if required for pushing commits). | -| **OpenSSL** | - Required for generating and managing digital certificates.
- **Minimum Version**: 1.1.1 or higher.
- **Verify**: `openssl version`.
- **Path Configuration**: Ensure OpenSSL is correctly added to the system path.
- [Download OpenSSL](https://www.openssl.org/source/) | -| **cURL** | - Necessary for command-line data transfers, especially useful for API requests.
- **Minimum Version**: 7.68.0 or higher.
- **Verify**: `curl --version`.
- [Download cURL](https://curl.se/download.html) | -| **Git** | - Essential for version control and interacting with GitHub repositories.
- **Minimum Version**: 2.28.0 or higher (recommended for improved configuration capabilities).
- **Verify**: `git --version`.
- [Download Git](https://git-scm.com/downloads) | -| **Text Editor or IDE (Optional)** | - Use a reliable text editor or IDE such as **Visual Studio Code**, **Sublime Text**, or **Notepad++** for editing files.
- **Extensions**: If using VS Code, consider adding extensions for Markdown and GitHub integration.
- [Download Visual Studio Code](https://code.visualstudio.com/) | -| **Network and Firewall Permissions** | - **Network Access**: Ensure network settings allow access to GitHub and other required external resources (e.g., API endpoints).
- **Firewall Permissions**: Verify firewall permissions to avoid connectivity issues. | -| **CLI Tools and Path Configuration** | - Confirm that all tools (e.g., `openssl`, `curl`, `git`) are available in the **system PATH** for easy command-line access.
- **OS Compatibility**: These instructions are applicable for Linux, macOS, and Windows. | -| **Environment Configuration** | - **Environment Variables**: Set required environment variables (e.g., API keys, tokens, or paths) as specified. | -| **Additional Resources and Documentation** | - Familiarize yourself with supplementary documentation, including API references, security guidelines, and data handling policies needed for the onboarding process. | +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Tools/RequirementDescription
GitHub Account + - Ensure you have an active GitHub account with access to the relevant repositories.
+ - Permissions: Confirm the necessary repository permissions (read/write access if required for pushing commits). +
OpenSSL + - Required for generating and managing digital certificates.
+ - Minimum Version: 1.1.1 or higher.
+ - Verify: openssl version.
+ - Path Configuration: Ensure OpenSSL is correctly added to the system path.
+ - Download OpenSSL +
cURL + - Necessary for command-line data transfers, especially useful for API requests.
+ - Minimum Version: 7.68.0 or higher.
+ - Verify: curl --version.
+ - Download cURL +
Git + - Essential for version control and interacting with GitHub repositories.
+ - Minimum Version: 2.28.0 or higher (recommended for improved configuration capabilities).
+ - Verify: git --version.
+ - Download Git +
Text Editor or IDE (Optional) + - Use a reliable text editor or IDE such as Visual Studio Code, Sublime Text, or Notepad++ for editing files.
+ - Extensions: If using VS Code, consider adding extensions for Markdown and GitHub integration.
+ - Download Visual Studio Code +
Network and Firewall Permissions + - Network Access: Ensure network settings allow access to GitHub and other required external resources (e.g., API endpoints).
+ - Firewall Permissions: Verify firewall permissions to avoid connectivity issues. +
CLI Tools and Path Configuration + - Confirm that all tools (e.g., openssl, curl, git) are available in the system PATH for easy command-line access.
+ - OS Compatibility: These instructions are applicable for Linux, macOS, and Windows. +
Environment Configuration + - Environment Variables: Set required environment variables (e.g., API keys, tokens, or paths) as specified. +
Additional Resources and Documentation + - Familiarize yourself with supplementary documentation, including API references, security guidelines, and data handling policies needed for the onboarding process. +
+
> **Save For Later:** Be sure to securely save items like **GPG Keys, Secrets, GitHub usernames, GitHub Repository URL, GitHub PAT (Personal Access Token)**, and **other configurations** as they will be needed in upcoming steps. From 0dbecef848fbef11019f1817add952a828b96018 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Fri, 15 Nov 2024 15:34:29 +0530 Subject: [PATCH 16/31] Update concepts_onboarding_checklist.md --- input/pagecontent/concepts_onboarding_checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 6d08ea339..9ca2427c9 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -5,15 +5,15 @@ This repository contains the template for building [onboarding](https://github.c Before beginning the onboarding process, please ensure the following tools, permissions, and environment configurations are in place. This checklist is crucial for a seamless setup experience. -
+
- + - + - + From be859dd53be548c61b382627a07d5a8a7a7ef3a9 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Fri, 15 Nov 2024 15:56:22 +0530 Subject: [PATCH 18/31] Update concepts_onboarding_checklist.md correction in pre-requisite table --- input/pagecontent/concepts_onboarding_checklist.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index b041b11bf..bd596e328 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -78,7 +78,7 @@ Before beginning the onboarding process, please ensure the following tools, perm - + @@ -87,6 +87,7 @@ Before beginning the onboarding process, please ensure the following tools, perm
Tools/Requirement Description
GitHub Account From 3605927a0c85b22675d81ace5dd17ebe719b1b3b Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Fri, 15 Nov 2024 15:35:52 +0530 Subject: [PATCH 17/31] Update concepts_onboarding_checklist.md --- input/pagecontent/concepts_onboarding_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 9ca2427c9..b041b11bf 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -78,7 +78,7 @@ Before beginning the onboarding process, please ensure the following tools, perm
Additional Resources and Documentationtestn - Familiarize yourself with supplementary documentation, including API references, security guidelines, and data handling policies needed for the onboarding process.
testnAdditional Resources and Documentation - Familiarize yourself with supplementary documentation, including API references, security guidelines, and data handling policies needed for the onboarding process.
+ > **Save For Later:** Be sure to securely save items like **GPG Keys, Secrets, GitHub usernames, GitHub Repository URL, GitHub PAT (Personal Access Token)**, and **other configurations** as they will be needed in upcoming steps. @@ -101,6 +102,7 @@ Before beginning the onboarding process, please ensure the following tools, perm - Click on New - Enter Repository name, follow the convention, it has to contain the ISO 3 letter. All the rest is optional - Click on Create Repository + > **Save For Later:** Be sure to securely save items like **GitHub usernames**, and **Repository Name, URL** as they will be needed in upcoming steps. From c2dc84009e0e6004360603d18933b20033cdbfe0 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Fri, 15 Nov 2024 16:31:55 +0530 Subject: [PATCH 19/31] Update concepts_onboarding_checklist.md Fomatting correction --- .../concepts_onboarding_checklist.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index bd596e328..6f7ea6574 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -212,11 +212,12 @@ Before beginning the onboarding process, please ensure the following tools, perm >**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script on [Windows](#if-your-operating-systems-is-windows) operating system. > > These scripts, along with the provided configuration files, serve as guidelines for [certificate preparation](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/README.md) . -> + + #### If your Operating Systems is Unix/Linux/Mac > - To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. -- Modify the following default certificate parameters as needed: +- Modify the following default certificate parameters as needed: q ``` export OSSL_COUNTRY_NAME="XC" @@ -226,10 +227,12 @@ Before beginning the onboarding process, please ensure the following tools, perm export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" export OSSL_COMMON_NAME="NationXC_TNP" ``` -> Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. > -#### If your Operating Systems is Windows +> Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. + +#### If your Operating Systems is Windows +> For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script. You can modify the environment variables directly within the script or set them in your current PowerShell session: 1.Open PowerShell on your Windows machine. @@ -244,15 +247,17 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat $env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" $env:OSSL_COMMON_NAME="NationXC_TNP" ``` - + > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. Please note that you need to have [OpenSSL installed](https://slproweb.com/products/Win32OpenSSL.html) (e.g. Win64 OpenSSL v3.3.0 Light) and added to your PATH environment variable. Also you may need allow the execution by setting an execution policy. ``` Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process - ``` + ``` + **How to Run Script :** + - Once you execute the script. It will generate all certificates and keys in a subfolder named by current datetime. - **Notes**: While execution of "gen_all_certs.sh" script on **Unix/Linux Operating System,** Please provide script argument "DN_template.cnf" file which consists of country related information to generate all required certificates (TLS,SCA,UP) @@ -268,6 +273,8 @@ Please note that you need to have [OpenSSL installed](https://slproweb.com/prod cd scripts/certgen ./gen_all_certs.ps1 ``` + + This setup generates all required certificates (TLS, SCA, UP) and keys in a timestamped subfolder, based on the configuration specified in DN_template.cnf for Unix/Linux and the environment variables set in the current PowerShell session for Windows. **Prepare Folders** From 14d31be96ff24ae589c85d3fe1b88f1643412cb6 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Fri, 15 Nov 2024 16:54:54 +0530 Subject: [PATCH 20/31] Update concepts_onboarding_checklist.md formatting correction --- input/pagecontent/concepts_onboarding_checklist.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 6f7ea6574..c9c6df7be 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -211,13 +211,15 @@ Before beginning the onboarding process, please ensure the following tools, perm > >**Windows:** Use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.ps1) PowerShell script on [Windows](#if-your-operating-systems-is-windows) operating system. > -> These scripts, along with the provided configuration files, serve as guidelines for [certificate preparation](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/README.md) . + +These scripts, along with the provided configuration files, serve as guidelines for [certificate preparation](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/README.md) . #### If your Operating Systems is Unix/Linux/Mac -> +> - To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. -- Modify the following default certificate parameters as needed: q +- Modify the following default certificate parameters as needed: + ``` export OSSL_COUNTRY_NAME="XC" @@ -227,7 +229,7 @@ Before beginning the onboarding process, please ensure the following tools, perm export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" export OSSL_COMMON_NAME="NationXC_TNP" ``` -> + > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. @@ -240,7 +242,7 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat 2.Set the required environment variables. ``` - $env:OSSL_COUNTRY_NAME="XC" + $env:OSSL_COUNTRY_NAME="XC" $env:OSSL_STATE_NAME="Test State" $env:OSSL_LOCALITY_NAME="TEST" $env:OSSL_ORGANIZATION_NAME="WHO" @@ -250,6 +252,7 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. + Please note that you need to have [OpenSSL installed](https://slproweb.com/products/Win32OpenSSL.html) (e.g. Win64 OpenSSL v3.3.0 Light) and added to your PATH environment variable. Also you may need allow the execution by setting an execution policy. ``` @@ -280,6 +283,7 @@ This setup generates all required certificates (TLS, SCA, UP) and keys in a time **Prepare Folders** > Note: keep your private keys safe and secure. Do not share them with anyone. + Copy the generated certificates to the respective folders and change the file names to match the naming convention. For the case of self-signed TLS certificates, the CA.pem is just a copy of the TLS.pem (check to have keyCertSign in the keyUsage). The CA.pem should exist, since it is used to verify the TLS client certificate when connecting to the TNG application. Files to be copied in respective folders are as follows: - SCA.pem -> onboarding/DCC/SCA From 2e8de5fa65e448e0dcef2578083a0e97dc2b2f4c Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Fri, 15 Nov 2024 17:19:41 +0530 Subject: [PATCH 21/31] Update concepts_onboarding_checklist.md formatting changes --- input/pagecontent/concepts_onboarding_checklist.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index c9c6df7be..014f45f0e 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -220,15 +220,15 @@ These scripts, along with the provided configuration files, serve as guidelines - To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. - Modify the following default certificate parameters as needed: - ``` export OSSL_COUNTRY_NAME="XC" export OSSL_STATE_NAME="Test State" export OSSL_LOCALITY_NAME="TEST" export OSSL_ORGANIZATION_NAME="WHO" export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" - export OSSL_COMMON_NAME="NationXC_TNP" + export OSSL_COMMON_NAME="NationXC_TNP ``` + > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. @@ -241,8 +241,9 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat 2.Set the required environment variables. + ``` - $env:OSSL_COUNTRY_NAME="XC" + $env:OSSL_COUNTRY_NAME="XC" $env:OSSL_STATE_NAME="Test State" $env:OSSL_LOCALITY_NAME="TEST" $env:OSSL_ORGANIZATION_NAME="WHO" @@ -250,6 +251,9 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat $env:OSSL_COMMON_NAME="NationXC_TNP" ``` + + + > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. From 24ee2ba6adf5616c1483de1a4892c62a892077cc Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Fri, 15 Nov 2024 17:38:01 +0530 Subject: [PATCH 22/31] Update concepts_onboarding_checklist.md --- .../concepts_onboarding_checklist.md | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 014f45f0e..589eb53b0 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -218,7 +218,8 @@ These scripts, along with the provided configuration files, serve as guidelines #### If your Operating Systems is Unix/Linux/Mac > - To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. -- Modify the following default certificate parameters as needed: +- Modify the following default certificate parameters as needed. + ``` export OSSL_COUNTRY_NAME="XC" @@ -242,18 +243,15 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat 2.Set the required environment variables. - ``` - $env:OSSL_COUNTRY_NAME="XC" - $env:OSSL_STATE_NAME="Test State" - $env:OSSL_LOCALITY_NAME="TEST" - $env:OSSL_ORGANIZATION_NAME="WHO" - $env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" - $env:OSSL_COMMON_NAME="NationXC_TNP" - ``` - - + ``` + $env:OSSL_COUNTRY_NAME="XC" + $env:OSSL_STATE_NAME="Test State" + $env:OSSL_LOCALITY_NAME="TEST" + $env:OSSL_ORGANIZATION_NAME="WHO" + $env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" + $env:OSSL_COMMON_NAME="NationXC_TNP" + ``` - > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. From 48b46795fe94adb9e40d561d2f55c09c900ac5f8 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Fri, 15 Nov 2024 18:06:19 +0530 Subject: [PATCH 23/31] Update concepts_onboarding_checklist.md Formating correction. --- .../concepts_onboarding_checklist.md | 64 +++++++++---------- 1 file changed, 29 insertions(+), 35 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 589eb53b0..8b482e910 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -219,18 +219,15 @@ These scripts, along with the provided configuration files, serve as guidelines > - To customize certificate parameters, update the [DN_template.cnf](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/DN_template.cnf) file, which will be used by the [gen_all_certs.sh](https://github.com/WorldHealthOrganization/tng-participant-template/blob/main/scripts/certgen/gen_all_certs.sh) script. - Modify the following default certificate parameters as needed. - - ``` - export OSSL_COUNTRY_NAME="XC" - export OSSL_STATE_NAME="Test State" - export OSSL_LOCALITY_NAME="TEST" - export OSSL_ORGANIZATION_NAME="WHO" - export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" - export OSSL_COMMON_NAME="NationXC_TNP - ``` - - +``` +export OSSL_COUNTRY_NAME="XC" +export OSSL_STATE_NAME="Test State" +export OSSL_LOCALITY_NAME="TEST" +export OSSL_ORGANIZATION_NAME="WHO" +export OSSL_ORGANIZATIONAL_UNIT_NAME="R&D" +export OSSL_COMMON_NAME="NationXC_TNP +``` > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. @@ -242,42 +239,39 @@ For Windows, use the [gen_all_certs.ps1](https://github.com/WorldHealthOrganizat 2.Set the required environment variables. - - ``` - $env:OSSL_COUNTRY_NAME="XC" - $env:OSSL_STATE_NAME="Test State" - $env:OSSL_LOCALITY_NAME="TEST" - $env:OSSL_ORGANIZATION_NAME="WHO" - $env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" - $env:OSSL_COMMON_NAME="NationXC_TNP" - ``` - +``` +$env:OSSL_COUNTRY_NAME="XC" +$env:OSSL_STATE_NAME="Test State" +$env:OSSL_LOCALITY_NAME="TEST" +$env:OSSL_ORGANIZATION_NAME="WHO" +$env:OSSL_ORGANIZATIONAL_UNIT_NAME="RND" +$env:OSSL_COMMON_NAME="NationXC_TNP" +``` + > Note: OSSL_COUNTRY_NAME should be ISO 2 letter name of the country mapped to the name used in repository. Please note that you need to have [OpenSSL installed](https://slproweb.com/products/Win32OpenSSL.html) (e.g. Win64 OpenSSL v3.3.0 Light) and added to your PATH environment variable. Also you may need allow the execution by setting an execution policy. - ``` - Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process - ``` +``` +Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process +``` **How to Run Script :** - Once you execute the script. It will generate all certificates and keys in a subfolder named by current datetime. - **Notes**: While execution of "gen_all_certs.sh" script on **Unix/Linux Operating System,** Please provide script argument "DN_template.cnf" file which consists of country related information to generate all required certificates (TLS,SCA,UP) - - - ``` - **For Mac/Linux/Unix** - cd scripts/certgen - ./gen_all_certs.sh DN_template.cnf - zsh ./gen_all_certs.sh DN_template.cnf ## If you are using Ubuntu OS +``` +**For Mac/Linux/Unix** +cd scripts/certgen +./gen_all_certs.sh DN_template.cnf ## Provide DN_template.cnf file as a script argument. +zsh ./gen_all_certs.sh DN_template.cnf ## Use this if you are using Zsh on your Ubuntu system. - **For Windows:** - cd scripts/certgen - ./gen_all_certs.ps1 - ``` +**For Windows:** +cd scripts/certgen +./gen_all_certs.ps1 +``` This setup generates all required certificates (TLS, SCA, UP) and keys in a timestamped subfolder, based on the configuration specified in DN_template.cnf for Unix/Linux and the environment variables set in the current PowerShell session for Windows. From 06f0a81fbf2471d67067c9c676a4ba85348b1c68 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Mon, 18 Nov 2024 14:44:27 +0530 Subject: [PATCH 24/31] Update concepts_onboarding_checklist.md - spelling correction - format correction --- input/pagecontent/concepts_onboarding_checklist.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 8b482e910..5e7b7613b 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -112,6 +112,7 @@ Before beginning the onboarding process, please ensure the following tools, perm - Click on Generate New Token button (Generate New Token classic) - Use Authentication code - Add Note, Expiration, 'Repo' as a scope and click ‘Generate Token’ + > **Save For Later:** Be sure to securely save the **GitHub PAT (Personal Access Token)**, as it will be needed in upcoming steps. ### Local Repository @@ -465,7 +466,7 @@ Please be aware that RSA is NOT RECOMMENDED for the DSC and if you want to use R ``` ``` - Output + **OutPut** gpg --list-key /home/test/.gnupg/pubring.kbx ----------------------------- @@ -475,6 +476,7 @@ Please be aware that RSA is NOT RECOMMENDED for the DSC and if you want to use R uid [ultimate] Test User1 (This GPG Key is for XXC test Country) sub rsa4096 2024-09-19 [E] ``` + **Note**: The PUB ID in above output is CD822874C7862BA4BB6B950E40CC62009D9A00B0 , In your case you need to replace with << replace with your Pub ID >> with your actual GPG public key ID to configure Git to use a GPG key for signing commits or tags in next command. @@ -637,7 +639,7 @@ curl -v https://tng-dev.who.int/trustList/DSC/XC --cert TLS.pem --key TLS.key > Note: Some versions of curl don’t attach the client certificates automatically. This can be checked via curl --version Ensure that the used version is linked to OpenSSL. Especially under Windows (https://curl.se/windows/): > -> **Curl verson on Unix/Mac**: We strongly recommend updating curl and nss to newer latest versions for full compatibility with modern cryptographic standards.The outdated version of curl or nss and may not support modern SSL/TLS protocols or elliptic curve cryptography (ECC) cipher suites properly. +> **Curl version on Unix/Mac**: We strongly recommend updating curl and nss to newer latest versions for full compatibility with modern cryptographic standards.The outdated version of curl or nss and may not support modern SSL/TLS protocols or elliptic curve cryptography (ECC) cipher suites properly. From b2db54f96e11a665bc080243d8b818ede0812102 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Mon, 18 Nov 2024 15:00:40 +0530 Subject: [PATCH 25/31] Update concepts_onboarding_checklist.md Formating correction --- input/pagecontent/concepts_onboarding_checklist.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 5e7b7613b..a18b051ad 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -465,8 +465,9 @@ Please be aware that RSA is NOT RECOMMENDED for the DSC and if you want to use R gpg --list-key ``` - ``` - **OutPut** + ``` + OutPut + gpg --list-key /home/test/.gnupg/pubring.kbx ----------------------------- @@ -475,7 +476,7 @@ Please be aware that RSA is NOT RECOMMENDED for the DSC and if you want to use R CD822874C7862BA4BB6B950E40CC62009D9A00B0 uid [ultimate] Test User1 (This GPG Key is for XXC test Country) sub rsa4096 2024-09-19 [E] - ``` + ``` **Note**: The PUB ID in above output is CD822874C7862BA4BB6B950E40CC62009D9A00B0 , In your case you need to replace with << replace with your Pub ID >> with your actual GPG public key ID to configure Git to use a GPG From 3afeea4b8bc6c9a49e2c3ef3afe78e0b13bc6120 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Tue, 19 Nov 2024 13:49:56 +0530 Subject: [PATCH 26/31] Update concepts_onboarding_checklist.md Document Formating --- input/pagecontent/concepts_onboarding_checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index a18b051ad..9391c0903 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -466,17 +466,17 @@ Please be aware that RSA is NOT RECOMMENDED for the DSC and if you want to use R ``` ``` - OutPut + OutPut gpg --list-key /home/test/.gnupg/pubring.kbx ----------------------------- pub rsa4096 2024-09-19 [SC] - CD822874C7862BA4BB6B950E40CC62009D9A00B0 + CD822874C7862BA4BB6B950E40CC62009D9A00B0 uid [ultimate] Test User1 (This GPG Key is for XXC test Country) sub rsa4096 2024-09-19 [E] - ``` + ``` **Note**: The PUB ID in above output is CD822874C7862BA4BB6B950E40CC62009D9A00B0 , In your case you need to replace with << replace with your Pub ID >> with your actual GPG public key ID to configure Git to use a GPG From 311aae1158bbea1d999e9cc22c65b64185c7e486 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Tue, 19 Nov 2024 14:04:19 +0530 Subject: [PATCH 27/31] Update concepts_onboarding_checklist.md correction in how to run script section --- input/pagecontent/concepts_onboarding_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 9391c0903..ca45ae531 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -261,7 +261,7 @@ Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process **How to Run Script :** - Once you execute the script. It will generate all certificates and keys in a subfolder named by current datetime. -- **Notes**: While execution of "gen_all_certs.sh" script on **Unix/Linux Operating System,** Please provide script argument "DN_template.cnf" file which consists of country related information to generate all required certificates (TLS,SCA,UP) +- **Notes**: While execution of "gen_all_certs.sh" script on **Unix/Linux/Mac Operating System,** Please provide script argument "DN_template.cnf" file which consists of country related information to generate all required certificates (TLS,SCA,UP) ``` **For Mac/Linux/Unix** From d6d20551fc465b96dd1d915e3db156e0448d3025 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Tue, 19 Nov 2024 14:21:05 +0530 Subject: [PATCH 28/31] Update concepts_onboarding_checklist.md correction in --key TLS.key part --- input/pagecontent/concepts_onboarding_checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index ca45ae531..3eae40757 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -548,7 +548,7 @@ Signing tags and commits is great, but if you decide to use this in your normal - After onboarding in the DEV/UAT/PROD Environment, check the connectivity with the Trust Network Gateway using its [API](https://smart.who.int/trust/openapi/). This can be achieved with following command: ``` -curl -v https://tng-dev.who.int/trustList --cert TLS.pem --key TLS_key.pem +curl -v https://tng-dev.who.int/trustList --cert TLS.pem --key TLS.key ``` You should see a output like: @@ -629,7 +629,7 @@ curl -v https://tng-dev.who.int/trustList/DSC/XC --cert TLS.pem --key TLS.key - Upload the CMS Package to the Gateway ``` -curl -v -X POST -H "Content-Type: application/cms" --cert TLS.pem --key TLS_key.pem --data @cms.b64 https://tng-dev.who.int/signerCertificate +curl -v -X POST -H "Content-Type: application/cms" --cert TLS.pem --key TLS.key --data @cms.b64 https://tng-dev.who.int/signerCertificate ``` - Download the Trustlist again, and check if your DSC is available. From e81521195e3f985ac23f7ff7709b888a91d2ec3f Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Wed, 20 Nov 2024 17:06:15 +0530 Subject: [PATCH 29/31] Update concepts_onboarding_checklist.md correction in Send an onboarding/participation request section of document --- input/pagecontent/concepts_onboarding_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 3eae40757..41091a3ee 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -533,7 +533,7 @@ Signing tags and commits is great, but if you decide to use this in your normal - Send an onboarding/participation request to gdhcn-support@who.int which contains: - URL of the private repository created as a prerequisite - - The GPG key exported in Step [1.8.6.4](#generate-gpg-key) + - The GPG key ( Beginning with -----BEGIN PGP PUBLIC KEY BLOCK----- and ending with -----END PGP PUBLIC KEY BLOCK-----) exported in Step [1.8.6.4](#generate-gpg-key) ### Validate the connection - Once the confirmation of successful onboarding is received from the TNG Support Team ( gdhcn-support@who.int), please do the following From ce22393db590f49df11e7a84d5d069aa58c23902 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Mon, 25 Nov 2024 14:48:55 +0530 Subject: [PATCH 30/31] Update concepts_onboarding_checklist.md --- input/pagecontent/concepts_onboarding_checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index 41091a3ee..f4c3bced7 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -1,7 +1,7 @@ This repository contains the template for building [onboarding](https://github.com/WorldHealthOrganization/smart-trust/blob/main/input/pagecontent/concepts_onboarding.md) information for the Smart Trust Network Attendees. This includes CSCAs, Auth information, signing information and other relevant files for onboarding a participant. Videos guides to the steps described here are available on this [page](video_tutorial.html). {% include img.html img="Onboarding%20Process.drawio.png" caption="Onboarding Process" width ="60%" %} -### Prerequisites for Onboarding +# Prerequisites for Onboarding Before beginning the onboarding process, please ensure the following tools, permissions, and environment configurations are in place. This checklist is crucial for a seamless setup experience. @@ -188,7 +188,7 @@ Before beginning the onboarding process, please ensure the following tools, perm ``` Shell - gpg --armor --export << replace you actual GPG key ID >> + gpg --armor --export << replace with your actual GPG key ID >> # Prints the GPG key ID, in ASCII armor format ``` > **Save For Later:** Be sure to securely save the **GPG Key**, as it will be needed in upcoming steps. From e0a18703e704c5a90084733a1e63fbf5ee7102a4 Mon Sep 17 00:00:00 2001 From: arajnor99 <153087310+arajnor99@users.noreply.github.com> Date: Mon, 25 Nov 2024 15:41:28 +0530 Subject: [PATCH 31/31] Update concepts_onboarding_checklist.md correction in format - Steps to Be Followed by Participant Country: --- input/pagecontent/concepts_onboarding_checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/input/pagecontent/concepts_onboarding_checklist.md b/input/pagecontent/concepts_onboarding_checklist.md index f4c3bced7..b160b7ee6 100644 --- a/input/pagecontent/concepts_onboarding_checklist.md +++ b/input/pagecontent/concepts_onboarding_checklist.md @@ -1,7 +1,7 @@ This repository contains the template for building [onboarding](https://github.com/WorldHealthOrganization/smart-trust/blob/main/input/pagecontent/concepts_onboarding.md) information for the Smart Trust Network Attendees. This includes CSCAs, Auth information, signing information and other relevant files for onboarding a participant. Videos guides to the steps described here are available on this [page](video_tutorial.html). {% include img.html img="Onboarding%20Process.drawio.png" caption="Onboarding Process" width ="60%" %} -# Prerequisites for Onboarding +**Prerequisites for Onboarding** Before beginning the onboarding process, please ensure the following tools, permissions, and environment configurations are in place. This checklist is crucial for a seamless setup experience. @@ -91,7 +91,7 @@ Before beginning the onboarding process, please ensure the following tools, perm > **Save For Later:** Be sure to securely save items like **GPG Keys, Secrets, GitHub usernames, GitHub Repository URL, GitHub PAT (Personal Access Token)**, and **other configurations** as they will be needed in upcoming steps. -### Steps to Follow: +**Steps to Be Followed by Participant Country:** ### Git Repository