Skip to Content

Security model

What OpenBeacon's encryption protects, who you rely on, and what removing a phone or a person does.

OpenBeacon is built so that a server can store your group's data without being able to read it. This page sets out what that protects, and what you rely on for it to hold. It applies to our hosted server and to any self-hosted server.

What's protected

Protected fromHow
The server and whoever runs itLocations, battery levels, where places are, pictures, nicknames and group colours are encrypted on your phone with keys the server never has. What the server can see lists everything it can read.
Networks, and picture and map storageEverything travels over HTTPS. Picture storage only holds encrypted files, and map storage only holds the map.
The push serviceA push only wakes a phone. It holds no names, places or message text.
People who join a group laterThe group's key is replaced when someone joins, and new members never get the earlier keys.
People who leave or are removedThe group's key is replaced, and they aren't given the new one.
Someone who learns your passwordA new phone can't see anyone's location until one of your set-up phones approves it, you enter your recovery phrase, or it's reset with Start fresh. A reset gives it nothing shared earlier, and needs a code from your email if your server sends email. Your other phones tell you about the new sign-in. Sign-in codes add a code from your email.
Someone holding your unlocked phoneApp lock, if you turn it on, asks for your screen lock before OpenBeacon opens, and important account changes need a recent sign-in.

What you rely on

Your own phones

Your keys are stored on your phones. Anyone who can unlock your phone and open OpenBeacon sees what you see. App lock controls who can open the app. It doesn't add a second layer of encryption, so location sharing carries on while the app is locked.

The people in your groups

Members can read everything shared in a group while they're in it, and their phones keep what they've received.

Members' phones also re-encrypt a group's places and picture keys for people who join later. The server can't check the result, so a member running a modified app could save a place in a different position, or replace a picture's key with one that doesn't work. The OpenBeacon app re-encrypts them unchanged, and repairs a broken picture key by itself.

The server, for public keys

Your phone encrypts each new group key for the other members' phones, using public keys it gets from the server. A server that had been deliberately altered could hand out a key of its own and receive new group keys. With a group key it could read new locations and add false ones. It could also leave some keys out of what it sends your phone, so your history looks more complete than it is.

Two steps don't depend on the server:

  • Linking a phone. Your history keys only go to the phone that showed the QR code you scanned.
  • Restoring with a recovery phrase. Your phone only accepts recovery data that was made with your phrase.

If you self-host, this trust sits with whoever runs your server, and with any service that decrypts traffic in front of it, such as Cloudflare.

Removing a phone or a person

When you remove a phone, the server signs it out, refuses its requests and leaves it out of every new group key. The phone deletes its keys and data the next time it connects. Your account's history key stays the same, so a removed phone that never connects again still holds the keys it had. It can't use them to get anything new, because the server no longer answers it.

When someone leaves a group or is removed, the server deletes their locations in that group and the group's key is replaced. Their phone keeps what it had already received.

Other phones in the group switch to the new key the next time they sync. How encryption works describes that switch.

Independent review

OpenBeacon's encryption hasn't had an independent security review yet. The design is described in How encryption works, the code is open source, and you can report a vulnerability privately.

On this page