https://github.com/alcalzone/node-dtls-client
clientside UDP wrapper for DTLS v1.2
https://github.com/alcalzone/node-dtls-client
Last synced: about 1 year ago
JSON representation
clientside UDP wrapper for DTLS v1.2
- Host: GitHub
- URL: https://github.com/alcalzone/node-dtls-client
- Owner: AlCalzone
- Created: 2017-05-15T17:31:41.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T02:57:53.000Z (about 3 years ago)
- Last Synced: 2024-04-14T21:54:35.277Z (about 2 years ago)
- Language: TypeScript
- Size: 1.71 MB
- Stars: 24
- Watchers: 2
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# node-dtls-client
[ ](https://www.npmjs.com/package/node-dtls-client)
[](https://circleci.com/gh/AlCalzone/node-dtls-client)
[](https://coveralls.io/github/AlCalzone/node-dtls-client)
USE AT YOUR OWN RISK!
[DTLS](https://en.wikipedia.org/wiki/Datagram_Transport_Layer_Security) protocol implementation for Node.js written in TypeScript.
This library provides the missing native DTLS support for Node.js client-side applications. It contains no server-side implementation.
Although great care has been taken to properly implement the required encryption and validation,
there's no explicit protection against TLS attacks. Thus it is not advised to use it for security-critical applications.
This libary's main goal is to allow using protocols that *require* DTLS.
## Usage
### Establish a secure connection:
```js
var dtls = require("node-dtls-client");
const socket = dtls
// create a socket and initialize the secure connection
.createSocket(options /* DtlsOptions */)
// subscribe events
.on("connected", () => {/* start sending data */})
.on("error", (e /* Error */) => { })
.on("message", (msg /* Buffer */) => { })
.on("close", () => { })
;
```
The `DtlsOptions` object looks as follows:
```js
{
type: "udp4",
address: "ip or host",
port: 5684,
psk: { "psk_hint": "PSK" },
timeout: 1000, // in ms, optional, minimum 100, default 1000
ciphers: [ /* ... */ ], // optional array of (D)TLS cipher suites, e.g. ["TLS_PSK_WITH_AES_128_CCM"]
listenPort: 2345 // optional local port number to listen at, default: chosen at random
compat: { // optional compat options
/**
* The IKEA gateway v1.15.x has a bug where the Server Hello reuses the sequence number of the Hello Verify Request.
* This flag can be set to true to work around it.
*/
resetAntiReplayWindowBeforeServerHello: true,
}
}
```
The `ciphers` property allows specifying which cipher suites should be advertised as supported. If this property is not provided, all supported ciphers are used by default. Use this if you want to force specific cipher suites for the communication.
The currently supported cipher suites are limited to those with PSK key exchange:
* `"TLS_PSK_WITH_3DES_EDE_CBC_SHA"`
* `"TLS_PSK_WITH_AES_128_CBC_SHA"`
* `"TLS_PSK_WITH_AES_256_CBC_SHA"`
* `"TLS_PSK_WITH_AES_128_CBC_SHA256"`
* `"TLS_PSK_WITH_AES_256_CBC_SHA384"`
* `"TLS_PSK_WITH_AES_128_GCM_SHA256"`
* `"TLS_PSK_WITH_AES_256_GCM_SHA384"`
* `"TLS_PSK_WITH_AES_128_CCM_8"`
* `"TLS_PSK_WITH_AES_256_CCM_8"`
**PRs for other key exchange methods are welcome!**
### Send some data (after the `connected` event was received):
```js
socket.send(data /* Buffer */, [callback]);
```
The events are defined as follows:
- `connected`: A secure connection has been established. Start sending data in the callback
- `error`: An error has happened. This usually means the handshake was not successful
- `message`: The socket received some data.
- `close`: The connection was closed successfully.
## Missing features:
- [x] alert protocol implementation (partially supported)
- [ ] cipher suites with non-PSK key exchange algorithms: `dhe_dss` | `dhe_rsa` | `rsa` | `dh_dss` | `dh_rsa` | `dhe_psk` | `rsa_psk`
- [ ] packet retransmission
- [ ] session renegotiation
- [ ] other compression algorithms except NULL
**PRs adding support for these are welcome!**
## Changelog
### 1.1.1 (2023-01-26)
* Updated the `node-aead-crypto` dependency for proper Electron support
### 1.0.2 (2023-01-26)
* Fixed the check for Electron runtime
### 1.0.1 (2021-06-30)
* Workaround for a bug in IKEA gateway firmware `v1.15.x`
### 1.0.0 (2021-06-19)
* Require Node.js 12+
### 0.7.0 (2021-03-04)
* Added the ability to specify the local listen port
### 0.6.0 (2020-02-29)
* Add support for DTLS 1.3 alerts
### 0.5.6 (2018-11-04)
* `node-aead-crypto` is now an optional dependency
* Remove `strictPropertyInitialization` since it doesn't work without `strictNullChecks`
### 0.5.4 (2018-05-01)
* **Potentially breaking change:** No longer use `node-aead-crypto` on NodeJS 10+
### 0.4.0 (2018-05-01)
* Check connection options before creating a new socket
* Improve testing setup, use CircleCI for deployment
### 0.3.2 (2018-04-27)
* Support NodeJS 10
### 0.3.1 (2018-02-13)
* Suppress spurious errors from DNS lookup after the connection has already timed out
### 0.3.0 (2018-02-05)
* Fixed cipher parameters of 3DES and 256-bit AES (AEAD) cipher suites.
* Added the possibility to limit the cipher suites to use
### 0.2.2 (2017-09-25)
* Removed possible sources of infinite loops
### 0.2.1 (2017-09-25)
* Fix error handling while trying to connect to a non-available endpoint
### 0.2.0 (2017-09-21)
* add partial alert protocol implementation
### 0.1.0 (2017-08-23)
* publish to npm
### 0.0.3 (2017-08-09)
* bugfixes
### 0.0.2 (2017-08-01)
* improved error and timeout handling in the socket wrapper.
### 0.0.1
* initial release.
## Contributors
* https://github.com/thoukydides - Thanks for noticing the errors in the 3DES and 256-bit AES (AEAD) cipher suites.
## License
The MIT License (MIT)
Copyright (c) 2017-2023 AlCalzone
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.