Skip to content

Commit f25c748

Browse files
Update README.md
1 parent 659fb56 commit f25c748

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,8 @@ messageAliases: [{ alias: "msg", score: 100 }]
215215
216216
blockedEndpoints:
217217
- /v1/about
218+
allowedEndpoints:
219+
- /v2/send
218220
```
219221

220222
#### Token Configs
@@ -291,7 +293,7 @@ like Blocked Endpoints and any sort of Auth.
291293
> [!NOTE]
292294
> Blocked Endpoints can be reactivated by manually configuring them
293295

294-
### Blocked Endpoints
296+
### Endpoints
295297

296298
Because Secured Signal API is just a Proxy you can use all of the [Signal REST API](https://github.com/bbernhard/signal-cli-rest-api/blob/master/doc/EXAMPLES.md) endpoints except for...
297299

@@ -306,12 +308,27 @@ Because Secured Signal API is just a Proxy you can use all of the [Signal REST A
306308
| **/v1/accounts** |
307309
| **/v1/contacts** |
308310

311+
> [!NOTE]
312+
> Matching works by checking if the requested Endpoints startswith a Blocked or Allowed Endpoint
313+
309314
These Endpoints are blocked by default due to Security Risks, but can be modified by setting `blockedEndpoints` in your config:
310315

311316
```yaml
312317
blockedEndpoints: [/v1/register, /v1/unregister, /v1/qrcodelink, /v1/contacts]
313318
```
314319

320+
Override Blocked Endpoints by explicitly allowing endpoints in `allowedEndpoints`.
321+
322+
| Config (Allow) | (Block) | Result | | | |
323+
| :------------------------------- | :---------------------------------- | :--------: | --- | :---------------: | --- |
324+
| `allowedEndpoints: ["/v2/send"]` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |
325+
| `unset` | `blockedEndpoints: ["/v1/receive"]` | **all** | ✅ | **`/v1/receive`** | 🛑 |
326+
| `blockedEndpoints: ["/v2"]` | `allowedEndpoints: ["/v2/send"]` | **`/v2*`** | 🛑 | **`/v2/send`** | ✅ |
327+
328+
```yaml
329+
allowedEndpoints: [/v2/send]
330+
```
331+
315332
### Variables
316333

317334
Placeholders can be added under `variables` and can then be referenced in the Body, Query or URL.

0 commit comments

Comments
 (0)