package v4a

Import Path
	github.com/aws/aws-sdk-go-v2/internal/v4a (on go.dev)

Dependency Relation
	imports 30 packages, and imported by 2 packages

Involved Source Files

	      credentials.go
	      error.go
	      go_module_metadata.go
	      middleware.go
	      presign_middleware.go
	      v4a.go
Package-Level Type Names (total 14, in which 12 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Credentials (struct)
		Credentials is Context, ECDSA, and Optional Session Token that can be used
		to sign requests using SigV4a

		Fields (total 5, all are exported)
			CanExpire bool
				Time the credentials will expire.

			Context string
			Expires time.Time
			PrivateKey *ecdsa.PrivateKey
			SessionToken string
		Methods (total 2, both are exported)
			( Credentials) Expired() bool
				Expired returns if the credentials have expired.

			( Credentials) HasKeys() bool
				HasKeys returns if the credentials keys are set.

		As Outputs Of (at least 3, in which 2 are exported)
			func CredentialsProvider.RetrievePrivateKey(context.Context) (Credentials, error)
			func (*SymmetricCredentialAdaptor).RetrievePrivateKey(ctx context.Context) (Credentials, error)
			/* at least one unexported ... *//* at least one unexported: */
			func (*SymmetricCredentialAdaptor).getCreds() *Credentials
		As Inputs Of (at least 4, all are exported)
			func HTTPPresigner.PresignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, regionSet []string, signingTime time.Time, optFns ...func(*SignerOptions)) (url string, signedHeader http.Header, err error)
			func HTTPSigner.SignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, regionSet []string, signingTime time.Time, optfns ...func(*SignerOptions)) error
			func (*Signer).PresignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, regionSet []string, signingTime time.Time, optFns ...func(*SignerOptions)) (signedURI string, signedHeaders http.Header, err error)
			func (*Signer).SignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, regionSet []string, signingTime time.Time, optFns ...func(*SignerOptions)) error

	 type CredentialsProvider (interface)
		CredentialsProvider is the interface for a provider to retrieve credentials
		to sign requests with.

		Methods (only one, which is exported)
			( CredentialsProvider) RetrievePrivateKey(context.Context) (Credentials, error)
		Implemented By (at least one exported)
			*SymmetricCredentialAdaptor
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func hasCredentialProvider(p CredentialsProvider) bool

	 type HTTPPresigner (interface)
		HTTPPresigner is an interface to a SigV4a signer that can sign create a
		presigned URL for a HTTP requests.

		Methods (only one, which is exported)
			( HTTPPresigner) PresignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, regionSet []string, signingTime time.Time, optFns ...func(*SignerOptions)) (url string, signedHeader http.Header, err error)
		Implemented By (at least 2, in which 1 are exported)
			*Signer
			/* at least one unexported ... *//* at least one unexported: */
			 github.com/aws/aws-sdk-go-v2/service/s3.httpPresignerV4a (interface)
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 HTTPPresigner : github.com/aws/aws-sdk-go-v2/service/s3.httpPresignerV4a

	 type HTTPSigner (interface)
		HTTPSigner is SigV4a HTTP signer implementation

		Methods (only one, which is exported)
			( HTTPSigner) SignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, regionSet []string, signingTime time.Time, optfns ...func(*SignerOptions)) error
		Implemented By (at least 2, in which 1 are exported)
			*Signer
			/* at least one unexported ... *//* at least one unexported: */
			 github.com/aws/aws-sdk-go-v2/service/s3.httpSignerV4a (interface)
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 HTTPSigner : github.com/aws/aws-sdk-go-v2/service/s3.httpSignerV4a

	 type PresignHTTPRequestMiddleware (struct)
		PresignHTTPRequestMiddleware provides the Finalize middleware for creating a
		presigned URL for an HTTP request.

		Will short circuit the middleware stack and not forward onto the next
		Finalize handler.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			credentialsProvider CredentialsProvider
			logSigning bool
			presigner HTTPPresigner
		Methods (total 2, both are exported)
			(*PresignHTTPRequestMiddleware) HandleFinalize(ctx context.Context, in middleware.FinalizeInput, next middleware.FinalizeHandler) (out middleware.FinalizeOutput, metadata middleware.Metadata, err error)
				HandleFinalize will take the provided input and create a presigned url for
				the http request using the SigV4 presign authentication scheme.

			(*PresignHTTPRequestMiddleware) ID() string
				ID provides the middleware ID.

		Implements (at least 2, in which 1 are exported)
			*PresignHTTPRequestMiddleware : github.com/aws/smithy-go/middleware.FinalizeMiddleware
			/* at least one unexported ... *//* at least one unexported: */
			*PresignHTTPRequestMiddleware : github.com/aws/smithy-go/middleware.ider
		As Outputs Of (at least one exported)
			func NewPresignHTTPRequestMiddleware(options PresignHTTPRequestMiddlewareOptions) *PresignHTTPRequestMiddleware

	 type PresignHTTPRequestMiddlewareOptions (struct)
		PresignHTTPRequestMiddlewareOptions is the options for the PresignHTTPRequestMiddleware middleware.

		Fields (total 3, all are exported)
			CredentialsProvider CredentialsProvider
			LogSigning bool
			Presigner HTTPPresigner
		As Inputs Of (at least one exported)
			func NewPresignHTTPRequestMiddleware(options PresignHTTPRequestMiddlewareOptions) *PresignHTTPRequestMiddleware

	 type Signer (struct)
		Signer is a SigV4a HTTP signing implementation

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			options SignerOptions
		Methods (total 2, both are exported)
			(*Signer) PresignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, regionSet []string, signingTime time.Time, optFns ...func(*SignerOptions)) (signedURI string, signedHeaders http.Header, err error)
				PresignHTTP takes the provided http.Request, payload hash, service, regionSet, and time and presigns using SigV4a
				Returns the presigned URL along with the headers that were signed with the request.

				PresignHTTP will not set the expires time of the presigned request
				automatically. To specify the expire duration for a request add the
				"X-Amz-Expires" query parameter on the request with the value as the
				duration in seconds the presigned URL should be considered valid for. This
				parameter is not used by all AWS services, and is most notable used by
				Amazon S3 APIs.

			(*Signer) SignHTTP(ctx context.Context, credentials Credentials, r *http.Request, payloadHash string, service string, regionSet []string, signingTime time.Time, optFns ...func(*SignerOptions)) error
				SignHTTP takes the provided http.Request, payload hash, service, regionSet, and time and signs using SigV4a.
				The passed in request will be modified in place.

		Implements (at least 4, in which 2 are exported)
			*Signer : HTTPPresigner
			*Signer : HTTPSigner
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*Signer : github.com/aws/aws-sdk-go-v2/service/s3.httpPresignerV4a
			*Signer : github.com/aws/aws-sdk-go-v2/service/s3.httpSignerV4a
		As Outputs Of (at least 2, in which 1 are exported)
			func NewSigner(optFns ...func(*SignerOptions)) *Signer
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/aws/aws-sdk-go-v2/service/s3.newDefaultV4aSigner(o s3.Options) *Signer

	 type SignerOptions (struct)
		SignerOptions is the SigV4a signing options for constructing a Signer.

		Fields (total 4, all are exported)
			DisableHeaderHoisting bool
				Disables the Signer's moving HTTP header key/value pairs from the HTTP
				request header to the request's query string. This is most commonly used
				with pre-signed requests preventing headers from being added to the
				request's query string.

			DisableURIPathEscaping bool
				Disables the automatic escaping of the URI path of the request for the
				siganture's canonical string's path. For services that do not need additional
				escaping then use this to disable the signer escaping the path.

				S3 is an example of a service that does not need additional escaping.

				http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

			LogSigning bool
			Logger logging.Logger
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func logHTTPSigningInfo(ctx context.Context, options SignerOptions, r signedRequest)

	 type SignHTTPRequestMiddleware (struct)
		SignHTTPRequestMiddleware is a middleware for signing an HTTP request using SigV4a.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			credentials CredentialsProvider
			logSigning bool
			signer HTTPSigner
		Methods (total 2, both are exported)
			(*SignHTTPRequestMiddleware) HandleFinalize(ctx context.Context, in middleware.FinalizeInput, next middleware.FinalizeHandler) (out middleware.FinalizeOutput, metadata middleware.Metadata, err error)
				HandleFinalize signs an HTTP request using SigV4a.

			(*SignHTTPRequestMiddleware) ID() string
				ID the middleware identifier.

		Implements (at least 2, in which 1 are exported)
			*SignHTTPRequestMiddleware : github.com/aws/smithy-go/middleware.FinalizeMiddleware
			/* at least one unexported ... *//* at least one unexported: */
			*SignHTTPRequestMiddleware : github.com/aws/smithy-go/middleware.ider
		As Outputs Of (at least one exported)
			func NewSignHTTPRequestMiddleware(options SignHTTPRequestMiddlewareOptions) *SignHTTPRequestMiddleware
		As Inputs Of (at least one exported)
			func RegisterSigningMiddleware(stack *middleware.Stack, signingMiddleware *SignHTTPRequestMiddleware) (err error)

	 type SignHTTPRequestMiddlewareOptions (struct)
		SignHTTPRequestMiddlewareOptions is the middleware options for constructing a SignHTTPRequestMiddleware.

		Fields (total 3, all are exported)
			Credentials CredentialsProvider
			LogSigning bool
			Signer HTTPSigner
		As Inputs Of (at least one exported)
			func NewSignHTTPRequestMiddleware(options SignHTTPRequestMiddlewareOptions) *SignHTTPRequestMiddleware

	 type SigningError (struct)
		SigningError indicates an error condition occurred while performing SigV4a signing

		Fields (only one, which is exported)
			Err error
		Methods (total 2, both are exported)
			(*SigningError) Error() string
			(*SigningError) Unwrap() error
				Unwrap returns the underlying error cause

		Implements (at least one exported)
			*SigningError : error

	 type SymmetricCredentialAdaptor (struct)
		SymmetricCredentialAdaptor wraps a SigV4 AccessKey/SecretKey provider and adapts the credentials
		to a ECDSA PrivateKey for signing with SiV4a

		Fields (total 3, in which 1 are exported)
			SymmetricProvider aws.CredentialsProvider
			/* 2 unexporteds ... *//* 2 unexporteds: */
			asymmetric atomic.Value
			m sync.Mutex
		Methods (total 4, in which 2 are exported)
			(*SymmetricCredentialAdaptor) Retrieve(ctx context.Context) (aws.Credentials, error)
				Retrieve retrieves symmetric credentials from the underlying provider.

			(*SymmetricCredentialAdaptor) RetrievePrivateKey(ctx context.Context) (Credentials, error)
				RetrievePrivateKey returns credentials suitable for SigV4a signing

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*SymmetricCredentialAdaptor) getCreds() *Credentials
			(*SymmetricCredentialAdaptor) retrieveFromSymmetricProvider(ctx context.Context) (aws.Credentials, error)
		Implements (at least 2, both are exported)
			*SymmetricCredentialAdaptor : CredentialsProvider
			*SymmetricCredentialAdaptor : github.com/aws/aws-sdk-go-v2/aws.CredentialsProvider

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type httpSigner (struct)

		Fields (total 11, all are exported)
			Credentials Credentials
			Debug bool
			DisableHeaderHoisting bool
			DisableURIPathEscaping bool
			IsPreSign bool
			Logger logging.Logger
			PayloadHash string
				PayloadHash is the hex encoded SHA-256 hash of the request payload
				If len(PayloadHash) == 0 the signer will attempt to send the request
				as an unsigned payload. Note: Unsigned payloads only work for a subset of services.

			RegionSet []string
			Request *http.Request
			ServiceName string
			Time time.Time
		Methods (total 7, in which 1 are exported)
			(*httpSigner) Build() (signedRequest, error)
			/* 6 unexporteds ... *//* 6 unexporteds: */
			(*httpSigner) buildCanonicalHeaders(host string, rule v4Internal.Rule, header http.Header, length int64) (signed http.Header, signedHeaders, canonicalHeadersStr string)
			(*httpSigner) buildCanonicalString(method, uri, query, signedHeaders, canonicalHeaders string) string
			(*httpSigner) buildCredentialScope() string
			(*httpSigner) buildSignature(strToSign string) (string, error)
			(*httpSigner) buildStringToSign(credentialScope, canonicalRequestString string) string
			(*httpSigner) setRequiredSigningFields(headers http.Header, query url.Values)

	 type signedRequest (struct)

		Fields (total 5, all are exported)
			CanonicalString string
			PreSigned bool
			Request *http.Request
			SignedHeaders http.Header
			StringToSign string
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func logHTTPSigningInfo(ctx context.Context, options SignerOptions, r signedRequest)


Package-Level Functions (total 11, in which 4 are exported)

	 func NewPresignHTTPRequestMiddleware(options PresignHTTPRequestMiddlewareOptions) *PresignHTTPRequestMiddleware
		NewPresignHTTPRequestMiddleware returns a new PresignHTTPRequestMiddleware
		initialized with the presigner.

	 func NewSigner(optFns ...func(*SignerOptions)) *Signer
		NewSigner constructs a SigV4a Signer.

	 func NewSignHTTPRequestMiddleware(options SignHTTPRequestMiddlewareOptions) *SignHTTPRequestMiddleware
		NewSignHTTPRequestMiddleware constructs a SignHTTPRequestMiddleware using the given SignHTTPRequestMiddlewareOptions.

	 func RegisterSigningMiddleware(stack *middleware.Stack, signingMiddleware *SignHTTPRequestMiddleware) (err error)
		RegisterSigningMiddleware registers the SigV4a signing middleware to the stack. If a signing middleware is already
		present, this provided middleware will be swapped. Otherwise the middleware will be added at the tail of the
		finalize step.

	/* 7 unexporteds ... *//* 7 unexporteds: */
	 func buildAuthorizationHeader(credentialStr, signedHeadersStr, signingSignature string) string
	 func buildQuery(r v4Internal.Rule, header http.Header) (url.Values, http.Header)
	 func deriveKeyFromAccessKeyPair(accessKey, secretKey string) (*ecdsa.PrivateKey, error)
		deriveKeyFromAccessKeyPair derives a NIST P-256 PrivateKey from the given
		IAM AccessKey and SecretKey pair.

		Based on FIPS.186-4 Appendix B.4.2

	 func hasCredentialProvider(p CredentialsProvider) bool
	 func init()
	 func logHTTPSigningInfo(ctx context.Context, options SignerOptions, r signedRequest)
	 func makeHash(hash hash.Hash, b []byte) []byte
Package-Level Variables (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	  var nMinusTwoP256 *big.Int
	  var one *big.Int
	  var p256 elliptic.Curve
Package-Level Constants (total 15, in which 3 are exported)

	const AmzRegionSetKey = "X-Amz-Region-Set"
		AmzRegionSetKey represents the region set header used for sigv4a

	const EmptyStringSHA256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
		EmptyStringSHA256 is a hex encoded SHA-256 hash of an empty string

	const Version = "SigV4A"
		Version of signing v4a

	/* 12 unexporteds ... *//* 12 unexporteds: */
	const amzAlgorithmKey = "X-Amz-Algorithm"
	const amzCredentialKey = "X-Amz-Credential"
	const amzDateKey = "X-Amz-Date"
	const amzSecurityTokenKey = "X-Amz-Security-Token"
	const amzSignedHeadersKey = "X-Amz-SignedHeaders"
	const authorizationHeader = "Authorization"
	const goModuleVersion = "1.0.21"
		goModuleVersion is the tagged release for this module

	const logSignedURLMsg = "\n---[ SIGNED URL ]------------------------------------\n%s"
	const logSignInfoMsg = "Request Signature:\n---[ CANONICAL STRING  ]------------------------...
	const shortTimeFormat = "20060102"
	const signingAlgorithm = "AWS4-ECDSA-P256-SHA256"
	const timeFormat = "20060102T150405Z"

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)