Skip to content

no support for google.auth.default #179

Closed

Description

@fatestapestry

To support CI workflows building off gh actions, I'd like to use the recommended auth method using google.auth.default with google-github-actions/auth@v0.4.0 - https://github.com/google-github-actions/auth.

This would (hopefully) allow the following, using the more modern google.auth lib:

    gauth = GoogleAuth()
    try:
        gauth.credentials = ServiceAccountCredentials.from_json_keyfile_name(LOCAL_KEY, SCOPES)  # support local dev
    except FileNotFoundError:
        credentials, _ = google.auth.default(SCOPES)  # prod
        gauth.credentials = credentials

This is defined here:
https://google-auth.readthedocs.io/en/master/user-guide.html

Unfortunately forcing auth with a local service account key file is a poor security implementation, and not really acceptable for cloud CI.

Activity

  1. fatestapestry commented on May 29, 2022

    @fatestapestry
    Author

    @junpeng-jp will test after merge

  2. fatestapestry commented on May 29, 2022

    @fatestapestry
    Author

    Fixing this should also support:

    from google.oauth2.service_account import Credentials
    
    credentials = Credentials.from_service_account_file(key_file, scopes)
    
  3. fatestapestry commented on May 30, 2022

    @fatestapestry
    Author

    A working alternative until this is implemented is to use this after reading key from env:

    oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_dict()

  4. junpeng-jp commented on May 30, 2022

    @junpeng-jp

    hey @jonathanelscpt, the GoogleAuth in this library supports file-based service auth through:

    1. specifying the service credential file name in the yaml config under service_config > client_json_file_path or specifying the GOOGLE_APPLICATION_CREDENTIALS environment variable and setting service_config > use_default = True
    2. instantiate GoogleAuth
    3. run the ServiceAuth method which would:
      • reads the service credential json path
      • use the from_service_account_file class method (see here) to create the service account credentials
  5. junpeng-jp commented on May 30, 2022

    @junpeng-jp

    At least, this is how it would be after my pull request above has been merged. Because the entire library's google auth is driven by the .yaml config file, I've kept to the same design whilst I was working to migrate from oauth2client -> google-auth

  6. shcheklein commented on Nov 13, 2022

    @shcheklein
    Member

    For the record, current implementation supports reading from a dict, from ENV, etc. I'm not sure about the default credentials. It depends on the underlying implementation for them.

  7. shcheklein commented on Nov 21, 2026

    @shcheklein
    Member

    The credential assignment in the original example is supported on main through #395, pending release. Call credentials, _ = google.auth.default(scopes=["https://www.googleapis.com/auth/drive"]) and assign gauth.credentials = credentials before using GoogleDrive(gauth). I verified that path with a mocked Drive request. Automatic discovery by PyDrive2 itself is tracked in #187.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions