Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @aws-sdk/middleware-signing

Index

References

AwsAuthInputConfig

Re-exports AwsAuthInputConfig

AwsAuthResolvedConfig

Re-exports AwsAuthResolvedConfig

SigV4AuthInputConfig

Re-exports SigV4AuthInputConfig

SigV4AuthResolvedConfig

Re-exports SigV4AuthResolvedConfig

awsAuthMiddleware

Re-exports awsAuthMiddleware

awsAuthMiddlewareOptions

Re-exports awsAuthMiddlewareOptions

getAwsAuthPlugin

Re-exports getAwsAuthPlugin

getSigV4AuthPlugin

Re-exports getSigV4AuthPlugin

resolveAwsAuthConfig

Re-exports resolveAwsAuthConfig

resolveSigV4AuthConfig

Re-exports resolveSigV4AuthConfig

Variables

Const CREDENTIAL_EXPIRE_WINDOW

CREDENTIAL_EXPIRE_WINDOW: 300000 = 300000

Const getSigV4AuthPlugin

getSigV4AuthPlugin: getAwsAuthPlugin = getAwsAuthPlugin

Functions

Const awsAuthMiddleware

Const getAwsAuthPlugin

Const getDateHeader

  • getDateHeader(response: unknown): string | undefined

Const getSkewCorrectedDate

  • getSkewCorrectedDate(systemClockOffset: number): Date

Const getUpdatedSystemClockOffset

  • getUpdatedSystemClockOffset(clockTime: string, currentSystemClockOffset: number): number
  • If clock is skewed, it returns the difference between serverTime and current time. If clock is not skewed, it returns currentSystemClockOffset.

    Parameters

    • clockTime: string

      The string value of the server time.

    • currentSystemClockOffset: number

      The current system clock offset.

    Returns number

Const isClockSkewed

  • isClockSkewed(clockTime: number, systemClockOffset: number): boolean
  • Checks if the provided date is within the skew window of 300000ms.

    Parameters

    • clockTime: number

      The time to check for skew in milliseconds.

    • systemClockOffset: number

      The offset of the system clock in milliseconds.

    Returns boolean

Const normalizeCredentialProvider

Const normalizeProvider

Const resolveAwsAuthConfig

Const resolveSigV4AuthConfig

Object literals

Const awsAuthMiddlewareOptions

awsAuthMiddlewareOptions: object

name

name: string = "awsAuthMiddleware"

override

override: true = true

relation

relation: "after" = "after"

tags

tags: string[] = ["SIGNATURE", "AWSAUTH"]

toMiddleware

toMiddleware: string = "retryMiddleware"