diff --git a/.github/workflows/verify-on-macos.yml b/.github/workflows/verify-on-macos.yml index 3bf6061..f4621b4 100644 --- a/.github/workflows/verify-on-macos.yml +++ b/.github/workflows/verify-on-macos.yml @@ -12,8 +12,8 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} - known-hosts: ${{ secrets.KNOWN_HOSTS }} # optional + key: ${{ secrets.SSH_KEY }} + known_hosts: ${{ secrets.KNOWN_HOSTS }} - name: print created files run: ls -l ~/.ssh - name: git clone through SSH @@ -27,8 +27,8 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} - known-hosts: ${{ secrets.KNOWN_HOSTS }} # optional + key: ${{ secrets.SSH_KEY }} + known_hosts: ${{ secrets.KNOWN_HOSTS }} name: ssh_key_name # optional config: | # optional Host github diff --git a/.github/workflows/verify-on-ubuntu.yml b/.github/workflows/verify-on-ubuntu.yml index 960eecd..6577545 100644 --- a/.github/workflows/verify-on-ubuntu.yml +++ b/.github/workflows/verify-on-ubuntu.yml @@ -12,8 +12,8 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} - known-hosts: ${{ secrets.KNOWN_HOSTS }} # optional + key: ${{ secrets.SSH_KEY }} + known_hosts: ${{ secrets.KNOWN_HOSTS }} - name: print created files run: ls -l ~/.ssh - name: git clone through SSH @@ -27,8 +27,8 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} - known-hosts: ${{ secrets.KNOWN_HOSTS }} # optional + key: ${{ secrets.SSH_KEY }} + known_hosts: ${{ secrets.KNOWN_HOSTS }} name: ssh_key_name # optional config: | # optional Host github diff --git a/.github/workflows/verify-on-ubuntu1604.yml b/.github/workflows/verify-on-ubuntu1604.yml index e4afd53..a9d0fb6 100644 --- a/.github/workflows/verify-on-ubuntu1604.yml +++ b/.github/workflows/verify-on-ubuntu1604.yml @@ -12,8 +12,8 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} - known-hosts: ${{ secrets.KNOWN_HOSTS }} # optional + key: ${{ secrets.SSH_KEY }} + known_hosts: ${{ secrets.KNOWN_HOSTS }} - name: print created files run: ls -l ~/.ssh - name: git clone through SSH @@ -27,8 +27,8 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} - known-hosts: ${{ secrets.KNOWN_HOSTS }} # optional + key: ${{ secrets.SSH_KEY }} + known_hosts: ${{ secrets.KNOWN_HOSTS }} name: ssh_key_name # optional config: | # optional Host github diff --git a/.github/workflows/verify-on-windows.yml b/.github/workflows/verify-on-windows.yml index 9615c88..c65b2b1 100644 --- a/.github/workflows/verify-on-windows.yml +++ b/.github/workflows/verify-on-windows.yml @@ -12,8 +12,8 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} - known-hosts: ${{ secrets.KNOWN_HOSTS }} # optional + key: ${{ secrets.SSH_KEY }} + known_hosts: ${{ secrets.KNOWN_HOSTS }} - name: print created files run: ls ~/.ssh - name: git clone through SSH @@ -27,8 +27,8 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} - known-hosts: ${{ secrets.KNOWN_HOSTS }} # optional + key: ${{ secrets.SSH_KEY }} + known_hosts: ${{ secrets.KNOWN_HOSTS }} name: ssh_key_name # optional config: | # optional Host github diff --git a/CHANGELOG.md b/CHANGELOG.md index 7328163..aaaf6f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +## [2.0.0] - 2020-02-08 + +### Changed + +* rename `private-key` to `key` +* rename `known-hosts` to `known_hosts` +* make `known_hosts` required + ## [1.6.5] - 2020-02-08 ### Others @@ -83,7 +91,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. * First release. -[Unreleased]: https://github.com/shimataro/ssh-key-action/compare/v1.6.5...HEAD +[Unreleased]: https://github.com/shimataro/ssh-key-action/compare/v2.0.0...HEAD +[2.0.0]: https://github.com/shimataro/ssh-key-action/compare/v1.6.5...v2.0.0 [1.6.5]: https://github.com/shimataro/ssh-key-action/compare/v1.6.4...v1.6.5 [1.6.4]: https://github.com/shimataro/ssh-key-action/compare/v1.6.3...v1.6.4 [1.6.3]: https://github.com/shimataro/ssh-key-action/compare/v1.6.2...v1.6.3 diff --git a/README.md b/README.md index f206c16..04a7d56 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,11 @@ Add your SSH key to your product secrets by clicking `Settings` - `Secrets` - `A runs-on: ubuntu-latest steps: - name: Install SSH key - uses: shimataro/ssh-key-action@v1 + uses: shimataro/ssh-key-action@v2 with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} name: id_rsa # optional - known-hosts: ${{ secrets.KNOWN_HOSTS }} # known_hosts; optional + known_hosts: ${{ secrets.KNOWN_HOSTS }} config: ${{ secrets.CONFIG }} # ssh_config; optional - name: rsync over ssh run: rsync ./foo/ user@remote:bar/ @@ -42,28 +42,28 @@ See [Workflow syntax for GitHub Actions](https://help.github.com/en/articles/wor If you want to install multiple keys, call this action multiple times. It is useful for port forwarding. -**NOTE:** When this action is called multiple times, **the contents of `known-hosts` and `config` will be appended**. `private-key` must be saved as different name, by using `name` option. +**NOTE:** When this action is called multiple times, **the contents of `known_hosts` and `config` will be appended**. `key` must be saved as different name, by using `name` option. ```yaml runs-on: ubuntu-latest steps: - name: Install SSH key of bastion - uses: shimataro/ssh-key-action@v1 + uses: shimataro/ssh-key-action@v2 with: - private-key: ${{ secrets.SSH_KEY_OF_BASTION }} + key: ${{ secrets.SSH_KEY_OF_BASTION }} name: id_rsa-bastion - known-hosts: ${{ secrets.KNOWN_HOSTS_OF_BASTION }} + known_hosts: ${{ secrets.KNOWN_HOSTS_OF_BASTION }} config: | Host bastion HostName xxx.xxx.xxx.xxx User user-of-bastion IdentityFile ~/.ssh/id_rsa-bastion - name: Install SSH key of target - uses: shimataro/ssh-key-action@v1 + uses: shimataro/ssh-key-action@v2 with: - private-key: ${{ secrets.SSH_KEY_OF_TARGET }} + key: ${{ secrets.SSH_KEY_OF_TARGET }} name: id_rsa-target - known-hosts: ${{ secrets.KNOWN_HOSTS_OF_TARGET }} # will be appended! + known_hosts: ${{ secrets.KNOWN_HOSTS_OF_TARGET }} # will be appended! config: | # will be appended! Host target HostName yyy.yyy.yyy.yyy @@ -84,9 +84,7 @@ Check belows: * OPENSSH format (key begins with `-----BEGIN OPENSSH PRIVATE KEY-----`) may not work. * Use PEM format (begins with `-----BEGIN RSA PRIVATE KEY-----`). * `Host key verification failed.`: - * Set `known-hosts` option or use `ssh -o StrictHostKeyChecking=no`. - * The former is **HIGHLY** recommended for security reason. - * I'm planning to make `known-hosts` required in v2. + * Set `known_hosts` option correctly (use `ssh-keyscan` command). ### How do I use encrypted SSH key? @@ -104,7 +102,7 @@ I recommend **rsync via bastion**. It has some advantages over other methods: * "Rsync via bastion" doesn't require to update workflow files and `secrets` even if it is necessary to transfer files to multiple servers. - * Other methods require to update `known-hosts` if servers have changed. + * Other methods require to update `known_hosts` if servers have changed. * Rsync: * is fastest of all. * does **NOT** break files even if disconnected during transferring. @@ -125,15 +123,15 @@ The scripts and documentation in this project are released under the [MIT Licens See [CHANGELOG.md](CHANGELOG.md). -[image-build]: https://github.com/shimataro/ssh-key-action/workflows/Build/badge.svg?event=push&branch=v1 +[image-build]: https://github.com/shimataro/ssh-key-action/workflows/Build/badge.svg?event=push&branch=v2 [link-build]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3ABuild -[image-verify-windows]: https://github.com/shimataro/ssh-key-action/workflows/Windows/badge.svg?event=push&branch=v1 +[image-verify-windows]: https://github.com/shimataro/ssh-key-action/workflows/Windows/badge.svg?event=push&branch=v2 [link-verify-windows]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3AWindows -[image-verify-macos]: https://github.com/shimataro/ssh-key-action/workflows/macOS/badge.svg?event=push&branch=v1 +[image-verify-macos]: https://github.com/shimataro/ssh-key-action/workflows/macOS/badge.svg?event=push&branch=v2 [link-verify-macos]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3AmacOS -[image-verify-ubuntu]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu/badge.svg?event=push&branch=v1 +[image-verify-ubuntu]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu/badge.svg?event=push&branch=v2 [link-verify-ubuntu]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3AUbuntu -[image-verify-ubuntu1604]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu%2016.04/badge.svg?event=push&branch=v1 +[image-verify-ubuntu1604]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu%2016.04/badge.svg?event=push&branch=v2 [link-verify-ubuntu1604]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3A%22Ubuntu+16.04%22 [image-release]: https://img.shields.io/github/release/shimataro/ssh-key-action.svg [link-release]: https://github.com/shimataro/ssh-key-action/releases diff --git a/action.yml b/action.yml index 734fd12..bf35c34 100644 --- a/action.yml +++ b/action.yml @@ -6,16 +6,16 @@ branding: icon: "terminal" color: "gray-dark" inputs: - private-key: - description: "private SSH key" + key: + description: "SSH private key" required: true name: description: "SSH key file name (default: id_rsa)" required: false default: "id_rsa" - known-hosts: + known_hosts: description: "public keys of SSH servers" - required: false + required: true default: "" config: description: "SSH config" diff --git a/lib/main.js b/lib/main.js index 9b04913..eb7cf57 100644 --- a/lib/main.js +++ b/lib/main.js @@ -21,7 +21,7 @@ function main() { const files = [ { name: core.getInput("name"), - contents: core.getInput("private-key", { + contents: core.getInput("key", { required: true, }), options: { @@ -31,7 +31,9 @@ function main() { }, { name: "known_hosts", - contents: prependLf(core.getInput("known-hosts")), + contents: prependLf(core.getInput("known_hosts", { + required: true, + })), options: { mode: 0o644, flag: "a", diff --git a/lib/main.js.map b/lib/main.js.map index 66e1d00..74f3783 100644 --- a/lib/main.js.map +++ b/lib/main.js.map @@ -1 +1 @@ -{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB,oDAAsC;AAStC;;GAEG;AACH,SAAS,IAAI;IAEZ,IACA;QACC,MAAM,KAAK,GAAe;YACzB;gBACC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE;oBACtC,QAAQ,EAAE,IAAI;iBACd,CAAC;gBACF,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,IAAI;iBACV;aACD;YACD;gBACC,IAAI,EAAE,aAAa;gBACnB,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;gBACjD,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,GAAG;iBACT;aACD;YACD;gBACC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC5C,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,GAAG;iBACT;aACD;SACD,CAAC;QAEF,0BAA0B;QAC1B,MAAM,IAAI,GAAG,gBAAgB,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3C,YAAE,CAAC,SAAS,CAAC,OAAO,EAAE;YACrB,SAAS,EAAE,IAAI;YACf,IAAI,EAAE,KAAK;SACX,CAAC,CAAC;QAEH,eAAe;QACf,KAAI,MAAM,IAAI,IAAI,KAAK,EACvB;YACC,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;SACxD;QAED,OAAO,CAAC,GAAG,CAAC,8BAA8B,OAAO,gBAAgB,CAAC,CAAC;KACnE;IACD,OAAM,GAAG,EACT;QACC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KAC5B;AACF,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB;IAExB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAClC,IAAG,IAAI,KAAK,SAAS,EACrB;QACC,MAAM,KAAK,CAAC,GAAG,OAAO,iBAAiB,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU;IAElB,IAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,EAC/B;QACC,UAAU;QACV,OAAO,aAAa,CAAC;KACrB;IAED,gBAAgB;IAChB,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,KAAa;IAE/B,IAAG,KAAK,CAAC,MAAM,KAAK,CAAC,EACrB;QACC,sBAAsB;QACtB,OAAO,EAAE,CAAC;KACV;IAED,OAAO,KAAK,KAAK,EAAE,CAAC;AACrB,CAAC;AAED,IAAI,EAAE,CAAC"} \ No newline at end of file +{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB,oDAAsC;AAStC;;GAEG;AACH,SAAS,IAAI;IAEZ,IACA;QACC,MAAM,KAAK,GAAe;YACzB;gBACC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;oBAC9B,QAAQ,EAAE,IAAI;iBACd,CAAC;gBACF,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,IAAI;iBACV;aACD;YACD;gBACC,IAAI,EAAE,aAAa;gBACnB,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE;oBAChD,QAAQ,EAAE,IAAI;iBACd,CAAC,CAAC;gBACH,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,GAAG;iBACT;aACD;YACD;gBACC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC5C,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,GAAG;iBACT;aACD;SACD,CAAC;QAEF,0BAA0B;QAC1B,MAAM,IAAI,GAAG,gBAAgB,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3C,YAAE,CAAC,SAAS,CAAC,OAAO,EAAE;YACrB,SAAS,EAAE,IAAI;YACf,IAAI,EAAE,KAAK;SACX,CAAC,CAAC;QAEH,eAAe;QACf,KAAI,MAAM,IAAI,IAAI,KAAK,EACvB;YACC,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;SACxD;QAED,OAAO,CAAC,GAAG,CAAC,8BAA8B,OAAO,gBAAgB,CAAC,CAAC;KACnE;IACD,OAAM,GAAG,EACT;QACC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KAC5B;AACF,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB;IAExB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAClC,IAAG,IAAI,KAAK,SAAS,EACrB;QACC,MAAM,KAAK,CAAC,GAAG,OAAO,iBAAiB,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU;IAElB,IAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,EAC/B;QACC,UAAU;QACV,OAAO,aAAa,CAAC;KACrB;IAED,gBAAgB;IAChB,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,KAAa;IAE/B,IAAG,KAAK,CAAC,MAAM,KAAK,CAAC,EACrB;QACC,sBAAsB;QACtB,OAAO,EAAE,CAAC;KACV;IAED,OAAO,KAAK,KAAK,EAAE,CAAC;AACrB,CAAC;AAED,IAAI,EAAE,CAAC"} \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 7ca97ab..1cebb04 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "install-ssh-key", - "version": "1.6.5", + "version": "2.0.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index b0121c0..50a2b19 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "install-ssh-key", - "version": "1.6.5", + "version": "2.0.0", "private": true, "description": "Install SSH key in .ssh", "main": "lib/main.js", diff --git a/src/main.ts b/src/main.ts index 97a0650..dff8fcd 100644 --- a/src/main.ts +++ b/src/main.ts @@ -20,7 +20,7 @@ function main(): void const files: FileInfo[] = [ { name: core.getInput("name"), - contents: core.getInput("private-key", { + contents: core.getInput("key", { required: true, }), options: { @@ -30,7 +30,9 @@ function main(): void }, { name: "known_hosts", - contents: prependLf(core.getInput("known-hosts")), + contents: prependLf(core.getInput("known_hosts", { + required: true, + })), options: { mode: 0o644, flag: "a",