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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion Src/Support/Google.Apis.Auth/OAuth2/GoogleCredential.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ limitations under the License.
*/

using Google.Apis.Http;
using Google.Apis.Util;
using System;
using System.Collections.Generic;
using System.IO;
Expand Down Expand Up @@ -114,6 +113,13 @@ public static Task<GoogleCredential> GetApplicationDefaultAsync(CancellationToke
/// Console or a stored user credential using the format supported by the Cloud SDK.
/// </para>
/// </summary>
/// <remarks>
/// Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source
/// for authentication to Google Cloud, you must validate it before providing it to any Google API or library.
/// 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>
public static GoogleCredential FromStream(Stream stream) => defaultCredentialProvider.CreateDefaultCredentialFromStream(stream);

/// <summary>
Expand All @@ -123,6 +129,13 @@ public static Task<GoogleCredential> GetApplicationDefaultAsync(CancellationToke
/// Console or a stored user credential using the format supported by the Cloud SDK.
/// </para>
/// </summary>
/// <remarks>
/// Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source
/// for authentication to Google Cloud, you must validate it before providing it to any Google API or library.
/// 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>
public static Task<GoogleCredential> FromStreamAsync(Stream stream, CancellationToken cancellationToken) =>
defaultCredentialProvider.CreateDefaultCredentialFromStreamAsync(stream, cancellationToken);

Expand All @@ -135,6 +148,13 @@ public static Task<GoogleCredential> FromStreamAsync(Stream stream, Cancellation
/// </summary>
/// <param name="path">The path to the credential file.</param>
/// <returns>The loaded credentials.</returns>
/// <remarks>
/// Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source
/// for authentication to Google Cloud, you must validate it before providing it to any Google API or library.
/// 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>
public static GoogleCredential FromFile(string path)
{
using (var f = File.OpenRead(path))
Expand All @@ -153,6 +173,13 @@ public static GoogleCredential FromFile(string path)
/// <param name="path">The path to the credential file.</param>
/// <param name="cancellationToken">Cancellation token for the operation.</param>
/// <returns>The loaded credentials.</returns>
/// <remarks>
/// Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source
/// for authentication to Google Cloud, you must validate it before providing it to any Google API or library.
/// 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>
public static async Task<GoogleCredential> FromFileAsync(string path, CancellationToken cancellationToken)
{
using (var f = File.OpenRead(path))
Expand All @@ -168,13 +195,27 @@ public static async Task<GoogleCredential> FromFileAsync(string path, Cancellati
/// Console or a stored user credential using the format supported by the Cloud SDK.
/// </para>
/// </summary>
/// <remarks>
/// Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source
/// for authentication to Google Cloud, you must validate it before providing it to any Google API or library.
/// 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>
public static GoogleCredential FromJson(string json) => defaultCredentialProvider.CreateDefaultCredentialFromJson(json);

/// <summary>
/// Loads a credential from JSON credential parameters. Fields are a union of credential fields
/// for all supported types. <see cref="JsonCredentialParameters"/> for more detailed information
/// about supported types and corresponding fields.
/// </summary>
/// <remarks>
/// Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source
/// for authentication to Google Cloud, you must validate it before providing it to any Google API or library.
/// 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>
public static GoogleCredential FromJsonParameters(JsonCredentialParameters credentialParameters) =>
defaultCredentialProvider.CreateDefaultCredentialFromParameters(credentialParameters);

Expand Down
Loading