Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robojones/command-server
Execute commands via a SSL encrypted connection in Node.js
https://github.com/robojones/command-server
Last synced: 23 days ago
JSON representation
Execute commands via a SSL encrypted connection in Node.js
- Host: GitHub
- URL: https://github.com/robojones/command-server
- Owner: robojones
- License: mit
- Created: 2018-05-15T18:43:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-05-20T14:12:25.000Z (over 6 years ago)
- Last Synced: 2024-03-06T16:44:07.371Z (8 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/command-server
- Size: 90.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# command-server
Execute commands via a SSL encrypted connection.
[](https://circleci.com/gh/robojones/command-server)
[](https://codeclimate.com/github/robojones/command-server/test_coverage)
[](https://codeclimate.com/github/robojones/command-server/maintainability)
## Example
This example shows how a client and a server can be connected using self-signed certificates.
For some help on how to generate self-signed certificates [see this comment](https://github.com/nodejs/help/issues/253#issuecomment-242425636).
```javascript
const { CommandServer, CommandClient } = require('command-server')
/* ### Server ### */
const server = new CommandServer({
host: 'localhost',
port: 8090,
key: fs.readFileSync('certs/server/server.key'),
cert: fs.readFileSync('certs/server/server.crt'),
ca: fs.readFileSync('certs/ca/ca.crt'),
requestCert: true, // ask for a client cert
})
// Implement command 0.
server.command(0, async (payload) => {
console.log('Server received:', payload)
return 'result from the server'
})
/* ### Client ### */
const client = new CommandClient({
host: 'localhost',
port: 8090,
key: fs.readFileSync('certs/client/client.key'),
cert: fs.readFileSync('certs/client/client.crt'),
ca: fs.readFileSync('certs/ca/ca.crt'),
})
// Execute the command 0.
client.command(0, 'message from the client', 1000).then((result) => {
console.log('Client received::', result)
})
```
## API
### CommandClient
Extends the [TokenClient](https://www.npmjs.com/package/token-server#tokenclient) from the token-server package.
#### CommandClient#command()
Executes a command on the server and then returns the **result as a promise**.
The returned promise will be **rejected** when no response arrives before the expiresIn time has passed. The promise will also be rejected if an error occurs on the server during the execution of the command.
```typescript
client.command(command, payload, expiresIn)
```
- **command** `` A number identifying the command you want to execute. The number must be between 0 and 254.
- **payload** `` A parameter that will be passed to the command.
It may be of any value that can be stringified using `JSON.stringify()` so it must not be `undefined`.
- **expiresIn** `` Milliseconds until the command times out.
### CommandServer
Extends the [TokenServer](https://www.npmjs.com/package/token-server#tokenserver) from the token-server package.
#### CommandServer#command()
Executes a command on the server and then returns the **result as a promise**.
The returned promise will be **rejected** when no response arrives before the expiresIn time has passed. The promise will also be rejected if an error occurs on the server during the execution of the command.
```typescript
client.command(command, (payload, connection) => result)
```
- **command** `` A number identifying the command. The number must be between 0 and 254.
- **payload** `` The value that was passed as the payload parameter to the CommandClient#command().
- **connection** `` [see here](https://www.npmjs.com/package/token-server#connection) The connection that triggered the command.
- **result** `` A result that will be transmitted as response to the client.
It may be of any value that can be stringified using `JSON.stringify()` so it must not be `undefined`.