Skip to main content

How to setup GPG keys in windows and configure the public key in github

GPG

In this post today, we are going to look into the steps that we need to follow to generate and use a gpg key with github

Below given are the steps

Installation

Install GnuPG for windows

Validation of Installation

Run the below command to verify if gpg is installed and working fine

gpg --version

Generate GPG key

gpg --full-generate-key

Running the above command will start running a command line wizard or sequence of steps,
Choose the right length of the key
Provide your username and email address
Also provide a comment (Optional)
Once done, approve with "O"
Then the system will prompt for Key phrase, which will be used to secure the keys, so please remember and provide a secure value

Listing the key

List the keys that were generated as a result of the previous command using the below command 

gpg --list-secret-keys --keyid-format=long
This command will produce a similar output
gpg --list-secret-keys --keyid-format=long
--------------------------------
pub   2048R/35F5FFB2 2016-04-23
uid                  name (New key) <name@mail.com>
sub   2048R/112A8C2D 2016-04-23

In the above output, we have 35F5FFB2 as the [short-key] that will be used in the commands below 

Export the key in ASCII armor format

gpg --armor --export 35F5FFB2

This command will produce an output like the one given below

-----BEGIN PGP PUBLIC KEY BLOCK-----
[key]
-----END PGP PUBLIC KEY BLOCK-----


Here, the [key] will be the real key which is used to identify and verify the commits that were signed from the local environment.

Github Add GPG Keys

In order to add the above key to your github account, please follow as per this link
Basically, the steps are Login to github.com > click on the user profile icon on the top right corner > settings > SSH and GPG keys > Add GPG key > Paste and submit

git configuration

Execute the below given commands to setup the git configuration to use the GPG keys for signing the commits to github

git config --global user.signingkey 35F5FFB2
git config --global commit.gpgsign true
git config --global gpg.program "C:/Program Files (x86)/gnupg/bin/gpg"

In case gpg is installed in a different path, please update the gpg.program value in the last line in the command given above

gpg agent status check

As a last step, ensure that the gpg-agent  is up and running by executing the below command 

gpg-agent --version

Final .gitconfig verification

In order to verify if the git configurations are rightly applied, find and open the .gitconfig file normally present in the c:\users\username\.gitconfig

The file contents will have values closer to the below given sample

[user]
    name = Your Name
    email = your@email.com
    signingkey = 35F5FFB2
[commit]
    gpgsign = true
[gpg]
    program = C:/Program Files (x86)/gnupg/bin/gpg

This concludes the configuration. We can validate this by performing below steps
git clone -b <branch_name> <git_url>
update any file
git commit -m "GPG signing validation"

In the above command, if there is no errors, we can can be sure that the gpg configuration is working fine. Post which we can execute the git push command to sync local changes to the server.

In this process, if the gpg-agent needs to be restarted to validate if any errors or to restart for safe running, we can use below command

gpg-connect-agent reloadagent /bye

The above configuration also works with Tortoise git, which I have validated as on date of writing this blog [12th May, 2022]
Labels:

Comments

Post a Comment

Popular posts from this blog

User Authentication schemes in a Multi-Tenant SaaS Application

User Authentication in Multi-Tenant SaaS Apps Introduction We will cover few scenarios that we can follow to perform the user authentication in a Multi-Tenant SaaS application. Scenario 1 - Global Users Authentication with Tenancy and Tenant forwarding In this scheme, we have the SaaS Provider Authentication gateway that takes care of Authentication of the users by performing the following steps Tenant Identification User Authentication User Authorization Forwarding the user to the tenant application / tenant pages in the SaaS App This demands that the SaaS provider authentication gateway be a scalable microservice that can take care of the load across all tenants. The database partitioning (horizontal or other means) is left upto the SaaS provider Service. Scenario 2 - Global Tenant Identification and User Authentication forwarding   In the above scenario, the tenant identification happens on part of the SaaS provider Tenant Identification gateway. Post which, ...
Post a Comment
Read more

Handling exceptions in the Executor service threads in Java

Introduction This is a continuation post on the exception handling strategies in the threads in Java. For Introduction, please read this post The second post is available here This post addresses the problem statement "How to use the exception handlers in the threads spawned by the Executor Service in Java?" Not all times, we will be using Thread  classes to run our threads because we have to manage a lot of the underlying logic for managing threads. There is ExecutorService in Java which comes to the rescue for the above problem. In the previous posts, we have discussed on how to handle the exceptions in plain threads. However, when using executor service, we do not create / manage threads, so how do we handle exception in this case. We have a ThreadFactory   as an argument which can be used to customize the way threads are created for use within the ExecutorService . The below snippet of code leverages this feature to illustrate the exception handling, wherein we creat...
Post a Comment
Read more

Download CSV file using JavaScript fetch API

Downloading a CSV File from an API Using JavaScript Fetch API: A Step-by-Step Guide Introduction: Downloading files from an API is a common task in web development. This article walks you through the process of downloading a CSV file from an API using the Fetch API in JavaScript. We'll cover the basics of making API requests and handling file downloads, complete with a sample code snippet. Prerequisites: Ensure you have a basic understanding of JavaScript and web APIs. No additional libraries are required for this tutorial. Step 1: Creating the HTML Structure: Start by creating a simple HTML structure that includes a button to initiate the file download. <!DOCTYPE html> < html lang = "en" > < head > < meta charset = "UTF-8" > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" > < title > CSV File Download </ title > </ head > < body > ...
Post a Comment
Read more

SFTP and File Upload in SFTP using C# and Tamir. SShSharp

The right choice of SFTP Server for Windows OS Follow the following steps, 1. Download the server version from here . The application is here 2. Provide the Username, password and root path, i.e. the ftp destination. 3. The screen shot is given below for reference. 4. Now download the CoreFTP client from this link 5. The client settings will be as in this screen shot: 6. Now the code to upload files via SFTP will be as follows. //ip of the local machine and the username and password along with the file to be uploaded via SFTP. FileUploadUsingSftp("172.24.120.87", "ftpserveruser", "123456", @"D:\", @"Web.config"); private static void FileUploadUsingSftp(string FtpAddress, string FtpUserName, string FtpPassword, string FilePath, string FileName) { Sftp sftp = null; try { // Create instance for Sftp to upload given files using given credentials sf...
2 comments
Read more

Upgrade from http1.1 to http2 for Java spring boot applications hosted in tomcat

In this post, we will list down the tasks to be done for enabling the HTTP 2.0 support in spring boot applications which are hosted in Apache tomcat webserver Application Level Changes Spring boot Application Configuration Changes server.http2.enabled=true In the spring boot application's application.properties file, we have to add the above line so that Spring boot can add the support for http2 Tomcat server configuration In the tomcat web server, we should have SSL enabled before doing the below change. To start with, we have to shutdown the tomcat server instance that is running CD to the directory that has tomcat installed and cd to the bin directory and run the below command sh shutdown.sh We have add the UpgradeProtocol  which adds the respective Http2Protocol handler classname to the connector pipeline that enables support for http2.0 <UpgradeProtocol className="org.apache.coyote.http2.Http2Protocol" /> The above UpgradeProtocol can be added to the connec...
Post a Comment
Read more