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 documentation to docs.rs, revoke github tokens used for gh-pages #1

Open
SimonSapin opened this issue May 9, 2017 · 3 comments

Comments

@SimonSapin
Copy link

I’m abusing this repo as a place to file an org-wide issue. We have four unicode-* code repos, and all of them currently have .travis.yml configured to build docs and push them to Github Pages with someone’s "personal access token".

This kind of setup is at risk of leaking access tokens, giving away push access to repositories: https://blog.travis-ci.com/2017-05-08-security-advisory. For these four repositories however, we correctly pass -q to git push so that the git URL (including the token) is not printed in the git logs. Therefore, to my knowledge, none of these tokens have been compromised.

Still, getting this right is subtle. And this setup is generally kinda fragile.

Since the time this was set up, docs.rs was created. It automatically builds and publishes docs for everything published to crates.io. For example: https://docs.rs/unicode-xid/0.1.0/unicode_xid/

@alexcrichton @huonw @Manishearth @kwantam, what do you think of removing the GitHub Pages setup (replacing with a redirect) and linking to docs.rs instead?

After that, github access tokens should be revoked. This kind of token is dangerous because they are associated not to a repository, but to a user. They give push access to every repository that this user has access to. Revoking them is tricky because it is not easy to find out what user a given token is for. According to git history (who added them), it looks like @alexcrichton has the token used in unicode-width, and @kwantam has the one used in unicode-normalization, unicode-segmentation, and unicode-xid.

@SimonSapin
Copy link
Author

Links to update are (at least) in README.md, Cargo.toml, and src/lib.rs of each repo.

@alexcrichton
Copy link

Seems reasonable to me!

@Manishearth
Copy link
Member

Yeah, we should be using docs.rs wherever possible

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

No branches or pull requests

3 participants