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

Jump to bottom

[SRA] Update service clients to remove usage of fallback credentials factory #3546

Open
wants to merge 1 commit into
base: sra-identity-auth
Choose a base branch
from
Open

[SRA] Update service clients to remove usage of fallback credentials factory #3546

Show file tree
Hide file tree
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
374 changes: 224 additions & 150 deletions generator/ServiceClientGeneratorLib/Generators/SourceFiles/ServiceClientsNetFramework.cs
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions generator/ServiceClientGeneratorLib/Generators/SourceFiles/ServiceClientsNetFramework.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,11 @@ namespace <#=this.Config.Namespace#>
///
/// </summary>
public Amazon<#=this.Config.ClassName#>Client()
<# if (this.Config.ClassName == "AutoScaling") { #>
: base(new Amazon<#=this.Config.ClassName#>Config()) { }
<#} else {#>
: base(FallbackCredentialsFactory.GetCredentials(<#= fallbackToAnonymousCredentials ? "fallbackToAnonymous: true" : ""#>), new Amazon<#=this.Config.ClassName#>Config()) { }
<#}#>

/// <summary>
/// Constructs Amazon<#=this.Config.ClassName#>Client with the credentials loaded from the application's
Expand All @@ -99,7 +103,11 @@ namespace <#=this.Config.Namespace#>
/// </summary>
/// <param name="region">The region to connect.</param>
public Amazon<#=this.Config.ClassName#>Client(RegionEndpoint region)
<# if (this.Config.ClassName == "AutoScaling") { #>
: base(new Amazon<#=this.Config.ClassName#>Config{RegionEndpoint = region}) { }
<#} else {#>
: base(FallbackCredentialsFactory.GetCredentials(<#= fallbackToAnonymousCredentials ? "fallbackToAnonymous: true" : ""#>), new Amazon<#=this.Config.ClassName#>Config{RegionEndpoint = region}) { }
<#}#>

/// <summary>
/// Constructs Amazon<#=this.Config.ClassName#>Client with the credentials loaded from the application's
Expand All @@ -118,7 +126,11 @@ namespace <#=this.Config.Namespace#>
/// </summary>
/// <param name="config">The Amazon<#=this.Config.ClassName#>Client Configuration Object</param>
public Amazon<#=this.Config.ClassName#>Client(Amazon<#=this.Config.ClassName#>Config config)
<# if (this.Config.ClassName == "AutoScaling") { #>
: base(config) { }
<#} else {#>
: base(FallbackCredentialsFactory.GetCredentials(config<#= fallbackToAnonymousCredentials ? ", fallbackToAnonymous: true" : ""#>), config){}
<#}#>

/// <summary>
/// Constructs Amazon<#=this.Config.ClassName#>Client with AWS Credentials
Expand Down
370 changes: 222 additions & 148 deletions generator/ServiceClientGeneratorLib/Generators/SourceFiles/ServiceClientsNetStandard.cs
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions generator/ServiceClientGeneratorLib/Generators/SourceFiles/ServiceClientsNetStandard.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,11 @@ namespace <#=this.Config.Namespace#>
///
/// </summary>
public Amazon<#=this.Config.ClassName#>Client()
<# if (this.Config.ClassName == "AutoScaling") { #>
: base(new Amazon<#=this.Config.ClassName#>Config()) { }
<#} else {#>
: base(FallbackCredentialsFactory.GetCredentials(<#= fallbackToAnonymousCredentials ? "fallbackToAnonymous: true" : ""#>), new Amazon<#=this.Config.ClassName#>Config()) { }
<#}#>

/// <summary>
/// Constructs Amazon<#=this.Config.ClassName#>Client with the credentials loaded from the application's
Expand All @@ -76,7 +80,11 @@ namespace <#=this.Config.Namespace#>
/// </summary>
/// <param name="region">The region to connect.</param>
public Amazon<#=this.Config.ClassName#>Client(RegionEndpoint region)
<# if (this.Config.ClassName == "AutoScaling") { #>
: base(new Amazon<#=this.Config.ClassName#>Config{RegionEndpoint = region}) { }
<#} else {#>
: base(FallbackCredentialsFactory.GetCredentials(<#= fallbackToAnonymousCredentials ? "fallbackToAnonymous: true" : ""#>), new Amazon<#=this.Config.ClassName#>Config{RegionEndpoint = region}) { }
<#}#>

/// <summary>
/// Constructs Amazon<#=this.Config.ClassName#>Client with the credentials loaded from the application's
Expand All @@ -95,7 +103,11 @@ namespace <#=this.Config.Namespace#>
/// </summary>
/// <param name="config">The Amazon<#=this.Config.ClassName#>Client Configuration Object</param>
public Amazon<#=this.Config.ClassName#>Client(Amazon<#=this.Config.ClassName#>Config config)
<# if (this.Config.ClassName == "AutoScaling") { #>
: base(config) { }
<#} else {#>
: base(FallbackCredentialsFactory.GetCredentials(config<#= fallbackToAnonymousCredentials ? ", fallbackToAnonymous: true" : ""#>), config){}
<#}#>


/// <summary>
Expand Down
6 changes: 3 additions & 3 deletions sdk/src/Core/Amazon.Runtime/AmazonServiceClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public abstract class AmazonServiceClient : IDisposable
private Logger _logger;
protected EndpointDiscoveryResolverBase EndpointDiscoveryResolver { get; private set; }
protected RuntimePipeline RuntimePipeline { get; set; }
protected internal AWSCredentials Credentials { get; private set; }
protected internal AWSCredentials DefaultAWSCredentials { get; private set; }
public IClientConfig Config => _config;
private readonly ClientConfig _config;
protected virtual IServiceMetadata ServiceMetadata { get; } = new ServiceMetadata();
Expand Down Expand Up @@ -160,7 +160,7 @@ protected AmazonServiceClient(AWSCredentials credentials, ClientConfig config)
_logger = Logger.GetLogger(this.GetType());

config.Validate();
this.Credentials = credentials;
this.DefaultAWSCredentials = credentials;
_config = config;
Signer = CreateSigner();
EndpointDiscoveryResolver = new EndpointDiscoveryResolver(config, _logger);
Expand Down Expand Up @@ -390,7 +390,7 @@ private void BuildRuntimePipeline()
// ChecksumHandler must come after EndpointsResolver because of an upcoming project.
new ChecksumHandler(),
// CredentialsRetriever must come after RetryHandler because of any credential related changes.
new CredentialsRetriever(this.Credentials),
new CredentialsRetriever(this.DefaultAWSCredentials),
new RetryHandler(retryPolicy),
new CompressionHandler(),
postMarshallHandler,
Expand Down
14 changes: 12 additions & 2 deletions sdk/src/Core/Amazon.Runtime/ClientConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,19 @@
using System.Collections.Generic;
using System.Net;
using System.Threading;
using System.Globalization;


using Smithy.Identity.Abstractions;
using Amazon.Util;
using System.Globalization;
using Amazon.Internal;
using Amazon.Runtime.Endpoints;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Util;
using Amazon.Runtime.CredentialManagement;
using Amazon.Runtime.Internal.Settings;
using Amazon.Runtime.Telemetry;
using Amazon.Runtime.Credentials.Internal.IdentityResolvers;

#if NETSTANDARD
using System.Runtime.InteropServices;
Expand Down Expand Up @@ -88,6 +90,7 @@ public abstract partial class ClientConfig : IClientConfig
private const int MaxRetriesDefault = 2;
private const long DefaultMinCompressionSizeBytes = 10240;
private bool didProcessServiceURL = false;
private IIdentityResolverConfiguration _identityResolverConfiguration = DefaultIdentityResolverConfiguration.Instance;
private IAWSTokenProvider _awsTokenProvider = new DefaultAWSTokenProviderChain();
private TelemetryProvider telemetryProvider = AWSConfigs.TelemetryProvider;
private AccountIdEndpointMode? accountIdEndpointMode = null;
Expand Down Expand Up @@ -179,8 +182,15 @@ private static Amazon.Runtime.Internal.Util.WebProxy GetWebProxyWithCredentials(

return null;
}
/// <inheritdoc />
public IIdentityResolverConfiguration IdentityResolverConfiguration
{
get { return this._identityResolverConfiguration; }
set { this._identityResolverConfiguration = value; }
}

/// <inheritdoc />
[Obsolete("This property is deprecated in favor of the new Identity resolvers configured through IdentityResolverConfiguration.")]
public IAWSTokenProvider AWSTokenProvider
{
get { return this._awsTokenProvider; }
Expand Down Expand Up @@ -335,7 +345,7 @@ public string ServiceURL
}
else
{
CredentialProfileStoreChain.TryGetProfile(FallbackCredentialsFactory.GetProfileName(), out profile);
CredentialProfileStoreChain.TryGetProfile(DefaultAWSCredentialsIdentityResolver.GetProfileName(), out profile);
}
if(profile != null)
{
Expand Down
2 changes: 1 addition & 1 deletion ...n.Runtime/Credentials/Internal/IdentityResolvers/DefaultAWSCredentialsIdentityResolver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ private static AWSCredentials GetAWSCredentials(ICredentialProfileSource source)
throw new AmazonClientException($"Unable to find the \"{profileName}\" profile in CredentialProfileStoreChain.");
}

private static string GetProfileName()
internal static string GetProfileName()
{
var profileName = AWSConfigs.AWSProfileName;

Expand Down
10 changes: 10 additions & 0 deletions sdk/src/Core/Amazon.Runtime/IClientConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@
*/
using System;
using System.Net;
using Smithy.Identity.Abstractions;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Endpoints;
using Amazon.Runtime.Internal.Auth;
using Amazon.Util;
using Amazon.Runtime.Telemetry;
using Amazon.Runtime.Credentials.Internal.IdentityResolvers;
#if NETSTANDARD
using System.Net.Http;
#endif
Expand Down Expand Up @@ -55,6 +57,14 @@ public partial interface IClientConfig
/// </summary>
Profile Profile { get; }

/// <summary>
/// Gets the configuration for identity resolvers used by the service client, which manages
/// the resolvers used to obtain various types of identities.
Comment on lines +61 to +62
Copy link
Contributor

@dscpinheiro dscpinheiro Nov 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
/// Gets the configuration for identity resolvers used by the service client, which manages
/// the resolvers used to obtain various types of identities.
/// Gets the configuration for the identity resolvers configured in the service client.

I think the documentation could be improved further, but I don't have a better suggestion at the moment (looks like Java ended up not using *Configuration at all: aws/aws-sdk-java-v2#4423).

Copy link
Member Author

Choose a reason for hiding this comment

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

I did see that and it took me a while to figure out that the IdentityResolvers is the IdentityResolverConfiguration mentioned in the SRA, so I would prefer to use the SRA names to make it easier to find what it means in the SRA unless we have a good reason not to do so.

Copy link
Contributor

@dscpinheiro dscpinheiro Nov 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Oh, for sure. I wasn't suggesting renaming the type, just mentioning we can improve the documentation for this property (since it's visible in the config and may not be clear to customers at first).

/// <para />
/// See <see cref="DefaultIdentityResolverConfiguration"/> for additional information.
/// </summary>
IIdentityResolverConfiguration IdentityResolverConfiguration { get; }

/// <summary>
/// For Services using Bearer authentication, this controls how <see cref="BearerTokenSigner"/>
/// resolves a <see cref="AWSToken"/>.
Expand Down
4 changes: 2 additions & 2 deletions sdk/src/Core/Amazon.Runtime/Internal/ServiceClientHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public static TClient CreateServiceFromAnother<TClient, TConfig>(AmazonServiceCl
where TConfig : ClientConfig, new ()
where TClient : AmazonServiceClient
{
var credentials = originalServiceClient.Credentials;
var credentials = originalServiceClient.DefaultAWSCredentials;
var newConfig = originalServiceClient.CloneConfig<TConfig>();

var newServiceClientTypeInfo = typeof(TClient);
Expand Down Expand Up @@ -126,7 +126,7 @@ public static TClient CreateServiceFromAssembly<TClient>(string assemblyName, st
config.GetType()
});

var newServiceClient = constructor.Invoke(new object[] { originalServiceClient.Credentials, config }) as TClient;
var newServiceClient = constructor.Invoke(new object[] { originalServiceClient.DefaultAWSCredentials, config }) as TClient;

return newServiceClient;
}
Expand Down
2 changes: 1 addition & 1 deletion sdk/src/Core/Amazon.Runtime/Internal/Util/SdkCache.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ public static CacheKey Create(AmazonServiceClient client, object cacheType)

var key = new CacheKey();

var credentials = client.Credentials;
var credentials = client.DefaultAWSCredentials;
key.ImmutableCredentials = credentials == null ?
null : credentials.GetCredentials();
key.RegionEndpoint = client.Config.RegionEndpoint;
Expand Down
6 changes: 3 additions & 3 deletions sdk/src/Services/AutoScaling/Generated/_bcl/AmazonAutoScalingClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public IAutoScalingPaginatorFactory Paginators
///
/// </summary>
public AmazonAutoScalingClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonAutoScalingConfig()) { }
: base(new AmazonAutoScalingConfig()) { }

/// <summary>
/// Constructs AmazonAutoScalingClient with the credentials loaded from the application's
Expand All @@ -108,7 +108,7 @@ public AmazonAutoScalingClient()
/// </summary>
/// <param name="region">The region to connect.</param>
public AmazonAutoScalingClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonAutoScalingConfig{RegionEndpoint = region}) { }
: base(new AmazonAutoScalingConfig{RegionEndpoint = region}) { }

/// <summary>
/// Constructs AmazonAutoScalingClient with the credentials loaded from the application's
Expand All @@ -127,7 +127,7 @@ public AmazonAutoScalingClient(RegionEndpoint region)
/// </summary>
/// <param name="config">The AmazonAutoScalingClient Configuration Object</param>
public AmazonAutoScalingClient(AmazonAutoScalingConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
: base(config) { }

/// <summary>
/// Constructs AmazonAutoScalingClient with AWS Credentials
Expand Down
6 changes: 3 additions & 3 deletions sdk/src/Services/AutoScaling/Generated/_netstandard/AmazonAutoScalingClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public partial class AmazonAutoScalingClient : AmazonServiceClient, IAmazonAutoS
///
/// </summary>
public AmazonAutoScalingClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonAutoScalingConfig()) { }
: base(new AmazonAutoScalingConfig()) { }

/// <summary>
/// Constructs AmazonAutoScalingClient with the credentials loaded from the application's
Expand All @@ -93,7 +93,7 @@ public AmazonAutoScalingClient()
/// </summary>
/// <param name="region">The region to connect.</param>
public AmazonAutoScalingClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonAutoScalingConfig{RegionEndpoint = region}) { }
: base(new AmazonAutoScalingConfig{RegionEndpoint = region}) { }

/// <summary>
/// Constructs AmazonAutoScalingClient with the credentials loaded from the application's
Expand All @@ -112,7 +112,7 @@ public AmazonAutoScalingClient(RegionEndpoint region)
/// </summary>
/// <param name="config">The AmazonAutoScalingClient Configuration Object</param>
public AmazonAutoScalingClient(AmazonAutoScalingConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
: base(config) { }


/// <summary>
Expand Down
8 changes: 4 additions & 4 deletions sdk/src/Services/S3/Custom/AmazonS3Client.Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ protected override void Initialize()
/// <exception cref="T:System.ArgumentNullException" />
internal string GetPreSignedURLInternal(GetPreSignedUrlRequest request, bool useSigV2Fallback = true)
{
if (Credentials == null)
if (DefaultAWSCredentials == null)
throw new AmazonS3Exception("Credentials must be specified, cannot call method anonymously");

if (request == null)
Expand All @@ -97,7 +97,7 @@ internal string GetPreSignedURLInternal(GetPreSignedUrlRequest request, bool use
throw new InvalidOperationException("The Expires specified is null!");
Arn arn = null;
var signatureVersionToUse = DetermineSignatureVersionToUse(request, ref arn, useSigV2Fallback);
var immutableCredentials = Credentials.GetCredentials();
var immutableCredentials = DefaultAWSCredentials.GetCredentials();
var irequest = Marshall(this.Config, request, immutableCredentials.AccessKey, immutableCredentials.Token, signatureVersionToUse);

var context = new Amazon.Runtime.Internal.ExecutionContext(new Amazon.Runtime.Internal.RequestContext(true, new NullSigner()) { Request = irequest, ClientConfig = this.Config }, null);
Expand Down Expand Up @@ -150,7 +150,7 @@ internal string GetPreSignedURLInternal(GetPreSignedUrlRequest request, bool use
[SuppressMessage("AWSSDKRules", "CR1004")]
internal async Task<string> GetPreSignedURLInternalAsync(GetPreSignedUrlRequest request, bool useSigV2Fallback = true)
{
if (Credentials == null)
if (DefaultAWSCredentials == null)
throw new AmazonS3Exception("Credentials must be specified, cannot call method anonymously");

if (request == null)
Expand All @@ -160,7 +160,7 @@ internal async Task<string> GetPreSignedURLInternalAsync(GetPreSignedUrlRequest
throw new InvalidOperationException("The Expires specified is null!");
Arn arn = null;
var signatureVersionToUse = DetermineSignatureVersionToUse(request, ref arn, useSigV2Fallback);
var immutableCredentials = await Credentials.GetCredentialsAsync().ConfigureAwait(false);
var immutableCredentials = await DefaultAWSCredentials.GetCredentialsAsync().ConfigureAwait(false);
var irequest = Marshall(this.Config, request, immutableCredentials.AccessKey, immutableCredentials.Token, signatureVersionToUse);


Expand Down