org.http4k.contract.Security.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http4k-contract Show documentation

http4k typesafe HTTP contracts and OpenApi support

There is a newer version: 5.31.0.0

package org.http4k.contract

import org.http4k.core.Filter
import org.http4k.core.Method.OPTIONS
import org.http4k.core.Request
import org.http4k.core.Response
import org.http4k.core.Status.Companion.UNAUTHORIZED
import org.http4k.lens.Lens
import org.http4k.lens.LensFailure


/**
 * Endpoint security. Provides filter to be applied to endpoints for all requests.
 */
interface Security {
    val filter: Filter
}

/**
 * Default NoOp security filter. Filter allows all traffic through.
 */
object NoSecurity : Security {
    override val filter = Filter { it }
}

/**
 * Checks the presence of the named Api Key parameter. Filter returns 401 if Api-Key is not found in request.
 */
interface ApiKey : Security {
    val param: Lens

    companion object {
        /**
         * Default implementation of ApiKey. Includes an option to NOT authorise OPTIONS requests, which is
         * currently not enabled for OpenAPI.
         */
        operator fun  invoke(param: Lens,
                                validateKey: (T) -> Boolean,
                                authorizeOptionsRequests: Boolean = true): ApiKey =
            object: ApiKey {
                override val param = param
                override val filter = Filter { next ->
                    {
                        if (!authorizeOptionsRequests && it.method == OPTIONS) {
                            next(it)
                        } else {
                            val keyValid = try {
                                validateKey(param(it))
                            } catch (e: LensFailure) {
                                false
                            }
                            if (keyValid) next(it) else Response(UNAUTHORIZED)
                        }
                    }
                }
            }
    }
}