api_op_GetAuthorizationToken.go

Documentation: github.com/aws/aws-sdk-go-v2/service/ecr

     1  // Code generated by smithy-go-codegen DO NOT EDIT.
     2  
     3  package ecr
     4  
     5  import (
     6  	"context"
     7  	"errors"
     8  	"fmt"
     9  	"github.com/aws/aws-sdk-go-v2/aws"
    10  	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
    11  	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
    12  	internalauth "github.com/aws/aws-sdk-go-v2/internal/auth"
    13  	"github.com/aws/aws-sdk-go-v2/service/ecr/types"
    14  	smithyendpoints "github.com/aws/smithy-go/endpoints"
    15  	"github.com/aws/smithy-go/middleware"
    16  	smithyhttp "github.com/aws/smithy-go/transport/http"
    17  )
    18  
    19  // Retrieves an authorization token. An authorization token represents your IAM
    20  // authentication credentials and can be used to access any Amazon ECR registry
    21  // that your IAM principal has access to. The authorization token is valid for 12
    22  // hours. The authorizationToken returned is a base64 encoded string that can be
    23  // decoded and used in a docker login command to authenticate to a registry. The
    24  // CLI offers an get-login-password command that simplifies the login process. For
    25  // more information, see Registry authentication (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth)
    26  // in the Amazon Elastic Container Registry User Guide.
    27  func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, optFns ...func(*Options)) (*GetAuthorizationTokenOutput, error) {
    28  	if params == nil {
    29  		params = &GetAuthorizationTokenInput{}
    30  	}
    31  
    32  	result, metadata, err := c.invokeOperation(ctx, "GetAuthorizationToken", params, optFns, c.addOperationGetAuthorizationTokenMiddlewares)
    33  	if err != nil {
    34  		return nil, err
    35  	}
    36  
    37  	out := result.(*GetAuthorizationTokenOutput)
    38  	out.ResultMetadata = metadata
    39  	return out, nil
    40  }
    41  
    42  type GetAuthorizationTokenInput struct {
    43  
    44  	// A list of Amazon Web Services account IDs that are associated with the
    45  	// registries for which to get AuthorizationData objects. If you do not specify a
    46  	// registry, the default registry is assumed.
    47  	//
    48  	// Deprecated: This field is deprecated. The returned authorization token can be
    49  	// used to access any Amazon ECR registry that the IAM principal has access to,
    50  	// specifying a registry ID doesn't change the permissions scope of the
    51  	// authorization token.
    52  	RegistryIds []string
    53  
    54  	noSmithyDocumentSerde
    55  }
    56  
    57  type GetAuthorizationTokenOutput struct {
    58  
    59  	// A list of authorization token data objects that correspond to the registryIds
    60  	// values in the request.
    61  	AuthorizationData []types.AuthorizationData
    62  
    63  	// Metadata pertaining to the operation's result.
    64  	ResultMetadata middleware.Metadata
    65  
    66  	noSmithyDocumentSerde
    67  }
    68  
    69  func (c *Client) addOperationGetAuthorizationTokenMiddlewares(stack *middleware.Stack, options Options) (err error) {
    70  	err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetAuthorizationToken{}, middleware.After)
    71  	if err != nil {
    72  		return err
    73  	}
    74  	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetAuthorizationToken{}, middleware.After)
    75  	if err != nil {
    76  		return err
    77  	}
    78  	if err = addlegacyEndpointContextSetter(stack, options); err != nil {
    79  		return err
    80  	}
    81  	if err = addSetLoggerMiddleware(stack, options); err != nil {
    82  		return err
    83  	}
    84  	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
    85  		return err
    86  	}
    87  	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
    88  		return err
    89  	}
    90  	if err = addResolveEndpointMiddleware(stack, options); err != nil {
    91  		return err
    92  	}
    93  	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
    94  		return err
    95  	}
    96  	if err = addRetryMiddlewares(stack, options); err != nil {
    97  		return err
    98  	}
    99  	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
   100  		return err
   101  	}
   102  	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
   103  		return err
   104  	}
   105  	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
   106  		return err
   107  	}
   108  	if err = addClientUserAgent(stack, options); err != nil {
   109  		return err
   110  	}
   111  	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
   112  		return err
   113  	}
   114  	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
   115  		return err
   116  	}
   117  	if err = addGetAuthorizationTokenResolveEndpointMiddleware(stack, options); err != nil {
   118  		return err
   119  	}
   120  	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetAuthorizationToken(options.Region), middleware.Before); err != nil {
   121  		return err
   122  	}
   123  	if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
   124  		return err
   125  	}
   126  	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
   127  		return err
   128  	}
   129  	if err = addResponseErrorMiddleware(stack); err != nil {
   130  		return err
   131  	}
   132  	if err = addRequestResponseLogging(stack, options); err != nil {
   133  		return err
   134  	}
   135  	if err = addendpointDisableHTTPSMiddleware(stack, options); err != nil {
   136  		return err
   137  	}
   138  	return nil
   139  }
   140  
   141  func newServiceMetadataMiddleware_opGetAuthorizationToken(region string) *awsmiddleware.RegisterServiceMetadata {
   142  	return &awsmiddleware.RegisterServiceMetadata{
   143  		Region:        region,
   144  		ServiceID:     ServiceID,
   145  		SigningName:   "ecr",
   146  		OperationName: "GetAuthorizationToken",
   147  	}
   148  }
   149  
   150  type opGetAuthorizationTokenResolveEndpointMiddleware struct {
   151  	EndpointResolver EndpointResolverV2
   152  	BuiltInResolver  builtInParameterResolver
   153  }
   154  
   155  func (*opGetAuthorizationTokenResolveEndpointMiddleware) ID() string {
   156  	return "ResolveEndpointV2"
   157  }
   158  
   159  func (m *opGetAuthorizationTokenResolveEndpointMiddleware) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
   160  	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
   161  ) {
   162  	if awsmiddleware.GetRequiresLegacyEndpoints(ctx) {
   163  		return next.HandleSerialize(ctx, in)
   164  	}
   165  
   166  	req, ok := in.Request.(*smithyhttp.Request)
   167  	if !ok {
   168  		return out, metadata, fmt.Errorf("unknown transport type %T", in.Request)
   169  	}
   170  
   171  	if m.EndpointResolver == nil {
   172  		return out, metadata, fmt.Errorf("expected endpoint resolver to not be nil")
   173  	}
   174  
   175  	params := EndpointParameters{}
   176  
   177  	m.BuiltInResolver.ResolveBuiltIns(&params)
   178  
   179  	var resolvedEndpoint smithyendpoints.Endpoint
   180  	resolvedEndpoint, err = m.EndpointResolver.ResolveEndpoint(ctx, params)
   181  	if err != nil {
   182  		return out, metadata, fmt.Errorf("failed to resolve service endpoint, %w", err)
   183  	}
   184  
   185  	req.URL = &resolvedEndpoint.URI
   186  
   187  	for k := range resolvedEndpoint.Headers {
   188  		req.Header.Set(
   189  			k,
   190  			resolvedEndpoint.Headers.Get(k),
   191  		)
   192  	}
   193  
   194  	authSchemes, err := internalauth.GetAuthenticationSchemes(&resolvedEndpoint.Properties)
   195  	if err != nil {
   196  		var nfe *internalauth.NoAuthenticationSchemesFoundError
   197  		if errors.As(err, &nfe) {
   198  			// if no auth scheme is found, default to sigv4
   199  			signingName := "ecr"
   200  			signingRegion := m.BuiltInResolver.(*builtInResolver).Region
   201  			ctx = awsmiddleware.SetSigningName(ctx, signingName)
   202  			ctx = awsmiddleware.SetSigningRegion(ctx, signingRegion)
   203  
   204  		}
   205  		var ue *internalauth.UnSupportedAuthenticationSchemeSpecifiedError
   206  		if errors.As(err, &ue) {
   207  			return out, metadata, fmt.Errorf(
   208  				"This operation requests signer version(s) %v but the client only supports %v",
   209  				ue.UnsupportedSchemes,
   210  				internalauth.SupportedSchemes,
   211  			)
   212  		}
   213  	}
   214  
   215  	for _, authScheme := range authSchemes {
   216  		switch authScheme.(type) {
   217  		case *internalauth.AuthenticationSchemeV4:
   218  			v4Scheme, _ := authScheme.(*internalauth.AuthenticationSchemeV4)
   219  			var signingName, signingRegion string
   220  			if v4Scheme.SigningName == nil {
   221  				signingName = "ecr"
   222  			} else {
   223  				signingName = *v4Scheme.SigningName
   224  			}
   225  			if v4Scheme.SigningRegion == nil {
   226  				signingRegion = m.BuiltInResolver.(*builtInResolver).Region
   227  			} else {
   228  				signingRegion = *v4Scheme.SigningRegion
   229  			}
   230  			if v4Scheme.DisableDoubleEncoding != nil {
   231  				// The signer sets an equivalent value at client initialization time.
   232  				// Setting this context value will cause the signer to extract it
   233  				// and override the value set at client initialization time.
   234  				ctx = internalauth.SetDisableDoubleEncoding(ctx, *v4Scheme.DisableDoubleEncoding)
   235  			}
   236  			ctx = awsmiddleware.SetSigningName(ctx, signingName)
   237  			ctx = awsmiddleware.SetSigningRegion(ctx, signingRegion)
   238  			break
   239  		case *internalauth.AuthenticationSchemeV4A:
   240  			v4aScheme, _ := authScheme.(*internalauth.AuthenticationSchemeV4A)
   241  			if v4aScheme.SigningName == nil {
   242  				v4aScheme.SigningName = aws.String("ecr")
   243  			}
   244  			if v4aScheme.DisableDoubleEncoding != nil {
   245  				// The signer sets an equivalent value at client initialization time.
   246  				// Setting this context value will cause the signer to extract it
   247  				// and override the value set at client initialization time.
   248  				ctx = internalauth.SetDisableDoubleEncoding(ctx, *v4aScheme.DisableDoubleEncoding)
   249  			}
   250  			ctx = awsmiddleware.SetSigningName(ctx, *v4aScheme.SigningName)
   251  			ctx = awsmiddleware.SetSigningRegion(ctx, v4aScheme.SigningRegionSet[0])
   252  			break
   253  		case *internalauth.AuthenticationSchemeNone:
   254  			break
   255  		}
   256  	}
   257  
   258  	return next.HandleSerialize(ctx, in)
   259  }
   260  
   261  func addGetAuthorizationTokenResolveEndpointMiddleware(stack *middleware.Stack, options Options) error {
   262  	return stack.Serialize.Insert(&opGetAuthorizationTokenResolveEndpointMiddleware{
   263  		EndpointResolver: options.EndpointResolverV2,
   264  		BuiltInResolver: &builtInResolver{
   265  			Region:       options.Region,
   266  			UseDualStack: options.EndpointOptions.UseDualStackEndpoint,
   267  			UseFIPS:      options.EndpointOptions.UseFIPSEndpoint,
   268  			Endpoint:     options.BaseEndpoint,
   269  		},
   270  	}, "ResolveEndpoint", middleware.After)
   271  }
   272
View as plain text