Skip to content

Add security page #327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
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
4 changes: 4 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ export default defineConfig({
label: 'Status',
link: '/status',
},
{
label: 'Security',
link: '/security',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this PR meant to replace the one for shorebird.dev/security? Or are the two meant to co-exist? If so what's the difference in the content?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They're meant to coexist. The handbook describes a policy , this document is meant to be more developer facing and to answer specific questions.

},
{
label: 'Billing',
link: '/billing',
Expand Down
66 changes: 66 additions & 0 deletions src/content/docs/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: Security
description: Security
---

Shorebird takes security very seriously. We take several steps to make sure that
we protect the data you give us, that only you can publish changes to your app,
and that the patches your users get are the same ones you created.

## Release Artifact Privacy

Your release artifacts (created by `shorebird release`) are hosted privately on
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Importantly the Release artifacts are the same ones they publish to the stores.

GCP and are not publicly visible. When they need to be downloaded by you (to run
`shorebird preview`, for example), we generate a signed URL that requires your
auth credentials and expires after a short period of time.

## Patch Integrity

The most common security question we get is: How do you verify that the patches
our users are downloading are the ones that I created and that they haven't been
tampered with?

We ensure the integrity of patches in several ways.

Over the air:

1. Patches are not full artifacts; rather, they are binary diffs. To create a
patch, you need access to the release artifact, which is private.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Release's made to the stores are public, so it's easy to get that release artifact.

2. When a patch is "inflated" (i.e., the binary diff is applied to the base
release), we verify that the md5 hash of the _inflated_ patch matches what is
in the patch check response.

On device:

1. When the app boots, we ensure that the inflated patch is the same size as it
was when it was first inflated. If the size has changed, we will not attempt
to boot it.
2. (Optional) you can opt in to patch signing. This involves including a private
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the main protection, and really needs to be default. We should pitch it as though it is the recommended option/default.

key with your release and signing your patches when you create them. If a
patch is signed, we verify its signature before attempting to boot from it.
This is the highest level of security for patches. Read more about it
[here](/guides/patch-signing).

## Data privacy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might lead with this section. Our privacy stance informs our risk-area of security.


Shorebird is committed to privacy and provides a high standard of privacy
protection to all our customers and their customers. We never collect data from
your customers, and only collect the data necessary from you to provide services
to you. We take care to protect your data that you entrust with us.

Read our [privacy policy](https:/shorebird.dev/privacy).

## Shorebird on the public cloud

While we do not offer SOC2, ISO 27001 certifications, Shorebird exclusively
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should say that we're in the process of doing our ISO 27001 certification (I just have to sign the contract in my inbox), expected Q2 2025.

relies on vendors who do. Shorebird explicitly does _not_ build its own servers
or data storage, relying only on public cloud vendors with rigorous security
such as CloudFlare and Google Cloud.

## Learn more

Read our [public security policies](https://handbook.shorebird.dev/security).

## Other questions?

Feel free to contact us at [email protected] or reach out to us on Discord.
Loading