Skip to content

Commit f2a0347

Browse files
authored
fix: update endpoints section (#117)
1 parent 94589a1 commit f2a0347

File tree

4 files changed

+16
-10
lines changed

4 files changed

+16
-10
lines changed

.github/templates/README.template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,15 +220,15 @@ Since Secured Signal API is just a Proxy you can use all of the [Signal REST API
220220
221221
| Endpoint | |
222222
| :-------------------- | ------------------ |
223-
| **/v1/about** | **/v1/unregister** |
224-
| **/v1/configuration** | **/v1/qrcodelink** |
223+
| **/v1/configuration** | **/v1/unregister** |
225224
| **/v1/devices** | **/v1/contacts** |
226225
| **/v1/register** | **/v1/accounts** |
226+
| **/v1/qrcodelink** | |
227227
228228
These Endpoints are blocked by default due to Security Risks.
229229
230230
> [!NOTE]
231-
> Matching works by checking if the requested Endpoints starts with a Blocked or an Allowed Endpoint
231+
> Matching uses [glob-style patterns](https://www.gnu.org/software/bash/manual/html_node/Pattern-Matching.html): `*` matches any sequence of characters, `?` matches a single character and `[abc]` matches one of the characters in the brackets
232232

233233
You can modify endpoints by configuring `access.endpoints` in your config:
234234

@@ -252,7 +252,7 @@ By default adding an endpoint explictly allows access to it, use `!` to block it
252252
| :------------- | :------------- | :--------: | --- | :---------------: | --- |
253253
| `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |
254254
| `unset` | `!/v1/receive` | **all** | ✅ | **`/v1/receive`** | 🛑 |
255-
| `/v2` | `!/v2/send` | **`/v2*`** | 🛑 | **`/v2/send`** | ✅ |
255+
| `!/v2*` | `/v2/send` | **`/v2*`** | 🛑 | **`/v2/send`** | ✅ |
256256

257257
### Variables
258258

docs/configuration/endpoints.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ but by default the following endpoints are **blocked**, because of Security Conc
1313

1414
| Endpoint | |
1515
| :-------------------- | ------------------ |
16-
| **/v1/about** | **/v1/unregister** |
17-
| **/v1/configuration** | **/v1/qrcodelink** |
16+
| **/v1/configuration** | **/v1/unregister** |
1817
| **/v1/devices** | **/v1/contacts** |
1918
| **/v1/register** | **/v1/accounts** |
19+
| **/v1/qrcodelink** | |
2020

2121
## Customize
2222

2323
> [!NOTE]
24-
> Matching works by checking if the requested Endpoints starts with a Blocked or an Allowed Endpoint
24+
> Matching uses [glob-like patterns](https://www.gnu.org/software/bash/manual/html_node/Pattern-Matching.html): `*` matches any sequence of characters, `?` matches a single character and `[abc]` matches one of the characters in the brackets
2525
2626
You can modify endpoints by configuring `access.endpoints` in your config:
2727

@@ -45,4 +45,4 @@ By default adding an endpoint explictly allows access to it, use `!` to block it
4545
| :------------- | :------------- | :--------: | --- | :---------------: | --- |
4646
| `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |
4747
| `unset` | `!/v1/receive` | **all** | ✅ | **`/v1/receive`** | 🛑 |
48-
| `/v2` | `!/v2/send` | **`/v2*`** | 🛑 | **`/v2/send`** | ✅ |
48+
| `!/v2*` | `/v2/send` | **`/v2*`** | 🛑 | **`/v2/send`** | ✅ |

docs/configuration/examples/config.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,11 @@ settings:
2525

2626
access:
2727
endpoints:
28-
- !/v1/about
28+
- "!/v1/about"
2929
- /v2/send
30+
31+
fieldPolicies:
32+
"@number": {
33+
value: "+123400003",
34+
action: block
35+
}

docs/configuration/examples/token.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ overrides:
77

88
access:
99
endpoints: # Disable Sending
10-
- !/v2/send
10+
- "!/v2/send"

0 commit comments

Comments
 (0)