Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mollyim/mollysocket

MollySocket allows getting Signal notifications via UnifiedPush.
https://github.com/mollyim/mollysocket

Last synced: about 8 hours ago
JSON representation

MollySocket allows getting Signal notifications via UnifiedPush.

Awesome Lists containing this project

README 

        
# MollySocket



MollySocket allows getting signal notifications via [UnifiedPush](https://unifiedpush.org/). It works like a linked device, which doesn't have an encryption key, connected to the Signal server. Everytime it receives an encrypted event, it notifies your mobile via UnifiedPush.



## Overview



```mermaid

---

title: Message flow

---

graph TD

    

    MS[fa:fa-tablets MollySocket]

    S[fa:fa-comment Signal Server]

    P[fa:fa-server Push server]

    subgraph "fa:fa-mobile Android"

        D[fa:fa-tower-broadcast Distributor App]

        MA[fa:fa-tablets Molly Android]

    end

    MS -- 1. Persistent connection --> S

    MS -- 2. 'Notifications present' --> P

    P -- 3. 'Notications present for Molly' --> D

    D -- 4. 'Check Signal servers' --> MA

    MA -- 5. 'Got messages?' --> S

    S -- 6. Messages --> MA

```



## Setup



1. You need the right flavor of Molly to use UnifiedPush: .

2. You can install MollySocket via:

    1. Docker/Podman: `docker pull ghcr.io/mollyim/mollysocket:latest`

    2. Crates.io: `cargo install mollysocket` (see [INSTALL.md](INSTALL.md) for the setup) 

    3. Direct download:  (see [INSTALL.md](INSTALL.md) for the setup)

3. A [distributor app](https://unifiedpush.org/users/distributors/) (easiest is [ntfy](https://f-droid.org/en/packages/io.heckel.ntfy/))



You can optionally install your own push server like ntfy or NextPush.

For beginners, you can use a free service like ntfy.sh (do consider donating if you have the means).



## Web Server



MollySocket exposes a web server so that Molly can send the information it needs to operate. You must configure TLS with a reverse proxy in front of MollySocket. Molly can only connect to the server over HTTPS.



It is possible to use MollySocket without the web server, but you will have to manually register the information MollySocket needs: see the **Air Gapped** mode on Android settings.



## Configuration



The configuration file uses the [TOML format](https://toml.io/). Below is an overview of configuration options. You can configure each parameter using either the conf file, the environment variable or the cli option (if available).



| Parameter (conf. file) | Environment variable       | Cli Option  | Description                                       | Default              | Examples                                                |

|------------------------|----------------------------|-------------|---------------------------------------------------|----------------------|---------------------------------------------------------|

|                        | RUST_LOG                \* | -v/-vv/-vvv | Verbosity                                         | error                | RUST_LOG=info, RUST_LOG=debug                           |

|                        | MOLLY_CONF                 | -c \*       | Path to the configuration file, optional          |                      | /etc/mollysocket.conf                                   |

| host                   | MOLLY_HOST              \* |             | Listening address of the web server               | 127.0.0.1            | 0.0.0.0                                                 |

| port                   | MOLLY_PORT              \* |             | Listening port of the web server                  | 8020                 | 8080                                                    |

| webserver              | MOLLY_WEBSERVER         \* |             | Wether to start the web server                    | true                 | false                                                   |

| allowed_endpoints      | MOLLY_ALLOWED_ENDPOINTS \* |             | List of UnifiedPush servers                       | `["*"]`              | `["*"]`,`["https://yourdomain.tld","https://ntfy.sh"]`  |

| allowed_uuids          | MOLLY_ALLOWED_UUIDS     \* |             | UUIDs of signal accounts that may use this server | `["*"]`              | `["*"]`, `["abcdef-12345-tuxyz-67890"]`                 |

| db                     | MOLLY_DB                \* |             | Path to the DB                                    | `db.sqlite`          | `"/data/ms.sqlite"`                                     |

| vapid_privkey          | MOLLY_VAPID_PRIVKEY     \* |             | VAPID key, see [VAPID key](#vapid-key)            | None                 | "DSqYuWchrB6yIMYJtidvqANeRQic4uWy34afzZRsZnI"           |

| vapid_key_file         | MOLLY_VAPID_KEY_FILE    \* |             | File with VAPID key, see [VAPID key](#vapid-key)  | None                 | "/etc/ms_vapid_key"                                     |



\* Takes the precedence



### VAPID key



VAPID key is used to authorize mollysocket server to send requests to your push server, if it supports it.



To generate a new key, you can run this command `mollysocket vapid gen`. Or using docker, `docker-compose run mollysocket vapid gen`.



This value can be passed to mollysocket via a file, location given with `vapid_key_file` parameter, or directly in the `vapid_privkey` parameter. _The key file takes the precedence_.



To pass this value to mollysocket, you may wish to use [systemd-creds](https://systemd.io/CREDENTIALS/):



```console

$ mollysocket vapid gen | systemd-creds encrypt --name=ms_vapid -p - -

SetCredentialEncrypted=ms_vapid: \

        k6iUCUh0RJCQyvL8k8q1UyAAAAABAAAADAAAABAAAAC1lFmbWAqWZ8dCCQkAAAAAgAAAA \

        AAAAAALACMA0AAAACAAAAAAfgAg9uNpGmj8LL2nHE0ixcycvM3XkpOCaf+9rwGscwmqRJ \

        cAEO24kB08FMtd/hfkZBX8PqoHd/yPTzRxJQBoBsvo9VqolKdy9Wkvih0HQnQ6NkTKEdP \

        HQ08+x8sv5sr+Mkv4ubp3YT1Jvv7CIPCbNhFtag1n5y9J7bTOKt2SQwBOAAgACwAAABIA \

        ID8H3RbsT7rIBH02CIgm/Gv1ukSXO3DMHmVQkDG0wEciABAAII6LvrmL60uEZcp5qnEkx \

        SuhUjsDoXrJs0rfSWX4QAx5PwfdFuxPusgE==

```



This will output `SetCredentialEncrypted` you can use in your systemd unit file:



```ini

[Service]

SetCredentialEncrypted=ms_vapid: \

        k6iUCUh0RJCQyvL8k8q1UyAAAAABAAAADAAAABAAAAC1lFmbWAqWZ8dCCQkAAAAAgAAAA \

        AAAAAALACMA0AAAACAAAAAAfgAg9uNpGmj8LL2nHE0ixcycvM3XkpOCaf+9rwGscwmqRJ \

        cAEO24kB08FMtd/hfkZBX8PqoHd/yPTzRxJQBoBsvo9VqolKdy9Wkvih0HQnQ6NkTKEdP \

        HQ08+x8sv5sr+Mkv4ubp3YT1Jvv7CIPCbNhFtag1n5y9J7bTOKt2SQwBOAAgACwAAABIA \

        ID8H3RbsT7rIBH02CIgm/Gv1ukSXO3DMHmVQkDG0wEciABAAII6LvrmL60uEZcp5qnEkx \

        SuhUjsDoXrJs0rfSWX4QAx5PwfdFuxPusgE==

Environment=MOLLY_VAPID_KEY_FILE=%d/ms_vapid

```



#### `allowed_endpoints`



These are the UnifiedPush endpoints that MollySocket may use to push notifications with. 



⚠️ **If you self-host your push server, add your push server to the `allowed_endpoints`.** ⚠️



That's because, for security reasons, endpoints on your local network must be allowed explicitly. You just have to set the scheme (https), the domain and the port if required. For instance `allowed_endpoints=['https://push.mydomain.tld']`



#### `allowed_uuids`



You can allow registration for all accounts by setting `allowed_uuids` to `['*']`. Else set your account ids in the array: `['account_id1','account_id2']`.



The account IDs are showing in the Molly application under Settings > Notifications > UnifiedPush.

You need to activate UnifiedPush first before your account ID is shown.



## Troubleshoot



* **On the Android app, the status states _MollySocket server not found_**



You haven't entered the right url.



This must be the one where MollySocket is reachable. To test it, open the link you have entered in a browser: you should see a json containing the version of MollySocket. For instance `{"mollysocket":{"version":"1.2.0"}}`.



If you can access the web server, make sure it is accessible over HTTPS. Molly can't connect to the server over HTTP.



* **On the Android app, the status states _The account ID is refused by the server_**



You have restricted the allowed account ID who can use your MollySocket server.



Add your account ID[1] to _allowed_uuids_ to allow your account, or add a wildcard `["*"]` to allow all the accounts to use your server. See [Configuration](#configuration) to configure your server correctly.



[1] Your account ID can be copied on the Android app, under the UnifiedPush settings



* **On the Android app, the status states _The endpoint is forbidden by the server_**



You have restricted the allowed UnifiedPush endpoints, or you are using a self-hosted server you haven't whitelisted.



Add your server to the _allowed_endpoints_: `["https://push.mydomain.tld"]`. _This is NOT your MollySocket URL_ but the one from your push provider. See [Configuration](#configuration) to configure your server correctly.



* **On the Android app, the status is _Air gapped, waiting for test notification_**



There might be 3 reasons for that:

- You don't have yet registered your connection on a MollySocket server.

    - It is better to use MollySocket configured with a web interface, see [Web Server](#web-server) for more information.

    - If you can't have a web interface, you can use it in air gapped mode. The MollySocket server should be constantly running. You can use the docker-compose or follow the [Install doc](/Install.md).

    - Then, if you stick with air gapped mode, you will need to add your account to the MollySocket registration. You can copy the parameter on the Android settings view. Then run:

```console

$ # If you use docker-compose:

$ docker compose run mollysocket 

$ # Else, if you use the binary:

$ mollysocket 

```

- It is possible you don't use a recent enough version of MollySocket and it hasn't send a request during the registration. You can run :

```console

$ # Replace the UUID with your account Id

$ # If you use docker-compose:

$ docker compose run mollysocket connection ping c8d44128-5c99-4810-a7d3-71c079891c27

$ # Else, if you use the binary:

$ mollysocket connection ping c8d44128-5c99-4810-a7d3-71c079891c27

```

- You have a problem with your UnifiedPush setup. You can get further troubleshooting information on this page: .



* **On the Android app, the status is _Waiting for test notification_**



- It is possible you don't use a recent enough version of MollySocket and it hasn't send a request during the registration. You can either:

    - Update your MollySocket server, then on Molly Android go to the linked devices settings, remove MollySocket, then go to the notifications settings, switch the delivery method to websocket then to UnifiedPush again.

    - Run :

```console

$ # Replace the UUID with your account Id

$ # If you use docker-compose:

$ docker compose run mollysocket connection ping c8d44128-5c99-4810-a7d3-71c079891c27

$ # Else, if you use the binary:

$ mollysocket connection ping c8d44128-5c99-4810-a7d3-71c079891c27

```

- You have a problem with your UnifiedPush setup. You can get further troubleshooting information on this page: .



* **I use the Air-gapped mode and I don't receive notifications**.



If you use air-gapped mode, then Molly (android) can't test the setup and it assumes you have correctly setup everything. You should double check that the account ID is accepted by your mollysocket server and the endpoint is allowed by your mollysocket server (check the output logs).



* **The status is "OK" or "OK: Air Gapped" but I still don't get notifications**



If you are using Molly version >= 7.1.3-1.up1 and MollySocket version >= 1.3.0, you can run this command:



```console

$ # Replace the UUID with your account Id

$ # If you use docker-compose:

$ docker compose run mollysocket connection ping c8d44128-5c99-4810-a7d3-71c079891c27

$ # Else, if you use the binary:

$ mollysocket connection ping c8d44128-5c99-4810-a7d3-71c079891c27

```



If you receive a test notification (image bellow), then you should check that Molly and your [distributor](https://unifiedpush.org/users/distributors/) have unrestricted battery usage. You should check if you have additional configuration for your device regarding battery management: .






If you don't receive a test notification, then your MollySocket server can't reach your push server or your phone don't have network access.



You can get further troubleshooting information on this page: .



## About security



**Relative to Signal security**



**MollySocket never has any encryption key**



MollySocket receives the credentials for a linked device and does not receive any encryption key. Which means:

* Someone with access to MollySocket database can't change the identity key, to impersonate users. See [setKeys](https://github.com/signalapp/Signal-Server/blob/v8.67.0/service/src/main/java/org/whispersystems/textsecuregcm/controllers/KeysController.java#L111).

* Someone with access to MollySocket database may be able to use the credentials of linked devices to spam the Signal server and hit the rate limits. I haven't checked if this would temporarily block the account or just the linked device. (Availability risk)

* Someone with access to MollySocket database may be able to change some account field in a destructive way. For instance changing the account Name to something random. The cleartext will be random since these field are encrypted and require encryption keys to be properly encrypted.



## License

AGPLv3: see [LICENSE.txt](./LICENSE.txt).



## Disclaimer

This project is NOT sponsored by or affiliated to Signal Messenger or Signal Foundation.



The software is produced independently of Signal and carries no guarantee about quality, security or anything else. Use at your own risk.