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

[Docs issue] Need guidance on how securely to treat Sentry auth token (should it go in source control?) #1096

Open
lukewlms opened this issue Sep 21, 2020 · 5 comments
Labels
Platform: Docs Regarding the documentation Platform: React-Native security Pull requests that address a security vulnerability Type: Feature Request
Projects

Comments

@lukewlms
Copy link

By default, the Sentry auth token is added to source control in multiple ways:

  • ./ios/sentry.properties and ./android/sentry.properties
  • In our case, added to fastfile in the upload_symbols_to_sentry step

The docs don't specify if the auth token should be treated more securely than the URL-esque key used in source code (which we put in an .ENV file although it will of course ship in the client).

It doesn't look like the CLI can do anything too destructive - only add, not delete, as far as I can see on a quick skim. So perhaps it's ok to have this auth token in source control.

But it would be I think valuable to have an explicit instruction both in the setup steps, and at this URL: https://sentry.io/settings/account/api/auth-tokens/ (That page also does not appear to give any guidance on how to treat this auth token.)

That way we'll all know what the best security practice is for these tokens.

Thanks for taking a look!

@jennmueng
Copy link
Member

Hmm I agree, the auth token should not be included in source-control. Thanks for the suggestion and I will get on this.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2021

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@marandaneto marandaneto added Platform: Docs Regarding the documentation security Pull requests that address a security vulnerability labels Nov 12, 2021
@marandaneto marandaneto added this to To Do in kanban via automation Nov 12, 2021
@marandaneto
Copy link
Contributor

we'll discuss that internally if we have to document the optimal approach for this but I'd say this is App's responsibility to secure its own token, this is sensitive information and should be treated as such, not checking into source control, etc.
an idea is to remove the token from files and set as SENTRY_AUTH_TOKEN env. var. when running releases

@marandaneto marandaneto reopened this Nov 15, 2021
kanban automation moved this from To Do to In progress Nov 15, 2021
@marandaneto marandaneto moved this from In progress to To Do in kanban Nov 15, 2021
@marandaneto
Copy link
Contributor

We'll document that this is sensitive information and should not be publicly available.

@darrylyoung
Copy link

In case this is useful for anyone else coming across the issue, this has since been discussed here as well — #2618

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Platform: Docs Regarding the documentation Platform: React-Native security Pull requests that address a security vulnerability Type: Feature Request
Projects
Status: Backlog
kanban
To Do
Development

No branches or pull requests

7 participants