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

Move away from gist for better automatic reports #762

Closed
quyse opened this issue Jul 2, 2016 · 3 comments
Closed

Move away from gist for better automatic reports #762

quyse opened this issue Jul 2, 2016 · 3 comments
Labels
security Keep the baddies out ui / ux Something graphical, something you experience

Comments

@quyse
Copy link
Contributor

quyse commented Jul 2, 2016

When game crashes itch app shows message asking to "Report broken" game. This feature uploads log onto gist.github.com and opens a "New issue" github page for itch-compatibility-watchlist repo in browser. And here is the problem: log is uploaded as an anonymous "secret" gist. It's not really secret, because a link to the gist will be posted in issue's public text. And it's anonymous, which means it cannot be deleted or changed by anyone. Log includes some innocent stuff, like app manifest content, but also name of the user's home directory (which may or may not be sensitive), and full stdout log of the game. In my case stdout log contained pretty sensitive data, like environment variables with some API keys and some other details about system environment. My game was printing those for development purposes, but I would say a lot of released games output excessive amount of data into their logs, and inability to filter some data out before reporting is seriously bad.

Could the log be posted as non-anonymous gist, for example? As you need to be logged in Github to post an issue, you are probably logged in gist.github.com too. Then you will be able to edit or delete the gist.

Or maybe post log inline in issue's text? Or maybe use some specialized service for error reporting, allowing to report bugs privately to developers. It's also will be easier for users: not every user has an account on Github ;)

@fasterthanlime
Copy link
Collaborator

In my case stdout log contained pretty sensitive data, like environment variables with some API keys

This is no longer true as of 7a8de28 - a stable version was never released that leaks the environment.

Could the log be posted as non-anonymous gist, for example?

That would require linking up your GitHub account with itch.io, as the gist is created by the app via an API request, not in the browser where you're logged in.

Or maybe post log inline in issue's text?

We used to do this but was reaching max URL length (since the issue's body is url-encoded and passed as a GET parameter).

To address the overall issue: I'm planning on moving from gist to something itch.io-controlled which both the reporter and admins (and contributors?) can see when logged into their itch.io account, and that the reporter can delete whenever they want to.

@fasterthanlime fasterthanlime changed the title Sensitive data could be exposed via "Report broken" feature Move away from gist for better automatic reports Jul 3, 2016
@quyse
Copy link
Contributor Author

quyse commented Jul 3, 2016

This is no longer true as of 7a8de28 - a stable version was never released that leaks the environment.

No, I meant that my game, not itch app, was leaking data by printing them onto stdout for development purposes. I just didn't expect it to be sent as a gist. And I think I've seen a lot of released games outputting a lot of data on stdout, and presumably not expecting to expose those publicly either.

I'm planning on moving from gist to something itch.io-controlled which both the reporter and admins (and contributors?) can see when logged into their itch.io account, and that the reporter can delete whenever they want to.

That would be perfect :)

@fasterthanlime fasterthanlime added ui / ux Something graphical, something you experience infrastructure security Keep the baddies out labels Jul 18, 2016
@fasterthanlime
Copy link
Collaborator

Closing in favor of #1511

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
security Keep the baddies out ui / ux Something graphical, something you experience
Projects
None yet
Development

No branches or pull requests

2 participants