Skip to content

Releases

FreeSpeech for Windows 1.3.4

Choose a tag to compare

@rebisway rebisway released this 12 Nov 10:31

FreeSpeech is an end-to-end encrypted messenger with no account: no phone number, no e-mail address. Your identity is computed on your computer from three phrases, and everything you send is signed and encrypted before it leaves. The servers only pass messages between connected devices and store nothing. You can be on several servers at once, public or private, and anyone can host their own.

This is the Windows desktop application. It uses the same library as the Android application, so messages, groups, files and security are the same on both.

What it does

  • Text, replies, forwarding, emoji reactions, editing and deleting a message (for yourself or for everyone), typing indicator, read receipts you can turn off, pinned messages, a mute per conversation.
  • Messages whose first line is md are shown formatted (headings, lists, bold, italic, links).
  • Groups with a shared key renewed at every arrival, departure or exclusion; an invitation is never automatic.
  • Photos, videos and files up to 2 GiB, sent in 48 KiB pieces, each checked, with resumable transfers.
  • Several servers at once, public and private. A private server can be reached with an invitation or by asking its administrator for access.
  • A security number to compare with a contact, an encrypted local database and an optional PIN. Your three phrases can be printed on a sheet with a QR code or kept in a password-protected key file.
  • Several profiles on one computer: FreeSpeech.exe --profile name --server url.
  • Two columns (list and conversation), one column on a narrow window. Available in German, English, Spanish, French, Italian, Dutch, Polish, Portuguese, Russian and Turkish, plus any language you import.

What is new in 1.3.4

A private server is no longer written in a contact card by its address: the card carries an identifier that only the members of that server recognise. A contact you already had is recognised as soon as you add the server. This needs a relay in version 1.9.0 or later to give the key; with an older relay, the address stays in the card.

Installation

Download FreeSpeech-1.3.4-x64.msi and run it. It installs for your user only, in %LocalAppData%\Programs\FreeSpeech, without administrator rights. The .NET runtime is included.

SHA-256: 5f4a9df9255c0edfdbf1c9ecba5d62ab8cabca6e3881ad28bcfd83fc39c81a2a

Get-FileHash FreeSpeech-1.3.4-x64.msi -Algorithm SHA256

The installer is not signed with a code-signing certificate. Windows SmartScreen may show "Windows protected your PC" the first time: choose "More info", then "Run anyway". Check the SHA-256 above first if you want to be sure the file is the one published here.

First start

The application gives you three phrases drawn from a public-domain book. Write them down or print the sheet: they are the only way to get your identity back, and there is no recovery if you lose them. Then enter a first name. There is no server to configure: the application asks the directories built into it, once, for relays that take new accounts and have room, starting with your country, and signs you up on one. If no directory answers, it uses one of its built-in fallback relays.

Advanced mode lets you choose your own server instead, which is then kept.

Documentation

  • How it works: HOW_IT_WORKS.en.md, protocol: PROTOCOL.en.md
  • Features of the applications: FEATURES.en.md

Licence AGPL-3.0-or-later.

Source code: https://git.rebisway.com/rebisway/freespeech

FreeSpeech Relay Server 1.9.0

Choose a tag to compare

@rebisway rebisway released this 12 Nov 10:29

A relay is the server of FreeSpeech, an end-to-end encrypted messenger with no account. It connects the applications that are online and passes messages between them. It stores no message: when the recipient is offline, the message waits on the sender's device. The relay keeps in memory only who is online and a few waiting markers. It sees the sender, the recipient and the connection times, never the content.

What this relay does

  • It receives the WebSocket connections of the applications (Android, Windows, Linux) behind nginx over HTTPS.
  • It can be public (everybody signs up, except banned identities) or private, reserved for the identities the administrator allows or invites (access allowlist, single-use invitations).
  • It links with a push gateway (waking the phones), a directory (offered to new applications) and other relays, by keys and acceptance by both administrators.
  • It limits volume and rate per identity and per address, and can advise a client to move to a neighbouring server when it is full.
  • Everything is set without a restart with the admin command: access, invitations, bans, limits, links, e-mail notifications.
  • A restricted server is not written in contact cards by its address: an identifier computed with the circle key, which only its members recognise. admin circle-key renew draws a new key; the old one is still recognised for 30 days.

What you need

  • A Debian 12/13 or Ubuntu 22.04/24.04 machine, with sudo.
  • A domain name whose DNS points to the machine, and ports 80 and 443 reachable.
  • The recent applications (mobile 1.3.5, desktop 1.3.4) to use restricted servers without an address in the cards.

Installation

The archive holds the program, the systemd service, an nginx example and the install.sh script. The .NET runtime is installed by the script.

sha256sum -c --ignore-missing SHA256SUMS
tar -xzf freespeech-relay-1.9.0.tar.gz
cd freespeech-relay-1.9.0
sudo bash install.sh fs.example.org --email admin@example.org

The script installs the packages, opens the firewall (SSH, 80, 443), installs the service, writes appsettings.Local.json with a randomly drawn admin secret, sets up nginx and the certificate, then runs check and starts the service only if check passes. --email is the address Let's Encrypt keeps for expiry notices: giving it accepts its subscriber agreement. Other options: --contact, --no-certificate, --no-firewall.

Then fsrelay status shows the state and fsrelay help lists the commands. A private server for close contacts is set with fsrelay private, fsrelay access allowlist and fsrelay invite "Anna" --days 7.

Wake-ups for the phones go through a push gateway. Two are available free of charge: link your relay to them with fsrelay add push https://push1.rebisway.com and fsrelay add push https://push2.rebisway.com; their administrator accepts the request after checking who asks, which is why --contact is worth giving at installation. Without a linked gateway, the applications poll their servers about every 15 minutes.

Update

Install the recent applications first, then run install.sh again with the newer archive: the program is replaced, appsettings.Local.json is never rewritten. Two sibling servers are updated together.

Backup

The files worth a copy are in /var/lib/freespeech (access.json, siblings.json, peers.json, peer-identity.json, settings.json). peer-identity.json is the relay's key: losing it means linking the relay again with its partners.

Documentation

  • Step-by-step installation, manual included: INSTALL_RELAY.en.md
  • Relay commands: cli-relay.en.md
  • How it works: HOW_IT_WORKS.en.md, protocol: PROTOCOL.en.md

Other systems

The installation script and the guide cover Debian and Ubuntu. The program itself is portable .NET 10 and runs wherever the ASP.NET Core 10 runtime does (Windows, macOS, other Linux distributions, x64 and ARM): extract the publish folder, write appsettings.Local.json, run dotnet FreeSpeech.Relay.dll check, then run the server behind an HTTPS reverse proxy that forwards WebSockets. These setups are not documented here and are not tested.

Licence AGPL-3.0-or-later. Source code: https://git.rebisway.com/rebisway/freespeech

FreeSpeech Push Gateway 1.5.0

Choose a tag to compare

@rebisway rebisway released this 12 Nov 10:26

The push gateway wakes the phones of FreeSpeech users when a message waits for them. It is the only component that holds the Firebase (FCM) and Apple (APNs) keys. A relay calls it to wake a phone; the gateway receives neither identity nor content, and the notification itself never carries the text of a message. A gateway with no linked relay refuses every request.

Who needs it

Most relay administrators do not need to install a gateway. Two are available free of charge: https://push1.rebisway.com and https://push2.rebisway.com. To use one, link your relay to it (see below); its administrator checks who asks and accepts the link. Installing your own gateway is for those who run their own Firebase project, for instance with an application they build themselves.

What this gateway does

  • It receives signed wake-up requests from the relays linked to it and passes them to Firebase.
  • A relay is linked only by keys and the agreement of both administrators (requests / accept); no secret is shared between servers.
  • It checks the link with each relay every minute (peer-check sets the interval) and raises an alarm after three failed checks. peers shows the state of each link.
  • Several gateways can serve the same relays (load, failure): the relay switches by itself and sets aside a failed or saturated gateway for a few tens of seconds. Push:MaxConcurrent (default 100) limits the simultaneous requests of one gateway.
  • Everything is set without a restart with the admin command, including e-mail notifications.

What you need

  • A Debian 12/13 or Ubuntu 22.04/24.04 machine, with sudo.
  • A domain name whose DNS points to the machine, and ports 80 and 443 reachable.
  • A Firebase project with the Android application org.freespeech.mobile and the Firebase Cloud Messaging API (V1) enabled, and a service-account key file (Firebase console > Project settings > Service accounts > Generate new private key). Keep this file on the gateway only, never in a repository.
  • A relay to link (see below).

Installation

The archive holds the program, the systemd service, an nginx example and the install.sh script. The .NET runtime is installed by the script.

sha256sum -c --ignore-missing SHA256SUMS
tar -xzf freespeech-push-1.5.0.tar.gz
cd freespeech-push-1.5.0
sudo bash install.sh push.example.org --email admin@example.org

The script installs the packages, opens the firewall (SSH, 80, 443), installs the service, writes appsettings.Local.json with a randomly drawn admin secret, sets up nginx and the certificate, then runs check. --email is the address Let's Encrypt keeps for expiry notices: giving it accepts its subscriber agreement. Other options: --contact, --no-certificate, --no-firewall.

The Firebase key file is not in the archive. Until it is in place, check fails and the service is not started. Put it in /var/www/freespeech_push/secrets/firebase-service-account.json (owner www-data, mode 600), then:

sudo systemctl start freespeech-push

Link a relay to a gateway

On the relay: admin add push https://push1.rebisway.com (or push2, or your own gateway). The gateway's administrator sees your request with the name, address and fingerprint of your relay, and accepts it after checking who asks: give a way to reach you with --contact when you install the relay, or set Peer:Contact in its appsettings.Local.json. The relay knows within a minute (admin list push). Linking to both public gateways lets the relay switch by itself if one fails.

On your own gateway, the administrator reads the requests and accepts:

fspush requests
fspush accept <id>

Compare the fingerprint with the one the relay's administrator reads before accepting.

Update

Install the recent applications first, then run install.sh again with the newer archive, giving the same domain and e-mail address: the program is replaced, appsettings.Local.json and the secrets folder are never rewritten.

Other systems

The installation script and the guide cover Debian and Ubuntu. The program itself is portable .NET 10 and runs wherever the ASP.NET Core 10 runtime does (Windows, macOS, other Linux distributions, x64 and ARM): extract the publish folder, write appsettings.Local.json, run dotnet FreeSpeech.Push.dll check, then run the gateway behind an HTTPS reverse proxy. These setups are not documented here and are not tested.

Backup

/var/lib/freespeech-push/peer-identity.json (the gateway's key: losing it means linking each relay again), peers.json and settings.json, mode 600; and /var/www/freespeech_push/appsettings.Local.json with secrets/.

Documentation

  • Step-by-step installation, manual included: INSTALL_PUSH.en.md
  • Gateway commands: cli-push.en.md
  • How it works: HOW_IT_WORKS.en.md, protocol: PROTOCOL.en.md section 9

Licence AGPL-3.0-or-later. Source code: https://git.rebisway.com/rebisway/freespeech

FreeSpeech Directory Server 1.2.0

Choose a tag to compare

@rebisway rebisway released this 12 Nov 10:20

A directory tells an application that knows no relay which relays accept new accounts, and distributes newcomers across them.

The application contacts the directory once, on its first connection. The directory responds with a signed list and keeps no information about clients. After that, it plays no part in their communications.

The directory's key is its identity. Applications already know this key, so it must never change.

What this directory does

  • Lists the relays linked to it that are public, accept new accounts (access open) and have available capacity.
  • Selects relays by country first, then randomly, weighted by their remaining capacity.
  • Relays register using their keys and the agreement of both administrators (requests / accept). No shared secret is exchanged.
  • Each relay sends a heartbeat every two minutes (country, available capacity, version).
  • The directory checks each relay's address on its first heartbeat and every 30 minutes. Relays that remain silent or fail to authenticate with the accepted key are no longer offered.
  • Private relays remain invisible and are never offered to new users.
  • Monitors connectivity with each relay and raises an alert after three consecutive failed checks. The peers command displays the status of each link and the country of each relay.
  • All configuration is handled through the admin command, without restarting the service, including e-mail notifications.

Who needs it?

Most relay administrators do not need to install their own directory.

Two public directories are available free of charge:

To make your relay available to new users, link it to these directories:

admin add directory https://directory1.rebisway.com
admin add directory https://directory2.rebisway.com

The directory administrator reviews incoming requests and approves them.

Running your own directory is intended for those who build the application with their own directory infrastructure.

Requirements

  • Debian 12/13 or Ubuntu 22.04/24.04.
  • A machine with sudo access.
  • A permanent domain name pointing to the server.
  • Ports 80 and 443 accessible from the Internet.

Installation

The archive includes:

  • The directory application.
  • A systemd service.
  • An nginx configuration example.
  • The install.sh installation script.

The .NET runtime is installed automatically by the script.

sha256sum -c --ignore-missing SHA256SUMS
tar -xzf freespeech-directory-1.2.0.tar.gz
cd freespeech-directory-1.2.0
sudo bash install.sh directory.example.org --email admin@example.org --contact admin@example.org

The installation script:

  1. Installs the required packages.
  2. Configures the firewall (SSH, HTTP and HTTPS).
  3. Installs the systemd service.
  4. Creates appsettings.Local.json with a randomly generated administrator secret.
  5. Configures nginx and the TLS certificate.
  6. Runs the configuration checks.
  7. Starts the service only if all checks pass.

--email specifies the address used by Let's Encrypt for certificate expiration notifications. Providing this address means accepting its subscriber agreement.

Additional options:

  • --contact: contact address for relay administrators.
  • --no-certificate: skip automatic certificate installation.
  • --no-firewall: skip firewall configuration.

Once installed, check the service:

fsdir status
fsdir help

Accepting a relay

On the relay server, request a link to the directory:

admin add directory https://directory.example.org

On the directory server, review and accept the request:

fsdir requests
fsdir accept <id>

Before accepting, compare the fingerprint displayed by the directory with the one provided by the relay administrator.

A relay is offered to applications only after it has connected successfully, responds at its advertised address, is public, accepts new accounts and has available capacity.

Updating

Run install.sh again with the newer archive, using the same domain name and e-mail address.

The application is replaced, while appsettings.Local.json is preserved and never overwritten.

Other operating systems

The installation script and documentation cover Debian and Ubuntu.

The application itself is portable .NET 10 and runs wherever the ASP.NET Core 10 runtime is available, including:

  • Windows
  • macOS
  • Other Linux distributions
  • x64 and ARM architectures

For these platforms, extract the publish directory, create appsettings.Local.json, and run:

dotnet FreeSpeech.Directory.dll check

The directory must then run behind an HTTPS reverse proxy.

These alternative setups are not documented or tested.

Backup and identity key

The directory's key is its identity. Applications trust this key, so it must be backed up offline and must never change.

When moving the directory to another machine, preserve its identity key and update the DNS record accordingly.

Use the admin export and import commands to transfer the directory configuration and identity.

Documentation

  • Step-by-step installation guide: INSTALL_DIRECTORY.en.md
  • Directory administration commands: cli-directory.en.md
  • Architecture and operation: HOW_IT_WORKS.en.md
  • Protocol specification: PROTOCOL.en.md

License

AGPL-3.0-or-later

Source code: https://git.rebisway.com/rebisway/freespeech