commonMain.aws.smithy.kotlin.runtime.http.auth.HttpSigner.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-auth-api Show documentation

HTTP auth interfaces

There is a newer version: 1.3.31

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package aws.smithy.kotlin.runtime.http.auth

import aws.smithy.kotlin.runtime.http.request.HttpRequestBuilder
import aws.smithy.kotlin.runtime.identity.Identity
import aws.smithy.kotlin.runtime.util.Attributes

/**
 * Represents a component capable of signing an HTTP request
 */
public interface HttpSigner {
    /**
     * Sign the provided HTTP request (e.g. add AWS SigV4 headers, Bearer token header, etc)
     */
    public suspend fun sign(signingRequest: SignHttpRequest)
}

/**
 * Container for signing request parameters/config
 * @param httpRequest the request to sign
 * @param identity the identity to sign with
 * @param signingAttributes additional signing attributes that influence the signing config used to sign the request
 */
public data class SignHttpRequest(
    val httpRequest: HttpRequestBuilder,
    val identity: Identity,
    val signingAttributes: Attributes,
)