From 94e439a294cbb93cc10353e0ec650d1a386b198b Mon Sep 17 00:00:00 2001 From: Eshan Roy Date: Thu, 5 Dec 2024 12:33:32 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(=5Fnew):=20upload=20gpg=20k?= =?UTF-8?q?ey=20to=20a=20server?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...on-tutorialsidebar-category-tools-82a.json | 4 +- ...te-docs-dev-guide-build-source-md-9dc.json | 4 +- ...docs-dev-guide-deploy-packages-md-043.json | 4 +- .../site-docs-dev-guide-gpg-key-md-89e.json | 12 +- .../site-docs-dev-guide-pkgbuild-md-66e.json | 12 +- .../site-docs-dev-guide-write-md-ec3.json | 4 +- .../version-current-metadata-prop-751.json | 25 +++- .../docusaurus-debug-all-content-673.json | 67 ++++++--- .docusaurus/globalData.json | 5 + .docusaurus/registry.js | 1 + .docusaurus/routes.js | 12 +- .docusaurus/routesChunkNames.json | 10 +- docs/dev_guide/gpg_key.md | 2 +- docs/dev_guide/pkgbuild.md | 2 +- docs/dev_guide/upload_gog_key.md | 134 ++++++++++++++++++ 15 files changed, 246 insertions(+), 52 deletions(-) create mode 100644 docs/dev_guide/upload_gog_key.md diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-tools-82a.json b/.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-tools-82a.json index 7ed0434c..2434d687 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-tools-82a.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/category-documentation-tutorialsidebar-category-tools-82a.json @@ -5,8 +5,8 @@ "permalink": "/documentation/category/tools", "navigation": { "previous": { - "title": "Writing Documentation", - "permalink": "/documentation/dev_guide/write" + "title": "PKGBUILD Template", + "permalink": "/documentation/dev_guide/pkgbuild" }, "next": { "title": "Tool: DNS Enum", diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-build-source-md-9dc.json b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-build-source-md-9dc.json index 027fe8e6..dbe9e91a 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-build-source-md-9dc.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-build-source-md-9dc.json @@ -21,7 +21,7 @@ "permalink": "/documentation/category/developers-guide" }, "next": { - "title": "PKGBUILD Template", - "permalink": "/documentation/dev_guide/pkgbuild" + "title": "Generate GPG Key", + "permalink": "/documentation/dev_guide/gpg_key" } } \ No newline at end of file diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-deploy-packages-md-043.json b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-deploy-packages-md-043.json index 3d3f3a8b..de30a2d3 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-deploy-packages-md-043.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-deploy-packages-md-043.json @@ -17,8 +17,8 @@ }, "sidebar": "tutorialSidebar", "previous": { - "title": "Generate GPG Key", - "permalink": "/documentation/dev_guide/gpg_key" + "title": "Upload Key => Server", + "permalink": "/documentation/dev_guide/upload_gog_key" }, "next": { "title": "Install Keyrings", diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-gpg-key-md-89e.json b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-gpg-key-md-89e.json index 1c5c3051..ba5b5963 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-gpg-key-md-89e.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-gpg-key-md-89e.json @@ -11,17 +11,17 @@ "editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/docs/dev_guide/gpg_key.md", "tags": [], "version": "current", - "sidebarPosition": 3, + "sidebarPosition": 2, "frontMatter": { - "sidebar_position": 3 + "sidebar_position": 2 }, "sidebar": "tutorialSidebar", "previous": { - "title": "PKGBUILD Template", - "permalink": "/documentation/dev_guide/pkgbuild" + "title": "Build From Source", + "permalink": "/documentation/dev_guide/build_source" }, "next": { - "title": "Upload & Deploy Packages", - "permalink": "/documentation/dev_guide/deploy_packages" + "title": "Upload Key => Server", + "permalink": "/documentation/dev_guide/upload_gog_key" } } \ No newline at end of file diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-pkgbuild-md-66e.json b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-pkgbuild-md-66e.json index 0e74cbfe..1af7bc5b 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-pkgbuild-md-66e.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-pkgbuild-md-66e.json @@ -11,17 +11,17 @@ "editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/docs/dev_guide/pkgbuild.md", "tags": [], "version": "current", - "sidebarPosition": 2, + "sidebarPosition": 7, "frontMatter": { - "sidebar_position": 2 + "sidebar_position": 7 }, "sidebar": "tutorialSidebar", "previous": { - "title": "Build From Source", - "permalink": "/documentation/dev_guide/build_source" + "title": "Writing Documentation", + "permalink": "/documentation/dev_guide/write" }, "next": { - "title": "Generate GPG Key", - "permalink": "/documentation/dev_guide/gpg_key" + "title": "Tools", + "permalink": "/documentation/category/tools" } } \ No newline at end of file diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-write-md-ec3.json b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-write-md-ec3.json index 9f3dd1c2..7c109208 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-write-md-ec3.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-dev-guide-write-md-ec3.json @@ -21,7 +21,7 @@ "permalink": "/documentation/dev_guide/install_keyring" }, "next": { - "title": "Tools", - "permalink": "/documentation/category/tools" + "title": "PKGBUILD Template", + "permalink": "/documentation/dev_guide/pkgbuild" } } \ No newline at end of file diff --git a/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json b/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json index 1e186503..f0a1315e 100644 --- a/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json +++ b/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json @@ -304,16 +304,16 @@ }, { "type": "link", - "label": "PKGBUILD Template", - "href": "/documentation/dev_guide/pkgbuild", - "docId": "dev_guide/pkgbuild", + "label": "Generate GPG Key", + "href": "/documentation/dev_guide/gpg_key", + "docId": "dev_guide/gpg_key", "unlisted": false }, { "type": "link", - "label": "Generate GPG Key", - "href": "/documentation/dev_guide/gpg_key", - "docId": "dev_guide/gpg_key", + "label": "Upload Key => Server", + "href": "/documentation/dev_guide/upload_gog_key", + "docId": "dev_guide/upload_gog_key", "unlisted": false }, { @@ -336,6 +336,13 @@ "href": "/documentation/dev_guide/write", "docId": "dev_guide/write", "unlisted": false + }, + { + "type": "link", + "label": "PKGBUILD Template", + "href": "/documentation/dev_guide/pkgbuild", + "docId": "dev_guide/pkgbuild", + "unlisted": false } ], "href": "/documentation/category/developers-guide" @@ -407,6 +414,12 @@ "description": "Snigdha OS has it's own PKGBUILD template for building packages. We follow the the template so that we can maintain the packages in a better way. If you are building packages for Snigdha OS, then it will be a good option to follow the PKGBUILD template.", "sidebar": "tutorialSidebar" }, + "dev_guide/upload_gog_key": { + "id": "dev_guide/upload_gog_key", + "title": "Upload Key => Server", + "description": "🌐 Sending and Receiving GPG Keys Using a Key Server", + "sidebar": "tutorialSidebar" + }, "dev_guide/write": { "id": "dev_guide/write", "title": "Writing Documentation", diff --git a/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json b/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json index 6cf51e07..94788268 100644 --- a/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json +++ b/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json @@ -123,8 +123,8 @@ "permalink": "/documentation/category/developers-guide" }, "next": { - "title": "PKGBUILD Template", - "permalink": "/documentation/dev_guide/pkgbuild" + "title": "Generate GPG Key", + "permalink": "/documentation/dev_guide/gpg_key" } }, { @@ -146,8 +146,8 @@ }, "sidebar": "tutorialSidebar", "previous": { - "title": "Generate GPG Key", - "permalink": "/documentation/dev_guide/gpg_key" + "title": "Upload Key => Server", + "permalink": "/documentation/dev_guide/upload_gog_key" }, "next": { "title": "Install Keyrings", @@ -167,18 +167,18 @@ "editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/docs/dev_guide/gpg_key.md", "tags": [], "version": "current", - "sidebarPosition": 3, + "sidebarPosition": 2, "frontMatter": { - "sidebar_position": 3 + "sidebar_position": 2 }, "sidebar": "tutorialSidebar", "previous": { - "title": "PKGBUILD Template", - "permalink": "/documentation/dev_guide/pkgbuild" + "title": "Build From Source", + "permalink": "/documentation/dev_guide/build_source" }, "next": { - "title": "Upload & Deploy Packages", - "permalink": "/documentation/dev_guide/deploy_packages" + "title": "Upload Key => Server", + "permalink": "/documentation/dev_guide/upload_gog_key" } }, { @@ -221,18 +221,45 @@ "editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/docs/dev_guide/pkgbuild.md", "tags": [], "version": "current", - "sidebarPosition": 2, + "sidebarPosition": 7, "frontMatter": { - "sidebar_position": 2 + "sidebar_position": 7 }, "sidebar": "tutorialSidebar", "previous": { - "title": "Build From Source", - "permalink": "/documentation/dev_guide/build_source" + "title": "Writing Documentation", + "permalink": "/documentation/dev_guide/write" }, "next": { + "title": "Tools", + "permalink": "/documentation/category/tools" + } + }, + { + "id": "dev_guide/upload_gog_key", + "title": "Upload Key => Server", + "description": "🌐 Sending and Receiving GPG Keys Using a Key Server", + "source": "@site/docs/dev_guide/upload_gog_key.md", + "sourceDirName": "dev_guide", + "slug": "/dev_guide/upload_gog_key", + "permalink": "/documentation/dev_guide/upload_gog_key", + "draft": false, + "unlisted": false, + "editUrl": "https://github.com/Snigdha-OS/documentation/tree/master/docs/dev_guide/upload_gog_key.md", + "tags": [], + "version": "current", + "sidebarPosition": 3, + "frontMatter": { + "sidebar_position": 3 + }, + "sidebar": "tutorialSidebar", + "previous": { "title": "Generate GPG Key", "permalink": "/documentation/dev_guide/gpg_key" + }, + "next": { + "title": "Upload & Deploy Packages", + "permalink": "/documentation/dev_guide/deploy_packages" } }, { @@ -258,8 +285,8 @@ "permalink": "/documentation/dev_guide/install_keyring" }, "next": { - "title": "Tools", - "permalink": "/documentation/category/tools" + "title": "PKGBUILD Template", + "permalink": "/documentation/dev_guide/pkgbuild" } }, { @@ -1280,11 +1307,11 @@ }, { "type": "doc", - "id": "dev_guide/pkgbuild" + "id": "dev_guide/gpg_key" }, { "type": "doc", - "id": "dev_guide/gpg_key" + "id": "dev_guide/upload_gog_key" }, { "type": "doc", @@ -1297,6 +1324,10 @@ { "type": "doc", "id": "dev_guide/write" + }, + { + "type": "doc", + "id": "dev_guide/pkgbuild" } ], "link": { diff --git a/.docusaurus/globalData.json b/.docusaurus/globalData.json index d78cb90e..ae9eef76 100644 --- a/.docusaurus/globalData.json +++ b/.docusaurus/globalData.json @@ -50,6 +50,11 @@ "path": "/documentation/dev_guide/pkgbuild", "sidebar": "tutorialSidebar" }, + { + "id": "dev_guide/upload_gog_key", + "path": "/documentation/dev_guide/upload_gog_key", + "sidebar": "tutorialSidebar" + }, { "id": "dev_guide/write", "path": "/documentation/dev_guide/write", diff --git a/.docusaurus/registry.js b/.docusaurus/registry.js index 6db1af4b..2f71c7b1 100644 --- a/.docusaurus/registry.js +++ b/.docusaurus/registry.js @@ -39,6 +39,7 @@ export default { "content---documentation-dev-guide-gpg-key-89-e-a96": [() => import(/* webpackChunkName: "content---documentation-dev-guide-gpg-key-89-e-a96" */ "@site/docs/dev_guide/gpg_key.md"), "@site/docs/dev_guide/gpg_key.md", require.resolveWeak("@site/docs/dev_guide/gpg_key.md")], "content---documentation-dev-guide-install-keyring-404-6d6": [() => import(/* webpackChunkName: "content---documentation-dev-guide-install-keyring-404-6d6" */ "@site/docs/dev_guide/install_keyring.md"), "@site/docs/dev_guide/install_keyring.md", require.resolveWeak("@site/docs/dev_guide/install_keyring.md")], "content---documentation-dev-guide-pkgbuild-66-e-684": [() => import(/* webpackChunkName: "content---documentation-dev-guide-pkgbuild-66-e-684" */ "@site/docs/dev_guide/pkgbuild.md"), "@site/docs/dev_guide/pkgbuild.md", require.resolveWeak("@site/docs/dev_guide/pkgbuild.md")], + "content---documentation-dev-guide-upload-gog-keya-6-f-008": [() => import(/* webpackChunkName: "content---documentation-dev-guide-upload-gog-keya-6-f-008" */ "@site/docs/dev_guide/upload_gog_key.md"), "@site/docs/dev_guide/upload_gog_key.md", require.resolveWeak("@site/docs/dev_guide/upload_gog_key.md")], "content---documentation-dev-guide-writeec-3-564": [() => import(/* webpackChunkName: "content---documentation-dev-guide-writeec-3-564" */ "@site/docs/dev_guide/write.md"), "@site/docs/dev_guide/write.md", require.resolveWeak("@site/docs/dev_guide/write.md")], "content---documentation-installation-download-snigdha-os-34-e-4c4": [() => import(/* webpackChunkName: "content---documentation-installation-download-snigdha-os-34-e-4c4" */ "@site/docs/installation/download_snigdha_os.md"), "@site/docs/installation/download_snigdha_os.md", require.resolveWeak("@site/docs/installation/download_snigdha_os.md")], "content---documentation-installation-live-env-795-073": [() => import(/* webpackChunkName: "content---documentation-installation-live-env-795-073" */ "@site/docs/installation/live_env.md"), "@site/docs/installation/live_env.md", require.resolveWeak("@site/docs/installation/live_env.md")], diff --git a/.docusaurus/routes.js b/.docusaurus/routes.js index 46335696..0ec72f0e 100644 --- a/.docusaurus/routes.js +++ b/.docusaurus/routes.js @@ -79,15 +79,15 @@ export default [ }, { path: '/documentation/', - component: ComponentCreator('/documentation/', 'f13'), + component: ComponentCreator('/documentation/', '117'), routes: [ { path: '/documentation/', - component: ComponentCreator('/documentation/', '7bb'), + component: ComponentCreator('/documentation/', 'f55'), routes: [ { path: '/documentation/', - component: ComponentCreator('/documentation/', 'b4c'), + component: ComponentCreator('/documentation/', 'e93'), routes: [ { path: '/documentation/before_installation/imporatnt_notes', @@ -191,6 +191,12 @@ export default [ exact: true, sidebar: "tutorialSidebar" }, + { + path: '/documentation/dev_guide/upload_gog_key', + component: ComponentCreator('/documentation/dev_guide/upload_gog_key', '899'), + exact: true, + sidebar: "tutorialSidebar" + }, { path: '/documentation/dev_guide/write', component: ComponentCreator('/documentation/dev_guide/write', '856'), diff --git a/.docusaurus/routesChunkNames.json b/.docusaurus/routesChunkNames.json index 3a01d22d..9b36e487 100644 --- a/.docusaurus/routesChunkNames.json +++ b/.docusaurus/routesChunkNames.json @@ -113,17 +113,17 @@ }, "content": "content---documentation-privacy-policyfbb-0dc" }, - "/documentation/-f13": { + "/documentation/-117": { "__comp": "__comp---theme-docs-root-5-e-9-0b6", "__context": { "plugin": "plugin---documentation-ed-9-690" } }, - "/documentation/-7bb": { + "/documentation/-f55": { "__comp": "__comp---theme-doc-version-roota-7-b-5de", "version": "version---documentation-935-548" }, - "/documentation/-b4c": { + "/documentation/-e93": { "__comp": "__comp---theme-doc-roota-94-67a" }, "/documentation/before_installation/imporatnt_notes-89a": { @@ -194,6 +194,10 @@ "__comp": "__comp---theme-doc-item-178-a40", "content": "content---documentation-dev-guide-pkgbuild-66-e-684" }, + "/documentation/dev_guide/upload_gog_key-899": { + "__comp": "__comp---theme-doc-item-178-a40", + "content": "content---documentation-dev-guide-upload-gog-keya-6-f-008" + }, "/documentation/dev_guide/write-856": { "__comp": "__comp---theme-doc-item-178-a40", "content": "content---documentation-dev-guide-writeec-3-564" diff --git a/docs/dev_guide/gpg_key.md b/docs/dev_guide/gpg_key.md index 96238bed..287b1add 100644 --- a/docs/dev_guide/gpg_key.md +++ b/docs/dev_guide/gpg_key.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 2 --- # Generate GPG Key ### 🔐 How to Generate a GPG Key on Snigdha OS diff --git a/docs/dev_guide/pkgbuild.md b/docs/dev_guide/pkgbuild.md index f5f43bcd..5f84edde 100644 --- a/docs/dev_guide/pkgbuild.md +++ b/docs/dev_guide/pkgbuild.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 7 --- # PKGBUILD Template Snigdha OS has it's own `PKGBUILD` template for building packages. We follow the the template so that we can maintain the packages in a better way. If you are building packages for Snigdha OS, then it will be a good option to follow the `PKGBUILD` template. diff --git a/docs/dev_guide/upload_gog_key.md b/docs/dev_guide/upload_gog_key.md new file mode 100644 index 00000000..0d8ddbd2 --- /dev/null +++ b/docs/dev_guide/upload_gog_key.md @@ -0,0 +1,134 @@ +--- +sidebar_position: 3 +--- +# Upload Key => Server + +### 🌐 Sending and Receiving GPG Keys Using a Key Server + +Key servers are repositories for sharing and retrieving GPG public keys. They make it easy to distribute your public key and fetch others’ keys for verifying signatures or encrypted communications. Here's how to send and receive GPG keys to/from a key server. + +--- + +### 1️⃣ **Send (Upload) Your Public Key to a Key Server** + +#### A. **Export Your Key's Fingerprint** + +First, identify your key by its fingerprint. List your GPG keys: + +```bash +gpg --list-keys +``` + +Example output: + +```plaintext +pub rsa4096 2023-12-05 [SC] + A41886F639658CA1A5519426E1415F19F21171F2 +uid [ultimate] Eshan Roy +sub rsa4096 2023-12-05 [E] +``` + +Copy the key ID or fingerprint (e.g., `A41886F639658CA1A5519426E1415F19F21171F2`). + +#### B. **Send the Key to a Key Server** + +Use the following command to upload your public key to a key server: + +```bash +gpg --keyserver hkp://keyserver.ubuntu.com --send-keys A41886F639658CA1A5519426E1415F19F21171F2 +``` + +- Replace `hkp://keyserver.ubuntu.com` with your preferred key server (e.g., `keys.openpgp.org`). +- Replace the key ID with your actual key ID or fingerprint. + +If successful, your public key is now available on the key server for others to retrieve. + +--- + +### 2️⃣ **Receive (Download) a Public Key from a Key Server** + +#### A. **Search for a Key by Email or Key ID** + +If you know the email address or key ID of the person whose key you need, search for it: + +```bash +gpg --keyserver hkp://keyserver.ubuntu.com --search-keys eshanized@example.com +``` + +You’ll see a list of matching keys. Example: + +```plaintext +(1) Eshan Roy + A41886F639658CA1A5519426E1415F19F21171F2 +(2) John X. Doe + 1234EFGH5678IJKL9012MNOP3456QRST7890ABCD +``` + +Choose the appropriate key by typing its number (e.g., `1`) and pressing Enter. + +#### B. **Receive the Key Directly by Key ID** + +If you already know the key ID or fingerprint: + +```bash +gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys A41886F639658CA1A5519426E1415F19F21171F2 +``` + +The public key will be downloaded and added to your keyring. + +--- + +### 3️⃣ **Verify the Downloaded Key** + +After receiving a key, verify its details to ensure it belongs to the correct person: + +```bash +gpg --list-keys +``` + +Check the `uid` (user ID) and ensure it matches the expected email or name. + +--- + +### 4️⃣ **Sign a Received Key (Optional)** + +If you trust the key’s owner, you can sign the key to indicate trust: + +```bash +gpg --sign-key A41886F639658CA1A5519426E1415F19F21171F2 +``` + +This adds your signature to their key and shows others you vouch for its authenticity. + +--- + +### 5️⃣ **Synchronize Keys with a Key Server** + +If the key is updated (e.g., new subkeys added), synchronize it with the server: + +```bash +gpg --refresh-keys +``` + +This ensures you have the latest version of all keys in your keyring. + +--- + +### 6️⃣ **Tips for Key Server Usage** + +- **Choose a Reliable Key Server**: Common servers include: + - `hkp://keyserver.ubuntu.com` + - `hkp://keys.openpgp.org` + - `hkp://pgp.mit.edu` +- **Use TLS for Security**: + Some key servers support HTTPS for secure communication: + ```bash + gpg --keyserver hkps://keys.openpgp.org --send-keys A41886F639658CA1A5519426E1415F19F21171F2 + ``` + +- **Update Regularly**: + Synchronize your keyring periodically to stay current with any changes or revocations. + +--- + +By following these steps, you can efficiently share your GPG public key and fetch others' keys for secure communication and verification. 🎉 \ No newline at end of file