The Community is undergoing a major upgrade. Find out more, ask us questions or share your thoughts here.

Forum Discussion

andrewnicols's avatar
andrewnicols
Helpful | Level 5
4 years ago

OAuth2 empty scope does not behave correctly

According to the OAuth2 Authorization documentation , the `scope` is a nullable String:

 

scope String? This parameter allows your user to authorize a subset of the scopes selected in the App Console. Multiple scopes are separated by a space. If this parameter is omitted, the authorization page will request all scopes selected on the Permissions tab. Read about scopes in the OAuth Guide.

 

This matches RFC6749 section 3.3 which states:

   If the client omits the scope parameter when requesting
   authorization, the authorization server MUST either process the
   request using a pre-defined default value or fail the request
   indicating an invalid scope.  The authorization server SHOULD
   document its scope requirements and default value (if defined).

 

However, the Dropbox API treats the nullable state incorrectly:

  • If the scope is provided, but is empty, then a 400 error message is displayed; but
  • if the scope is missing entirely then the default value is provided.

Section 3.1 of the RFC states:

   Parameters sent without a value MUST be treated as if they were
   omitted from the request.  The authorization server MUST ignore
   unrecognized request parameters.  Request and response parameters
   MUST NOT be included more than once.

It seems that the Dropbox authorization endpoint is mis-treating the value, causing the 400 error. Per the specification, a parameter with an empty value MUST be treated in the same way as an omitted parameter.

  • Greg-DB's avatar
    Greg-DB
    Icon for Dropbox Staff rankDropbox Staff

    Thanks for the detailed writeup! That's very helpful. I'll ask the team to update the implementation to treat an empty scope parameter the same way as a missing scope parameter.

    • andrewnicols's avatar
      andrewnicols
      Helpful | Level 5

      Thanks for the update Greg-DB!

       

      I look forward to the change. I'll mark this as accepted once there's a response as to if/when that will be implemented.

       

      Cheers

    • andrewnicols's avatar
      andrewnicols
      Helpful | Level 5

      Hi Greg-DB,

       

      I was just wondering whether there's any update from the relevant team on the state of this and an ETA for a fix?

       

      Thanks,

       

      Andrew

      • Greg-DB's avatar
        Greg-DB
        Icon for Dropbox Staff rankDropbox Staff

        I don't have an update on this quite yet, but I'll follow up here once I do.

About Dropbox API Support & Feedback

Find help with the Dropbox API from other developers.

5,875 PostsLatest Activity: 38 minutes ago
323 Following

If you need more help you can view your support options (expected response time for an email or ticket is 24 hours), or contact us on X or Facebook.

For more info on available support options for your Dropbox plan, see this article.

If you found the answer to your question in this Community thread, please 'like' the post to say thanks and to let us know it was useful!