Add support for app authentication (#305)

dropbox · Dec 30, 2020 · 9204111 · 9204111
1 parent b21934d
commit 9204111
Show file tree

Hide file tree

Showing 16 changed files with 535 additions and 248 deletions.
diff --git a/dropbox/account.py b/dropbox/account.py
@@ -248,7 +248,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     SetProfilePhotoArg_validator,
     SetProfilePhotoResult_validator,
     SetProfilePhotoError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 

diff --git a/dropbox/auth.py b/dropbox/auth.py
@@ -679,7 +679,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     TokenFromOAuth1Arg_validator,
     TokenFromOAuth1Result_validator,
     TokenFromOAuth1Error_validator,
-    {'host': u'api',
+    {'auth': u'app',
+     'host': u'api',
      'style': u'rpc'},
 )
 token_revoke = bb.Route(
@@ -689,7 +690,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     bv.Void(),
     bv.Void(),
     bv.Void(),
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 

diff --git a/dropbox/check.py b/dropbox/check.py
@@ -80,7 +80,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     EchoArg_validator,
     EchoResult_validator,
     bv.Void(),
-    {'host': u'api',
+    {'auth': u'app',
+     'host': u'api',
      'style': u'rpc'},
 )
 user = bb.Route(
@@ -90,7 +91,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     EchoArg_validator,
     EchoResult_validator,
     bv.Void(),
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 

diff --git a/dropbox/contacts.py b/dropbox/contacts.py
@@ -115,7 +115,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     bv.Void(),
     bv.Void(),
     bv.Void(),
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 delete_manual_contacts_batch = bb.Route(
@@ -125,7 +126,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     DeleteManualContactsArg_validator,
     bv.Void(),
     DeleteManualContactsError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 

diff --git a/dropbox/dropbox_client.py b/dropbox/dropbox_client.py
@@ -8,6 +8,7 @@
 # before release.
 __version__ = '0.0.0'
 
+import base64
 import contextlib
 import json
 import logging
@@ -59,6 +60,11 @@
 
 SELECT_USER_HEADER = 'Dropbox-API-Select-User'
 
+USER_AUTH = 'user'
+TEAM_AUTH = 'team'
+APP_AUTH = 'app'
+NO_AUTH = 'noauth'
+
 class RouteResult(object):
     """The successful result of a call to a route."""
 
@@ -293,6 +299,7 @@ def request(self,
         self.check_and_refresh_access_token()
 
         host = route.attrs['host'] or 'api'
+        auth_type = route.attrs['auth']
         route_name = namespace + '/' + route.name
         if route.version > 1:
             route_name += '_v{}'.format(route.version)
@@ -315,6 +322,7 @@ def request(self,
                                                   route_name,
                                                   route_style,
                                                   serialized_arg,
+                                                  auth_type,
                                                   request_binary,
                                                   timeout=timeout)
         decoded_obj_result = json.loads(res.obj_result)
@@ -407,6 +415,7 @@ def request_json_object(self,
                             route_name,
                             route_style,
                             request_arg,
+                            auth_type,
                             request_binary,
                             timeout=None):
         """
@@ -418,6 +427,7 @@ def request_json_object(self,
         :param route_style: The style of the route.
         :param str request_arg: A JSON-serializable Python object representing
             the argument for the route.
+        :param auth_type str
         :param Optional[bytes] request_binary: Bytes representing the binary
             payload. Use None if there is no binary payload.
         :param Optional[float] timeout: Maximum duration in seconds
@@ -432,6 +442,7 @@ def request_json_object(self,
                                                   route_name,
                                                   route_style,
                                                   serialized_arg,
+                                                  auth_type,
                                                   request_binary,
                                                   timeout=timeout)
         # This can throw a ValueError if the result is not deserializable,
@@ -447,6 +458,7 @@ def request_json_string_with_retry(self,
                                        route_name,
                                        route_style,
                                        request_json_arg,
+                                       auth_type,
                                        request_binary,
                                        timeout=None):
         """
@@ -465,6 +477,7 @@ def request_json_string_with_retry(self,
                                                 route_name,
                                                 route_style,
                                                 request_json_arg,
+                                                auth_type,
                                                 request_binary,
                                                 timeout=timeout)
             except AuthError as e:
@@ -507,6 +520,7 @@ def request_json_string(self,
                             func_name,
                             route_style,
                             request_json_arg,
+                            auth_type,
                             request_binary,
                             timeout=None):
         """
@@ -529,10 +543,24 @@ def request_json_string(self,
         url = self._get_route_url(fq_hostname, func_name)
 
         headers = {'User-Agent': self._user_agent}
-        if host != HOST_NOTIFY:
+        if auth_type == USER_AUTH or auth_type == TEAM_AUTH:
             headers['Authorization'] = 'Bearer %s' % self._oauth2_access_token
             if self._headers:
                 headers.update(self._headers)
+        elif auth_type == APP_AUTH:
+            if self._app_key is None or self._app_secret is None:
+                raise BadInputException(
+                    'Client id and client secret are required for routes with app auth')
+            auth_header = base64.b64encode(
+                "{}:{}".format(self._app_key, self._app_secret).encode("utf-8")
+            )
+            headers['Authorization'] = 'Basic {}'.format(auth_header.decode("utf-8"))
+            if self._headers:
+                headers.update(self._headers)
+        elif auth_type == NO_AUTH:
+            pass
+        else:
+            raise BadInputException('Unhandled auth type: {}'.format(auth_type))
 
         # The contents of the body of the HTTP request
         body = None

diff --git a/dropbox/file_properties.py b/dropbox/file_properties.py
@@ -2106,7 +2106,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     AddPropertiesArg_validator,
     bv.Void(),
     AddPropertiesError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 properties_overwrite = bb.Route(
@@ -2116,7 +2117,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     OverwritePropertyGroupArg_validator,
     bv.Void(),
     InvalidPropertyGroupError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 properties_remove = bb.Route(
@@ -2126,7 +2128,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     RemovePropertiesArg_validator,
     bv.Void(),
     RemovePropertiesError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 properties_search = bb.Route(
@@ -2136,7 +2139,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     PropertiesSearchArg_validator,
     PropertiesSearchResult_validator,
     PropertiesSearchError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 properties_search_continue = bb.Route(
@@ -2146,7 +2150,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     PropertiesSearchContinueArg_validator,
     PropertiesSearchResult_validator,
     PropertiesSearchContinueError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 properties_update = bb.Route(
@@ -2156,7 +2161,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     UpdatePropertiesArg_validator,
     bv.Void(),
     UpdatePropertiesError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_add_for_team = bb.Route(
@@ -2166,7 +2172,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     AddTemplateArg_validator,
     AddTemplateResult_validator,
     ModifyTemplateError_validator,
-    {'host': u'api',
+    {'auth': u'team',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_add_for_user = bb.Route(
@@ -2176,7 +2183,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     AddTemplateArg_validator,
     AddTemplateResult_validator,
     ModifyTemplateError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_get_for_team = bb.Route(
@@ -2186,7 +2194,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     GetTemplateArg_validator,
     GetTemplateResult_validator,
     TemplateError_validator,
-    {'host': u'api',
+    {'auth': u'team',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_get_for_user = bb.Route(
@@ -2196,7 +2205,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     GetTemplateArg_validator,
     GetTemplateResult_validator,
     TemplateError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_list_for_team = bb.Route(
@@ -2206,7 +2216,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     bv.Void(),
     ListTemplateResult_validator,
     TemplateError_validator,
-    {'host': u'api',
+    {'auth': u'team',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_list_for_user = bb.Route(
@@ -2216,7 +2227,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     bv.Void(),
     ListTemplateResult_validator,
     TemplateError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_remove_for_team = bb.Route(
@@ -2226,7 +2238,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     RemoveTemplateArg_validator,
     bv.Void(),
     TemplateError_validator,
-    {'host': u'api',
+    {'auth': u'team',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_remove_for_user = bb.Route(
@@ -2236,7 +2249,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     RemoveTemplateArg_validator,
     bv.Void(),
     TemplateError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_update_for_team = bb.Route(
@@ -2246,7 +2260,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     UpdateTemplateArg_validator,
     UpdateTemplateResult_validator,
     ModifyTemplateError_validator,
-    {'host': u'api',
+    {'auth': u'team',
+     'host': u'api',
      'style': u'rpc'},
 )
 templates_update_for_user = bb.Route(
@@ -2256,7 +2271,8 @@ def _process_custom_annotations(self, annotation_type, field_path, processor):
     UpdateTemplateArg_validator,
     UpdateTemplateResult_validator,
     ModifyTemplateError_validator,
-    {'host': u'api',
+    {'auth': u'user',
+     'host': u'api',
      'style': u'rpc'},
 )