mirror of
https://github.com/kennethreitz/requests.git
synced 2026-06-05 22:50:18 +00:00
Nick Coghlan
4942b40496
The previous summary gave the impression that requests-oauthlib only supports OAuth 1. This updates makes it clear that it also supports OAuth 2, and links directly to the use case specific authentication flow guides.
143 lines
5.0 KiB
ReStructuredText
143 lines
5.0 KiB
ReStructuredText
.. _authentication:
|
|
|
|
Authentication
|
|
==============
|
|
|
|
This document discusses using various kinds of authentication with Requests.
|
|
|
|
Many web services require authentication, and there are many different types.
|
|
Below, we outline various forms of authentication available in Requests, from
|
|
the simple to the complex.
|
|
|
|
|
|
Basic Authentication
|
|
--------------------
|
|
|
|
Many web services that require authentication accept HTTP Basic Auth. This is
|
|
the simplest kind, and Requests supports it straight out of the box.
|
|
|
|
Making requests with HTTP Basic Auth is very simple::
|
|
|
|
>>> from requests.auth import HTTPBasicAuth
|
|
>>> requests.get('https://api.github.com/user', auth=HTTPBasicAuth('user', 'pass'))
|
|
<Response [200]>
|
|
|
|
In fact, HTTP Basic Auth is so common that Requests provides a handy shorthand
|
|
for using it::
|
|
|
|
>>> requests.get('https://api.github.com/user', auth=('user', 'pass'))
|
|
<Response [200]>
|
|
|
|
Providing the credentials in a tuple like this is exactly the same as the
|
|
``HTTPBasicAuth`` example above.
|
|
|
|
|
|
netrc Authentication
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
If no authentication method is given with the ``auth`` argument, Requests will
|
|
attempt to get the authentication credentials for the URL's hostname from the
|
|
user's netrc file. The netrc file overrides raw HTTP authentication headers
|
|
set with `headers=`.
|
|
|
|
If credentials for the hostname are found, the request is sent with HTTP Basic
|
|
Auth.
|
|
|
|
|
|
Digest Authentication
|
|
---------------------
|
|
|
|
Another very popular form of HTTP Authentication is Digest Authentication,
|
|
and Requests supports this out of the box as well::
|
|
|
|
>>> from requests.auth import HTTPDigestAuth
|
|
>>> url = 'http://httpbin.org/digest-auth/auth/user/pass'
|
|
>>> requests.get(url, auth=HTTPDigestAuth('user', 'pass'))
|
|
<Response [200]>
|
|
|
|
|
|
OAuth 1 Authentication
|
|
----------------------
|
|
|
|
A common form of authentication for several web APIs is OAuth. The ``requests-oauthlib``
|
|
library allows Requests users to easily make OAuth authenticated requests::
|
|
|
|
>>> import requests
|
|
>>> from requests_oauthlib import OAuth1
|
|
|
|
>>> url = 'https://api.twitter.com/1.1/account/verify_credentials.json'
|
|
>>> auth = OAuth1('YOUR_APP_KEY', 'YOUR_APP_SECRET',
|
|
... 'USER_OAUTH_TOKEN', 'USER_OAUTH_TOKEN_SECRET')
|
|
|
|
>>> requests.get(url, auth=auth)
|
|
<Response [200]>
|
|
|
|
For more information on how to OAuth flow works, please see the official `OAuth`_ website.
|
|
For examples and documentation on requests-oauthlib, please see the `requests_oauthlib`_
|
|
repository on GitHub
|
|
|
|
OAuth 2 Authentication
|
|
----------------------
|
|
|
|
The ``requests-oauthlib`` library handles OAuth 2 in addition to OAuth 1. See their
|
|
documentation for details of the various OAuth 2 credential management flows:
|
|
|
|
* `Web Application Flow`_
|
|
* `Mobile Application Flow`_
|
|
* `Legacy Application Flow`_
|
|
* `Backend Application Flow`_
|
|
|
|
Other Authentication
|
|
--------------------
|
|
|
|
Requests is designed to allow other forms of authentication to be easily and
|
|
quickly plugged in. Members of the open-source community frequently write
|
|
authentication handlers for more complicated or less commonly-used forms of
|
|
authentication. Some of the best have been brought together under the
|
|
`Requests organization`_, including:
|
|
|
|
- Kerberos_
|
|
- NTLM_
|
|
|
|
If you want to use any of these forms of authentication, go straight to their
|
|
GitHub page and follow the instructions.
|
|
|
|
|
|
New Forms of Authentication
|
|
---------------------------
|
|
|
|
If you can't find a good implementation of the form of authentication you
|
|
want, you can implement it yourself. Requests makes it easy to add your own
|
|
forms of authentication.
|
|
|
|
To do so, subclass :class:`AuthBase <requests.auth.AuthBase>` and implement the
|
|
``__call__()`` method::
|
|
|
|
>>> import requests
|
|
>>> class MyAuth(requests.auth.AuthBase):
|
|
... def __call__(self, r):
|
|
... # Implement my authentication
|
|
... return r
|
|
...
|
|
>>> url = 'http://httpbin.org/get'
|
|
>>> requests.get(url, auth=MyAuth())
|
|
<Response [200]>
|
|
|
|
When an authentication handler is attached to a request,
|
|
it is called during request setup. The ``__call__`` method must therefore do
|
|
whatever is required to make the authentication work. Some forms of
|
|
authentication will additionally add hooks to provide further functionality.
|
|
|
|
Further examples can be found under the `Requests organization`_ and in the
|
|
``auth.py`` file.
|
|
|
|
.. _OAuth: http://oauth.net/
|
|
.. _requests_oauthlib: https://github.com/requests/requests-oauthlib
|
|
.. _Web Application Flow: http://requests-oauthlib.readthedocs.io/en/latest/oauth2_workflow.html#web-application-flow
|
|
.. _Mobile Application Flow: http://requests-oauthlib.readthedocs.io/en/latest/oauth2_workflow.html#mobile-application-flow
|
|
.. _Legacy Application Flow: http://requests-oauthlib.readthedocs.io/en/latest/oauth2_workflow.html#legacy-application-flow
|
|
.. _Backend Application Flow: http://requests-oauthlib.readthedocs.io/en/latest/oauth2_workflow.html#backend-application-flow
|
|
.. _Kerberos: https://github.com/requests/requests-kerberos
|
|
.. _NTLM: https://github.com/requests/requests-ntlm
|
|
.. _Requests organization: https://github.com/requests
|