Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/templates/README.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,15 +220,15 @@ Since Secured Signal API is just a Proxy you can use all of the [Signal REST API

| Endpoint | |
| :-------------------- | ------------------ |
| **/v1/about** | **/v1/unregister** |
| **/v1/configuration** | **/v1/qrcodelink** |
| **/v1/configuration** | **/v1/unregister** |
| **/v1/devices** | **/v1/contacts** |
| **/v1/register** | **/v1/accounts** |
| **/v1/qrcodelink** | |

These Endpoints are blocked by default due to Security Risks.

> [!NOTE]
> Matching works by checking if the requested Endpoints starts with a Blocked or an Allowed Endpoint
> 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

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

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

### Variables

Expand Down
8 changes: 4 additions & 4 deletions docs/configuration/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ but by default the following endpoints are **blocked**, because of Security Conc

| Endpoint | |
| :-------------------- | ------------------ |
| **/v1/about** | **/v1/unregister** |
| **/v1/configuration** | **/v1/qrcodelink** |
| **/v1/configuration** | **/v1/unregister** |
| **/v1/devices** | **/v1/contacts** |
| **/v1/register** | **/v1/accounts** |
| **/v1/qrcodelink** | |

## Customize

> [!NOTE]
> Matching works by checking if the requested Endpoints starts with a Blocked or an Allowed Endpoint
> 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

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

Expand All @@ -45,4 +45,4 @@ By default adding an endpoint explictly allows access to it, use `!` to block it
| :------------- | :------------- | :--------: | --- | :---------------: | --- |
| `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |
| `unset` | `!/v1/receive` | **all** | ✅ | **`/v1/receive`** | 🛑 |
| `/v2` | `!/v2/send` | **`/v2*`** | 🛑 | **`/v2/send`** | ✅ |
| `!/v2*` | `/v2/send` | **`/v2*`** | 🛑 | **`/v2/send`** | ✅ |
8 changes: 7 additions & 1 deletion docs/configuration/examples/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,11 @@ settings:

access:
endpoints:
- !/v1/about
- "!/v1/about"
- /v2/send

fieldPolicies:
"@number": {
value: "+123400003",
action: block
}
2 changes: 1 addition & 1 deletion docs/configuration/examples/token.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ overrides:

access:
endpoints: # Disable Sending
- !/v2/send
- "!/v2/send"