OAuth 2.0 Client Library

Warnings

• breaking The `oauth2client` library is officially deprecated as of v4.1.0. No new features will be added, and support is winding down. Continued use is discouraged.
  Fix: Migrate your application to use `google-auth` for Google-specific authentication and `oauthlib` for general OAuth 2.0 client needs.
• breaking Version 4.0.0 dropped support for Python 2.6 and 3.3. It also removed the `oauth2client.contrib.multistore_file` module.
  Fix: Ensure your environment uses Python 2.7 or 3.4+. If you were using `multistore_file`, refactor your code to use `oauth2client.contrib.multiprocess_storage` or implement custom storage.
• breaking Changes in `oauth2client.contrib.django_util` and `oauth2client.contrib.django_orm` in v2.2.0 broke compatibility with Django versions below 1.8.
  Fix: If using `oauth2client` with Django, ensure your Django project is running version 1.8 or higher.
• gotcha The library is tightly coupled with `httplib2`, which has faced periods of limited maintenance. This dependency may introduce security vulnerabilities or compatibility issues with modern HTTP practices.
  Fix: Prefer modern OAuth libraries (like `google-auth` or `oauthlib`) that use actively maintained HTTP clients (e.g., `requests`, `httpx`).
• gotcha The OAuth 2.0 Implicit Flow, which `oauth2client` may facilitate, is now considered deprecated due to inherent security vulnerabilities (e.g., token exposure in URLs, no refresh token support).
  Fix: If your application uses the Implicit Flow, migrate to the more secure Authorization Code Flow with PKCE (Proof Key for Code Exchange).

Install

• pip install oauth2client Install stable version

Imports

• GoogleCredentials

  from oauth2client.client import GoogleCredentials

• OAuth2WebServerFlow

  from oauth2client.client import OAuth2WebServerFlow

• run_flow

  from oauth2client.tools import run_flow

• Storage

  from oauth2client.file import Storage

Quickstart

This quickstart demonstrates a basic OAuth 2.0 web server flow using `oauth2client.client.OAuth2WebServerFlow` and `oauth2client.tools.run_flow` to obtain user credentials. The `run_flow` utility is suitable for local development as it opens a browser for user interaction. In a production web application, the authorization redirect and code exchange steps would be handled explicitly. Credentials are saved to a local JSON file using `oauth2client.file.Storage` for simplicity.

import os
import httplib2 # oauth2client relies heavily on httplib2
from oauth2client.client import OAuth2WebServerFlow
from oauth2client.tools import run_flow
from oauth2client.file import Storage

# NOTE: This library is deprecated. Consider migrating to google-auth and oauthlib.

# These values would typically come from your Google API Console project.
# For a quickstart, we use environment variables for demonstration.
CLIENT_ID = os.environ.get('OAUTH2CLIENT_CLIENT_ID', 'YOUR_CLIENT_ID')
CLIENT_SECRET = os.environ.get('OAUTH2CLIENT_CLIENT_SECRET', 'YOUR_CLIENT_SECRET')
REDIRECT_URI = 'http://localhost:8080/oauth2callback' # Must match a registered redirect URI in your Google project

def main():
    if CLIENT_ID == 'YOUR_CLIENT_ID' or CLIENT_SECRET == 'YOUR_CLIENT_SECRET':
        print("Please set OAUTH2CLIENT_CLIENT_ID and OAUTH2CLIENT_CLIENT_SECRET environment variables,")
        print("or replace 'YOUR_CLIENT_ID' and 'YOUR_CLIENT_SECRET' in the code.")
        return

    # 1. Create a flow object for a web server application
    flow = OAuth2WebServerFlow(
        client_id=CLIENT_ID,
        client_secret=CLIENT_SECRET,
        scope='https://www.googleapis.com/auth/userinfo.email',
        redirect_uri=REDIRECT_URI
    )

    # 2. Authorize the user
    # The `run_flow` function is typically used for local development and
    # will open a browser window for user authentication.
    # In a production web application, you would manage the redirects and
    # authorization code exchange manually.
    try:
        http = httplib2.Http()
        # Simple file storage for credentials; in production, use a secure database.
        storage = Storage('oauth2client_creds.json')
        
        print(f"Attempting to authorize. Please check your browser or navigate to: {flow.step1_get_authorize_url()}")
        credentials = run_flow(flow, storage, http=http)

        print(f"\nAuthorization successful!")
        print(f"Access Token: {credentials.access_token[:10]}...{credentials.access_token[-10:]}")
        if credentials.refresh_token:
            print(f"Refresh Token: {credentials.refresh_token[:10]}...{credentials.refresh_token[-10:]}")
        else:
            print("No Refresh Token (may be due to scope or one-time access).")
        print(f"Credentials saved to: {storage.filename}")
        
    except Exception as e:
        print(f"\nAn error occurred during OAuth2 flow: {e}")
        print("Ensure your client ID, client secret, and redirect URI are correctly configured and match your Google project.")
        print("Also, ensure 'oauth2client_creds.json' is writable or doesn't exist.")
        
if __name__ == '__main__':
    main()