Skip to content
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

Add security page #327

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add security page #327

wants to merge 4 commits into from

Conversation

bryanoltman
Copy link
Contributor

Status

READY

Description

Adds a security page that answers some of the more common questions we get about security.

@@ -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.


## 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.

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.

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.

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 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants