codekingpro/portable-devtools
115k
1�
2 ��j� � � � S r SSKrSSKrSSKrSSKrSSKrSSKrSSKrSSK r SSK3J r SSK4J r SSK
Jr SSKJr SSKJr SSKJrJrJrJrJrJrJr " S S5\5 r " S S 5 r " S
S5 r " S S5 r " S S\ 5 r " S S\ 5 r! " S S\ 5 r"0 S4S\\#\4 S\#S\#S\\#\4 S\\\#\4 S \$4 S jjr%0 S4S\\#\4 S\#S\#S\\#\4 S\\\#\4 S \$4 S jjr&S \\#\$4 S \#4S jr'S!\$S \\#\4 4S" jr(g)#a� This module contains implementations of various third-party6authentication schemes.7 8All the classes in this file are class mixins designed to be used with9the `tornado.web.RequestHandler` class. They are used in two ways:10 11* On a login handler, use methods such as ``authenticate_redirect()``,12 ``authorize_redirect()``, and ``get_authenticated_user()`` to13 establish the user's identity and store authentication tokens to your14 database and/or cookies.15* In non-login handlers, use methods such as ``facebook_request()``16 or ``twitter_request()`` to use the authentication tokens to make17 requests to the respective services.18 19They all take slightly different arguments due to the fact all these20services implement authentication and authorization slightly differently.21See the individual service classes below for complete documentation.22 23Example usage for Google OAuth:24 25.. testsetup::26 27 import urllib28 29.. testcode::30 31 class GoogleOAuth2LoginHandler(tornado.web.RequestHandler,32 tornado.auth.GoogleOAuth2Mixin):33 async def get(self):34 # Google requires an exact match for redirect_uri, so it's35 # best to get it from your app configuration instead of from36 # self.request.full_uri().37 redirect_uri = urllib.parse.urljoin(self.application.settings['redirect_base_uri'],38 self.reverse_url('google_oauth'))39 async def get(self):40 if self.get_argument('code', False):41 access = await self.get_authenticated_user(42 redirect_uri=redirect_uri,43 code=self.get_argument('code'))44 user = await self.oauth2_request(45 "https://www.googleapis.com/oauth2/v1/userinfo",46 access_token=access["access_token"])47 # Save the user and access token. For example:48 user_cookie = dict(id=user["id"], access_token=access["access_token"])49 self.set_signed_cookie("user", json.dumps(user_cookie))50 self.redirect("/")51 else:52 self.authorize_redirect(53 redirect_uri=redirect_uri,54 client_id=self.get_google_oauth_settings()['key'],55 scope=['profile', 'email'],56 response_type='code',57 extra_params={'approval_prompt': 'auto'})58 59� N)�60httpclient)�escape)�61url_concat)� unicode_type)�RequestHandler)�List�Any�Dict�cast�Iterable�Union�Optionalc � � \ rS rSrSrg)� AuthError�Z � N)�__name__�62__module__� __qualname__�__firstlineno__�__static_attributes__r � �RD:\code\apps\devtools\python\user_packages\Python313\site-packages\tornado/auth.pyr r Z s � �r r c � � \ rS rSrSrS/ SQ4S\\ S\\ SS4S jjr SS \\ R S\ \\ 4 4S63 jjr
/ S4S\S\\ S \\ S\ \\4 4S jjrS
\ R S\ \\ 4 4S jrS\ R 4S jrSrg)� OpenIdMixin�^ z�Abstract implementation of OpenID and Attribute Exchange.64 65Class attributes:66 67* ``_OPENID_ENDPOINT``: the identity provider's URI.68N)�name�email�language�username� callback_uri�ax_attrs�returnc �69 � [ [ U 5 nU=( d UR R nUc eU R XS9nU R70 nUR
US- [ R R U5 - 5 g)aH Redirects to the authentication URL for this service.71 72After authentication, the service will redirect back to the given73callback URI with additional parameters including ``openid.mode``.74 75We request the given attributes for the authenticated user by76default (name, email, language, and username). If you don't need77all those attributes for your app, you can request fewer with78the ax_attrs keyword argument.79 80.. versionchanged:: 6.081 82 The ``callback`` argument was removed and this method no83 longer returns an awaitable object. It is now an ordinary84 synchronous function.85N)r" �?)86r r �request�uri� _openid_args�_OPENID_ENDPOINT�redirect�urllib�parse� urlencode)�selfr! r" �handler�args�endpoints r �authenticate_redirect�!OpenIdMixin.authenticate_redirectf st � �* �~�t�,��#�:�w���':�':� ��'�'�'�� � � � �A���(�(������C� �&�,�,�*@�*@��*F�F�Gr � http_clientc � � # � [ [ U 5 nUR R R 5 VVs0 s H87 u p4X4S _M nnnSUS' U R88 nUc U R
5 nUR US[ R R U5 S9I Sh v�N nU R U5 $ s snnf N7f)a Fetches the authenticated user data upon redirect.89 90This method should be called by the handler that receives the91redirect from the `authenticate_redirect()` method (which is92often the same as the one that calls it; in that case you would93call `get_authenticated_user` if the ``openid.mode`` parameter94is present and `authenticate_redirect` if it is not).95 96The result of this method will generally be used to set a cookie.97 98.. versionchanged:: 6.099 100 The ``callback`` argument was removed. Use the returned101 awaitable object instead.102������check_authentication� openid.modeN�POST��method�body) r r r& � arguments�itemsr) �get_auth_http_client�fetchr+ r, r- �_on_authentication_verified)r. r4 r/ �k�vr0 �url�resps r �get_authenticated_user�"OpenIdMixin.get_authenticated_user� s� � � �$ �~�t�,�� ")� � �!:�!:�!@�!@�!B�103�!B���A��u�H�!B�
� 104� 5��]���#�#�� � � �3�3�5�K� �&�&� ��V�\�\�%;�%;�D�%A� '� 105� 106�� �/�/��5�5��107�108�s �8C�B9� AC�#B?�$ C� oauth_scopec � � [ [ U 5 n[ R R UR109 R
5 U5 nSSSU[ R R US5 SS.nU( a� UR SSS.5 [ U5 n/ nS U; a# U1 S110k- nU/ S Q-
nUR S S
SS.5 SSSS.nU H n X� USU - ' UR U 5 M SR U5 US' U( a; UR SUR111 R R S5 S US.5 U$ )Nz http://specs.openid.net/auth/2.0z2http://specs.openid.net/auth/2.0/identifier_select�/�
checkid_setup)z openid.ns�openid.claimed_idzopenid.identityzopenid.return_toz openid.realmr8 � http://openid.net/srv/ax/1.0�
fetch_request)z openid.ns.axzopenid.ax.moder > r �fullname�lastname� firstname)rQ rO rP �$http://axschema.org/namePerson/first� http://axschema.org/namePerson�#http://axschema.org/namePerson/last)zopenid.ax.type.firstnamezopenid.ax.type.fullnamezopenid.ax.type.lastname�!http://axschema.org/contact/email�!http://axschema.org/pref/language�'http://axschema.org/namePerson/friendly)r r r zopenid.ax.type.�,zopenid.ax.requiredz,http://specs.openid.net/extensions/oauth/1.0�:r )zopenid.ns.oauthzopenid.oauth.consumerzopenid.oauth.scope)
r r r+ r, �urljoinr& �full_url�update�set�append�join�host�split)112r. r! r" rH r/ rD r0 �required� known_attrsr s113 r r( �OpenIdMixin._openid_args� sR � � �~�t�,���l�l�"�"�7�?�?�#;�#;�#=�|�L��;�!U� S� #� "�L�L� 0� 0��c� :�*�
114�� � �K�K�$B�&5��
� �8�}�H��H���!�� I�I��� A�A��� � �4Z�3S�3X��� =� ?� E��K�115 !��1<�1B��&��-�.�����%� !� *-���(�);�D�%� &� � �K�K�'U�-4�_�_�-A�-A�-G�-G��-L�Q�-O�*5��
� � r �responsec �V ^
^� [ [ U 5 mSUR ; a [ SUR - 5 eS m
TR R116 H7 nUR
S5 ( d M TR U5 S:X d M2 USS m
O S[ S[ 4U
U4S jjnU" S 5 nU" S1175 nU" S 5 nU" S 5 nU" S
5 nU" S5 R 5 n [ 5 n118/ n U( a XjS' U R U5 U( a XzS' U R U5 U( a XZS' O:U ( a SR U 5 U119S' O U( a UR S5 S U120S' U( a XJS' U ( a X�S' U( a X�S' TR SS 5 n U ( a X�S' U121$ )Ns
is_valid:truezInvalid OpenID response: %rz122openid.ns.rM �123 r' r# c �B >� T( d gST- S- nS nTR R R 5 HK nTR U5 U :X d M UR U5 ( d M2 U[ U5 S nST- S- U- n O U( d gTR US5 $ )N� zopenid.z.type.z.value.)r& r= �keys� get_argument�124startswith�len)r' �prefix�ax_namer �part�ax_nsr/ s ��r �125get_ax_arg�;OpenIdMixin._on_authentication_verified.<locals>.get_ax_arg� s� �� ��� ��&��1�F��G� ���1�1�6�6�8���'�'��-��4�� � ��9P�9P� ��F� �
�.�D� '�%� /�)� ;�d� B�G�� 9�126 ���'�'���4� 4r rU rS rR rT rW rV �127first_name� last_namer � �@r r �localer rL �128claimed_id)r r r< r r& r= rl rk �str�lower�dictr^ r_ ra )r. re �keyrr r r rt ru r rx �user�129name_partsry rq r/ s @@r rA �'OpenIdMixin._on_authentication_verified� s� �� � �~�t�,�� �8�=�=� 0�� 9�H�M�M� I�J� J� ���?�?�,�,�C����|�,�,��(�(��-�1O�O��B�C����
-� 5�C� 5�C� 5� 5� �>�?���:�;�� � F�G�130� � D�E� � � G�H��� ?�@�F�F�H���v���131� �!+� � � � � �j� )� � )�� � � � �i� (� � ��L�
� �8�8�J�/�D��L�
� �;�;�s�+�A�.�D��L� � !��M� � #��N� � '�� � �)�)�*=�t�D�132� �!+� � �� r c �, � [ R " 5 $ �z�Returns the `.AsyncHTTPClient` instance to be used for auth requests.133 134May be overridden by subclasses to use an HTTP client other than135the default.136�r �AsyncHTTPClient�r. s r r? � OpenIdMixin.get_auth_http_client � � � �)�)�+�+r r �N)r r r r �__doc__r rz r r2 r r� r137 r rF r r( � HTTPResponserA r? r r r r r r ^ s� � �� '+� G�H� �s�m�H� �s�)�H� 138� H�: CG� 6�#�J�$>�$>�?� 6�
�c�3�h� � 6�F #%�%)� 4��4� �3�-�4� �c�]� 4�139 140�c�3�h� � 4�l<�"�/�/�<�
�c�3�h� �<�|,�j�&@�&@� ,r r c
�� � \ rS rSrSr SS\\ S\\\\4 S\\ R SS4S jjr SS\\ R S\\\4 4S jjr S S\\ S\\\\4 S\4S141 jjr
S \S\\ S \ R SS4S
jrS\\\4 S\4S jrS\\\4 4S jrS\\\4 S\\\4 4S jr0 S4S\S\\\4 S\\\4 S\S\\\4 4142S jjrS\ R 4S jrSrg) �143OAuthMixini a Abstract implementation of OAuth 1.0 and 1.0a.144 145See `TwitterMixin` below for an example implementation.146 147Class attributes:148 149* ``_OAUTH_AUTHORIZE_URL``: The service's OAuth authorization url.150* ``_OAUTH_ACCESS_TOKEN_URL``: The service's OAuth access token url.151* ``_OAUTH_VERSION``: May be either "1.0" or "1.0a".152* ``_OAUTH_NO_CALLBACKS``: Set this to True if the service requires153 advance registration of callbacks.154 155Subclasses must also override the `_oauth_get_user_future` and156`_oauth_consumer_token` methods.157Nr! � extra_paramsr4 r# c � � # � U( a [ U SS5 ( a [ S5 eUc U R 5 nUc e[ U SS5 S:X a' UR U R XS95 I Sh v�N nO'UR U R 5 5 I Sh v�N nU R158 nU R
XQU5 g NK N%7f)a� Redirects the user to obtain OAuth authorization for this service.159 160The ``callback_uri`` may be omitted if you have previously161registered a callback URI with the third-party service. For162some services, you must use a previously-registered callback163URI and cannot specify a callback via this method.164 165This method sets a cookie called ``_oauth_request_token`` which is166subsequently used (and cleared) in `get_authenticated_user` for167security purposes.168 169This method is asynchronous and must be called with ``await``170or ``yield`` (This is different from other ``auth*_redirect``171methods defined in this module). It calls172`.RequestHandler.finish` for you so you should not write any173other response after it returns.174 175.. versionchanged:: 3.1176 Now returns a `.Future` and takes an optional callback, for177 compatibility with `.gen.coroutine`.178 179.. versionchanged:: 6.0180 181 The ``callback`` argument was removed. Use the returned182 awaitable object instead.183 184�_OAUTH_NO_CALLBACKSFz,This service does not support oauth_callbackN�_OAUTH_VERSION�1.0a)r! r� )�getattr� Exceptionr? r@ �_oauth_request_token_url�_OAUTH_AUTHORIZE_URL�_on_request_token)r. r! r� r4 re rD s r �authorize_redirect� OAuthMixin.authorize_redirect0 s� � � �B �G�D�*?�� G� G�� J�K� K� � � �3�3�5�K��&�&�&� �4�)�6� 2�f� <� (� .� .��-�-�!-� .� � � �H� )� .� .�t�/L�/L�/N� O�O�H��'�'�� � � �s�(�;�� P�s$ �A/C�1B=�2'C�B?�$C�?Cc � � # � [ [ U 5 n[ R " UR S5 5 nUR SS5 nUR S5 nU( d [
S5 eUR S5 S UR S5 5 u pgXc:w a [
S5 e[ XgS 9nU( a XHS185' Uc U R 5 nUc eUR U R U5 5 I Sh v�N n [ U R 5 n186U R U1875 I Sh v�N n U ( d [
S 5 eX�S ' U $ NJ N 7f)
a5 Gets the OAuth authorized user and access token.188 189This method should be called from the handler for your190OAuth callback URL to complete the registration process. We run the191callback with the authenticated user dictionary. This dictionary192will contain an ``access_key`` which can be used to make authorized193requests to this service on behalf of the user. The dictionary will194also contain other fields such as ``name``, depending on the service195used.196 197.. versionchanged:: 6.0198 199 The ``callback`` argument was removed. Use the returned200 awaitable object instead.201� oauth_token�oauth_verifierN�_oauth_request_tokenz"Missing OAuth request token cookiec 3 �v # � U H/ n[ R " [ R " U5 5 v � M1 g 7fr� )�base64� b64decoder �utf8)�.0�is r � <genexpr>�4OAuthMixin.get_authenticated_user.<locals>.<genexpr>z s* � � � %202�6O��F� � �V�[�[��^� ,� ,�6O�s �79�|z#Request token does not match cookie�r} �secret�verifierzError getting user� access_token)r r r r� rk �203get_cookier � clear_cookiera r| r? r@ �_oauth_access_token_url�_oauth_parse_responser< �_oauth_get_user_future) r. r4 r/ � request_keyr� �request_cookie�204cookie_key�
cookie_secret�tokenre r� r~ s r rF �!OAuthMixin.get_authenticated_usera s= � � �$ �~�t�,�� �k�k�'�"6�"6�}�"E�F� � �-�-�.>��E�� �+�+�,B�C�� �� @�A� A�� � � 3�4�%205�6D�6J�6J�3�6O�%206�!�207� � $�� A�B� B���208�� � .�*� � � � �3�3�5�K��&�&�&�$�*�*�4�+G�+G��+N�O�O��,�X�]�]�;� ��0�0� �>�>���� 0�1� 1� +�^� �� �
P�>�s$ �C5E�7E�8-E�%E�& E�Ec �� � [ [ U 5 nU R 5 nU R n[ [209 R " US 5 S[ [ [ R " 5 5 5 [210 R " [ R " [ R " 5 R 5 5 SS9n[ U SS5 S:X at US:X a SUS' OBU( a; [ R" R% UR& R) 5 U5 US' U( a UR+ U5 [- US XV5 nO
[/ US XV5 nXvS211' US - [ R" R1 U5 - $ ) Nr} � HMAC-SHA1�1.0)�oauth_consumer_key�oauth_signature_method�oauth_timestamp� oauth_nonce�
oauth_versionr� r� �oob�oauth_callback�GET�oauth_signaturer% )r r �_oauth_consumer_token�_OAUTH_REQUEST_TOKEN_URLr| r �
to_basestringrz �int�time�binascii�b2a_hex�uuid�uuid4�bytesr� r+ r, rZ r& r[ r\ �_oauth10a_signature�_oauth_signaturer- )r. r! r� r/ �consumer_tokenrD r0 � signatures r r� �#OAuthMixin._oauth_request_token_url� s. � �212 �~�t�,�� �3�3�5���+�+��� %� 3� 3�N�5�4I� J�#.� ��D�I�I�K� 0� 1� �,�,�X�-=�-=�d�j�j�l�>P�>P�-Q�R� � 213�� �4�)�6� 2�f� <��u�$�).��%�&� �)/� � �)=�)=��O�O�,�,�.� �*��%�&� �� � �L�)�+�N�E�3�M�I�(� ���J�I�"+�
� ��S�y�6�<�<�1�1�$�7�7�7r �
authorize_urlre c � � [ [ U 5 n[ UR 5 n[ R214 " [ R " US 5 5 S- [ R215 " [ R " US 5 5 - nUR SU5 [ US S9nUS:X a5 UR US- [ R R U5 - 5 g U( a; [ R R UR R! 5 U5 US' UR# US- [ R R U5 - 5 g ) Nr} � |r� r� )r� r� r% r� )r r r� r< r� � b64encoder r� �216set_cookier| �finishr+ r, r- rZ r& r[ r* )r. r� r! re r/ �
request_token�datar0 s r r� � OAuthMixin._on_request_token� s � � �~�t�,��-�h�m�m�<�
� � � �V�[�[� �u�)=� >� ?��
�� � �v�{�{�=��+B� C�D�
E�
�217 ���1�4�8��
�e� 4�5�� �5� � �N�N�=�3�.�� � �1G�1G��1M�M� N� �
�%+�\�\�%9�%9����(�(�*�L�&�D�!� "� ��� ��,�v�|�|�/E�/E�d�/K�K�Lr r� c �P � U R 5 nU R n[ [ R " US 5 [ R " US 5 S[ [
[ R " 5 5 5 [ R " [ R " [ R " 5 R 5 5 SS9nSU; a US US' [ U SS5 S:X a [ US X4U5 nO[ US X4U5 nXTS218' US - [ R" R% U5 - $ ) Nr} r� r� �r� r� r� r� r� r� r� r� r� r� r� r� r% )r� �_OAUTH_ACCESS_TOKEN_URLr| r r� rz r� r� r� r� r� r� r� r� r� r� r+ r, r- )r. r� r� rD r0 r� s r r� �"OAuthMixin._oauth_access_token_url� s � � �3�3�5���*�*��� %� 3� 3�N�5�4I� J� �,�,�]�5�-A�B�#.� ��D�I�I�K� 0� 1� �,�,�X�-=�-=�d�j�j�l�>P�>P�-Q�R� �
219�� � � &�%2�:�%>�D�!� "� �4�)�6� 2�f� <�+� ��s�-��I� )� ��s�-��I� #,�
� ��S�y�6�<�<�1�1�$�7�7�7r c � � [ 5 e)z�Subclasses must override this to return their OAuth consumer keys.220 221The return value should be a `dict` with keys ``key`` and ``secret``.222��NotImplementedErrorr� s r r� � OAuthMixin._oauth_consumer_token� s
� �223 "�#�#r r� c � � # � [ 5 e7f)a Subclasses must override this to get basic information about the224user.225 226Should be a coroutine whose result is a dictionary227containing information about the user, which may have been228retrieved by using ``access_token`` to make a request to the229service.230 231The access token will be added to the returned dictionary to make232the result of `get_authenticated_user`.233 234.. versionchanged:: 5.1235 236 Subclasses may also define this method with ``async def``.237 238.. versionchanged:: 6.0239 240 A synchronous fallback to ``_oauth_get_user`` was removed.241r� )r. r� s r r� �!OAuthMixin._oauth_get_user_future� s � � �, "�#�#�s �
r� rD �242parametersr; c �D � U R 5 n[ [ R " US 5 [ R " US 5 S[ [ [ R " 5 5 5 [ R " [ R " [ R " 5 R 5 5 SS9n0 nUR U5 UR U5 [ U SS5 S:X a [ XTXU5 nO
[ XTXU5 n[ R " U5 US' U$ )z�Returns the OAuth parameters as a dict for the given request.243 244parameters should include all POST arguments and query string arguments245that will be sent with the request.246r} r� r� r� r� r� r� )r� r| r r� rz r� r� r� r� r� r� r� r\ r� r� r� ) r. rD r� r� r; r� � base_argsr0 r� s r �_oauth_request_parameters�$OAuthMixin._oauth_request_parameters� s� � � �3�3�5��� %� 3� 3�N�5�4I� J� �,�,�\�%�-@�A�#.� ��D�I�I�K� 0� 1� �,�,�X�-=�-=�d�j�j�l�>P�>P�-Q�R� �
247� � �� � � �I� � � � �J� � �4�)�6� 2�f� <�+� ��<��I� )� ��<��I� (.�';�';�I�'F� �#�$��r c �, � [ R " 5 $ r� r� r� s r r? � OAuthMixin.get_auth_http_client" r� r r )NNNr� �NN)r r r r r� r rz r248 r r r� r� rF r� r� r� r� r� r� r� r? r r r r r� r� s� � ��$ '+�15�<@� /<� �s�m�/<� �t�C��H�~�.�/<� �j� 8� 8�9� /<�249 250� /<�d CG�,�#�J�$>�$>�?�,�
�c�3�h� �,�` '+�15� 8� �s�m� 8� �t�C��H�~�.� 8� 251
� 8�>M��M� �s�m�M� �)�)� M�252 253� M�08�T�#�s�(�^� 8�� 8�4$�t�C��H�~� $�$� ��c��N�$�
�c�3�h� �$�8 &(�� !�
�!� �3��8�n�!� ��c��N� !�254 � !� 255�c�3�h� �
!�F,�j�&@�&@� ,r r� c �2 � \ rS rSrSr SS\\ S\\ S\\ S\\\\4 S \\ \ S256\S S4S jjr257 SS\\ S\\ S\\ S\\ S\\\\4 S \4 S
jjr SS\S\\ S\\\\4 S\S \4258S jjr S \
R 4S jrSrg)� OAuth2Mixini+ a Abstract implementation of OAuth 2.0.259 260See `FacebookGraphMixin` or `GoogleOAuth2Mixin` below for example261implementations.262 263Class attributes:264 265* ``_OAUTH_AUTHORIZE_URL``: The service's authorization url.266* ``_OAUTH_ACCESS_TOKEN_URL``: The service's access token url.267N�code� redirect_uri� client_id�
client_secretr� �scope�
response_typer# c �6 � Ub [ R " S[ 5 [ [ U 5 nSU0nUb XS' Ub X(S' U( a UR U5 U( a SR
U5 US' U R n UR [ X�5 5 g)ay Redirects the user to obtain OAuth authorization for this service.268 269Some providers require that you register a redirect URL with270your application instead of passing one via this method. You271should call this method to log the user in, and then call272``get_authenticated_user`` in the handler for your273redirect URL to complete the authorization process.274 275.. versionchanged:: 6.0276 277 The ``callback`` argument and returned awaitable were removed;278 this is now an ordinary synchronous function.279 280.. deprecated:: 6.4281 The ``client_secret`` argument (which has never had any effect)282 is deprecated and will be removed in Tornado 7.0.283Nz$client_secret argument is deprecatedr� r� r� rv r� )284�warnings�warn�DeprecationWarningr r r\ r_ r� r* r )285r. r� r� r� r� r� r� r/ r0 rD s286 r r� � OAuth2Mixin.authorize_redirect7 s� � �4 � $� �M�M�@�BT� U��~�t�,�� � �/�� � #�#/� � � � � )�� � � �K�K� � %� � �H�H�U�O�D��M��'�'������C�.�/r c � � U R n0 nUb XS' Ub XGS' Ub X'S' Ub X7S' U( a UR U5 [ Xg5 $ )Nr� r� r� r� )r� r\ r )r. r� r� r� r� r� rD r0 s r r� �$OAuth2Mixin._oauth_request_token_url` se � � �*�*���� � #�#/� � � � � ��L� � � )�� � � $�$1� � !� � �K�K� � %��#�$�$r rD r� � post_argsr0 c � � # � 0 nU( a X%S' UR U5 U( a% US[ R R U5 - -
nU R 5 nUb7 UR US[ R R U5 S9I Sh v�N nOUR U5 I Sh v�N n[ R " UR 5 $ N> N&7f)a� Fetches the given URL auth an OAuth2 access token.287 288If the request is a POST, ``post_args`` should be provided. Query289string arguments should be given as keyword arguments.290 291Example usage:292 293..testcode::294 295 class MainHandler(tornado.web.RequestHandler,296 tornado.auth.FacebookGraphMixin):297 @tornado.web.authenticated298 async def get(self):299 new_entry = await self.oauth2_request(300 "https://graph.facebook.com/me/feed",301 post_args={"message": "I am posting from my Tornado application!"},302 access_token=self.current_user["access_token"])303 304 if not new_entry:305 # Call failed; perhaps missing permission?306 self.authorize_redirect()307 return308 self.finish("Posted a message!")309 310.. versionadded:: 4.3311 312.. versionchanged::: 6.0313 314 The ``callback`` argument was removed. Use the returned awaitable object instead.315r� r% Nr9 r: ) r\ r+ r, r- r? r@ r � json_decoder< )r. rD r� r� r0 �all_args�httpre s r �oauth2_request�OAuth2Mixin.oauth2_requestv s� � � �J �� �'3�^� $� �O�O�D� !� � �3�� � �/�/��9�9� 9�C��(�(�*�� � � !�Z�Z��F�� � �)?�)?� �)J� (� � �H� "�Z�Z��_�,�H��!�!�(�-�-�0�0� � -�s$ �BC�C�C�+C�,%C�Cc �, � [ R " 5 $ )z�Returns the `.AsyncHTTPClient` instance to be used for auth requests.316 317May be overridden by subclasses to use an HTTP client other than318the default.319 320.. versionadded:: 4.3321r� r� s r r? � OAuth2Mixin.get_auth_http_client� s � � �)�)�+�+r r )NNNNNr� )NNNNNr� )r r r r r� r rz r322 r r r� r� r� r r� r? r r r r r� r� + sU � � � '+�#'�'+�15�%)� #�'0� �s�m�'0� �C�=�'0� ��}� '0�323 �t�C��H�~�.� '0� ��S� �"�
'0� �'0� 324�'0�V '+�#'�'+� "�15�
%� �s�m�%� �C�=�%� ��}� %�325 �s�m� %� �t�C��H�~�.�
%� 326
�%�2 '+�.2� 31�
�31� �s�m�31� �D��c��N�+� 31�327 � 31� 328
�
31�j,�j�&@�&@� ,r r� c �� � \ rS rSrSrSrSrSrSrSr Sr329SS330\ \ S S 4S jjr
SS
\ S\\ \4 S\ \\ \4 S\S \4331S jjrS \\ \4 4S jrS\\ \4 S \\ \4 4S jrSrg )� TwitterMixini� a� Twitter OAuth authentication.332 333To authenticate with Twitter, register your application with334Twitter at http://twitter.com/apps. Then copy your Consumer Key335and Consumer Secret to the application336`~tornado.web.Application.settings` ``twitter_consumer_key`` and337``twitter_consumer_secret``. Use this mixin on the handler for the338URL you registered as your application's callback URL.339 340When your application is set up, you can use this mixin like this341to authenticate the user with Twitter and get access to their stream:342 343.. testcode::344 345 class TwitterLoginHandler(tornado.web.RequestHandler,346 tornado.auth.TwitterMixin):347 async def get(self):348 if self.get_argument("oauth_token", None):349 user = await self.get_authenticated_user()350 # Save the user using e.g. set_signed_cookie()351 else:352 await self.authorize_redirect()353 354The user object returned by `~OAuthMixin.get_authenticated_user`355includes the attributes ``username``, ``name``, ``access_token``,356and all of the custom Twitter user attributes described at357https://dev.twitter.com/docs/api/1.1/get/users/show358 359.. deprecated:: 6.3360 This class refers to version 1.1 of the Twitter API, which has been361 deprecated by Twitter. Since Twitter has begun to limit access to its362 API, this class will no longer be updated and will be removed in the363 future.364z+https://api.twitter.com/oauth/request_tokenz*https://api.twitter.com/oauth/access_tokenz'https://api.twitter.com/oauth/authorizez*https://api.twitter.com/oauth/authenticateFzhttps://api.twitter.com/1.1Nr! r# c � � # � U R 5 nUR U R US95 I Sh v�N nU R U R SU5 g N"7f)a� Just like `~OAuthMixin.authorize_redirect`, but365auto-redirects if authorized.366 367This is generally the right interface to use if you are using368Twitter for single-sign on.369 370.. versionchanged:: 3.1371 Now returns a `.Future` and takes an optional callback, for372 compatibility with `.gen.coroutine`.373 374.. versionchanged:: 6.0375 376 The ``callback`` argument was removed. Use the returned377 awaitable object instead.378)r! N)r? r@ r� r� �_OAUTH_AUTHENTICATE_URL)r. r! r� re s r r2 �"TwitterMixin.authenticate_redirect� sX � � � �(�(�*�� ��� � )� )�|� )� D�379� 380��
� � �t� ;� ;�T�8�L�381�s �2A�A�#A�pathr� r� r0 c � � # � UR S5 ( d UR S5 ( a UnOU R U- S- nU( aU 0 nUR U5 UR U=( d 0 5 Ub SOSnU R XRXgS9nUR U5 U( a% US[ R382 R
U5 - -
nU R 5 n Ub7 U R US[ R383 R
U5 S 9I Sh v�N n384OU R U5 I Sh v�N n385[ R " U386R 5 $ N> N&7f)387av Fetches the given API path, e.g., ``statuses/user_timeline/btaylor``388 389The path should not include the format or API version number.390(we automatically use JSON format and API version 1).391 392If the request is a POST, ``post_args`` should be provided. Query393string arguments should be given as keyword arguments.394 395All the Twitter methods are documented at http://dev.twitter.com/396 397Many methods require an OAuth access token which you can398obtain through `~OAuthMixin.authorize_redirect` and399`~OAuthMixin.get_authenticated_user`. The user returned through that400process includes an 'access_token' attribute that can be used401to make authenticated requests via this method. Example402usage:403 404.. testcode::405 406 class MainHandler(tornado.web.RequestHandler,407 tornado.auth.TwitterMixin):408 @tornado.web.authenticated409 async def get(self):410 new_entry = await self.twitter_request(411 "/statuses/update",412 post_args={"status": "Testing Tornado Web Server"},413 access_token=self.current_user["access_token"])414 if not new_entry:415 # Call failed; perhaps missing permission?416 await self.authorize_redirect()417 return418 self.finish("Posted a message!")419 420.. versionchanged:: 6.0421 422 The ``callback`` argument was removed. Use the returned423 awaitable object instead.424zhttp:zhttps:z.jsonNr9 r� )r; r% r: ) rl �_TWITTER_BASE_URLr\ r� r+ r, r- r? r@ r r� r< ) r. r r� r� r0 rD r� r; �oauthr� re s r �twitter_request� TwitterMixin.twitter_request� s- � � �Z �?�?�7� #� #�t���x�'@�'@� �C��(�(�4�/�'�9�C� ��H� �O�O�D� !� �O�O�I�O�� ,� (� 4�V�%�F��2�2��8� 3� �E�
�K�K�� � � �3�� � �/�/��5�5� 5�C��(�(�*�� � � !�Z�Z��F�� � �)?�)?� �)J� (� � �H� "�Z�Z��_�,�H��!�!�(�-�-�0�0� � -�s$ �DE�E�E�*E�+%E�Ec � � [ [ U 5 nUR SS5 UR SS5 [ UR S UR S S9$ )N�twitter_consumer_keyz
Twitter OAuth�twitter_consumer_secretr� )r r �require_settingr| �settings�r. r/ s r r� �"TwitterMixin._oauth_consumer_token? s[ � ��~�t�,��� � � 6��H�� � � 9�?�K��� � �!7�8��#�#�$=�>�425� 426r c � �` # � U R SUS9I S h v�N nU( a US US' U$ N7f)Nz/account/verify_credentials)r� � screen_namer )r )r. r� r~ s r r� �#TwitterMixin._oauth_get_user_futureH sD � � � �)�)� )� � *� 427� 428�� � #�M� 2�D�� �� � 429�s �.�,�.r r� )r r r r r� r� r� r� r r� r430 r rz r2 r431 r r r� r� r r r r r r � s� � �!�F M� � J��D�� J�� ��5��M���
� M�QU� M�4 /3� F1��F1� �3��8�n�F1� �D��c��N�+� F1�432 � F1� 433
�
F1�P434�t�C��H�~� 435�� ��c��N��
�c�3�h� �r r c
� � \ rS rSrSrSrSrSrSrSr S\436\ \ 4 4S jr SS \ S \ S
\
\ S\
\ S\437\ \4 4438S jjrSrg439)�GoogleOAuth2MixiniS a� Google authentication using OAuth2.440 441In order to use, register your application with Google and copy the442relevant parameters to your application settings.443 444* Go to the Google Dev Console at http://console.developers.google.com445* Select a project, or create a new one.446* Depending on permissions required, you may need to set your app to447 "testing" mode and add your account as a test user, or go through448 a verfication process. You may also need to use the "Enable449 APIs and Services" command to enable specific services.450* In the sidebar on the left, select Credentials.451* Click CREATE CREDENTIALS and click OAuth client ID.452* Under Application type, select Web application.453* Name OAuth 2.0 client and click Create.454* Copy the "Client secret" and "Client ID" to the application settings as455 ``{"google_oauth": {"key": CLIENT_ID, "secret": CLIENT_SECRET}}``456* You must register the ``redirect_uri`` you plan to use with this class457 on the Credentials page.458 459.. versionadded:: 3.2460z,https://accounts.google.com/o/oauth2/v2/authz*https://www.googleapis.com/oauth2/v4/tokenz-https://www.googleapis.com/oauth2/v1/userinfoF� google_oauthr# c �T � [ [ U 5 nUR U R $ )aZ Return the Google OAuth 2.0 credentials that you created with461[Google Cloud462Platform](https://console.cloud.google.com/apis/credentials). The dict463format is::464 465 {466 "key": "your_client_id", "secret": "your_client_secret"467 }468 469If your credentials are stored differently (e.g. in a db) you can470override this method for custom provision.471)r r r �_OAUTH_SETTINGS_KEYr s r �get_google_oauth_settings�+GoogleOAuth2Mixin.get_google_oauth_settingsq s' � � �~�t�,��� � �� 8� 8�9�9r Nr� r� r� r� c � �P # � Ub Uc U R 5 nUc US nUc US nU R 5 n[ R R UUUUSS.5 nUR U R SSS0US 9I Sh v�N n[ R " UR 5 $ N$7f)472a� Handles the login for the Google user, returning an access token.473 474The result is a dictionary containing an ``access_token`` field475([among others](https://developers.google.com/identity/protocols/OAuth2WebServer#handlingtheresponse)).476Unlike other ``get_authenticated_user`` methods in this package,477this method does not return any additional information about the user.478The returned access token can be used with `OAuth2Mixin.oauth2_request`479to request additional information (perhaps from480``https://www.googleapis.com/oauth2/v2/userinfo``)481 482Example usage:483 484.. testsetup::485 486 import urllib487 488.. testcode::489 490 class GoogleOAuth2LoginHandler(tornado.web.RequestHandler,491 tornado.auth.GoogleOAuth2Mixin):492 async def get(self):493 # Google requires an exact match for redirect_uri, so it's494 # best to get it from your app configuration instead of from495 # self.request.full_uri().496 redirect_uri = urllib.parse.urljoin(self.application.settings['redirect_base_uri'],497 self.reverse_url('google_oauth'))498 async def get(self):499 if self.get_argument('code', False):500 access = await self.get_authenticated_user(501 redirect_uri=redirect_uri,502 code=self.get_argument('code'))503 user = await self.oauth2_request(504 "https://www.googleapis.com/oauth2/v1/userinfo",505 access_token=access["access_token"])506 # Save the user and access token. For example:507 user_cookie = dict(id=user["id"], access_token=access["access_token"])508 self.set_signed_cookie("user", json.dumps(user_cookie))509 self.redirect("/")510 else:511 self.authorize_redirect(512 redirect_uri=redirect_uri,513 client_id=self.get_google_oauth_settings()['key'],514 scope=['profile', 'email'],515 response_type='code',516 extra_params={'approval_prompt': 'auto'})517 518.. versionchanged:: 6.0519 520 The ``callback`` argument was removed. Use the returned awaitable object instead.521Nr} r� �authorization_code)r� r� r� r� �522grant_typer9 z Content-Typez!application/x-www-form-urlencoded)r; �headersr< )523r r? r+ r, r- r@ r� r r� r< ) r. r� r� r� r� r r� r< re s r rF �(GoogleOAuth2Mixin.get_authenticated_user� s� � � �t � �
� 5��5�5�7�H�� � $�U�O� � �$� (�� 2�
��(�(�*���|�|�%�%� ,� � &�!.� 2�
�524�� ��� � (� (��#�%H�I�� $� 525� 526�� �!�!�(�-�-�0�0�
527�s �A=B&�?B$� %B&r r� )r r r r r� r� r� �_OAUTH_USERINFO_URLr� r r528 rz r r r rF r r r r r r S s� � ��. J�� J��I�� ��(��:�4��S��>� :�( $(�'+� Q1��Q1� �Q1� �C�=� Q1�529 ��}� Q1� 530�c�3�h� �
Q1� Q1r r c � � \ rS rSrSrSrSrSrSr SS\ S \ S531\ S \ S \532\ \ \ 4 S
\533\ \ \ 4 4 S jjr
SS\ S\534\ S\535\ \ \ 4 S\ S
\ 4536S jjrSrg)�FacebookGraphMixini� z;Facebook authentication using the new Graph API and OAuth2.z.https://graph.facebook.com/oauth/access_token?z&https://www.facebook.com/dialog/oauth?Fzhttps://graph.facebook.comNr� r� r� r� � extra_fieldsr# c 537 � � # � U R 5 nUUUUS.n1 SknU( a UR U5 UR U R " S
0 UD65 I Sh v�N n [ R538 " U R 5 nUR S5 UR S5 S.n539U540S c eU R SU541S [ R " UR S5 U542S R S5 [ R S 9R 5 S543R U5 S 9I Sh v�N n U c g0 n U H n
U R U
5 X�' M U R U544S [! U545R S5 5 S .5 U $ GN NZ7f)a� Handles the login for the Facebook user, returning a user object.546 547Example usage:548 549.. testcode::550 551 class FacebookGraphLoginHandler(tornado.web.RequestHandler,552 tornado.auth.FacebookGraphMixin):553 async def get(self):554 redirect_uri = urllib.parse.urljoin(555 self.application.settings['redirect_base_uri'],556 self.reverse_url('facebook_oauth'))557 if self.get_argument("code", False):558 user = await self.get_authenticated_user(559 redirect_uri=redirect_uri,560 client_id=self.settings["facebook_api_key"],561 client_secret=self.settings["facebook_secret"],562 code=self.get_argument("code"))563 # Save the user with e.g. set_signed_cookie564 else:565 self.authorize_redirect(566 redirect_uri=redirect_uri,567 client_id=self.settings["facebook_api_key"],568 extra_params={"scope": "user_posts"})569 570This method returns a dictionary which may contain the following fields:571 572* ``access_token``, a string which may be passed to `facebook_request`573* ``session_expires``, an integer encoded as a string representing574 the time until the access token expires in seconds. This field should575 be used like ``int(user['session_expires'])``; in a future version of576 Tornado it will change from a string to an integer.577* ``id``, ``name``, ``first_name``, ``last_name``, ``locale``, ``picture``,578 ``link``, plus any fields named in the ``extra_fields`` argument. These579 fields are copied from the Facebook graph API580 `user object <https://developers.facebook.com/docs/graph-api/reference/user>`_581 582.. versionchanged:: 4.5583 The ``session_expires`` field was updated to support changes made to the584 Facebook API in March 2017.585 586.. versionchanged:: 6.0587 588 The ``callback`` argument was removed. Use the returned awaitable object instead.589)r� r� r� r� > �id�linkr rx �pictureru rt Nr� �590expires_in)r� r, z/mer� )r} �msg� digestmodrX )r r� �appsecret_proof�fields)r� �session_expiresr )r? r\ r@ r� r r� r< �get�facebook_request�hmac�new�encode�hashlib�sha256� hexdigestr_ rz )r. r� r� r� r� r' r� r0 r0 re �sessionr~ �fieldmap�fields r rF �)FacebookGraphMixin.get_authenticated_user� s� � � �j �(�(�*�� (��"� *� 591�� X�� � �M�M�,� '� ��� � )� )� 1�D� 1�592� 593�� �!�!�(�-�-�0�� �H�H�^� 4� �(�(�<�0�594�� �~�&�2�2�2��*�*�� � �0� �H�H�!�(�(��0��N�+�2�2�6�:�!�.�.� � �i�k��8�8�F�#� +� 595� 596�� �<�����E� "�h�h�u�o�H�O� � ��� '�� 7�#&�w�{�{�<�'@�#A�
� 597� ��M598� 599�s& �AE?�E:�CE?�"E=�#AE?�=E?r r� r� r0 c � �f # � U R U- nU R " U4X#S.UD6I Sh v�N $ N7f)a� Fetches the given relative API path, e.g., "/btaylor/picture"600 601If the request is a POST, ``post_args`` should be provided. Query602string arguments should be given as keyword arguments.603 604An introduction to the Facebook Graph API can be found at605http://developers.facebook.com/docs/api606 607Many methods require an OAuth access token which you can608obtain through `~OAuth2Mixin.authorize_redirect` and609`get_authenticated_user`. The user returned through that610process includes an ``access_token`` attribute that can be611used to make authenticated requests via this method.612 613Example usage:614 615.. testcode::616 617 class MainHandler(tornado.web.RequestHandler,618 tornado.auth.FacebookGraphMixin):619 @tornado.web.authenticated620 async def get(self):621 new_entry = await self.facebook_request(622 "/me/feed",623 post_args={"message": "I am posting from my Tornado application!"},624 access_token=self.current_user["access_token"])625 626 if not new_entry:627 # Call failed; perhaps missing permission?628 self.authorize_redirect()629 return630 self.finish("Posted a message!")631 632The given path is relative to ``self._FACEBOOK_BASE_URL``,633by default "https://graph.facebook.com".634 635This method is a wrapper around `OAuth2Mixin.oauth2_request`;636the only difference is that this method takes a relative path,637while ``oauth2_request`` takes a complete url.638 639.. versionchanged:: 3.1640 Added the ability to override ``self._FACEBOOK_BASE_URL``.641 642.. versionchanged:: 6.0643 644 The ``callback`` argument was removed. Use the returned awaitable object instead.645)r� r� N)�_FACEBOOK_BASE_URLr� )r. r r� r� r0 rD s r r3 �#FacebookGraphMixin.facebook_requestF sH � � �l �%�%��,���(�(� �646� *�647�CG�648� 649� 650� 651�s �(1�/�1r r� r� )r r r r r� r� r� r� r? rz r r652 r rF r3 r r r r r& r& � s� � �E� N��C�� ��5�� 26�
g��g� �g� � g�653 � g� �t�C��H�~�.�
g� 654�$�s�C�x�.� !�g�X '+�.2� 9655��9656� �s�m�9657� �D��c��N�+� 9658�659 � 9660� 661
�
9662� 9663r r& r� r; rD r� r� r# c �( � [ R R U5 nUSS u pgnUR 5 S- UR 5 - U- n / n664U665R UR 5 5 U666R U 5 U667R SR
S [ UR 5 5 5 5 5 SR
S U668 5 5 n [ R " U S 5 /n U R [ R " U( a US OS5 5 S R
U 5 n
[ R " U
[ R " U 5 [ R 5 n[ R " UR# 5 5 SS669 $ ) zpCalculates the HMAC-SHA1 OAuth signature for the given request.670 671See http://oauth.net/core/1.0/#signing_process672N� �://�&c 3 �X # � U H u pU S [ [ U5 5 3v � M" g7f��=N��
_oauth_escaperz �r� rB rC s r r� �#_oauth_signature.<locals>.<genexpr>� �) � � �W�<V�D�A�A�3�a�
�c�!�f�-�.�/�<V�� �(*c 3 �8 # � U H n[ U5 v � M g 7fr� �rI �r� �es r r� rK � � � � �@�Z��=��+�+�Z�� �r� ri � &r6 )r+ r, �urlparser{ r^ �upperr_ �sortedr> r r� r4 r5 r7 �sha1r� �673b2a_base64�digest�r� r; rD r� r� �parts�scheme�netlocr �normalized_url�674base_elems� base_string� key_elemsr} �hashs r r� r� � s3 � �
�L�L� !� !�#� &�E� ��!�9��F�D��\�\�^�e�+�f�l�l�n�<�t�C�N��J����f�l�l�n�%����n�%���� ���W�F�:�CS�CS�CU�<V�W�W�� �(�(�@�Z�@�@�K����^�H� 5�6�7�I�
���V�[�[�E��x� �r�B�C�675�)�)�I�676 �C� �8�8�C����[�1�7�<�<� @�D� � � �t�{�{�}� -�c�r� 2�2r c � � [ R R U5 nUSS u pgnUR 5 S- UR 5 - U- n / n677U678R UR 5 5 U679R U 5 U680R SR
S [ UR 5 5 5 5 5 SR
S U681 5 5 n [ R " [ R R U S SS 95 /n U R [ R " U( a! [ R R US SS 9OS6825 5 S R
U 5 n
[ R " U
[ R " U 5 [ R 5 n[ R" " UR% 5 5 SS $ )
zvCalculates the HMAC-SHA1 OAuth 1.0a signature for the given request.683 684See http://oauth.net/core/1.0a/#signing_process685NrB rC rD c 3 �X # � U H u pU S [ [ U5 5 3v � M" g7frF rH rJ s r r� �&_oauth10a_signature.<locals>.<genexpr>� rL rM c 3 �8 # � U H n[ U5 v � M g 7fr� rO rP s r r� rf � rR rS r� �~��saferi rT r6 )r+ r, rU r{ r^ rV r_ rW r> r r� �quoter4 r5 r7 rX r� rY rZ r[ s r r� r� � sa � �
�L�L� !� !�#� &�E� ��!�9��F�D��\�\�^�e�+�f�l�l�n�<�t�C�N��J����f�l�l�n�%����n�%���� ���W�F�:�CS�CS�CU�<V�W�W�� �(�(�@�Z�@�@�K����V�\�\� /� /��x�0H�s� /� S�T�U�I�
���� � �U�F�L�L�&�&�u�X��S�&�A�PR�S�� �)�)�I�686 �C� �8�8�C����[�1�7�<�<� @�D� � � �t�{�{�}� -�c�r� 2�2r �valc � � [ U [ 5 ( a U R S5 n [ R R U SS9$ )Nzutf-8rh ri )�687isinstancer r6 r+ r, rk )rl s r rI rI � s7 � ��#�|�$�$��j�j��!�� �<�<� � �c�� � ,�,r r< c �� ^^� [ R " U 5 n[ R R USS9m[ TS S TS S S9nSmUR
UU4S jT 5 5 U$ ) NF)�keep_blank_valuesr� r �oauth_token_secretr� )r� rq c 3 �F ># � U H oT; d M688 UTU S 4v � M g7f)r Nr )r� rB �p�specials ��r r� �(_oauth_parse_response.<locals>.<genexpr>� s$ �� � �=�q�!�W�,<� �!�Q�q�T�!�W� �q�s � !�!)r �689native_strr+ r, �parse_qsr| r\ )r< �body_strr� rs rt s @@r r� r� � sm �� � � � ��&�H�� � � � �h�%� �@�A� �Q�}�%�a�(��3G�1H��1K� L�E� 4�G� �L�L�=�q�=�=� �Lr ))r� r� r� r7 r4 r� � urllib.parser+ r� r� �tornador r �tornado.httputilr � tornado.utilr � tornado.webr �typingr r r690 r r r
r r� r r r� r� r r r& rz r� r� r� rI r� r r r �<module>r s� �� 6�p � � � � � � � � � � '� %� &� C� C� C� � � �~,� ~,�BI,� I,�XH,� H,�VZ�:� Z�z1� � 1�Dj691�� j692�b "$�&*� 3���c��N� 3� � 3� 693
� 3� �S�#�X�� 3�694 �D��c��N� #� 3� �
3�F "$�&*� 3���c��N� 3� � 3� 695
� 3� �S�#�X�� 3�696 �D��c��N� #� 3� �
3�B-�u�S�%�Z�(� -�S� -� �� �$�s�C�x�.� r