From 3b847fac3d6ecb1672d30e87998e412d13f97ddc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 2 Nov 2025 13:36:43 +0000 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1083715..7c0325a 100644 --- a/README.md +++ b/README.md @@ -225,8 +225,14 @@ settings: access: endpoints: - - !/v1/about + - "!/v1/about" - /v2/send + + fieldPolicies: + "@number": { + value: "+123400003", + action: block + } ``` #### Token Configs @@ -247,7 +253,7 @@ overrides: access: endpoints: # Disable Sending - - !/v2/send + - "!/v2/send" ``` ### Templating @@ -314,15 +320,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: @@ -346,7 +352,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