Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add warning note about user provided credential configurations. #2916

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

amanda-tarafa
Copy link
Contributor

Towards b/389125232

@amanda-tarafa amanda-tarafa requested a review from jskeet January 17, 2025 00:32
@amanda-tarafa amanda-tarafa requested a review from a team as a code owner January 17, 2025 00:32
@amanda-tarafa amanda-tarafa added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jan 17, 2025
@amanda-tarafa
Copy link
Contributor Author

FYI @sai-sunder-s

@jskeet Not to be merged until confirmation

/// Providing an unvalidated credential configuration to Google APIs can compromise the security of your
/// systems and data. For more information, refer to
/// <see href="https://cloud.google.com/docs/authentication/external/externally-sourced-credentials">Validate credential configurations from external sources</see>.
/// </remarks>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to update here? Only SA json can be accepted here right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Started an internal thread.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We discussed internally, removing from here as it's not necessary.

@amanda-tarafa amanda-tarafa removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jan 22, 2025
@amanda-tarafa amanda-tarafa merged commit ee3ae68 into googleapis:main Jan 22, 2025
4 checks passed
@amanda-tarafa amanda-tarafa deleted the warning branch January 22, 2025 23:01
amanda-tarafa added a commit to amanda-tarafa/google-api-dotnet-client that referenced this pull request Jan 23, 2025
Fixes:

- googleapis#2869 Use universe-domain instead of universe_domain as the MDS endpoint
- googleapis#2870 BaseClientService.UniverDomain setter is obsolete
- googleapis#2871 Pause automatic requests to MDS Universe Domain endpoint

Features:

- googleapis#2746 Simplify setting the HttpClient timeout
- googleapis#2809 Improve error handling when signing with the IAM service

  BREAKING CHANGE: The ComputeCredential and ImpersonatedCredential SignBlobAsync methods will throw a GoogleApiException instead of a HttpRequestExtension. The GoogleApiException makes the HttpResponseMessage content available, which usually includes details about the error.
  We consider the risk of this change breaking users  lower than the risk of disrupting all users with a new major version so we've decided to release this breaking change on a minor version of the library. Please create an issue on this repo if you are affected and we will e happy to help.

- googleapis#2879 Use recommended retries for token and IAM sign blob endpoints
- googleapis#2913 Support GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variable

Dependencies:

- googleapis#2730 Remove unused dependency Microsoft.AspNetCore.Authorization from Google.Apis.Auth.AspNetCore3

  BREAKING CHANGE: Projects using Google.Apis.Auth.AspNetCore3 that transitively depend on Microsoft.AspNetCore.Authorization may be broken. They only need to add an implicit dependency themselves. We consider the risk of this change breaking users  lower than the risk of disrupting all users with a new major version so we've decided to release this breaking change on a minor version of the library. Please create an issue on this repo if you are affected and we will e happy to help.

Documentation:

- googleapis#2916 Add warning note about user provided credential configurations
amanda-tarafa added a commit that referenced this pull request Jan 23, 2025
Fixes:

- #2869 Use universe-domain instead of universe_domain as the MDS endpoint
- #2870 BaseClientService.UniverDomain setter is obsolete
- #2871 Pause automatic requests to MDS Universe Domain endpoint

Features:

- #2746 Simplify setting the HttpClient timeout
- #2809 Improve error handling when signing with the IAM service

  BREAKING CHANGE: The ComputeCredential and ImpersonatedCredential SignBlobAsync methods will throw a GoogleApiException instead of a HttpRequestExtension. The GoogleApiException makes the HttpResponseMessage content available, which usually includes details about the error.
  We consider the risk of this change breaking users  lower than the risk of disrupting all users with a new major version so we've decided to release this breaking change on a minor version of the library. Please create an issue on this repo if you are affected and we will e happy to help.

- #2879 Use recommended retries for token and IAM sign blob endpoints
- #2913 Support GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variable

Dependencies:

- #2730 Remove unused dependency Microsoft.AspNetCore.Authorization from Google.Apis.Auth.AspNetCore3

  BREAKING CHANGE: Projects using Google.Apis.Auth.AspNetCore3 that transitively depend on Microsoft.AspNetCore.Authorization may be broken. They only need to add an implicit dependency themselves. We consider the risk of this change breaking users  lower than the risk of disrupting all users with a new major version so we've decided to release this breaking change on a minor version of the library. Please create an issue on this repo if you are affected and we will e happy to help.

Documentation:

- #2916 Add warning note about user provided credential configurations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants