AWS rules engine authentication scheme validators

AWS-specific rules engine library authentication scheme validators make it possible to validate configurations for AWS authentication schemes like AWS signature version 4. An additional dependency is required to access these validators

The following example adds smithy-aws-endpoints as a dependency to a Smithy project:

Smithy CLI

smithy-build.json

{
    "maven": {
        "dependencies": [
            "software.amazon.smithy:smithy-aws-endpoints:1.48.0"
        ]
    }
}

Gradle

Kotlin

build.gradle.kts

dependencies {
    ...
    implementation("software.amazon.smithy:smithy-aws-endpoints:1.48.0")
    ...
}

Groovy

build.gradle

dependencies {
    ...
    implementation 'software.amazon.smithy:smithy-aws-endpoints:1.48.0'
    ...
}

sigv4 authentication scheme validator

Requirement

The name property is the string value sigv4.

Properties

Property	Type	Description
signingName	option<string>	The "service" value to use when creating a signing string for this endpoint.
signingRegion	option<string>	The "region" value to use when creating a signing string for this endpoint.
disableDoubleEncoding	option<boolean>	Default: false. When true, clients MUST NOT double-escape the path during signing.
disableNormalizePath	option<boolean>	Default: false. When true, clients MUST NOT perform any path normalization during signing.

sigv4a authentication scheme validator

Requirement

The name property is the string value sigv4a.

Properties

Property	Type	Description
signingName	option<string>	The "service" value to use when creating a signing string for this endpoint.
signingRegionSet	array<string>	The set of signing regions to use when creating a signing string for this endpoint.
disableDoubleEncoding	option<boolean>	Default: false. When true, clients MUST NOT double-escape the path during signing.
disableNormalizePath	option<boolean>	Default: false. When true, clients MUST NOT perform any path normalization during signing.