Unable to enable ClientLogMode for request signing on individual operation.

[jasdel]

It is not currently possible to enable or disable request signing via ClientLogMode API Client Options on individual operations. This configuration can only be provided when the API Client is first initialized, and only if a custom HTTPSignerV4 is not provided. (Its OK that the log option is ignored if custom signer is used.)

Issues

There is also no way to enable LogSigning per operation call because the addHTTPSignerV4Middleware does not pass down logging level.

The default v4 signer's LogSigning is only modified when when API client is created without custom HTTPSignerV4.

aws-sdk-go-v2/service/s3/api_client.go

Lines 215 to 226 in 3f8ff9a

	func resolveHTTPSignerV4(o *Options) {
	if o.HTTPSignerV4 != nil {
	return
	}
	o.HTTPSignerV4 = v4.NewSigner(
	func(s *v4.Signer) {
	s.Logger = o.Logger
	s.LogSigning = o.ClientLogMode.IsSigning()
	s.DisableURIPathEscaping = true
	},
	)
	}

When an Operation is invoked and the addHTTPSignerV4Middleware helper is run to add the signing middleware, the helper takes functional parameters instead of a structure. This would make it impossible to add additional parameters in the future without using a different middleware helper in the v4 package.

aws-sdk-go-v2/service/s3/api_client.go

Lines 207 to 209 in 3f8ff9a

	func addHTTPSignerV4Middleware(stack *middleware.Stack, o Options) error {
	return stack.Finalize.Add(v4.NewSignHTTPRequestMiddleware(o.Credentials, o.HTTPSignerV4), middleware.After)
	}

aws-sdk-go-v2/aws/signer/v4/middleware.go

Lines 204 to 207 in 3f8ff9a

	// NewSignHTTPRequestMiddleware constructs a SignHTTPRequest using the given Signer for signing requests
	func NewSignHTTPRequestMiddleware(credentialsProvider aws.CredentialsProvider, signer HTTPSigner) *SignHTTPRequest {
	return &SignHTTPRequest{credentialsProvider: credentialsProvider, signer: signer}
	}

The HTTPSignerV4 API client generated interface does not provide functional options for additional configurations.

aws-sdk-go-v2/service/s3/api_client.go

Lines 211 to 213 in 3f8ff9a

	type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
	}

Proposal

Update v4.NewSignHTTPRequestMiddleware to take structure for options instead of individual function parameters. This will allow future options to be passed down from the operation's adding the middleware.

type SignHTTPRequestMiddlewareOptions struct {
     Credentials aws.CredentialsProvider
     Signer         HTTPSigner
     LogSigning bool
}

func NewSignHTTPRequestMiddleware(options SignHTTPRequestMiddlewareOptions) *SignHTTPRequest {
     return &SignHTTPRequest{
          credentialsProvider: options.Credentials,
          signer: options.Signer,
          logSigning: options.logSigning,
     }
}

Update the HTTPSignerV4, and HTTPSigner interfaces to to functional options for additional signing options such as LogSigning. Adding a , optFns ...func(*v4.SignerOptions) to the signature.

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.