Compare commits
74 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| d3a748d26e | |||
| 3b20db79d0 | |||
| 4a97d63c04 | |||
| d8ab8a8d73 | |||
| a9820a9e98 | |||
| 7037cee3d8 | |||
| f7661e3133 | |||
| cfcaa5b059 | |||
| ac048b7025 | |||
| dcd32e2dd2 | |||
| 9a10f83bb6 | |||
| 9fc03e8504 | |||
| 9a32b156fe | |||
| a319e54d60 | |||
| 6a2577cde6 | |||
| 1f1bf7c21f | |||
| c652d0bf07 | |||
| eccc6294a8 | |||
| f8a75a8d42 | |||
| d5c2bc1b53 | |||
| d577a82a7b | |||
| f0b52c8da7 | |||
| 4cb6aa03e6 | |||
| 8b85b6c8bc | |||
| c032ff69d0 | |||
| 0454eef45f | |||
| def368f8ab | |||
| 6853fa28b6 | |||
| 56318f28cf | |||
| 32b26f21cd | |||
| 32c2698af7 | |||
| 27237f14c7 | |||
| 8f29f234f1 | |||
| 5091625953 | |||
| f74b3a51b0 | |||
| 062f3ad060 | |||
| ecd0fd8fad | |||
| 742bf694e4 | |||
| 38165f11db | |||
| ef2b31b4b2 | |||
| 5b1f800067 | |||
| 6339a3ed9b | |||
| bf27aaf167 | |||
| 9bc3aea59c | |||
| f5ff302d4d | |||
| cac8203bf5 | |||
| e4532271cc | |||
| faf6c91199 | |||
| d0009e7a9c | |||
| da76df2c3e | |||
| a43976110a | |||
| c3ee35a699 | |||
| a0ce759552 | |||
| 201d5cc6d7 | |||
| e5bdfff743 | |||
| 967c9fd9d1 | |||
| 35da2f0b73 | |||
| 5e991a4e4f | |||
| 0f75f5238c | |||
| e8f3047ac0 | |||
| 812d28ee3d | |||
| fa301eea71 | |||
| 48ccf317d6 | |||
| 9b3af8a50a | |||
| 78aa36c2be | |||
| 09d96fd94c | |||
| f4f60a685d | |||
| 904129706c | |||
| 9a96bbd266 | |||
| 39abfd760b | |||
| 1b30aa428e | |||
| 41613c0b93 | |||
| 2d14617b13 | |||
| 3106945b47 |
@@ -0,0 +1,66 @@
|
||||
name: Default (not tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags-ignore:
|
||||
- '**'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Install pnpm and npmci
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
|
||||
- name: Run npm prepare
|
||||
run: npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
@@ -0,0 +1,124 @@
|
||||
name: Default (tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
|
||||
release:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Release
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm publish
|
||||
|
||||
metadata:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
continue-on-error: true
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Code quality
|
||||
run: |
|
||||
npmci command npm install -g typescript
|
||||
npmci npm install
|
||||
|
||||
- name: Trigger
|
||||
run: npmci trigger
|
||||
|
||||
- name: Build docs and upload artifacts
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
pnpm install -g @git.zone/tsdoc
|
||||
npmci command tsdoc
|
||||
continue-on-error: true
|
||||
+19
-6
@@ -1,7 +1,20 @@
|
||||
.idea/
|
||||
node_modules/
|
||||
.nogit/
|
||||
|
||||
# artifacts
|
||||
coverage/
|
||||
docs/
|
||||
ts/typings/
|
||||
ts/*.js
|
||||
ts/*.js.map
|
||||
public/
|
||||
pages/
|
||||
|
||||
# installs
|
||||
node_modules/
|
||||
|
||||
# caches
|
||||
.yarn/
|
||||
.cache/
|
||||
.rpt2_cache
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_*/
|
||||
|
||||
# custom
|
||||
@@ -1,43 +0,0 @@
|
||||
image: hosttoday/ht-docker-node:latest
|
||||
|
||||
stages:
|
||||
- test
|
||||
- release
|
||||
- page
|
||||
|
||||
testLTS:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test lts
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test stable
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
|
||||
pages:
|
||||
stage: page
|
||||
script:
|
||||
- npmci test lts
|
||||
- mkdir .public
|
||||
- cp -r test/assets/docs/ .public
|
||||
- cp -r test/assets/coverage/ .public
|
||||
- mv .public public
|
||||
artifacts:
|
||||
paths:
|
||||
- public
|
||||
only:
|
||||
- master
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
},
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartssh",
|
||||
"shortDescription": "SSH automation utilities",
|
||||
"description": "Secure SSH configuration, key management, and remote machine control for TypeScript.",
|
||||
"npmPackagename": "@push.rocks/smartssh",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"SSH",
|
||||
"SSH configuration",
|
||||
"SSH keys management",
|
||||
"automation",
|
||||
"development tools",
|
||||
"node.js",
|
||||
"security",
|
||||
"server management"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"@git.zone/tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.\n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.\n\nUse of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District Court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
-12
@@ -1,12 +0,0 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- '4'
|
||||
- stable
|
||||
deploy:
|
||||
provider: npm
|
||||
email: npm@lossless.digital
|
||||
api_key:
|
||||
secure: xApCMlDyZcTOgq+iomxR2A/2aMBhhPpgEBxdFYqXDNC/AGkr+NQJhGt67W4840FMrSUFEDZNQhOS+t6gYMqxUHv+vJFc0cHskFSuLDnAH2MS45TqtFYNcP+GARs1suuM9Il5hXNEvjVJ6XF0lYlNlK8mJstKQscdEKWyBHj42oSsgWRcuzBgqps8Vnbp+Ey2Bpfaw1yV+P1fyv8dNnkwG5dSt3EIxAcbGiMOhCz0u6oMroKfAYfNTxMJjja2uJJOqoTTShzeMyIYx+YwxorcZGfchI+TOPHHeVc+fByCHfzTZJYCy9qTSSTvWcKD/H7q3RGciEXHzhwMj0d8dlY3WPHC6BBliD6bLwVgDmToD3cdHm8OLsxW7hjFLO51vOIbhJZrWBVztlusuLwuyVAlIgeAsV8Yb5FxetxZmBU42qr5itykPl45rNd7talI0ZcoFPRTAWxxmCD8hp0d3ZLdjcEdbCzc5GYmEFN0NwKLTZF3Q1G4UbsHMgN8Pe4ohjdaYYhJ7RKgbmLR0J4NBrWIAUOhDaUTkZhgsHFyEmtbKI6JkxQtwCEBBBursemZWFQSIdtj2+O/RBaBCgoUNIpxUDBFq+D3Pir7BZP7DK2m3Otl0F9aCdqJmhCc7rOn3MueLpmndjtO1RFteXAdAkDxKp2RehIB6yohxbRmQ1O9PsA=
|
||||
on:
|
||||
tags: true
|
||||
repo: pushrocks/smartssh
|
||||
Vendored
+11
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
Vendored
+26
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"json.schemas": [
|
||||
{
|
||||
"fileMatch": ["/npmextra.json"],
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"npmci": {
|
||||
"type": "object",
|
||||
"description": "settings for npmci"
|
||||
},
|
||||
"gitzone": {
|
||||
"type": "object",
|
||||
"description": "settings for gitzone",
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,34 +0,0 @@
|
||||
# smartssh
|
||||
setups SSH quickly and in a painless manner
|
||||
|
||||
> Attention: This is still alpha, so some things won't work, not all things are inplemented.
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
var smartssh = require("smartssh");
|
||||
var sshInstance = new smartssh.sshInstance({
|
||||
sshDir: "/some/path/.ssh", // the standard ssh directory, optional, defaults to "~./.ssh"
|
||||
sshSync: true // sync ssh this instance will represent the status of an ssh dir if set to true;
|
||||
});
|
||||
|
||||
sshInstance.addKey(new smartssh.sshKey({
|
||||
private: "somestring",
|
||||
public: "somestring", // optional
|
||||
host:"github.com",
|
||||
encoding: "base64" // optional, defaults to "utf8", can be "utf8" or "base64", useful for reading ssh keys from environment variables
|
||||
}));
|
||||
|
||||
sshInstance.removeKey(sshInstance.getKey("github.com")); // removes key for host "github.com" is present
|
||||
|
||||
sshInstance.createKey({
|
||||
host:"gitlab.com" // returns new key in the form sshKey, read more about the sshKey class below
|
||||
})
|
||||
|
||||
sshInstance.getKey({ // returns ssh key in the form sshKey, read more about the sshKey class below
|
||||
host:"github.com"
|
||||
});
|
||||
|
||||
sshInstance.getKeys() // returns array of all available getKeys. Each key is in form of class sshKey
|
||||
|
||||
```
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-05-02 - 2.1.0 - feat(sshclient)
|
||||
add a promise-first SSH client with secure host verification and improve SSH key/config handling
|
||||
|
||||
- introduces SshClient and SshSftpClient for command execution, shells, file transfer, and port forwarding using ssh2
|
||||
- adds strict host key verification defaults with fingerprint-based trust options and explicit opt-out for test systems
|
||||
- implements SSH directory and key loading from disk, host alias validation, and safer file permissions for keys and config
|
||||
|
||||
## 2026-05-01 - 2.0.3 - fix(ssh)
|
||||
modernize filesystem handling and package exports for NodeNext compatibility
|
||||
|
||||
- replace smartfile, smartpromise, and shell-based chmod usage with direct fs operations
|
||||
- add package exports and tighten TypeScript settings with noImplicitAny and Node types
|
||||
- update tests to the current tstest runner and move them to a node-specific entry file
|
||||
- refresh package metadata and dependency versions to match the updated toolchain
|
||||
|
||||
## 2024-05-29 - 2.0.2 - maintenance
|
||||
Release 2.0.2 focused on repository and TypeScript configuration housekeeping.
|
||||
|
||||
- Updated project description
|
||||
- Refined TypeScript configuration
|
||||
- Updated npm metadata for git host configuration
|
||||
- Summarizes trivial maintenance commits across 2024-02-09 to 2024-05-29
|
||||
|
||||
## 2024-02-09 - 2.0.1 - core
|
||||
Delivered a core update in the 2.0.1 release line.
|
||||
|
||||
- Updated core implementation
|
||||
|
||||
## 2023-07-27 - 2.0.0 - core
|
||||
Delivered a core update for the 2.0.0 release.
|
||||
|
||||
- Updated core implementation
|
||||
|
||||
## 2022-10-11 - 1.2.7 - core
|
||||
Introduced a breaking core change by switching the package to ESM.
|
||||
|
||||
- BREAKING: switched core package output to ESM
|
||||
|
||||
## 2022-10-11 - 1.2.4 to 1.2.6 - core
|
||||
This release range contained small core maintenance updates.
|
||||
|
||||
- Repeated core update fixes delivered across versions 1.2.4, 1.2.5, and 1.2.6
|
||||
|
||||
## 2017-06-15 - 1.2.2 - maintenance
|
||||
Refined project structure in the 1.2.2 release.
|
||||
|
||||
- Updated project structure
|
||||
|
||||
## 2016-11-23 - 1.2.0 to 1.2.1 - maintenance
|
||||
This release range focused on standards and documentation improvements.
|
||||
|
||||
- Updated project to latest standards
|
||||
- Improved README documentation
|
||||
|
||||
## 2016-06-26 - 1.1.2 to 1.1.5 - core
|
||||
This release range delivered several core configuration and path-handling improvements.
|
||||
|
||||
- Added more flexible path handling
|
||||
- Created config generation as a standard behavior
|
||||
- Set rights for stored keys
|
||||
- Included general maintenance and standards updates
|
||||
|
||||
## 2016-06-25 - 1.1.0 to 1.1.1 - core
|
||||
This release range reworked the internal structure around SSH configuration and key storage.
|
||||
|
||||
- Updated structure of `SshConfig`
|
||||
- Updated `SshKey.store()`
|
||||
- Performed related structural cleanup
|
||||
|
||||
## 2016-06-24 - 1.0.6 to 1.0.7 - core
|
||||
This release range focused on structural changes in the core implementation.
|
||||
|
||||
- Major structural updates
|
||||
- Additional structure refinements
|
||||
|
||||
## 2016-06-01 - 1.0.2 to 1.0.5 - features
|
||||
This release range added testing, packaging, CI, and key-handling improvements.
|
||||
|
||||
- Renamed `Ssh` class to `SshInstance`
|
||||
- Added support for base64-encoded keys
|
||||
- Added typings to package metadata
|
||||
- Expanded and improved test coverage, including an 80% coverage milestone
|
||||
- Updated dependency and CI configuration
|
||||
- Improved directory synchronization behavior
|
||||
|
||||
## 2016-04-25 - 1.0.1 - core
|
||||
Expanded the initial API and improved class structure after the first stable release.
|
||||
|
||||
- Added `removeKey` and `replaceKey` methods
|
||||
- Improved sync triggering
|
||||
- Restructured class files
|
||||
- Standardized class names to start with capital letters
|
||||
- Added supporting logic and typing updates
|
||||
|
||||
## 2016-04-24 - 1.0.0 - project
|
||||
Initial public release of the project.
|
||||
|
||||
- Started the project structure
|
||||
- Created `package.json` and enabled CI
|
||||
- Added `.gitignore`
|
||||
- Added and improved README documentation
|
||||
Vendored
-5
@@ -1,5 +0,0 @@
|
||||
import "typings-global";
|
||||
export { Ssh } from "./smartssh.classes.ssh";
|
||||
export { SshKey } from "./smartssh.classes.sshkey";
|
||||
export { SshDir } from "./smartssh.classes.sshdir";
|
||||
export { SshConfig } from "./smartssh.classes.sshconfig";
|
||||
Vendored
-12
@@ -1,12 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var smartssh_classes_ssh_1 = require("./smartssh.classes.ssh");
|
||||
exports.Ssh = smartssh_classes_ssh_1.Ssh;
|
||||
var smartssh_classes_sshkey_1 = require("./smartssh.classes.sshkey");
|
||||
exports.SshKey = smartssh_classes_sshkey_1.SshKey;
|
||||
var smartssh_classes_sshdir_1 = require("./smartssh.classes.sshdir");
|
||||
exports.SshDir = smartssh_classes_sshdir_1.SshDir;
|
||||
var smartssh_classes_sshconfig_1 = require("./smartssh.classes.sshconfig");
|
||||
exports.SshConfig = smartssh_classes_sshconfig_1.SshConfig;
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUNQLENBQUMsQ0FEc0I7QUFHdkIscUNBQWtCLHdCQUF3QixDQUFDO0FBQW5DLHlDQUFtQztBQUMzQyx3Q0FBcUIsMkJBQTJCLENBQUM7QUFBekMsa0RBQXlDO0FBQ2pELHdDQUFxQiwyQkFBMkIsQ0FBQztBQUF6QyxrREFBeUM7QUFDakQsMkNBQXdCLDhCQUE4QixDQUFDO0FBQS9DLDJEQUErQyIsImZpbGUiOiJpbmRleC5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInR5cGluZ3MtZ2xvYmFsXCJcclxuaW1wb3J0ICogYXMgcGx1Z2lucyBmcm9tIFwiLi9zbWFydHNzaC5wbHVnaW5zXCI7XHJcblxyXG5leHBvcnQge1NzaH0gZnJvbSBcIi4vc21hcnRzc2guY2xhc3Nlcy5zc2hcIjtcclxuZXhwb3J0IHtTc2hLZXl9IGZyb20gXCIuL3NtYXJ0c3NoLmNsYXNzZXMuc3Noa2V5XCI7XHJcbmV4cG9ydCB7U3NoRGlyfSBmcm9tIFwiLi9zbWFydHNzaC5jbGFzc2VzLnNzaGRpclwiO1xyXG5leHBvcnQge1NzaENvbmZpZ30gZnJvbSBcIi4vc21hcnRzc2guY2xhc3Nlcy5zc2hjb25maWdcIjsiXX0=
|
||||
Vendored
-4
@@ -1,4 +0,0 @@
|
||||
import "typings-global";
|
||||
import { SshKey } from "./smartssh.classes.sshkey";
|
||||
export declare let sshKeyArrayFromDir: (dirArg: string) => SshKey[];
|
||||
export declare let getKeyIndex: (hostArg: string) => number;
|
||||
Vendored
-11
@@ -1,11 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
exports.sshKeyArrayFromDir = function (dirArg) {
|
||||
var sshKeyArray = []; //TODO
|
||||
return sshKeyArray;
|
||||
};
|
||||
exports.getKeyIndex = function (hostArg) {
|
||||
return 0; //TODO
|
||||
};
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0c3NoLmNsYXNzZXMuaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFDUCxDQUFDLENBRHNCO0FBSVosMEJBQWtCLEdBQUcsVUFBUyxNQUFhO0lBQ2xELElBQUksV0FBVyxHQUFHLEVBQUUsQ0FBQyxDQUFDLE1BQU07SUFDNUIsTUFBTSxDQUFDLFdBQVcsQ0FBQztBQUN2QixDQUFDLENBQUE7QUFFVSxtQkFBVyxHQUFHLFVBQVMsT0FBYztJQUM1QyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTztBQUNyQixDQUFDLENBQUEiLCJmaWxlIjoic21hcnRzc2guY2xhc3Nlcy5oZWxwZXJzLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFwidHlwaW5ncy1nbG9iYWxcIlxyXG5pbXBvcnQgKiBhcyBwbHVnaW5zIGZyb20gXCIuL3NtYXJ0c3NoLnBsdWdpbnNcIjtcclxuaW1wb3J0IHtTc2hLZXl9IGZyb20gXCIuL3NtYXJ0c3NoLmNsYXNzZXMuc3Noa2V5XCI7XHJcblxyXG5leHBvcnQgbGV0IHNzaEtleUFycmF5RnJvbURpciA9IGZ1bmN0aW9uKGRpckFyZzpzdHJpbmcpOlNzaEtleVtde1xyXG4gICAgbGV0IHNzaEtleUFycmF5ID0gW107IC8vVE9ET1xyXG4gICAgcmV0dXJuIHNzaEtleUFycmF5O1xyXG59XHJcblxyXG5leHBvcnQgbGV0IGdldEtleUluZGV4ID0gZnVuY3Rpb24oaG9zdEFyZzpzdHJpbmcpe1xyXG4gICAgcmV0dXJuIDA7IC8vVE9ETyBcclxufSJdfQ==
|
||||
Vendored
-17
@@ -1,17 +0,0 @@
|
||||
import "typings-global";
|
||||
import { SshKey } from "./smartssh.classes.sshkey";
|
||||
export declare class Ssh {
|
||||
private sshConfig;
|
||||
private sshDir;
|
||||
private sshKeys;
|
||||
private sshSync;
|
||||
constructor(optionsArg?: {
|
||||
sshDir?: string;
|
||||
sshSync?: boolean;
|
||||
});
|
||||
addKey(sshKeyArg: SshKey): void;
|
||||
getKey(hostArg: string): SshKey;
|
||||
removeKey(sshKeyArg: SshKey): void;
|
||||
replaceKey(sshKeyOldArg: SshKey, sshKeyNewArg: SshKey): void;
|
||||
sync(): void;
|
||||
}
|
||||
Vendored
-52
@@ -1,52 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var helpers = require("./smartssh.classes.helpers");
|
||||
var smartssh_classes_sshdir_1 = require("./smartssh.classes.sshdir");
|
||||
var Ssh = (function () {
|
||||
function Ssh(optionsArg) {
|
||||
if (optionsArg === void 0) { optionsArg = {}; }
|
||||
this.sshDir = new smartssh_classes_sshdir_1.SshDir(optionsArg.sshDir);
|
||||
this.sshKeys = this.sshDir.getKeys();
|
||||
this.sshSync = optionsArg.sshSync;
|
||||
}
|
||||
;
|
||||
Ssh.prototype.addKey = function (sshKeyArg) {
|
||||
this.sshKeys.push(sshKeyArg);
|
||||
this.sync();
|
||||
};
|
||||
;
|
||||
Ssh.prototype.getKey = function (hostArg) {
|
||||
var filteredArray = this.sshKeys.filter(function (keyArg) {
|
||||
return (keyArg.host == hostArg);
|
||||
});
|
||||
if (filteredArray.length > 0) {
|
||||
return filteredArray[0];
|
||||
}
|
||||
else {
|
||||
return undefined;
|
||||
}
|
||||
};
|
||||
;
|
||||
Ssh.prototype.removeKey = function (sshKeyArg) {
|
||||
var keyIndex = helpers.getKeyIndex(sshKeyArg.host);
|
||||
this.sshKeys.splice(keyIndex, 1);
|
||||
this.sync();
|
||||
};
|
||||
;
|
||||
Ssh.prototype.replaceKey = function (sshKeyOldArg, sshKeyNewArg) {
|
||||
var keyIndex = helpers.getKeyIndex(sshKeyOldArg.host);
|
||||
this.sshKeys.splice(keyIndex, 1, sshKeyNewArg);
|
||||
this.sync();
|
||||
};
|
||||
;
|
||||
Ssh.prototype.sync = function () {
|
||||
if (this.sshSync) {
|
||||
this.sshDir.sync(this.sshConfig, this.sshKeys); // call sync method of sshDir class;
|
||||
}
|
||||
};
|
||||
;
|
||||
return Ssh;
|
||||
}());
|
||||
exports.Ssh = Ssh;
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0c3NoLmNsYXNzZXMuc3NoLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUNQLENBQUMsQ0FEc0I7QUFFdkIsSUFBWSxPQUFPLFdBQU0sNEJBQTRCLENBQUMsQ0FBQTtBQUV0RCx3Q0FBcUIsMkJBQTJCLENBQUMsQ0FBQTtBQUlqRDtJQUtJLGFBQVksVUFBK0M7UUFBL0MsMEJBQStDLEdBQS9DLGVBQStDO1FBQ3ZELElBQUksQ0FBQyxNQUFNLEdBQUcsSUFBSSxnQ0FBTSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUM1QyxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDckMsSUFBSSxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUMsT0FBTyxDQUFDO0lBQ3RDLENBQUM7O0lBQ0Qsb0JBQU0sR0FBTixVQUFPLFNBQWdCO1FBQ25CLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQzdCLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUNoQixDQUFDOztJQUNELG9CQUFNLEdBQU4sVUFBTyxPQUFjO1FBQ2pCLElBQUksYUFBYSxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFVBQVMsTUFBTTtZQUNuRCxNQUFNLENBQUMsQ0FBQyxNQUFNLENBQUMsSUFBSSxJQUFJLE9BQU8sQ0FBQyxDQUFDO1FBQ3BDLENBQUMsQ0FBQyxDQUFDO1FBQ0gsRUFBRSxDQUFBLENBQUMsYUFBYSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQSxDQUFDO1lBQ3pCLE1BQU0sQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDNUIsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osTUFBTSxDQUFDLFNBQVMsQ0FBQztRQUNyQixDQUFDO0lBQ0wsQ0FBQzs7SUFDRCx1QkFBUyxHQUFULFVBQVUsU0FBZ0I7UUFDdEIsSUFBSSxRQUFRLEdBQUcsT0FBTyxDQUFDLFdBQVcsQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDbkQsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsUUFBUSxFQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ2hDLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUNoQixDQUFDOztJQUNELHdCQUFVLEdBQVYsVUFBVyxZQUFtQixFQUFDLFlBQW1CO1FBQzlDLElBQUksUUFBUSxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3RELElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFFBQVEsRUFBQyxDQUFDLEVBQUMsWUFBWSxDQUFDLENBQUM7UUFDN0MsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO0lBQ2hCLENBQUM7O0lBQ0Qsa0JBQUksR0FBSjtRQUNJLEVBQUUsQ0FBQSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQSxDQUFDO1lBQ2IsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxvQ0FBb0M7UUFDdkYsQ0FBQztJQUNMLENBQUM7O0lBQ0wsVUFBQztBQUFELENBdkNBLEFBdUNDLElBQUE7QUF2Q1ksV0FBRyxNQXVDZixDQUFBIiwiZmlsZSI6InNtYXJ0c3NoLmNsYXNzZXMuc3NoLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFwidHlwaW5ncy1nbG9iYWxcIlxyXG5pbXBvcnQgKiBhcyBwbHVnaW5zIGZyb20gXCIuL3NtYXJ0c3NoLnBsdWdpbnNcIjtcclxuaW1wb3J0ICogYXMgaGVscGVycyBmcm9tIFwiLi9zbWFydHNzaC5jbGFzc2VzLmhlbHBlcnNcIjtcclxuXHJcbmltcG9ydCB7U3NoRGlyfSBmcm9tIFwiLi9zbWFydHNzaC5jbGFzc2VzLnNzaGRpclwiO1xyXG5pbXBvcnQge1NzaENvbmZpZ30gZnJvbSBcIi4vc21hcnRzc2guY2xhc3Nlcy5zc2hjb25maWdcIjtcclxuaW1wb3J0IHtTc2hLZXl9IGZyb20gXCIuL3NtYXJ0c3NoLmNsYXNzZXMuc3Noa2V5XCI7XHJcblxyXG5leHBvcnQgY2xhc3MgU3NoIHtcclxuICAgIHByaXZhdGUgc3NoQ29uZmlnOlNzaENvbmZpZzsgLy8gcG9pbnRzIHRvIHNzaENvbmZpZyBjbGFzcyBpbnN0YW5jZVxyXG4gICAgcHJpdmF0ZSBzc2hEaXI6U3NoRGlyOyAvLyBwb2ludHMgdG8gc3NoRGlyIGNsYXNzIGluc3RhbmNlLlxyXG4gICAgcHJpdmF0ZSBzc2hLZXlzOlNzaEtleVtdOyAvL2hvbGRzIGFsbCBzc2gga2V5c1xyXG4gICAgcHJpdmF0ZSBzc2hTeW5jOmJvb2xlYW47IC8vIGlmIHNldCB0byB0cnVlLCB0aGUgc3NoIGRpciB3aWxsIGJlIGtlcHQgaW4gc3luYyBhdXRvbWF0aWNhbGx5XHJcbiAgICBjb25zdHJ1Y3RvcihvcHRpb25zQXJnOntzc2hEaXI/OnN0cmluZyxzc2hTeW5jPzpib29sZWFufT17fSl7XHJcbiAgICAgICAgdGhpcy5zc2hEaXIgPSBuZXcgU3NoRGlyKG9wdGlvbnNBcmcuc3NoRGlyKTtcclxuICAgICAgICB0aGlzLnNzaEtleXMgPSB0aGlzLnNzaERpci5nZXRLZXlzKCk7XHJcbiAgICAgICAgdGhpcy5zc2hTeW5jID0gb3B0aW9uc0FyZy5zc2hTeW5jO1xyXG4gICAgfTtcclxuICAgIGFkZEtleShzc2hLZXlBcmc6U3NoS2V5KXtcclxuICAgICAgICB0aGlzLnNzaEtleXMucHVzaChzc2hLZXlBcmcpO1xyXG4gICAgICAgIHRoaXMuc3luYygpO1xyXG4gICAgfTtcclxuICAgIGdldEtleShob3N0QXJnOnN0cmluZyl7XHJcbiAgICAgICAgbGV0IGZpbHRlcmVkQXJyYXkgPSB0aGlzLnNzaEtleXMuZmlsdGVyKGZ1bmN0aW9uKGtleUFyZyl7XHJcbiAgICAgICAgICAgIHJldHVybiAoa2V5QXJnLmhvc3QgPT0gaG9zdEFyZyk7XHJcbiAgICAgICAgfSk7XHJcbiAgICAgICAgaWYoZmlsdGVyZWRBcnJheS5sZW5ndGggPiAwKXtcclxuICAgICAgICAgICAgcmV0dXJuIGZpbHRlcmVkQXJyYXlbMF07XHJcbiAgICAgICAgfSBlbHNlIHtcclxuICAgICAgICAgICAgcmV0dXJuIHVuZGVmaW5lZDtcclxuICAgICAgICB9XHJcbiAgICB9O1xyXG4gICAgcmVtb3ZlS2V5KHNzaEtleUFyZzpTc2hLZXkpe1xyXG4gICAgICAgIGxldCBrZXlJbmRleCA9IGhlbHBlcnMuZ2V0S2V5SW5kZXgoc3NoS2V5QXJnLmhvc3QpO1xyXG4gICAgICAgIHRoaXMuc3NoS2V5cy5zcGxpY2Uoa2V5SW5kZXgsMSk7XHJcbiAgICAgICAgdGhpcy5zeW5jKCk7XHJcbiAgICB9O1xyXG4gICAgcmVwbGFjZUtleShzc2hLZXlPbGRBcmc6U3NoS2V5LHNzaEtleU5ld0FyZzpTc2hLZXkpe1xyXG4gICAgICAgIGxldCBrZXlJbmRleCA9IGhlbHBlcnMuZ2V0S2V5SW5kZXgoc3NoS2V5T2xkQXJnLmhvc3QpO1xyXG4gICAgICAgIHRoaXMuc3NoS2V5cy5zcGxpY2Uoa2V5SW5kZXgsMSxzc2hLZXlOZXdBcmcpO1xyXG4gICAgICAgIHRoaXMuc3luYygpO1xyXG4gICAgfTtcclxuICAgIHN5bmMoKXtcclxuICAgICAgICBpZih0aGlzLnNzaFN5bmMpe1xyXG4gICAgICAgICAgICB0aGlzLnNzaERpci5zeW5jKHRoaXMuc3NoQ29uZmlnLHRoaXMuc3NoS2V5cyk7IC8vIGNhbGwgc3luYyBtZXRob2Qgb2Ygc3NoRGlyIGNsYXNzO1xyXG4gICAgICAgIH1cclxuICAgIH07XHJcbn1cclxuXHJcblxyXG4iXX0=
|
||||
Vendored
-4
@@ -1,4 +0,0 @@
|
||||
import "typings-global";
|
||||
export declare class SshConfig {
|
||||
constructor();
|
||||
}
|
||||
Vendored
-10
@@ -1,10 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var SshConfig = (function () {
|
||||
function SshConfig() {
|
||||
}
|
||||
return SshConfig;
|
||||
}());
|
||||
exports.SshConfig = SshConfig;
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0c3NoLmNsYXNzZXMuc3NoY29uZmlnLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFHeEI7SUFDSTtJQUVBLENBQUM7SUFDTCxnQkFBQztBQUFELENBSkEsQUFJQyxJQUFBO0FBSlksaUJBQVMsWUFJckIsQ0FBQSIsImZpbGUiOiJzbWFydHNzaC5jbGFzc2VzLnNzaGNvbmZpZy5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInR5cGluZ3MtZ2xvYmFsXCI7XHJcbmltcG9ydCAqIGFzIHBsdWdpbnMgZnJvbSBcIi4vc21hcnRzc2gucGx1Z2luc1wiO1xyXG5pbXBvcnQgKiBhcyBoZWxwZXJzIGZyb20gXCIuL3NtYXJ0c3NoLmNsYXNzZXMuaGVscGVyc1wiO1xyXG5leHBvcnQgY2xhc3MgU3NoQ29uZmlnIHtcclxuICAgIGNvbnN0cnVjdG9yKCl7XHJcbiAgICAgICAgXHJcbiAgICB9XHJcbn0iXX0=
|
||||
Vendored
-9
@@ -1,9 +0,0 @@
|
||||
import "typings-global";
|
||||
import { SshKey } from "./smartssh.classes.sshkey";
|
||||
import { SshConfig } from "./smartssh.classes.sshconfig";
|
||||
export declare class SshDir {
|
||||
path: string;
|
||||
constructor(sshDirPathArg: string);
|
||||
sync(sshConfigArg: SshConfig, sshKeysArg: SshKey[]): void;
|
||||
getKeys(): SshKey[];
|
||||
}
|
||||
Vendored
-18
@@ -1,18 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
var helpers = require("./smartssh.classes.helpers");
|
||||
var SshDir = (function () {
|
||||
function SshDir(sshDirPathArg) {
|
||||
this.path = sshDirPathArg;
|
||||
}
|
||||
SshDir.prototype.sync = function (sshConfigArg, sshKeysArg) {
|
||||
};
|
||||
;
|
||||
SshDir.prototype.getKeys = function () {
|
||||
return helpers.sshKeyArrayFromDir(this.path);
|
||||
};
|
||||
return SshDir;
|
||||
}());
|
||||
exports.SshDir = SshDir;
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0c3NoLmNsYXNzZXMuc3NoZGlyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFFeEIsSUFBWSxPQUFPLFdBQU0sNEJBQTRCLENBQUMsQ0FBQTtBQUd0RDtJQUVJLGdCQUFZLGFBQW9CO1FBQzVCLElBQUksQ0FBQyxJQUFJLEdBQUcsYUFBYSxDQUFDO0lBQzlCLENBQUM7SUFDRCxxQkFBSSxHQUFKLFVBQUssWUFBc0IsRUFBQyxVQUFtQjtJQUUvQyxDQUFDOztJQUNELHdCQUFPLEdBQVA7UUFDSSxNQUFNLENBQUMsT0FBTyxDQUFDLGtCQUFrQixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNqRCxDQUFDO0lBQ0wsYUFBQztBQUFELENBWEEsQUFXQyxJQUFBO0FBWFksY0FBTSxTQVdsQixDQUFBIiwiZmlsZSI6InNtYXJ0c3NoLmNsYXNzZXMuc3NoZGlyLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFwidHlwaW5ncy1nbG9iYWxcIjtcclxuaW1wb3J0ICogYXMgcGx1Z2lucyBmcm9tIFwiLi9zbWFydHNzaC5wbHVnaW5zXCI7XHJcbmltcG9ydCAqIGFzIGhlbHBlcnMgZnJvbSBcIi4vc21hcnRzc2guY2xhc3Nlcy5oZWxwZXJzXCI7XHJcbmltcG9ydCB7U3NoS2V5fSBmcm9tIFwiLi9zbWFydHNzaC5jbGFzc2VzLnNzaGtleVwiO1xyXG5pbXBvcnQge1NzaENvbmZpZ30gZnJvbSBcIi4vc21hcnRzc2guY2xhc3Nlcy5zc2hjb25maWdcIjtcclxuZXhwb3J0IGNsYXNzIFNzaERpciB7IC8vIHNzaERpciBjbGFzcyAtPiBOT1QgRVhQT1JURUQsIE9OTFkgRk9SIElOVEVSTkFMIFVTRVxyXG4gICAgcGF0aDpzdHJpbmc7XHJcbiAgICBjb25zdHJ1Y3Rvcihzc2hEaXJQYXRoQXJnOnN0cmluZyl7XHJcbiAgICAgICAgdGhpcy5wYXRoID0gc3NoRGlyUGF0aEFyZztcclxuICAgIH1cclxuICAgIHN5bmMoc3NoQ29uZmlnQXJnOlNzaENvbmZpZyxzc2hLZXlzQXJnOlNzaEtleVtdKXtcclxuICAgICAgICBcclxuICAgIH07XHJcbiAgICBnZXRLZXlzKCl7XHJcbiAgICAgICAgcmV0dXJuIGhlbHBlcnMuc3NoS2V5QXJyYXlGcm9tRGlyKHRoaXMucGF0aCk7XHJcbiAgICB9XHJcbn0iXX0=
|
||||
Vendored
-18
@@ -1,18 +0,0 @@
|
||||
import "typings-global";
|
||||
export declare class SshKey {
|
||||
private privKey;
|
||||
private pubKey;
|
||||
private hostVar;
|
||||
constructor(optionsArg?: {
|
||||
private?: string;
|
||||
public?: string;
|
||||
host?: string;
|
||||
});
|
||||
host: string;
|
||||
privateKey: string;
|
||||
privateKeyBase64: any;
|
||||
publicKey: string;
|
||||
publicKeyBase64: any;
|
||||
type: string;
|
||||
store(filePathArg?: string): void;
|
||||
}
|
||||
Vendored
-98
File diff suppressed because one or more lines are too long
Vendored
-6
@@ -1,6 +0,0 @@
|
||||
import "typings-global";
|
||||
export declare let beautylog: any;
|
||||
export declare let base64: any;
|
||||
export declare let fs: any;
|
||||
export declare let path: any;
|
||||
export declare let smartfile: any;
|
||||
Vendored
-9
@@ -1,9 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
exports.beautylog = require("beautylog");
|
||||
exports.base64 = require("js-base64").Base64;
|
||||
exports.fs = require("fs-extra");
|
||||
exports.path = require("path");
|
||||
exports.smartfile = require("smartfile");
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0c3NoLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQ1AsQ0FBQyxDQURzQjtBQUNaLGlCQUFTLEdBQUcsT0FBTyxDQUFDLFdBQVcsQ0FBQyxDQUFDO0FBQ2pDLGNBQU0sR0FBRyxPQUFPLENBQUMsV0FBVyxDQUFDLENBQUMsTUFBTSxDQUFDO0FBQ3JDLFVBQUUsR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUM7QUFDekIsWUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztBQUN2QixpQkFBUyxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQyIsImZpbGUiOiJzbWFydHNzaC5wbHVnaW5zLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFwidHlwaW5ncy1nbG9iYWxcIlxyXG5leHBvcnQgbGV0IGJlYXV0eWxvZyA9IHJlcXVpcmUoXCJiZWF1dHlsb2dcIik7XHJcbmV4cG9ydCBsZXQgYmFzZTY0ID0gcmVxdWlyZShcImpzLWJhc2U2NFwiKS5CYXNlNjQ7XHJcbmV4cG9ydCBsZXQgZnMgPSByZXF1aXJlKFwiZnMtZXh0cmFcIik7XHJcbmV4cG9ydCBsZXQgcGF0aCA9IHJlcXVpcmUoXCJwYXRoXCIpO1xyXG5leHBvcnQgbGV0IHNtYXJ0ZmlsZSA9IHJlcXVpcmUoXCJzbWFydGZpbGVcIik7Il19
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016 Push.Rocks
|
||||
Copyright (c) 2026 Task Venture Capital GmbH <hello@task.vc>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
},
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartssh",
|
||||
"shortDescription": "SSH automation utilities",
|
||||
"description": "Secure SSH configuration, key management, and remote machine control for TypeScript.",
|
||||
"npmPackagename": "@push.rocks/smartssh",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"SSH",
|
||||
"SSH configuration",
|
||||
"SSH keys management",
|
||||
"automation",
|
||||
"development tools",
|
||||
"node.js",
|
||||
"security",
|
||||
"server management"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"@git.zone/tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.\n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.\n\nUse of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District Court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"mode":"default",
|
||||
"coverageTreshold":50
|
||||
}
|
||||
+55
-20
@@ -1,36 +1,71 @@
|
||||
{
|
||||
"name": "smartssh",
|
||||
"version": "1.0.2",
|
||||
"description": "setups SSH quickly and in a painless manner",
|
||||
"main": "dist/index.js",
|
||||
"name": "@push.rocks/smartssh",
|
||||
"version": "2.1.0",
|
||||
"private": false,
|
||||
"description": "Secure SSH configuration, key management, and remote machine control for TypeScript.",
|
||||
"exports": {
|
||||
".": "./dist_ts/index.js"
|
||||
},
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
"test": "tstest test/",
|
||||
"testDocker": "tsdocker",
|
||||
"build": "tsbuild",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/pushrocks/smartssh.git"
|
||||
"url": "https://code.foss.global/push.rocks/smartssh.git"
|
||||
},
|
||||
"keywords": [
|
||||
"SSH",
|
||||
"ENV",
|
||||
"base64"
|
||||
"SSH configuration",
|
||||
"SSH keys management",
|
||||
"automation",
|
||||
"development tools",
|
||||
"node.js",
|
||||
"security",
|
||||
"server management"
|
||||
],
|
||||
"author": "Lossless GmbH",
|
||||
"author": "Task Venture Capital GmbH <hello@task.vc>",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/pushrocks/smartssh/issues"
|
||||
"url": "https://code.foss.global/push.rocks/smartssh/issues"
|
||||
},
|
||||
"homepage": "https://github.com/pushrocks/smartssh#readme",
|
||||
"homepage": "https://code.foss.global/push.rocks/smartssh",
|
||||
"dependencies": {
|
||||
"beautylog": "^5.0.8",
|
||||
"fs-extra": "^0.30.0",
|
||||
"js-base64": "^2.1.9",
|
||||
"smartfile": "^3.0.10",
|
||||
"typings-global": "^1.0.3",
|
||||
"typings-test": "^1.0.1"
|
||||
"@push.rocks/smartcrypto": "^2.0.4",
|
||||
"@push.rocks/smartjson": "^6.0.1",
|
||||
"@push.rocks/smartpath": "^6.0.0",
|
||||
"@push.rocks/smartstring": "^4.1.1",
|
||||
"@types/fs-extra": "^11.0.4",
|
||||
"@types/ssh2": "^1.15.5",
|
||||
"fs-extra": "^11.3.4",
|
||||
"minimatch": "^10.2.5",
|
||||
"ssh2": "^1.17.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"npmts": "^5.1.19",
|
||||
"should": "^9.0.0"
|
||||
}
|
||||
"@git.zone/tsbuild": "^4.4.0",
|
||||
"@git.zone/tstest": "^3.6.3",
|
||||
"@types/node": "^25.6.0"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
".smartconfig.json",
|
||||
"license",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
}
|
||||
|
||||
Generated
+7694
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1 @@
|
||||
|
||||
@@ -0,0 +1,430 @@
|
||||
# @push.rocks/smartssh
|
||||
|
||||
Secure SSH configuration, key management, and remote machine control for modern TypeScript projects. `@push.rocks/smartssh` gives you two things in one focused package: safe local OpenSSH config/key orchestration and a promise-first SSH client for executing commands, opening shells, transferring files, and forwarding ports.
|
||||
|
||||
Built on top of the pure JavaScript `ssh2` engine, it keeps the low-level protocol details out of your application while still exposing the control you need for serious automation.
|
||||
|
||||
## Issue Reporting and Security
|
||||
|
||||
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pnpm add @push.rocks/smartssh
|
||||
```
|
||||
|
||||
## What It Does
|
||||
|
||||
- Manage SSH keys as typed `SshKey` objects.
|
||||
- Generate OpenSSH-compatible config files with secure defaults.
|
||||
- Read managed key material back from disk.
|
||||
- Connect to remote machines with `SshClient`.
|
||||
- Execute commands and collect stdout, stderr, exit code, and signal.
|
||||
- Stream long-running commands or start interactive shells.
|
||||
- Use SFTP for uploads, downloads, file reads, writes, stats, permissions, and directory operations.
|
||||
- Forward TCP connections through SSH.
|
||||
- Verify host keys by SHA256 or MD5 fingerprints, with explicit opt-out for disposable test systems.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```typescript
|
||||
import { SshClient, SshKey } from '@push.rocks/smartssh';
|
||||
|
||||
const privateKey = SshKey.fromFile('/home/deploy/.ssh/id_ed25519');
|
||||
|
||||
const sshClient = await SshClient.connect({
|
||||
host: 'server.example.com',
|
||||
username: 'deploy',
|
||||
privateKey,
|
||||
trustedHostFingerprints: ['SHA256:replaceWithYourKnownHostFingerprint'],
|
||||
});
|
||||
|
||||
const result = await sshClient.exec('uname -a');
|
||||
|
||||
console.log(result.code);
|
||||
console.log(result.stdout);
|
||||
console.error(result.stderr);
|
||||
|
||||
await sshClient.close();
|
||||
```
|
||||
|
||||
## Secure Defaults
|
||||
|
||||
`smartssh` is intentionally conservative:
|
||||
|
||||
- SSH config generation writes `StrictHostKeyChecking yes` by default.
|
||||
- `SshClient.connect()` requires host validation by default.
|
||||
- Private key files are written with `0600` permissions.
|
||||
- Public key files are written with `0644` permissions.
|
||||
- SSH directories are created with `0700` permissions.
|
||||
- Host aliases are validated before they are used as filenames or config entries.
|
||||
|
||||
For local throwaway test servers you can explicitly opt out of host checking:
|
||||
|
||||
```typescript
|
||||
const sshClient = await SshClient.connect({
|
||||
host: '127.0.0.1',
|
||||
username: 'tester',
|
||||
password: 'secret',
|
||||
strictHostKeyChecking: false,
|
||||
});
|
||||
```
|
||||
|
||||
Do not disable host checking for production infrastructure unless another trust layer is already enforcing host identity.
|
||||
|
||||
## Key Management
|
||||
|
||||
Create keys in memory:
|
||||
|
||||
```typescript
|
||||
import { SshKey } from '@push.rocks/smartssh';
|
||||
|
||||
const githubKey = new SshKey({
|
||||
host: 'github.com',
|
||||
private: process.env.GITHUB_PRIVATE_KEY,
|
||||
public: process.env.GITHUB_PUBLIC_KEY,
|
||||
});
|
||||
|
||||
console.log(githubKey.type); // 'duplex', 'private', 'public', or undefined
|
||||
console.log(githubKey.privKeyBase64);
|
||||
```
|
||||
|
||||
Load keys from files:
|
||||
|
||||
```typescript
|
||||
const deployKey = SshKey.fromFile('/home/deploy/.ssh/id_ed25519');
|
||||
|
||||
const combinedKey = SshKey.fromFiles({
|
||||
host: 'production-app',
|
||||
privateKeyPath: '/home/deploy/.ssh/production-app',
|
||||
publicKeyPath: '/home/deploy/.ssh/production-app.pub',
|
||||
});
|
||||
```
|
||||
|
||||
Store keys safely:
|
||||
|
||||
```typescript
|
||||
await combinedKey.store('/home/deploy/.ssh');
|
||||
```
|
||||
|
||||
## OpenSSH Config Management
|
||||
|
||||
Use `SshInstance` when you want to manage a whole SSH directory and config file.
|
||||
|
||||
```typescript
|
||||
import { SshInstance, SshKey } from '@push.rocks/smartssh';
|
||||
|
||||
const sshInstance = new SshInstance({
|
||||
sshDirPath: '/home/deploy/.ssh',
|
||||
strictHostKeyChecking: true,
|
||||
});
|
||||
|
||||
sshInstance.addKey(
|
||||
new SshKey({
|
||||
host: 'git.example.com',
|
||||
private: process.env.GIT_PRIVATE_KEY,
|
||||
public: process.env.GIT_PUBLIC_KEY,
|
||||
})
|
||||
);
|
||||
|
||||
sshInstance.writeToDisk();
|
||||
```
|
||||
|
||||
Generated config example:
|
||||
|
||||
```sshconfig
|
||||
Host git.example.com
|
||||
HostName git.example.com
|
||||
IdentityFile /home/deploy/.ssh/git.example.com
|
||||
StrictHostKeyChecking yes
|
||||
```
|
||||
|
||||
Read keys back from disk:
|
||||
|
||||
```typescript
|
||||
const existingSsh = new SshInstance({
|
||||
sshDirPath: '/home/deploy/.ssh',
|
||||
});
|
||||
|
||||
existingSsh.readFromDisk();
|
||||
|
||||
const key = existingSsh.getKey('git.example.com');
|
||||
console.log(key?.pubKey);
|
||||
```
|
||||
|
||||
## Remote Command Execution
|
||||
|
||||
`exec()` waits for the remote command to finish and returns a structured result.
|
||||
|
||||
```typescript
|
||||
const result = await sshClient.exec('systemctl is-active nginx', {
|
||||
timeout: 10_000,
|
||||
});
|
||||
|
||||
if (result.code !== 0) {
|
||||
throw new Error(result.stderr);
|
||||
}
|
||||
|
||||
console.log(result.stdout.trim());
|
||||
```
|
||||
|
||||
Send input to a command:
|
||||
|
||||
```typescript
|
||||
const result = await sshClient.exec('cat > /tmp/message.txt', {
|
||||
input: 'hello from smartssh\n',
|
||||
});
|
||||
```
|
||||
|
||||
Abort or time-limit a command:
|
||||
|
||||
```typescript
|
||||
const abortController = new AbortController();
|
||||
|
||||
setTimeout(() => abortController.abort(), 5_000);
|
||||
|
||||
await sshClient.exec('sleep 60', {
|
||||
signal: abortController.signal,
|
||||
});
|
||||
```
|
||||
|
||||
## Streaming Commands and Shells
|
||||
|
||||
Use `stream()` for long-running commands where you want to handle output as it arrives.
|
||||
|
||||
```typescript
|
||||
const stream = await sshClient.stream('tail -f /var/log/syslog');
|
||||
|
||||
stream.on('data', (chunk) => {
|
||||
process.stdout.write(chunk);
|
||||
});
|
||||
|
||||
stream.stderr.on('data', (chunk) => {
|
||||
process.stderr.write(chunk);
|
||||
});
|
||||
```
|
||||
|
||||
Start an interactive shell:
|
||||
|
||||
```typescript
|
||||
const shell = await sshClient.shell({
|
||||
window: {
|
||||
rows: 40,
|
||||
cols: 120,
|
||||
term: 'xterm-256color',
|
||||
},
|
||||
});
|
||||
|
||||
shell.write('whoami\n');
|
||||
shell.write('exit\n');
|
||||
```
|
||||
|
||||
## SFTP
|
||||
|
||||
Create an SFTP client from an active SSH connection:
|
||||
|
||||
```typescript
|
||||
const sftp = await sshClient.sftp();
|
||||
```
|
||||
|
||||
Upload and download files:
|
||||
|
||||
```typescript
|
||||
await sftp.upload({
|
||||
localPath: './dist/app.tar.gz',
|
||||
remotePath: '/tmp/app.tar.gz',
|
||||
});
|
||||
|
||||
await sftp.download({
|
||||
remotePath: '/var/log/app.log',
|
||||
localPath: './app.log',
|
||||
});
|
||||
```
|
||||
|
||||
Read and write remote files:
|
||||
|
||||
```typescript
|
||||
const osRelease = await sftp.readFile('/etc/os-release', 'utf8');
|
||||
|
||||
await sftp.writeFile('/tmp/deploy.json', JSON.stringify({
|
||||
version: '1.2.3',
|
||||
}));
|
||||
```
|
||||
|
||||
Inspect and manage remote paths:
|
||||
|
||||
```typescript
|
||||
const files = await sftp.readdir('/var/www');
|
||||
const stats = await sftp.stat('/var/www/app');
|
||||
|
||||
await sftp.mkdir('/tmp/smartssh');
|
||||
await sftp.chmod('/tmp/smartssh', 0o755);
|
||||
await sftp.rename('/tmp/old-name', '/tmp/new-name');
|
||||
await sftp.remove('/tmp/new-name');
|
||||
```
|
||||
|
||||
## Port Forwarding
|
||||
|
||||
Open a direct TCP channel through the SSH server:
|
||||
|
||||
```typescript
|
||||
const channel = await sshClient.forwardOut({
|
||||
destinationHost: '127.0.0.1',
|
||||
destinationPort: 5432,
|
||||
});
|
||||
|
||||
channel.write('raw tcp payload');
|
||||
```
|
||||
|
||||
Ask the remote SSH server to listen and forward incoming TCP connections:
|
||||
|
||||
```typescript
|
||||
const forward = await sshClient.forwardIn({
|
||||
remoteHost: '127.0.0.1',
|
||||
remotePort: 0,
|
||||
});
|
||||
|
||||
console.log(`Remote port: ${forward.remotePort}`);
|
||||
|
||||
await forward.close();
|
||||
```
|
||||
|
||||
## API Overview
|
||||
|
||||
### `SshClient`
|
||||
|
||||
- `SshClient.connect(profile)` creates and connects a client in one step.
|
||||
- `connect()` opens the SSH connection for an existing instance.
|
||||
- `exec(command, options)` runs a command and returns `ISshExecResult`.
|
||||
- `stream(command, options)` opens a command channel for streaming output.
|
||||
- `shell(options)` starts an interactive shell channel.
|
||||
- `sftp()` returns a typed `SshSftpClient`.
|
||||
- `forwardOut(options)` opens a direct TCP channel through SSH.
|
||||
- `forwardIn(options)` creates a remote listener and returns a closeable handle.
|
||||
- `close()` ends the connection.
|
||||
- `fingerprintSha256(key)` and `fingerprintMd5(key)` generate comparable host key fingerprints.
|
||||
|
||||
### `SshSftpClient`
|
||||
|
||||
- `upload({ localPath, remotePath })`
|
||||
- `download({ remotePath, localPath })`
|
||||
- `readFile(remotePath, encoding?)`
|
||||
- `writeFile(remotePath, data)`
|
||||
- `readdir(remotePath)`
|
||||
- `stat(remotePath)` and `lstat(remotePath)`
|
||||
- `mkdir(remotePath, attributes?)`
|
||||
- `chmod(remotePath, mode)`
|
||||
- `rename(sourcePath, destinationPath)`
|
||||
- `remove(remotePath)` and `rmdir(remotePath)`
|
||||
|
||||
### `SshKey`
|
||||
|
||||
- Construct with `{ host, private, public, authorized }`.
|
||||
- Read and write private/public key strings.
|
||||
- Encode and decode key material with `privKeyBase64` and `pubKeyBase64`.
|
||||
- Load keys from disk with `fromFile()` or `fromFiles()`.
|
||||
- Store keys to disk with safe permissions via `store()`.
|
||||
- Inspect `type` as `duplex`, `private`, `public`, or `undefined`.
|
||||
|
||||
### `SshInstance`
|
||||
|
||||
- `addKey(key)`, `removeKey(key)`, and `replaceKey(oldKey, newKey)` manage key collections.
|
||||
- `getKey(host)` retrieves a managed key by host alias.
|
||||
- `sshKeys` exposes the current key array.
|
||||
- `writeToDisk(dirPath?)` writes keys and config.
|
||||
- `readFromDisk(dirPath?)` reads key files from an SSH directory.
|
||||
- `sshSync: true` keeps disk state in sync on key changes.
|
||||
|
||||
### `SshConfig`
|
||||
|
||||
- `store(dirPath)` writes an OpenSSH config file.
|
||||
- `read(dirPath)` reads the config file.
|
||||
- `parse(dirPath)` parses host blocks from a config file.
|
||||
- `SshConfig.parse(configString)` parses host blocks from a string.
|
||||
|
||||
## Types You Will Usually Import
|
||||
|
||||
```typescript
|
||||
import type {
|
||||
ISshProfile,
|
||||
ISshExecOptions,
|
||||
ISshExecResult,
|
||||
ISshUploadOptions,
|
||||
ISshDownloadOptions,
|
||||
ISshForwardInHandle,
|
||||
ISshForwardInOptions,
|
||||
ISshForwardOutOptions,
|
||||
ISshShellOptions,
|
||||
TSshHostVerifier,
|
||||
} from '@push.rocks/smartssh';
|
||||
```
|
||||
|
||||
## Real-World Flow
|
||||
|
||||
```typescript
|
||||
import { SshClient, SshKey } from '@push.rocks/smartssh';
|
||||
|
||||
const key = SshKey.fromFile('/home/deploy/.ssh/production');
|
||||
|
||||
const server = await SshClient.connect({
|
||||
host: 'app-01.example.com',
|
||||
username: 'deploy',
|
||||
privateKey: key,
|
||||
trustedHostFingerprints: ['SHA256:replaceWithTheRealFingerprint'],
|
||||
keepaliveInterval: 30_000,
|
||||
});
|
||||
|
||||
try {
|
||||
const sftp = await server.sftp();
|
||||
|
||||
await sftp.upload({
|
||||
localPath: './release.tar.gz',
|
||||
remotePath: '/tmp/release.tar.gz',
|
||||
});
|
||||
|
||||
const deploy = await server.exec([
|
||||
'set -e',
|
||||
'mkdir -p /srv/app',
|
||||
'tar -xzf /tmp/release.tar.gz -C /srv/app',
|
||||
'systemctl restart app',
|
||||
].join(' && '), {
|
||||
timeout: 120_000,
|
||||
});
|
||||
|
||||
if (deploy.code !== 0) {
|
||||
throw new Error(deploy.stderr);
|
||||
}
|
||||
} finally {
|
||||
await server.close();
|
||||
}
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- The package is ESM-first and intended for TypeScript projects.
|
||||
- `ssh2` is used directly as the SSH protocol engine.
|
||||
- Config generation is intentionally simple and focused on managed host/key entries.
|
||||
- `readFromDisk()` reads key files from the SSH directory; it does not attempt to preserve or rewrite arbitrary user-managed config comments.
|
||||
- Host aliases are intentionally restricted to filename-safe values to avoid path traversal and config injection.
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
||||
|
||||
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
@@ -0,0 +1 @@
|
||||
somePrivateKey
|
||||
@@ -0,0 +1 @@
|
||||
somePublicKey
|
||||
@@ -0,0 +1,15 @@
|
||||
Host gitlab.com
|
||||
HostName gitlab.com
|
||||
IdentityFile ~/.ssh/gitlab.com
|
||||
StrictHostKeyChecking no
|
||||
|
||||
Host bitbucket.org
|
||||
HostName bitbucket.org
|
||||
IdentityFile ~/.ssh/bitbucket.org
|
||||
StrictHostKeyChecking no
|
||||
|
||||
Host github.com
|
||||
HostName github.com
|
||||
IdentityFile ~/.ssh/github.com
|
||||
StrictHostKeyChecking no
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
someExamplePrivateKey
|
||||
@@ -0,0 +1 @@
|
||||
someExamplePublicKey
|
||||
@@ -0,0 +1 @@
|
||||
someGitHubPrivateKey
|
||||
@@ -0,0 +1 @@
|
||||
someGitHubPublicKey
|
||||
@@ -0,0 +1 @@
|
||||
somePrivateKey
|
||||
@@ -0,0 +1 @@
|
||||
somePublicKey
|
||||
Vendored
-1
@@ -1 +0,0 @@
|
||||
import "typings-test";
|
||||
@@ -1,6 +0,0 @@
|
||||
"use strict";
|
||||
require("typings-test");
|
||||
var should = require("should");
|
||||
var smartssh = require("../dist/index.js");
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FDUCxDQUFDLENBRG9CO0FBQ3JCLElBQUksTUFBTSxHQUFHLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztBQUMvQixJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsa0JBQWtCLENBQUMsQ0FBQyIsImZpbGUiOiJ0ZXN0LmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFwidHlwaW5ncy10ZXN0XCJcclxubGV0IHNob3VsZCA9IHJlcXVpcmUoXCJzaG91bGRcIik7XHJcbmxldCBzbWFydHNzaCA9IHJlcXVpcmUoXCIuLi9kaXN0L2luZGV4LmpzXCIpO1xyXG4iXX0=
|
||||
@@ -0,0 +1,214 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as smartssh from '../ts/index.js';
|
||||
import fs from 'fs-extra';
|
||||
import type { AddressInfo } from 'net';
|
||||
import * as path from 'path';
|
||||
import ssh2 from 'ssh2';
|
||||
import type { Server as TSsh2Server } from 'ssh2';
|
||||
|
||||
const { Server, utils } = ssh2;
|
||||
|
||||
const testDir = path.join(process.cwd(), '.nogit/test/temp');
|
||||
const configPath = path.join(testDir, 'config');
|
||||
|
||||
let testSshInstance: smartssh.SshInstance;
|
||||
let testSshKey: smartssh.SshKey;
|
||||
let testSshServer: TSsh2Server;
|
||||
let testSshServerPort: number;
|
||||
|
||||
const createTestSshServer = async () => {
|
||||
const hostKeys = [utils.generateKeyPairSync('ed25519').private];
|
||||
const server = new Server({ hostKeys }, (client) => {
|
||||
client.on('authentication', (ctx) => {
|
||||
if (ctx.method === 'password' && ctx.username === 'tester' && ctx.password === 'secret') {
|
||||
ctx.accept();
|
||||
return;
|
||||
}
|
||||
ctx.reject();
|
||||
});
|
||||
|
||||
client.on('ready', () => {
|
||||
client.on('session', (accept) => {
|
||||
const session = accept();
|
||||
session.on('exec', (acceptExec, _rejectExec, info) => {
|
||||
const stream = acceptExec();
|
||||
if (info.command === 'printf smartssh') {
|
||||
stream.write('smartssh\n');
|
||||
stream.stderr.write('warn\n');
|
||||
stream.exit(0);
|
||||
stream.end();
|
||||
return;
|
||||
}
|
||||
|
||||
stream.stderr.write(`unknown command: ${info.command}\n`);
|
||||
stream.exit(127);
|
||||
stream.end();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
await new Promise<void>((resolve) => server.listen(0, '127.0.0.1', () => resolve()));
|
||||
const address = server.address() as AddressInfo;
|
||||
return {
|
||||
server,
|
||||
port: address.port,
|
||||
};
|
||||
};
|
||||
|
||||
tap.test('should prepare a clean test directory', async () => {
|
||||
await fs.emptyDir(testDir);
|
||||
});
|
||||
|
||||
tap.test('should create a valid SshKey object', async () => {
|
||||
testSshKey = new smartssh.SshKey({
|
||||
host: 'example.com',
|
||||
private: 'someExamplePrivateKey',
|
||||
public: 'someExamplePublicKey',
|
||||
});
|
||||
expect(testSshKey).toBeInstanceOf(smartssh.SshKey);
|
||||
});
|
||||
tap.test('.type should be a valid type', async () => {
|
||||
expect(testSshKey.type).toEqual('duplex');
|
||||
});
|
||||
tap.test('.publicKey should be public key', async () => {
|
||||
expect(testSshKey.pubKey).toEqual('someExamplePublicKey');
|
||||
});
|
||||
tap.test('.privateKey should be private key', async () => {
|
||||
expect(testSshKey.privKey).toEqual('someExamplePrivateKey');
|
||||
});
|
||||
tap.test('.publicKeyBase64 should be public key base 64 encoded', async () => {
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
testSshKey.pubKeyBase64;
|
||||
});
|
||||
tap.test('.store() should store the file to disk', async () => {
|
||||
await testSshKey.store(testDir);
|
||||
const privateKeyMode = (await fs.stat(path.join(testDir, 'example.com'))).mode & 0o777;
|
||||
const publicKeyMode = (await fs.stat(path.join(testDir, 'example.com.pub'))).mode & 0o777;
|
||||
expect(privateKeyMode).toEqual(0o600);
|
||||
expect(publicKeyMode).toEqual(0o644);
|
||||
});
|
||||
tap.test('.store() should reject unsafe host aliases', async () => {
|
||||
expect(() => {
|
||||
new smartssh.SshKey({
|
||||
host: '../evil',
|
||||
private: 'somePrivateKey',
|
||||
});
|
||||
}).toThrow();
|
||||
});
|
||||
|
||||
// SSH INstance
|
||||
tap.test("'new' keyword should create a new SshInstance object from class", async () => {
|
||||
testSshInstance = new smartssh.SshInstance({
|
||||
sshDirPath: testDir,
|
||||
});
|
||||
expect(testSshInstance).toBeInstanceOf(smartssh.SshInstance);
|
||||
});
|
||||
tap.test('.addKey() should accept a new SshKey object', async () => {
|
||||
testSshInstance.addKey(
|
||||
new smartssh.SshKey({
|
||||
public: 'somePublicKey',
|
||||
private: 'somePrivateKey',
|
||||
host: 'gitlab.com',
|
||||
})
|
||||
);
|
||||
testSshInstance.addKey(
|
||||
new smartssh.SshKey({
|
||||
public: 'somePublicKey',
|
||||
private: 'somePrivateKey',
|
||||
host: 'bitbucket.org',
|
||||
})
|
||||
);
|
||||
testSshInstance.addKey(
|
||||
new smartssh.SshKey({
|
||||
public: 'someGitHubPublicKey',
|
||||
private: 'someGitHubPrivateKey',
|
||||
host: 'github.com',
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
tap.test('.sshKeys should point to an array of sshKeys', async () => {
|
||||
let sshKeyArray = testSshInstance.sshKeys;
|
||||
expect(sshKeyArray).toBeInstanceOf(Array);
|
||||
expect(sshKeyArray[0].host).toEqual('gitlab.com');
|
||||
expect(sshKeyArray[1].host).toEqual('bitbucket.org');
|
||||
expect(sshKeyArray[2].host).toEqual('github.com');
|
||||
});
|
||||
|
||||
tap.test('.getKey() should get a specific key selected by host', async () => {
|
||||
const sshKey = testSshInstance.getKey('github.com');
|
||||
expect(sshKey).toBeInstanceOf(smartssh.SshKey);
|
||||
expect(sshKey?.pubKey).toEqual('someGitHubPublicKey');
|
||||
});
|
||||
|
||||
tap.test('.removeKey() should remove a key', async () => {
|
||||
const sshKey = testSshInstance.getKey('bitbucket.org');
|
||||
expect(sshKey).toBeInstanceOf(smartssh.SshKey);
|
||||
testSshInstance.removeKey(sshKey!);
|
||||
expect(testSshInstance.sshKeys[1].host).toEqual('github.com');
|
||||
});
|
||||
|
||||
tap.test('it should store to disk', async () => {
|
||||
testSshInstance.writeToDisk();
|
||||
const config = await fs.readFile(configPath, 'utf8');
|
||||
expect(config).toInclude(`IdentityFile ${path.join(testDir, 'github.com')}`);
|
||||
expect(config).toInclude('StrictHostKeyChecking yes');
|
||||
expect(config).not.toInclude('StrictHostKeyChecking no');
|
||||
});
|
||||
|
||||
tap.test('it should read keys back from disk', async () => {
|
||||
const readBackInstance = new smartssh.SshInstance({ sshDirPath: testDir });
|
||||
readBackInstance.readFromDisk();
|
||||
const githubKey = readBackInstance.getKey('github.com');
|
||||
expect(githubKey).toBeInstanceOf(smartssh.SshKey);
|
||||
expect(githubKey?.privKey).toEqual('someGitHubPrivateKey');
|
||||
expect(githubKey?.pubKey).toEqual('someGitHubPublicKey');
|
||||
});
|
||||
|
||||
tap.test('SshClient should require host validation by default', async () => {
|
||||
let strictHostError: Error | undefined;
|
||||
try {
|
||||
await smartssh.SshClient.connect({
|
||||
host: '127.0.0.1',
|
||||
username: 'tester',
|
||||
});
|
||||
} catch (error) {
|
||||
strictHostError = error as Error;
|
||||
}
|
||||
expect(strictHostError?.message).toInclude('strictHostKeyChecking');
|
||||
});
|
||||
|
||||
tap.test('SshClient should execute a command over a real SSH server', async () => {
|
||||
const testServer = await createTestSshServer();
|
||||
testSshServer = testServer.server;
|
||||
testSshServerPort = testServer.port;
|
||||
|
||||
const sshClient = await smartssh.SshClient.connect({
|
||||
host: '127.0.0.1',
|
||||
port: testSshServerPort,
|
||||
username: 'tester',
|
||||
password: 'secret',
|
||||
strictHostKeyChecking: false,
|
||||
});
|
||||
const result = await sshClient.exec('printf smartssh');
|
||||
await sshClient.close();
|
||||
|
||||
expect(result.code).toEqual(0);
|
||||
expect(result.stdout).toEqual('smartssh\n');
|
||||
expect(result.stderr).toEqual('warn\n');
|
||||
});
|
||||
|
||||
tap.test('should close the real SSH test server', async () => {
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
testSshServer.close((error?: Error) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
resolve();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
@@ -1,3 +0,0 @@
|
||||
import "typings-test"
|
||||
let should = require("should");
|
||||
let smartssh = require("../dist/index.js");
|
||||
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartssh',
|
||||
version: '2.1.0',
|
||||
description: 'Secure SSH configuration, key management, and remote machine control for TypeScript.'
|
||||
}
|
||||
+23
-6
@@ -1,7 +1,24 @@
|
||||
import "typings-global"
|
||||
import * as plugins from "./smartssh.plugins";
|
||||
import * as plugins from './smartssh.plugins.js';
|
||||
|
||||
export {Ssh} from "./smartssh.classes.ssh";
|
||||
export {SshKey} from "./smartssh.classes.sshkey";
|
||||
export {SshDir} from "./smartssh.classes.sshdir";
|
||||
export {SshConfig} from "./smartssh.classes.sshconfig";
|
||||
export { SshInstance } from './smartssh.classes.sshinstance.js';
|
||||
export { SshKey } from './smartssh.classes.sshkey.js';
|
||||
export { SshDir } from './smartssh.classes.sshdir.js';
|
||||
export { SshConfig } from './smartssh.classes.sshconfig.js';
|
||||
export { SshClient, SshSftpClient } from './smartssh.classes.sshclient.js';
|
||||
export type {
|
||||
ISshDownloadOptions,
|
||||
ISshExecOptions,
|
||||
ISshExecResult,
|
||||
ISshForwardInHandle,
|
||||
ISshForwardInOptions,
|
||||
ISshForwardOutOptions,
|
||||
ISshProfile,
|
||||
ISshShellOptions,
|
||||
ISshUploadOptions,
|
||||
TSshHostVerifier,
|
||||
} from './smartssh.classes.sshclient.js';
|
||||
export type {
|
||||
ISshConfigHostBlock,
|
||||
ISshConfigOptions,
|
||||
TSshStrictHostKeyChecking,
|
||||
} from './smartssh.classes.sshconfig.js';
|
||||
|
||||
+105
-10
@@ -1,12 +1,107 @@
|
||||
import "typings-global"
|
||||
import * as plugins from "./smartssh.plugins";
|
||||
import {SshKey} from "./smartssh.classes.sshkey";
|
||||
import * as plugins from './smartssh.plugins.js';
|
||||
import { SshKey } from './smartssh.classes.sshkey.js';
|
||||
|
||||
export let sshKeyArrayFromDir = function(dirArg:string):SshKey[]{
|
||||
let sshKeyArray = []; //TODO
|
||||
return sshKeyArray;
|
||||
}
|
||||
const unsafeHostMessage =
|
||||
'SSH host aliases must be single, filename-safe values without whitespace or path separators.';
|
||||
|
||||
export let getKeyIndex = function(hostArg:string){
|
||||
return 0; //TODO
|
||||
}
|
||||
export const assertSafeHost = (hostArg: string) => {
|
||||
if (!hostArg || hostArg === '.' || hostArg === '..') {
|
||||
throw new Error(unsafeHostMessage);
|
||||
}
|
||||
|
||||
if (!/^[A-Za-z0-9._@:%+-]+$/.test(hostArg)) {
|
||||
throw new Error(unsafeHostMessage);
|
||||
}
|
||||
};
|
||||
|
||||
export const isSafeHost = (hostArg: string) => {
|
||||
try {
|
||||
assertSafeHost(hostArg);
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
export const resolveSshDirPath = (dirPathArg?: string) => {
|
||||
return plugins.path.resolve(
|
||||
dirPathArg ?? plugins.path.join(plugins.smartpath.get.home(), '.ssh')
|
||||
);
|
||||
};
|
||||
|
||||
export const ensureSshDirSync = (dirPathArg: string) => {
|
||||
plugins.fs.ensureDirSync(dirPathArg);
|
||||
plugins.fs.chmodSync(dirPathArg, 0o700);
|
||||
};
|
||||
|
||||
export const quoteSshConfigValue = (valueArg: string) => {
|
||||
if (/^[A-Za-z0-9._~/:@%+-]+$/.test(valueArg)) {
|
||||
return valueArg;
|
||||
}
|
||||
|
||||
return `"${valueArg.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
|
||||
};
|
||||
|
||||
export const fingerprintSha256 = (keyArg: Buffer | string) => {
|
||||
const hash = plugins.crypto
|
||||
.createHash('sha256')
|
||||
.update(keyArg)
|
||||
.digest('base64')
|
||||
.replace(/=+$/, '');
|
||||
return `SHA256:${hash}`;
|
||||
};
|
||||
|
||||
export const fingerprintMd5 = (keyArg: Buffer | string) => {
|
||||
const hash = plugins.crypto.createHash('md5').update(keyArg).digest('hex');
|
||||
return hash.match(/.{2}/g)?.join(':') ?? hash;
|
||||
};
|
||||
|
||||
export const sshKeyArrayFromDir = (dirArg: string): SshKey[] => {
|
||||
const resolvedDir = resolveSshDirPath(dirArg);
|
||||
if (!plugins.fs.pathExistsSync(resolvedDir)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const entries = plugins.fs.readdirSync(resolvedDir, { withFileTypes: true });
|
||||
const keyMap = new Map<string, { private?: string; public?: string }>();
|
||||
|
||||
for (const entry of entries) {
|
||||
if (!entry.isFile()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const fileName = entry.name;
|
||||
if (
|
||||
fileName === 'config' ||
|
||||
fileName === 'authorized_keys' ||
|
||||
fileName === 'known_hosts' ||
|
||||
fileName.startsWith('.')
|
||||
) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const isPublicKey = fileName.endsWith('.pub');
|
||||
const host = isPublicKey ? fileName.slice(0, -4) : fileName;
|
||||
if (!isSafeHost(host)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const keyRecord = keyMap.get(host) ?? {};
|
||||
const filePath = plugins.path.join(resolvedDir, fileName);
|
||||
const keyContent = plugins.fs.readFileSync(filePath, 'utf8');
|
||||
if (isPublicKey) {
|
||||
keyRecord.public = keyContent;
|
||||
} else {
|
||||
keyRecord.private = keyContent;
|
||||
}
|
||||
keyMap.set(host, keyRecord);
|
||||
}
|
||||
|
||||
return Array.from(keyMap.entries()).map(([host, keyRecord]) => {
|
||||
return new SshKey({
|
||||
host,
|
||||
private: keyRecord.private,
|
||||
public: keyRecord.public,
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
@@ -1,50 +0,0 @@
|
||||
import "typings-global"
|
||||
import * as plugins from "./smartssh.plugins";
|
||||
import * as helpers from "./smartssh.classes.helpers";
|
||||
|
||||
import {SshDir} from "./smartssh.classes.sshdir";
|
||||
import {SshConfig} from "./smartssh.classes.sshconfig";
|
||||
import {SshKey} from "./smartssh.classes.sshkey";
|
||||
|
||||
export class Ssh {
|
||||
private sshConfig:SshConfig; // points to sshConfig class instance
|
||||
private sshDir:SshDir; // points to sshDir class instance.
|
||||
private sshKeys:SshKey[]; //holds all ssh keys
|
||||
private sshSync:boolean; // if set to true, the ssh dir will be kept in sync automatically
|
||||
constructor(optionsArg:{sshDir?:string,sshSync?:boolean}={}){
|
||||
this.sshDir = new SshDir(optionsArg.sshDir);
|
||||
this.sshKeys = this.sshDir.getKeys();
|
||||
this.sshSync = optionsArg.sshSync;
|
||||
};
|
||||
addKey(sshKeyArg:SshKey){
|
||||
this.sshKeys.push(sshKeyArg);
|
||||
this.sync();
|
||||
};
|
||||
getKey(hostArg:string){
|
||||
let filteredArray = this.sshKeys.filter(function(keyArg){
|
||||
return (keyArg.host == hostArg);
|
||||
});
|
||||
if(filteredArray.length > 0){
|
||||
return filteredArray[0];
|
||||
} else {
|
||||
return undefined;
|
||||
}
|
||||
};
|
||||
removeKey(sshKeyArg:SshKey){
|
||||
let keyIndex = helpers.getKeyIndex(sshKeyArg.host);
|
||||
this.sshKeys.splice(keyIndex,1);
|
||||
this.sync();
|
||||
};
|
||||
replaceKey(sshKeyOldArg:SshKey,sshKeyNewArg:SshKey){
|
||||
let keyIndex = helpers.getKeyIndex(sshKeyOldArg.host);
|
||||
this.sshKeys.splice(keyIndex,1,sshKeyNewArg);
|
||||
this.sync();
|
||||
};
|
||||
sync(){
|
||||
if(this.sshSync){
|
||||
this.sshDir.sync(this.sshConfig,this.sshKeys); // call sync method of sshDir class;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,534 @@
|
||||
import * as plugins from './smartssh.plugins.js';
|
||||
import * as helpers from './smartssh.classes.helpers.js';
|
||||
import { SshKey } from './smartssh.classes.sshkey.js';
|
||||
|
||||
import type * as ssh2 from 'ssh2';
|
||||
|
||||
export type TSshHostVerifier = (fingerprintArg: string, keyArg: Buffer) => boolean | Promise<boolean>;
|
||||
|
||||
export interface ISshProfile {
|
||||
host: string;
|
||||
port?: number;
|
||||
username?: string;
|
||||
password?: string;
|
||||
privateKey?: string | Buffer | SshKey;
|
||||
passphrase?: string | Buffer;
|
||||
agent?: ssh2.ConnectConfig['agent'];
|
||||
agentForward?: boolean;
|
||||
tryKeyboard?: boolean;
|
||||
readyTimeout?: number;
|
||||
keepaliveInterval?: number;
|
||||
keepaliveCountMax?: number;
|
||||
strictVendor?: boolean;
|
||||
strictHostKeyChecking?: boolean;
|
||||
trustedHostFingerprints?: string[];
|
||||
hostVerifier?: TSshHostVerifier;
|
||||
algorithms?: ssh2.Algorithms;
|
||||
authHandler?: ssh2.ConnectConfig['authHandler'];
|
||||
sock?: ssh2.ConnectConfig['sock'];
|
||||
forceIPv4?: boolean;
|
||||
forceIPv6?: boolean;
|
||||
localAddress?: string;
|
||||
localPort?: number;
|
||||
timeout?: number;
|
||||
ident?: Buffer | string;
|
||||
debug?: ssh2.DebugFunction;
|
||||
}
|
||||
|
||||
export interface ISshExecOptions extends ssh2.ExecOptions {
|
||||
input?: string | Buffer;
|
||||
encoding?: BufferEncoding;
|
||||
timeout?: number;
|
||||
signal?: AbortSignal;
|
||||
}
|
||||
|
||||
export interface ISshExecResult {
|
||||
command: string;
|
||||
code: number | null;
|
||||
signal: string | null;
|
||||
stdout: string;
|
||||
stderr: string;
|
||||
stdoutBuffer: Buffer;
|
||||
stderrBuffer: Buffer;
|
||||
}
|
||||
|
||||
export interface ISshShellOptions {
|
||||
window?: ssh2.PseudoTtyOptions | false;
|
||||
options?: ssh2.ShellOptions;
|
||||
}
|
||||
|
||||
export interface ISshForwardOutOptions {
|
||||
sourceHost?: string;
|
||||
sourcePort?: number;
|
||||
destinationHost: string;
|
||||
destinationPort: number;
|
||||
}
|
||||
|
||||
export interface ISshForwardInOptions {
|
||||
remoteHost?: string;
|
||||
remotePort: number;
|
||||
}
|
||||
|
||||
export interface ISshForwardInHandle {
|
||||
remoteHost: string;
|
||||
remotePort: number;
|
||||
close: () => Promise<void>;
|
||||
}
|
||||
|
||||
export interface ISshUploadOptions {
|
||||
localPath: string;
|
||||
remotePath: string;
|
||||
transferOptions?: ssh2.TransferOptions;
|
||||
}
|
||||
|
||||
export interface ISshDownloadOptions {
|
||||
remotePath: string;
|
||||
localPath: string;
|
||||
transferOptions?: ssh2.TransferOptions;
|
||||
}
|
||||
|
||||
export class SshSftpClient {
|
||||
constructor(private sftp: ssh2.SFTPWrapper) {}
|
||||
|
||||
async upload(optionsArg: ISshUploadOptions) {
|
||||
await this.runVoid((done) => {
|
||||
if (optionsArg.transferOptions) {
|
||||
this.sftp.fastPut(optionsArg.localPath, optionsArg.remotePath, optionsArg.transferOptions, done);
|
||||
} else {
|
||||
this.sftp.fastPut(optionsArg.localPath, optionsArg.remotePath, done);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
async download(optionsArg: ISshDownloadOptions) {
|
||||
await this.runVoid((done) => {
|
||||
if (optionsArg.transferOptions) {
|
||||
this.sftp.fastGet(optionsArg.remotePath, optionsArg.localPath, optionsArg.transferOptions, done);
|
||||
} else {
|
||||
this.sftp.fastGet(optionsArg.remotePath, optionsArg.localPath, done);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
async readFile(remotePathArg: string): Promise<Buffer>;
|
||||
async readFile(remotePathArg: string, encodingArg: BufferEncoding): Promise<string>;
|
||||
async readFile(remotePathArg: string, encodingArg?: BufferEncoding) {
|
||||
const fileBuffer = await this.run<Buffer>((done) => {
|
||||
this.sftp.readFile(remotePathArg, (error, fileContent) => done(error, fileContent));
|
||||
});
|
||||
return encodingArg ? fileBuffer.toString(encodingArg) : fileBuffer;
|
||||
}
|
||||
|
||||
async writeFile(remotePathArg: string, dataArg: string | Buffer) {
|
||||
await this.runVoid((done) => this.sftp.writeFile(remotePathArg, dataArg, done));
|
||||
}
|
||||
|
||||
async readdir(remotePathArg: string) {
|
||||
return this.run<ssh2.FileEntryWithStats[]>((done) => {
|
||||
this.sftp.readdir(remotePathArg, (error, list) => done(error, list));
|
||||
});
|
||||
}
|
||||
|
||||
async stat(remotePathArg: string) {
|
||||
return this.run<ssh2.Stats>((done) => {
|
||||
this.sftp.stat(remotePathArg, (error, stats) => done(error, stats));
|
||||
});
|
||||
}
|
||||
|
||||
async lstat(remotePathArg: string) {
|
||||
return this.run<ssh2.Stats>((done) => {
|
||||
this.sftp.lstat(remotePathArg, (error, stats) => done(error, stats));
|
||||
});
|
||||
}
|
||||
|
||||
async mkdir(remotePathArg: string, attributesArg?: ssh2.InputAttributes) {
|
||||
await this.runVoid((done) => {
|
||||
if (attributesArg) {
|
||||
this.sftp.mkdir(remotePathArg, attributesArg, done);
|
||||
} else {
|
||||
this.sftp.mkdir(remotePathArg, done);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
async chmod(remotePathArg: string, modeArg: number | string) {
|
||||
await this.runVoid((done) => this.sftp.chmod(remotePathArg, modeArg, done));
|
||||
}
|
||||
|
||||
async remove(remotePathArg: string) {
|
||||
await this.runVoid((done) => this.sftp.unlink(remotePathArg, done));
|
||||
}
|
||||
|
||||
async rmdir(remotePathArg: string) {
|
||||
await this.runVoid((done) => this.sftp.rmdir(remotePathArg, done));
|
||||
}
|
||||
|
||||
async rename(sourcePathArg: string, destinationPathArg: string) {
|
||||
await this.runVoid((done) => this.sftp.rename(sourcePathArg, destinationPathArg, done));
|
||||
}
|
||||
|
||||
private async run<T>(runnerArg: (doneArg: (errorArg?: Error | null, valueArg?: T) => void) => void) {
|
||||
return new Promise<T>((resolve, reject) => {
|
||||
runnerArg((error, value) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
resolve(value as T);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
private async runVoid(runnerArg: (doneArg: (errorArg?: Error | null) => void) => void) {
|
||||
await this.run<void>((done) => runnerArg(done));
|
||||
}
|
||||
}
|
||||
|
||||
export class SshClient {
|
||||
private connection?: ssh2.Client;
|
||||
private connected = false;
|
||||
private lastError?: Error;
|
||||
|
||||
constructor(private profile: ISshProfile) {}
|
||||
|
||||
static async connect(profileArg: ISshProfile) {
|
||||
const sshClient = new SshClient(profileArg);
|
||||
await sshClient.connect();
|
||||
return sshClient;
|
||||
}
|
||||
|
||||
static fingerprintSha256(keyArg: Buffer | string) {
|
||||
return helpers.fingerprintSha256(keyArg);
|
||||
}
|
||||
|
||||
static fingerprintMd5(keyArg: Buffer | string) {
|
||||
return helpers.fingerprintMd5(keyArg);
|
||||
}
|
||||
|
||||
async connect() {
|
||||
if (this.connected) {
|
||||
return;
|
||||
}
|
||||
|
||||
const connectConfig = this.createConnectConfig();
|
||||
const connection = new plugins.ssh2.Client();
|
||||
this.connection = connection;
|
||||
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
let settled = false;
|
||||
const settle = (errorArg?: Error) => {
|
||||
if (settled) {
|
||||
if (errorArg) {
|
||||
this.lastError = errorArg;
|
||||
}
|
||||
return;
|
||||
}
|
||||
settled = true;
|
||||
connection.removeListener('ready', handleReady);
|
||||
connection.removeListener('close', handleClose);
|
||||
if (errorArg) {
|
||||
reject(errorArg);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
};
|
||||
const handleReady = () => {
|
||||
this.connected = true;
|
||||
settle();
|
||||
};
|
||||
const handleClose = () => {
|
||||
this.connected = false;
|
||||
settle(new Error('SSH connection closed before it became ready.'));
|
||||
};
|
||||
const handleError = (errorArg: Error) => {
|
||||
this.lastError = errorArg;
|
||||
settle(errorArg);
|
||||
};
|
||||
|
||||
connection.on('error', handleError);
|
||||
connection.once('ready', handleReady);
|
||||
connection.once('close', handleClose);
|
||||
connection.connect(connectConfig);
|
||||
});
|
||||
}
|
||||
|
||||
async exec(commandArg: string, optionsArg: ISshExecOptions = {}): Promise<ISshExecResult> {
|
||||
const connection = this.ensureConnected();
|
||||
const { input, encoding = 'utf8', timeout, signal, ...execOptions } = optionsArg;
|
||||
|
||||
return new Promise<ISshExecResult>((resolve, reject) => {
|
||||
let settled = false;
|
||||
let timeoutHandle: NodeJS.Timeout | undefined;
|
||||
let channel: ssh2.ClientChannel | undefined;
|
||||
let code: number | null = null;
|
||||
let exitSignal: string | null = null;
|
||||
const stdoutChunks: Buffer[] = [];
|
||||
const stderrChunks: Buffer[] = [];
|
||||
|
||||
const settle = (errorArg?: Error) => {
|
||||
if (settled) {
|
||||
return;
|
||||
}
|
||||
settled = true;
|
||||
if (timeoutHandle) {
|
||||
clearTimeout(timeoutHandle);
|
||||
}
|
||||
signal?.removeEventListener('abort', handleAbort);
|
||||
if (errorArg) {
|
||||
reject(errorArg);
|
||||
return;
|
||||
}
|
||||
const stdoutBuffer = Buffer.concat(stdoutChunks);
|
||||
const stderrBuffer = Buffer.concat(stderrChunks);
|
||||
resolve({
|
||||
command: commandArg,
|
||||
code,
|
||||
signal: exitSignal,
|
||||
stdout: stdoutBuffer.toString(encoding),
|
||||
stderr: stderrBuffer.toString(encoding),
|
||||
stdoutBuffer,
|
||||
stderrBuffer,
|
||||
});
|
||||
};
|
||||
|
||||
const handleAbort = () => {
|
||||
channel?.close();
|
||||
settle(new Error(`SSH exec aborted: ${commandArg}`));
|
||||
};
|
||||
|
||||
if (signal?.aborted) {
|
||||
handleAbort();
|
||||
return;
|
||||
}
|
||||
|
||||
if (timeout) {
|
||||
timeoutHandle = setTimeout(() => {
|
||||
channel?.close();
|
||||
settle(new Error(`SSH exec timed out after ${timeout}ms: ${commandArg}`));
|
||||
}, timeout);
|
||||
}
|
||||
|
||||
signal?.addEventListener('abort', handleAbort);
|
||||
|
||||
connection.exec(commandArg, execOptions, (error, stream) => {
|
||||
if (error) {
|
||||
settle(error);
|
||||
return;
|
||||
}
|
||||
|
||||
channel = stream;
|
||||
stream.on('data', (chunk: Buffer | string) => stdoutChunks.push(Buffer.from(chunk)));
|
||||
stream.stderr.on('data', (chunk: Buffer | string) => stderrChunks.push(Buffer.from(chunk)));
|
||||
stream.on('exit', (exitCode: number | null, signalName?: string) => {
|
||||
code = exitCode;
|
||||
exitSignal = signalName ?? null;
|
||||
});
|
||||
stream.on('error', (streamError: Error) => settle(streamError));
|
||||
stream.on('close', () => settle());
|
||||
stream.end(input);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
async stream(commandArg: string, optionsArg: ssh2.ExecOptions = {}) {
|
||||
const connection = this.ensureConnected();
|
||||
return new Promise<ssh2.ClientChannel>((resolve, reject) => {
|
||||
connection.exec(commandArg, optionsArg, (error, channel) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
resolve(channel);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
async shell(optionsArg: ISshShellOptions = {}) {
|
||||
const connection = this.ensureConnected();
|
||||
return new Promise<ssh2.ClientChannel>((resolve, reject) => {
|
||||
const done = (error: Error | undefined, channel: ssh2.ClientChannel) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
resolve(channel);
|
||||
};
|
||||
|
||||
if (optionsArg.window !== undefined) {
|
||||
connection.shell(optionsArg.window, optionsArg.options ?? {}, done);
|
||||
} else {
|
||||
connection.shell(optionsArg.options ?? {}, done);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
async sftp() {
|
||||
const connection = this.ensureConnected();
|
||||
return new Promise<SshSftpClient>((resolve, reject) => {
|
||||
connection.sftp((error, sftp) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
resolve(new SshSftpClient(sftp));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
async forwardOut(optionsArg: ISshForwardOutOptions) {
|
||||
const connection = this.ensureConnected();
|
||||
return new Promise<ssh2.ClientChannel>((resolve, reject) => {
|
||||
connection.forwardOut(
|
||||
optionsArg.sourceHost ?? '127.0.0.1',
|
||||
optionsArg.sourcePort ?? 0,
|
||||
optionsArg.destinationHost,
|
||||
optionsArg.destinationPort,
|
||||
(error, channel) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
resolve(channel);
|
||||
}
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
async forwardIn(optionsArg: ISshForwardInOptions): Promise<ISshForwardInHandle> {
|
||||
const connection = this.ensureConnected();
|
||||
const remoteHost = optionsArg.remoteHost ?? '127.0.0.1';
|
||||
const remotePort = await new Promise<number>((resolve, reject) => {
|
||||
connection.forwardIn(remoteHost, optionsArg.remotePort, (error, port) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
resolve(port);
|
||||
});
|
||||
});
|
||||
|
||||
return {
|
||||
remoteHost,
|
||||
remotePort,
|
||||
close: async () => {
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
connection.unforwardIn(remoteHost, remotePort, (error) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
return;
|
||||
}
|
||||
resolve();
|
||||
});
|
||||
});
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
async close() {
|
||||
const connection = this.connection;
|
||||
if (!connection) {
|
||||
return;
|
||||
}
|
||||
|
||||
await new Promise<void>((resolve) => {
|
||||
const timeoutHandle = setTimeout(resolve, 1000);
|
||||
connection.once('close', () => {
|
||||
clearTimeout(timeoutHandle);
|
||||
resolve();
|
||||
});
|
||||
connection.end();
|
||||
});
|
||||
this.connected = false;
|
||||
this.connection = undefined;
|
||||
}
|
||||
|
||||
get isConnected() {
|
||||
return this.connected;
|
||||
}
|
||||
|
||||
get error() {
|
||||
return this.lastError;
|
||||
}
|
||||
|
||||
private createConnectConfig(): ssh2.ConnectConfig {
|
||||
const strictHostKeyChecking = this.profile.strictHostKeyChecking ?? true;
|
||||
const hasHostValidation =
|
||||
Boolean(this.profile.hostVerifier) || Boolean(this.profile.trustedHostFingerprints?.length);
|
||||
|
||||
if (strictHostKeyChecking && !hasHostValidation) {
|
||||
throw new Error(
|
||||
'strictHostKeyChecking is enabled. Provide trustedHostFingerprints, hostVerifier, or set strictHostKeyChecking to false.'
|
||||
);
|
||||
}
|
||||
|
||||
const privateKey =
|
||||
this.profile.privateKey instanceof SshKey
|
||||
? this.profile.privateKey.privKey
|
||||
: this.profile.privateKey;
|
||||
|
||||
const connectConfig: ssh2.ConnectConfig = {
|
||||
host: this.profile.host,
|
||||
port: this.profile.port,
|
||||
username: this.profile.username,
|
||||
password: this.profile.password,
|
||||
privateKey,
|
||||
passphrase: this.profile.passphrase,
|
||||
agent: this.profile.agent,
|
||||
agentForward: this.profile.agentForward,
|
||||
tryKeyboard: this.profile.tryKeyboard,
|
||||
readyTimeout: this.profile.readyTimeout,
|
||||
keepaliveInterval: this.profile.keepaliveInterval,
|
||||
keepaliveCountMax: this.profile.keepaliveCountMax,
|
||||
strictVendor: this.profile.strictVendor,
|
||||
algorithms: this.profile.algorithms,
|
||||
authHandler: this.profile.authHandler,
|
||||
sock: this.profile.sock,
|
||||
forceIPv4: this.profile.forceIPv4,
|
||||
forceIPv6: this.profile.forceIPv6,
|
||||
localAddress: this.profile.localAddress,
|
||||
localPort: this.profile.localPort,
|
||||
timeout: this.profile.timeout,
|
||||
ident: this.profile.ident,
|
||||
debug: this.profile.debug,
|
||||
};
|
||||
|
||||
connectConfig.hostVerifier = ((key: Buffer, verify: ssh2.VerifyCallback) => {
|
||||
const verifyHost = async () => {
|
||||
if (!strictHostKeyChecking && !hasHostValidation) {
|
||||
return true;
|
||||
}
|
||||
|
||||
const sha256Fingerprint = helpers.fingerprintSha256(key);
|
||||
const md5Fingerprint = helpers.fingerprintMd5(key);
|
||||
const trustedFingerprints = this.profile.trustedHostFingerprints ?? [];
|
||||
if (
|
||||
trustedFingerprints.includes(sha256Fingerprint) ||
|
||||
trustedFingerprints.includes(md5Fingerprint) ||
|
||||
trustedFingerprints.includes(`MD5:${md5Fingerprint}`)
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (this.profile.hostVerifier) {
|
||||
return this.profile.hostVerifier(sha256Fingerprint, key);
|
||||
}
|
||||
|
||||
return false;
|
||||
};
|
||||
|
||||
verifyHost().then(
|
||||
(result) => verify(Boolean(result)),
|
||||
() => verify(false)
|
||||
);
|
||||
}) as ssh2.HostVerifier;
|
||||
|
||||
return connectConfig;
|
||||
}
|
||||
|
||||
private ensureConnected() {
|
||||
if (!this.connection || !this.connected) {
|
||||
throw new Error('SSH client is not connected.');
|
||||
}
|
||||
return this.connection;
|
||||
}
|
||||
}
|
||||
@@ -1,8 +1,124 @@
|
||||
import "typings-global";
|
||||
import * as plugins from "./smartssh.plugins";
|
||||
import * as helpers from "./smartssh.classes.helpers";
|
||||
import * as plugins from './smartssh.plugins.js';
|
||||
import * as helpers from './smartssh.classes.helpers.js';
|
||||
import { SshKey } from './smartssh.classes.sshkey.js';
|
||||
|
||||
export type TSshStrictHostKeyChecking = boolean | 'accept-new';
|
||||
|
||||
export interface ISshConfigOptions {
|
||||
strictHostKeyChecking?: TSshStrictHostKeyChecking;
|
||||
}
|
||||
|
||||
export interface ISshConfigHostBlock {
|
||||
host: string;
|
||||
values: Record<string, string>;
|
||||
}
|
||||
|
||||
export class SshConfig {
|
||||
constructor(){
|
||||
|
||||
private _sshKeyArray: SshKey[];
|
||||
private _options: ISshConfigOptions;
|
||||
constructor(sshKeyArrayArg: SshKey[], optionsArg: ISshConfigOptions = {}) {
|
||||
this._sshKeyArray = sshKeyArrayArg;
|
||||
this._options = {
|
||||
...optionsArg,
|
||||
strictHostKeyChecking: optionsArg.strictHostKeyChecking ?? true,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* stores a config file
|
||||
*/
|
||||
store(dirPathArg: string) {
|
||||
const resolvedDir = helpers.resolveSshDirPath(dirPathArg);
|
||||
helpers.ensureSshDirSync(resolvedDir);
|
||||
const configArray: configObject[] = [];
|
||||
for (const sshKey of this._sshKeyArray) {
|
||||
let configString = '';
|
||||
if (sshKey.host) {
|
||||
helpers.assertSafeHost(sshKey.host);
|
||||
const identityFilePath = plugins.path.join(resolvedDir, sshKey.host);
|
||||
configString =
|
||||
'Host ' +
|
||||
sshKey.host +
|
||||
'\n' +
|
||||
' HostName ' +
|
||||
sshKey.host +
|
||||
'\n' +
|
||||
' IdentityFile ' +
|
||||
helpers.quoteSshConfigValue(identityFilePath) +
|
||||
'\n';
|
||||
if (this._options.strictHostKeyChecking !== undefined) {
|
||||
const strictHostKeyChecking = this._options.strictHostKeyChecking;
|
||||
configString +=
|
||||
' StrictHostKeyChecking ' +
|
||||
(strictHostKeyChecking === 'accept-new'
|
||||
? 'accept-new'
|
||||
: strictHostKeyChecking
|
||||
? 'yes'
|
||||
: 'no') +
|
||||
'\n';
|
||||
}
|
||||
}
|
||||
configArray.push({
|
||||
configString: configString,
|
||||
authorized: sshKey.authorized,
|
||||
sshKey: sshKey,
|
||||
});
|
||||
}
|
||||
}
|
||||
let configFile: string = '';
|
||||
for (const config of configArray) {
|
||||
configFile = configFile + config.configString + '\n';
|
||||
}
|
||||
plugins.fs.writeFileSync(plugins.path.join(resolvedDir, 'config'), configFile);
|
||||
plugins.fs.chmodSync(plugins.path.join(resolvedDir, 'config'), 0o600);
|
||||
}
|
||||
read(dirPathArg: string) {
|
||||
const configPath = plugins.path.join(helpers.resolveSshDirPath(dirPathArg), 'config');
|
||||
return plugins.fs.readFileSync(configPath, 'utf8');
|
||||
}
|
||||
|
||||
parse(dirPathArg: string) {
|
||||
return SshConfig.parse(this.read(dirPathArg));
|
||||
}
|
||||
|
||||
static parse(configStringArg: string): ISshConfigHostBlock[] {
|
||||
const blocks: ISshConfigHostBlock[] = [];
|
||||
let currentBlock: ISshConfigHostBlock | undefined;
|
||||
|
||||
for (const rawLine of configStringArg.split(/\r?\n/)) {
|
||||
const line = rawLine.trim();
|
||||
if (!line || line.startsWith('#')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const [keyword, ...valueParts] = line.split(/\s+/);
|
||||
const value = valueParts.join(' ');
|
||||
if (!keyword || !value) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (keyword.toLowerCase() === 'host') {
|
||||
if (!helpers.isSafeHost(value)) {
|
||||
continue;
|
||||
}
|
||||
currentBlock = {
|
||||
host: value,
|
||||
values: {},
|
||||
};
|
||||
blocks.push(currentBlock);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (currentBlock) {
|
||||
currentBlock.values[keyword.toLowerCase()] = value;
|
||||
}
|
||||
}
|
||||
|
||||
return blocks;
|
||||
}
|
||||
}
|
||||
|
||||
export interface configObject {
|
||||
configString: string;
|
||||
authorized: boolean;
|
||||
sshKey: SshKey;
|
||||
}
|
||||
|
||||
@@ -1,17 +1,45 @@
|
||||
import "typings-global";
|
||||
import * as plugins from "./smartssh.plugins";
|
||||
import * as helpers from "./smartssh.classes.helpers";
|
||||
import {SshKey} from "./smartssh.classes.sshkey";
|
||||
import {SshConfig} from "./smartssh.classes.sshconfig";
|
||||
export class SshDir { // sshDir class -> NOT EXPORTED, ONLY FOR INTERNAL USE
|
||||
path:string;
|
||||
constructor(sshDirPathArg:string){
|
||||
this.path = sshDirPathArg;
|
||||
import * as plugins from './smartssh.plugins.js';
|
||||
import * as helpers from './smartssh.classes.helpers.js';
|
||||
import { SshKey } from './smartssh.classes.sshkey.js';
|
||||
import { SshConfig } from './smartssh.classes.sshconfig.js';
|
||||
|
||||
export class SshDir {
|
||||
// sshDir class -> NOT EXPORTED, ONLY FOR INTERNAL USE
|
||||
private _path: string; // the path of the ssh directory
|
||||
private _sshKeyArray: SshKey[];
|
||||
private _sshConfig: SshConfig;
|
||||
constructor(sshKeyArray: SshKey[], sshConfig: SshConfig, sshDirPathArg?: string) {
|
||||
this._sshKeyArray = sshKeyArray;
|
||||
this._sshConfig = sshConfig;
|
||||
if (sshDirPathArg) {
|
||||
this._path = helpers.resolveSshDirPath(sshDirPathArg);
|
||||
} else {
|
||||
this._path = helpers.resolveSshDirPath();
|
||||
}
|
||||
sync(sshConfigArg:SshConfig,sshKeysArg:SshKey[]){
|
||||
|
||||
};
|
||||
getKeys(){
|
||||
return helpers.sshKeyArrayFromDir(this.path);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
writeToDir(dirPathArg?: string) {
|
||||
// syncs sshInstance to directory
|
||||
let path = this._path;
|
||||
if (dirPathArg) path = helpers.resolveSshDirPath(dirPathArg);
|
||||
this._sshKeyArray.forEach((sshKeyArg) => {
|
||||
sshKeyArg.storeSync(path);
|
||||
});
|
||||
this._sshConfig.store(path);
|
||||
}
|
||||
|
||||
readFromDir(dirPathArg?: string) {
|
||||
// syncs sshInstance from directory
|
||||
let path = this._path;
|
||||
if (dirPathArg) path = helpers.resolveSshDirPath(dirPathArg);
|
||||
const sshKeys = helpers.sshKeyArrayFromDir(path);
|
||||
this._sshKeyArray.splice(0, this._sshKeyArray.length, ...sshKeys);
|
||||
}
|
||||
updateDirPath(dirPathArg: string) {
|
||||
this._path = helpers.resolveSshDirPath(dirPathArg);
|
||||
}
|
||||
|
||||
getKeys() {
|
||||
return helpers.sshKeyArrayFromDir(this._path);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,103 @@
|
||||
import * as plugins from './smartssh.plugins.js';
|
||||
|
||||
import { SshDir } from './smartssh.classes.sshdir.js';
|
||||
import { SshConfig, type ISshConfigOptions } from './smartssh.classes.sshconfig.js';
|
||||
import { SshKey } from './smartssh.classes.sshkey.js';
|
||||
|
||||
/**
|
||||
* SshInstance is the main class dealing with ssh management
|
||||
*/
|
||||
export class SshInstance {
|
||||
private _sshKeyArray: SshKey[]; // holds all ssh keys
|
||||
private _sshConfig: SshConfig; // sshConfig (e.g. represents ~/.ssh/config)
|
||||
private _sshDir: SshDir; // points to sshDir class instance.
|
||||
private _sshSync: boolean; // if set to true, the ssh dir will be kept in sync automatically
|
||||
constructor(optionsArg: { sshDirPath?: string; sshSync?: boolean } & ISshConfigOptions = {}) {
|
||||
optionsArg ? void 0 : (optionsArg = {});
|
||||
this._sshKeyArray = [];
|
||||
this._sshConfig = new SshConfig(this._sshKeyArray, {
|
||||
strictHostKeyChecking: optionsArg.strictHostKeyChecking,
|
||||
});
|
||||
this._sshDir = new SshDir(this._sshKeyArray, this._sshConfig, optionsArg.sshDirPath);
|
||||
this._sshSync = optionsArg.sshSync ?? false;
|
||||
}
|
||||
|
||||
// altering methods
|
||||
addKey(sshKeyArg: SshKey) {
|
||||
this._syncAuto('from');
|
||||
this._sshKeyArray.push(sshKeyArg);
|
||||
this._syncAuto('to');
|
||||
}
|
||||
removeKey(sshKeyArg: SshKey) {
|
||||
this._syncAuto('from');
|
||||
const sshKeyIndex = this._sshKeyArray.indexOf(sshKeyArg);
|
||||
if (sshKeyIndex >= 0) {
|
||||
this._sshKeyArray.splice(sshKeyIndex, 1);
|
||||
}
|
||||
this._syncAuto('to');
|
||||
}
|
||||
replaceKey(sshKeyOldArg: SshKey, sshKeyNewArg: SshKey) {
|
||||
this._syncAuto('from');
|
||||
this.removeKey(sshKeyOldArg);
|
||||
this.addKey(sshKeyNewArg);
|
||||
this._syncAuto('to');
|
||||
}
|
||||
|
||||
// non altering methods
|
||||
getKey(hostArg: string): SshKey | undefined {
|
||||
this._syncAuto('from');
|
||||
let filteredArray = this._sshKeyArray.filter(function (keyArg) {
|
||||
return keyArg.host === hostArg;
|
||||
});
|
||||
if (filteredArray.length > 0) {
|
||||
return filteredArray[0];
|
||||
} else {
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
get sshKeys(): SshKey[] {
|
||||
this._syncAuto('from');
|
||||
return this._sshKeyArray;
|
||||
}
|
||||
|
||||
// FS methods
|
||||
|
||||
/**
|
||||
* write SshInstance to disk
|
||||
*/
|
||||
writeToDisk(dirPathArg?: string) {
|
||||
this._sync('to', dirPathArg);
|
||||
}
|
||||
|
||||
/**
|
||||
* read ab SshInstance from disk
|
||||
*/
|
||||
readFromDisk(dirPathArg?: string) {
|
||||
this._sync('from', dirPathArg);
|
||||
}
|
||||
|
||||
/* ===============================================================
|
||||
========================= Private Methods ========================
|
||||
================================================================*/
|
||||
|
||||
/**
|
||||
* method to invoke SshInstance _sync automatically when sshSync is true
|
||||
*/
|
||||
private _syncAuto(directionArg: 'from' | 'to') {
|
||||
if (this._sshSync) {
|
||||
// if auto sync is not enabled, do nothing
|
||||
this._sync(directionArg);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* private method to sync SshInstance
|
||||
*/
|
||||
private _sync(directionArg: 'from' | 'to', dirPathArg?: string) {
|
||||
if (directionArg === 'from') {
|
||||
this._sshDir.readFromDir(dirPathArg); // call sync method of sshDir class;
|
||||
} else if (directionArg === 'to') {
|
||||
this._sshDir.writeToDir(dirPathArg);
|
||||
}
|
||||
}
|
||||
}
|
||||
+147
-59
@@ -1,65 +1,153 @@
|
||||
import "typings-global";
|
||||
import * as plugins from "./smartssh.plugins";
|
||||
import * as helpers from "./smartssh.classes.helpers";
|
||||
import * as plugins from './smartssh.plugins.js';
|
||||
import * as helpers from './smartssh.classes.helpers.js';
|
||||
|
||||
export type TSshKeyType = 'duplex' | 'private' | 'public';
|
||||
|
||||
export class SshKey {
|
||||
private privKey:string;
|
||||
private pubKey:string;
|
||||
private hostVar:string;
|
||||
constructor(optionsArg:{private?:string,public?:string,host?:string}={}){
|
||||
this.privKey = optionsArg.private;
|
||||
this.pubKey = optionsArg.public;
|
||||
this.hostVar = optionsArg.host;
|
||||
};
|
||||
|
||||
// getters
|
||||
get host(){
|
||||
return this.hostVar;
|
||||
};
|
||||
get privateKey(){
|
||||
return this.privKey;
|
||||
};
|
||||
get privateKeyBase64(){
|
||||
return plugins.base64.encode(this.privKey);
|
||||
private _privKey: string;
|
||||
private _pubKey: string;
|
||||
private _hostVar: string;
|
||||
private _authorized: boolean;
|
||||
|
||||
/**
|
||||
* the constructor for class SshKey
|
||||
*/
|
||||
constructor(
|
||||
optionsArg: { private?: string; public?: string; host?: string; authorized?: boolean } = {}
|
||||
) {
|
||||
this._privKey = optionsArg.private ?? '';
|
||||
this._pubKey = optionsArg.public ?? '';
|
||||
if (optionsArg.host) {
|
||||
helpers.assertSafeHost(optionsArg.host);
|
||||
}
|
||||
get publicKey(){
|
||||
return this.publicKey;
|
||||
this._hostVar = optionsArg.host ?? '';
|
||||
this._authorized = optionsArg.authorized ?? false;
|
||||
}
|
||||
|
||||
// this.host
|
||||
get host() {
|
||||
return this._hostVar;
|
||||
}
|
||||
set host(hostArg: string) {
|
||||
if (hostArg) {
|
||||
helpers.assertSafeHost(hostArg);
|
||||
}
|
||||
get publicKeyBase64(){
|
||||
return plugins.base64.encode(this.pubKey);
|
||||
this._hostVar = hostArg;
|
||||
}
|
||||
|
||||
// this.privKey
|
||||
get privKey() {
|
||||
return this._privKey;
|
||||
}
|
||||
set privKey(privateKeyArg: string) {
|
||||
this._privKey = privateKeyArg;
|
||||
}
|
||||
|
||||
// this.privKeyBase64
|
||||
get privKeyBase64() {
|
||||
return plugins.smartstring.base64.encode(this._privKey);
|
||||
}
|
||||
set privKeyBase64(privateKeyArg: string) {
|
||||
this._privKey = plugins.smartstring.base64.decode(privateKeyArg);
|
||||
}
|
||||
|
||||
// this.pubKey
|
||||
get pubKey() {
|
||||
return this._pubKey;
|
||||
}
|
||||
set pubKey(publicKeyArg: string) {
|
||||
this._pubKey = publicKeyArg;
|
||||
}
|
||||
|
||||
// this.pubKeyBase64
|
||||
get pubKeyBase64() {
|
||||
return plugins.smartstring.base64.encode(this._pubKey);
|
||||
}
|
||||
set pubKeyBase64(publicKeyArg: string) {
|
||||
this._pubKey = plugins.smartstring.base64.decode(publicKeyArg);
|
||||
}
|
||||
|
||||
get authorized() {
|
||||
return this._authorized;
|
||||
}
|
||||
set authorized(authorizedArg: boolean) {
|
||||
this._authorized = authorizedArg;
|
||||
}
|
||||
|
||||
/**
|
||||
* returns wether there is a private, a public or both keys
|
||||
*/
|
||||
get type(): TSshKeyType | undefined {
|
||||
if (this._privKey && this._pubKey) {
|
||||
return 'duplex';
|
||||
} else if (this._privKey) {
|
||||
return 'private';
|
||||
} else if (this._pubKey) {
|
||||
return 'public';
|
||||
}
|
||||
get type(){
|
||||
if(this.privKey && this.pubKey){
|
||||
return "duplex";
|
||||
} else if(this.privKey){
|
||||
return "private";
|
||||
} else if(this.pubKey){
|
||||
return "public";
|
||||
}
|
||||
};
|
||||
|
||||
// setters
|
||||
set host(hostArg:string){
|
||||
this.hostVar = hostArg;
|
||||
};
|
||||
set privateKey(privateKeyArg:string){
|
||||
this.privKey = privateKeyArg;
|
||||
};
|
||||
// setters
|
||||
set publicKey(publicKeyArg:string){
|
||||
this.pubKey = publicKeyArg;
|
||||
};
|
||||
|
||||
store(filePathArg?:string){
|
||||
let filePathObj = plugins.path.parse(filePathArg);
|
||||
if(filePathObj.ext = ".priv"){
|
||||
plugins.smartfile.memory.toFsSync(this.privKey,{fileName:filePathObj.name + filePathObj.ext,filePath:filePathObj.dir});
|
||||
} else if (filePathObj.ext = ".pub"){
|
||||
plugins.smartfile.memory.toFsSync(this.pubKey,{fileName:filePathObj.name + filePathObj.ext,filePath:filePathObj.dir});
|
||||
} else { //we assume we are given a directory as filePathArg, so we store the whole key
|
||||
plugins.fs.ensureDirSync(filePathObj.dir);
|
||||
this.store(plugins.path.join(filePathObj.dir,"key.priv")); // call this function recursivly
|
||||
this.store(plugins.path.join(filePathObj.dir,"key.priv")); // call this function recursivly
|
||||
}
|
||||
}
|
||||
|
||||
// methods
|
||||
read(filePathArg: string) {
|
||||
const resolvedPath = plugins.path.resolve(filePathArg);
|
||||
const fileName = plugins.path.basename(resolvedPath);
|
||||
const isPublicKey = fileName.endsWith('.pub');
|
||||
const host = isPublicKey ? fileName.slice(0, -4) : fileName;
|
||||
helpers.assertSafeHost(host);
|
||||
|
||||
this._hostVar = host;
|
||||
if (isPublicKey) {
|
||||
this._pubKey = plugins.fs.readFileSync(resolvedPath, 'utf8');
|
||||
} else {
|
||||
this._privKey = plugins.fs.readFileSync(resolvedPath, 'utf8');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static fromFile(filePathArg: string) {
|
||||
const sshKey = new SshKey();
|
||||
sshKey.read(filePathArg);
|
||||
return sshKey;
|
||||
}
|
||||
|
||||
static fromFiles(optionsArg: { privateKeyPath?: string; publicKeyPath?: string; host?: string }) {
|
||||
const sshKey = new SshKey({ host: optionsArg.host });
|
||||
if (optionsArg.privateKeyPath) {
|
||||
sshKey.privKey = plugins.fs.readFileSync(plugins.path.resolve(optionsArg.privateKeyPath), 'utf8');
|
||||
if (!sshKey.host) {
|
||||
const fileName = plugins.path.basename(optionsArg.privateKeyPath);
|
||||
helpers.assertSafeHost(fileName);
|
||||
sshKey.host = fileName;
|
||||
}
|
||||
}
|
||||
if (optionsArg.publicKeyPath) {
|
||||
sshKey.pubKey = plugins.fs.readFileSync(plugins.path.resolve(optionsArg.publicKeyPath), 'utf8');
|
||||
if (!sshKey.host) {
|
||||
const fileName = plugins.path.basename(optionsArg.publicKeyPath).replace(/\.pub$/, '');
|
||||
helpers.assertSafeHost(fileName);
|
||||
sshKey.host = fileName;
|
||||
}
|
||||
}
|
||||
return sshKey;
|
||||
}
|
||||
|
||||
async store(dirPathArg: string) {
|
||||
this.storeSync(dirPathArg);
|
||||
}
|
||||
|
||||
storeSync(dirPathArg: string) {
|
||||
helpers.assertSafeHost(this.host);
|
||||
const resolvedDir = helpers.resolveSshDirPath(dirPathArg);
|
||||
helpers.ensureSshDirSync(resolvedDir);
|
||||
const fileNameBase = this.host;
|
||||
if (this._privKey) {
|
||||
const filePath = plugins.path.join(resolvedDir, fileNameBase);
|
||||
plugins.fs.writeFileSync(filePath, this._privKey);
|
||||
plugins.fs.chmodSync(filePath, 0o600);
|
||||
}
|
||||
if (this._pubKey) {
|
||||
const filePath = plugins.path.join(resolvedDir, fileNameBase + '.pub');
|
||||
plugins.fs.writeFileSync(filePath, this._pubKey);
|
||||
plugins.fs.chmodSync(filePath, 0o644);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+25
-6
@@ -1,6 +1,25 @@
|
||||
import "typings-global"
|
||||
export let beautylog = require("beautylog");
|
||||
export let base64 = require("js-base64").Base64;
|
||||
export let fs = require("fs-extra");
|
||||
export let path = require("path");
|
||||
export let smartfile = require("smartfile");
|
||||
// node native
|
||||
import * as crypto from 'crypto';
|
||||
import fs from 'fs-extra';
|
||||
import * as path from 'path';
|
||||
|
||||
export { crypto, fs, path };
|
||||
|
||||
// @push.rocks scope
|
||||
import * as smartjson from '@push.rocks/smartjson';
|
||||
import * as smartcrypto from '@push.rocks/smartcrypto';
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
import * as smartstring from '@push.rocks/smartstring';
|
||||
|
||||
export {
|
||||
smartjson,
|
||||
smartcrypto,
|
||||
smartpath,
|
||||
smartstring,
|
||||
};
|
||||
|
||||
// third party scope
|
||||
import * as minimatch from 'minimatch';
|
||||
import ssh2 from 'ssh2';
|
||||
|
||||
export { minimatch, ssh2 };
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"version": false,
|
||||
"dependencies": {},
|
||||
"ambientDependencies": {
|
||||
"colors": "registry:dt/colors#0.6.0-1+20160317120654",
|
||||
"node": "registry:dt/node#4.0.0+20160423143914"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"noImplicitAny": true,
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true,
|
||||
"types": ["node"]
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user