software.amazon.smithy.kotlin.codegen.model.knowledge.AwsSignatureVersion4.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package software.amazon.smithy.kotlin.codegen.model.knowledge

import software.amazon.smithy.aws.traits.auth.SigV4Trait
import software.amazon.smithy.kotlin.codegen.model.expectTrait
import software.amazon.smithy.kotlin.codegen.model.hasTrait
import software.amazon.smithy.model.Model
import software.amazon.smithy.model.knowledge.ServiceIndex
import software.amazon.smithy.model.shapes.OperationShape
import software.amazon.smithy.model.shapes.ServiceShape
import software.amazon.smithy.model.traits.OptionalAuthTrait

/**
 * AWS Signature Version 4 signing utils
 */
object AwsSignatureVersion4 {
    /**
     * Returns if the SigV4Trait is an auth scheme supported by the service.
     *
     * @param model        model definition
     * @param serviceShape service shape for the API
     * @return if the SigV4 trait is used by the service.
     */
    fun isSupportedAuthentication(model: Model, serviceShape: ServiceShape): Boolean =
        ServiceIndex
            .of(model)
            .getAuthSchemes(serviceShape)
            .values
            .any { it.javaClass == SigV4Trait::class.java }

    /**
     * Get the SigV4Trait auth name to sign request for
     *
     * @param serviceShape service shape for the API
     * @return the service name to use in the credential scope to sign for
     */
    fun signingServiceName(serviceShape: ServiceShape): String {
        val sigv4Trait = serviceShape.expectTrait()
        return sigv4Trait.name
    }

    /**
     * Returns if the SigV4Trait is a auth scheme for the service and operation.
     *
     * @param model     model definition
     * @param service   service shape for the API
     * @param operation operation shape
     * @return if SigV4Trait is an auth scheme for the operation and service.
     */
    fun hasSigV4AuthScheme(model: Model, service: ServiceShape, operation: OperationShape): Boolean {
        val auth = ServiceIndex.of(model).getEffectiveAuthSchemes(service.id, operation.id)
        return auth.containsKey(SigV4Trait.ID) && !operation.hasTrait()
    }
}