Jenkins: what is the correct format for private key in Credentials

Question

I'm creating a job in Jenkins 2.152 running on Windows Server 2016 which needs to pull from a git repo hosted on bitbucket.org. I tested the ssh key through git-bash so I know it works and there is no passphrase. When I try to use the very same private key with Jenkins I get an error message.

Failed to connect to repository : Command "git.exe ls-remote -h 
git@bitbucket.org:mygroup/myrepo HEAD" returned status code 128:
stdout: 
stderr: Load key 
"C:\\Users\\JE~1\\AppData\\Local\\Temp\\ssh2142299850576289882.key": invalid format 
git@bitbucket.org: Permission denied (publickey). 
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

The Credentials are set up as

 scope: Global
 user: git
 Private Key -> Enter Directly -> copy and past - generated by ssh-keygen -t rsa in gitbash
 Passphrase: empty
 ID: empty
 description: bitbucket.org

I noticed that on another Windows Jenkins server the private key has a different number of characters per line

Does anybody know what is the expected format of Private Key in Jenkins Credentials? Or maybe there is something else that I could check.

Any help is greatly appreciated.

Answer 1

You use id_rsa (private key) generated from a machine and then authenticate it on another Windows OS, be sure to check whether line separator of this file is LF - Unix(\n) or CRLF - Windows(\r\n). If you use this file with CRLF - Windows(\r\n), convert to LF - Unix(\n). To verify this file, you can use Notepad++ or Note pad. To convert to LF - Unix(\n), run this command on command prompt as: "C:\Program Files\Git\usr\bin\dos2unix.exe" C:\users\your_profile.ssh\id_rsa image of private key with Line Separator

Answer 2

following worked for me

1. Create a folder (say testkey), cd inside the folder and right click and select git bash

2. now create OPENSSH Key using following command in git bash. here test.key is name of your OPENSSH key (note that passphrase is optional)

ssh-keygen -f test.key

3. Copy that key connect, you can open the key using notepad, and paste that key into github. Remember Git accepts only OPENSSH key.

4. Now convert that key into PEM format, using same bash window, run following command (note that passphrase is optional)

ssh-keygen -f test-pem.key -m PEM -p

5. Now the key is converted into PEM key, copy the content of the key using notepad.

6. Go Jenkins -> Credentials -> Add New Credentials.

7.Select Kind SSH Username and Key , Provide username , and paste the PEM key content copied in step 5 and paste into private key, note that passphrase is optional.

8. Now add repo for ssh like this,

Original SSL Command Copied from GITHUB - git@github.com:test/goto.git

change it to  - ssh://git@github.com/test/goto.git

Answer 3

So just to add an answer to actually convert a key from the new OPENSSH format to the older PEM format:

$ ssh-keygen -f blah.key
Generating public/private rsa key pair.
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved in blah.key.
Your public key has been saved in blah.key.pub.
The key fingerprint is:
SHA256:ndMFvZjbD7M3MoqFy8+me74gPhcuoDVLF2/Oh+hXQ8I perbelding@erpelbook4.local
$ head -n 1 blah.key
-----BEGIN OPENSSH PRIVATE KEY-----
$ ssh-keygen  -f blah.key -m PEM -p
Key has comment 'redacted'
Enter new passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved with the new passphrase.
$ head -n 1 blah.key
-----BEGIN RSA PRIVATE KEY-----

ssh-keygen -p changes the passphrase but it does not mind the new passphrase being the same (even none) as the old one and in the process can convert the format.

Answer 4

Somehow I got it work again but the real steps that fix the issue is unclear.

what I did is to regenerate the ssh key again and put everything to its default location. Reupload the public key, replace the private key in the credential and then it starts to work.

Answer 5

I also got this error message and eventually found out that the Jenkins credential should be RSA secret key, not public key. Below is my steps for configuring Jenkins to clone from bitbucket:

1. Add credential in Jenkins credentials

   Kind: SSH username and private key
   Scope: Global
   Username: <my username in bitbucket>
   Private key: <Enter directly>
         -----BEGIN RSA PRIVATE KEY-----
         ......
         -----END RSA PRIVATE KEY-----

2. Create a job and configure the repository path and credential as following:

Answer 6

Check the version of Git for Windows that you are using: Starting 2.19.2, it comes with OpenSSH v7.9p1 (from 7.7 before)

And... openssh 7.8 just changed the default ssh-keygen format, from a classic PEM 64-chars, to an OPENSSH one 70 chars!

Only ssh-keygen -m PEM -t rsa -P "" -f afile would generate the old format (-m PEM)

ssh-keygen(1):

write OpenSSH format private keys by default instead of using OpenSSL's PEM format.

The OpenSSH format, supported in OpenSSH releases since 2014 and described in the PROTOCOL.key file in the source distribution, offers substantially better protection against offline password guessing and supports key comments in private keys.
If necessary, it is possible to write old PEM-style keys by adding "-m PEM" to ssh-keygen's arguments when generating or updating a key.

Answer 7

In the end, I couldn't find a way to make pasting private keys to Jenkins credentials work.

While it might common knowledge for many, I decided to put the workaround below anyway.

Here is what I did as a workaround to pull my private repositories from Bitbucket.org:

1. Log in to your Windows host as the user which runs Jenkins Service. In my case, Jenkins Service runs as a dedicated user because I needed to access network shares with write privileges restricted to this user only.
2. Open Git-bash and generate SSH keys with ssh-keygen command accepting all defaults
3. In Jenkins, enter the git repo URL as git@bitbucket.org:team_name/repo_name and leave the credentials as None

This way Git and SSH will be able to find SSH keys in the default location, which usually is c:\Users\username.ssh\

Hope this helps somebody.