Skip to content

Read-Only OAuth Scope on GitHub, Please? #6

Open

Description

@winston

We love @github. Our processes all revolve around GitHub.

Naturally by extension, we love the GitHub API, because it allows us to do creative things with GitHub.

So far, we have built a few apps that rely heavily on GitHub's API:

  • deppbot
    • A service that does automated dependency updates for Ruby apps, issued as Pull Requests
  • Dasherize
    • A simple dashboard for CI and GitHub stats
  • GitHub Gem Stats
    • A toy app for "Which RubyGems does X use?" and "Which GitHub repo uses Y gem?"

Let's talk about permissions next.

For both deppbot and Dasherize, we require access to both public and private repos.

Looking at GitHub's OAuth scopes, we'll need to use the repo scope.

screen shot 2015-10-16 at 12 21 19 pm

Hmm.. But wait a minute.. The repo scope grants read AND write access to basically everything! Getting read access is probably a must for all apps, but do we need write on everything?

Due to the nature of deppbot, we'll need write permission on public and private repos, so that it can issue Pull Requests when it finishes the dependency update for a project and perform other actions.

However, all Dasherize does is read from public or private repos, and it's not doing any write at all. You can even take a look at the source code to verify that.

So isn't it intrusive to require write permission too? Definitely.

As a user, I would like all apps to only require the lowest level of permission that it needs to operate.

As a developer, I am taking on unnecessary liability when my app has permissions that it doesn't need.

Of course, we are not the first to create apps that use GitHub API, and this has been a common issue for both users and app developers for a while, for example:

By design, GitHub API does not provide any Read-only OAuth scope for public and/or private repos. Once you ask for permissions to either public and/or private repos, you'll get both read and write. What can we do then if we just want Read-only access on GitHub API?

There are definitely work arounds, as mentioned in some of the links above:

Progressive Permissioning

This means that the app shall only ask for permissions when it requires it.

Let's use @houndci as an example.

When you first sign up, @houndci only asks for access to your email and public repos read/write.

screen shot 2015-10-16 at 4 18 16 pm

Then, it provides you with the option to "Include Private Repos".

screen shot 2015-10-16 at 4 19 44 pm

Clicking on that, you can now grant @houndci access to both public and private repos read/write.

screen shot 2015-10-16 at 4 20 19 pm

In this way, you only grant @houndci necessary permissions when it requires it.

But this still doesn't solve the problem if my app just requires a read scope, like Dasherize..

Manual Setup

Alternatively, maybe a manual setup of collaborators might help?

screen shot 2015-10-18 at 3 03 18 pm

Unfortunately not.

When you add a collaborator to a GitHub repo, the collaborator naturally has read and write permissions, and you can't change it.

What about Teams (for Organization repos only)? Can it grant Read-only permissions?

Yes. That might help!

You can create a special Team in the organization, grant the Team a read-only access to the repo,
and now you have a Read-only scope. But in most cases, manual setup is not the best UX experience. 😢

screen shot 2015-10-16 at 4 30 39 pm

Recently, GitHub also added Read-only Deploy Keys, as another option to grant Read-only access to one single repo.

Many are speculating that this eventually lead to a Read-only OAuth scope. I sure hope so.


In summary, we really hope that @github can provide developers with a Read-only OAuth scope, so that app developers don't have to explain ourselves every time we use the repo scope.

In both deppbot and Dasherize, we are conscious of our decision in asking for read write access to public and private repos because we went with the simplest solution for now to validate the ideas. Definitely, we should look into both Progressive Permissing or Manual Setup when the apps get enough traction and feedback from users.

Thank you for reading.

@winston ✏️ Jolly Good Code

About Jolly Good Code

Jolly Good Code

We specialise in Agile practices and Ruby, and we love contributing to open source.
Speak to us about your next big idea, or check out our projects.

Activity

  1. changed the title [-]Read-Only OAUth Scope on GitHub, Please?[/-] [+]Read-Only OAuth Scope on GitHub, Please?[/+] on Oct 20, 2015
  2. bluta commented on Sep 15, 2016

    @bluta

    i would also love to have this - and am now creating a deploy user having only read access to all of our repos needed by our application.
    👍

  3. ayurkows commented on Sep 22, 2016

    @ayurkows

    This is the first non-doc link from google I found when searching for how to get a read only scope.

    I agree this is needed, users are going to question why we are asking for write access as well especially since it's highlighted and there's no way for them to know that we are only asking for it because we have no other option.

  4. alexmalik commented on Feb 24, 2017

    @alexmalik

    I would definitely use this if it was a feature, my app doesn't need the write access that the current repo scope supplies, and as a developer I know I would only want to give the minimum permissions to an app if I were the user of my app.

  5. jnieuwhof commented on Mar 23, 2017

    @jnieuwhof

    Plus one on this, breaks principle of least privilege

  6. sgen commented on Jul 27, 2017

    @sgen

    It looks like this is on the horizon

  7. ronaldpetty commented on May 9, 2018

    @ronaldpetty

    Can anyone with experience clarify here? I am looking for read only private repo scope, and don't see something like that in roadmap or existing settings. Maybe I am misinterpreting what was stated above.

  8. deftio commented on Jul 18, 2018

    @deftio

    I have the same question. When an outside org such as Travis or BlackDuck or whatever wants access to my public repos I just want to give them read access so they can do their thing. I don't see why I would want to give them write access so how do I set that up?

  9. BernieSumption commented on Jul 26, 2018

    @BernieSumption

    +1! I routinely start to set up integrations, then stop half way because I remember that there's no way to allow an integration read-only access to my GitHub account. Most recent was the Trello and Slack integrations.

    The ability to modify code in a repo is basically the highest privilege you could grant, second perhaps only to deleting the repo. Most integrations are convenient tools for bringing GitHub data into other systems. If they need to write data it's probably only comments and PRs. These tools provide a lot of value, but given the security risk of having keys floating around that allow write access to all my repos I sadly have to ignore them all.

  10. udev commented on Aug 27, 2018

    @udev

    Guess we're checking in on this from August 2018... Seems to be a pretty in-demand feature request.
    dear-github/dear-github#113

  11. Bob-Thomson-zz commented on Sep 27, 2018

    @Bob-Thomson-zz

    +1 as has been said, least privilege - there will always be situations where granting read only access makes sense.

  12. jimsmith commented on Sep 27, 2018

    @jimsmith

    +1 least privilege access there are situations in corp/enterprise world when this is a must.

  13. peterbosalliandercom commented on Dec 14, 2018

    @peterbosalliandercom

    And again, please add this functionality, we need this for CI/CD purposes, for example argocd which deploys apps in combination with Helm charts wich depend on a values.yaml which is stored in a private repo where the config is stored. Github is not only for developers but also voor gitops configuration. We need read only scope on personal access tokens per repo.

  14. NateZimmer commented on Dec 19, 2018

    @NateZimmer

    psst microsoft devops can do this. cmon git. Yes i'm sure you think this would be redundant with deployment keys
    Why its a superior offering to have tokens:

    • It is far simpler to automate usage of these than a deployment key. SSH key setup is not a simple cross platform task to automate. Deployment keys needlessly add uneeded complexity and headache to cross platform deployment.
      I beg you git, please consider repo specific read-only tokens
  15. 37 remaining items

  16. jhullEO commented on Aug 30, 2021

    @jhullEO

    Well now I'd feel bad if they fixed it. It's a good chuckle every month or so.

  17. m4heshd commented on Aug 30, 2021

    @m4heshd
  18. Breiby commented on Nov 10, 2021

    @Breiby

    How is this not a thing yet? :|

  19. AashJ commented on Nov 15, 2021

    @AashJ

    😢 this still isn't included is it...

  20. Gby56 commented on Nov 15, 2021

    @Gby56

    Bumping this, the roadmap has no date planned. Just like previous comments said, this is seriously bad for Github runners, making things dangerous for supply chain by just pushing code to a repo from a runner.

  21. CerebralDatabank commented on Nov 16, 2021

    @CerebralDatabank

    I was researching this because I was wondering why an app that I was using required full read and write access to my public repos, even though the app only needed to read them. Little did I know this would be a problem with GitHub since at least 2015 that they haven't fixed in 2021...

  22. choonkeat commented on Nov 19, 2021

    @choonkeat

    Comments should henceforth go directly to community/community#7891 where Github is tuning in. Thanks everyone

  23. jg3 commented on Dec 15, 2021

    @jg3

    I don't understand why r/o SSH keys are a thing and r/o access token can't be. It makes me question everything.

  24. johnspurlock-skymethod commented on Dec 21, 2021

    @johnspurlock-skymethod

    Adding to the pileon - I can't believe a read-only scope does not exist!

  25. matanox commented on Jan 29, 2022

    @matanox

    One additional use case for this IMHO ― cloning a private github repo for using it in Google Colab. I can't think of another solution to cloning private repositories in Colab, Colab being an untrusted environment which is also ephemeral by nature. A personal access token with read only (clone) privileges may seem like the closest option for this light-risk scenario. Maybe I'm wrong.

  26. kderck commented on Mar 24, 2022

    @kderck

    I would also like to be able to see a Read Only scope for Private, and Public repositories in GitHub.

  27. deftio commented on Mar 24, 2022

    @deftio

    Don't worry the problem will be addressed.

    Here's how:

    1. There will be some cyberhack where some 3rd party with write access to 100k or 1M repos is hijacked.
    2. The hack will write lots of junk into those repos.
    3. A few millions services will suddenly get screwed up.
    4. There will be press about how this could happen / OMG / what happens now??
    5. Then Github / Microsoft team will notice and suddenly appropriately scoped permissions will be a feature.
  28. GitHunter0 commented on Jun 11, 2022

    @GitHunter0

    I'm absolute amazed there are no read-only rights on API tokens given that API tokens have a permissions system.

    Yes, this is absolutely ridiculous, it's obviously not a difficult feature for @github to implement. Some things in this world are just incomprehensible.

    Is there a formal response from @github about this issue?

  29. winston commented on Jun 11, 2022

    @winston
    MemberAuthor
  30. locked as too heated and limited conversation to collaborators on Jun 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions