software.amazon.smithy.openapi.fromsmithy.security.AwsV4Converter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smithy-openapi Show documentation

This module contains support for converting a Smithy model to OpenAPI.

There is a newer version: 1.51.0

/*
 * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package software.amazon.smithy.openapi.fromsmithy.security;

import java.util.Set;
import software.amazon.smithy.aws.traits.auth.SigV4Trait;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.traits.Trait;
import software.amazon.smithy.openapi.fromsmithy.Context;
import software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter;
import software.amazon.smithy.openapi.model.SecurityScheme;
import software.amazon.smithy.utils.SetUtils;
import software.amazon.smithy.utils.SmithyInternalApi;

/**
 * Adds AWS signature version in a way that"s compatible with AWS API Gateway.
 */
@SmithyInternalApi
public final class AwsV4Converter implements SecuritySchemeConverter {
    private static final String AUTH_HEADER = "Authorization";
    private static final Set REQUEST_HEADERS = SetUtils.of(
            AUTH_HEADER, "Date", "X-Amz-Date", "X-Amz-Target", "X-Amz-Security-Token");

    @Override
    public Class getAuthSchemeType() {
        return SigV4Trait.class;
    }

    @Override
    public SecurityScheme createSecurityScheme(Context context, SigV4Trait trait) {
        return SecurityScheme.builder()
                .type("apiKey")
                .description("AWS Signature Version 4 authentication")
                .name(AUTH_HEADER)
                .in("header")
                .putExtension("x-amazon-apigateway-authtype", Node.from("awsSigv4"))
                .build();
    }

    @Override
    public Set getAuthRequestHeaders(Context context, SigV4Trait trait) {
        return REQUEST_HEADERS;
    }
}