diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f599d1..9c7e4d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +### Changed + +* Add short note on how to convert OPENSSH to PEM format by [@shadow1runner](https://github.com/shadow1runner) + ## [2.0.2] - 2020-04-12 ### Security diff --git a/README.md b/README.md index 54dc1db..cb5f6a8 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,9 @@ Useful for SCP, SFTP, and `rsync` over SSH in deployment script. Add your SSH key to your product secrets by clicking `Settings` - `Secrets` - `Add a new secret` beforehand. -**NOTE:** OPENSSH format (key begins with `-----BEGIN OPENSSH PRIVATE KEY-----`) may not work due to OpenSSH version on VM. Please use PEM format (begins with `-----BEGIN RSA PRIVATE KEY-----`) instead. +**NOTE:** OPENSSH format (key begins with `-----BEGIN OPENSSH PRIVATE KEY-----`) may not work due to OpenSSH version on VM. +Please use PEM format (begins with `-----BEGIN RSA PRIVATE KEY-----`) instead. +In order to convert your key inline to PEM format simply use `ssh-keygen -p -m PEM -f ~/.ssh/id_rsa`. ```yaml runs-on: ubuntu-latest @@ -78,11 +80,11 @@ steps: ### SSH failed even though key has been installed. -Check belows: +Check below: * `Load key "/HOME/.ssh/id_rsa": invalid format`: * OPENSSH format (key begins with `-----BEGIN OPENSSH PRIVATE KEY-----`) may not work. - * Use PEM format (begins with `-----BEGIN RSA PRIVATE KEY-----`). + * Use PEM format (begins with `-----BEGIN RSA PRIVATE KEY-----`). Convert it from OPENSSH format using `ssh-keygen -p -m PEM -f ~/.ssh/id_rsa` * `Host key verification failed.`: * Set `known_hosts` option correctly (use `ssh-keyscan` command).