Skip to content

Commit 16f7cf9

Browse files
docs: add security notice
1 parent 6649a78 commit 16f7cf9

1 file changed

Lines changed: 27 additions & 16 deletions

File tree

README.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Socket.IO Redis adapter
1+
<h1>Socket.IO Redis adapter</h1>
22

33
The `@socket.io/redis-adapter` package allows broadcasting packets between multiple Socket.IO servers.
44

@@ -9,21 +9,24 @@ The `@socket.io/redis-adapter` package allows broadcasting packets between multi
99

1010
**Table of contents**
1111

12-
- [Supported features](#supported-features)
13-
- [Installation](#installation)
14-
- [Compatibility table](#compatibility-table)
15-
- [Usage](#usage)
16-
- [With the `redis` package](#with-the-redis-package)
17-
- [With the `redis` package and a Redis cluster](#with-the-redis-package-and-a-redis-cluster)
18-
- [With the `ioredis` package](#with-the-ioredis-package)
19-
- [With the `ioredis` package and a Redis cluster](#with-the-ioredis-package-and-a-redis-cluster)
20-
- [With Redis sharded Pub/Sub](#with-redis-sharded-pubsub)
21-
- [With `redis`](#with-redis)
22-
- [With `ioredis`](#with-ioredis)
23-
- [Options](#options)
24-
- [Default adapter](#default-adapter)
25-
- [Sharded adapter](#sharded-adapter)
26-
- [License](#license)
12+
<!-- TOC -->
13+
* [Supported features](#supported-features)
14+
* [Security notice](#security-notice)
15+
* [Installation](#installation)
16+
* [Compatibility table](#compatibility-table)
17+
* [Usage](#usage)
18+
* [With the `redis` package](#with-the-redis-package)
19+
* [With the `redis` package and a Redis cluster](#with-the-redis-package-and-a-redis-cluster)
20+
* [With the `ioredis` package](#with-the-ioredis-package)
21+
* [With the `ioredis` package and a Redis cluster](#with-the-ioredis-package-and-a-redis-cluster)
22+
* [With Redis sharded Pub/Sub](#with-redis-sharded-pubsub)
23+
* [With `redis`](#with-redis)
24+
* [With `ioredis`](#with-ioredis)
25+
* [Options](#options)
26+
* [Default adapter](#default-adapter)
27+
* [Sharded adapter](#sharded-adapter)
28+
* [License](#license)
29+
<!-- TOC -->
2730

2831
## Supported features
2932

@@ -34,6 +37,14 @@ The `@socket.io/redis-adapter` package allows broadcasting packets between multi
3437
| Broadcast with acknowledgements | `4.5.0` | :white_check_mark: YES (since version `7.2.0`) |
3538
| Connection state recovery | `4.6.0` | :x: NO |
3639

40+
## Security notice
41+
42+
The Redis adapter assumes that Redis is part of the trusted internal infrastructure.
43+
44+
Messages exchanged through Redis Pub/Sub are not signed, encrypted, or authenticated by the adapter. Anyone able to publish to the adapter channels may be able to inject packets or control messages. Redis should therefore not be exposed to untrusted networks or shared with untrusted clients.
45+
46+
Please use Redis ACLs, authentication, TLS, firewall rules, private networking, and dedicated credentials/channel permissions where appropriate.
47+
3748
## Installation
3849

3950
```

0 commit comments

Comments
 (0)