Ktor API Key Authentication Provider
Simple authentication provider for Ktor that verifies presence of the API key in the header. Useful if you want to use X-Api-Key or similar approaches for request authentication.
Installation
Include following in your build.gradle.kts:
implementation("dev.forst", "ktor-api-key", "1.0.0")
Usage
This is minimal implementation of the Ktor app that uses API Key authentication:
keyFromHeader
.takeIf { it == expectedApiKey }
?.let { AppPrincipal(it) }
}
}
}
routing {
authenticate {
get {
val p = call.principal()!!
call.respondText("Key: ${p.key}")
}
}
}
}">
/** * Minimal Ktor application with API Key authentication. */ fun Application.minimalExample() { // key that will be used to authenticate requests val expectedApiKey = "this-is-expected-key" // principal for the app data class AppPrincipal(val key: String) : Principal // now we install authentication feature install(Authentication) { // and then api key provider apiKey { // set function that is used to verify request validate { keyFromHeader -> keyFromHeader .takeIf { it == expectedApiKey } ?.let { AppPrincipal(it) } } } } routing { authenticate { get { val p = call.principal<AppPrincipal>()!! call.respondText("Key: ${p.key}") } } } }
For details see MinimalExampleApp.kt with this example application and TestMinimalExampleApp.kt which verifies that this app works as expected.
For more advanced configuration see TestApiKeyAuth.kt.
2 Nov 11, 2021
4 Jun 18, 2022
48 Aug 30, 2022
56 Dec 28, 2022
255 Jan 3, 2023
91 Jan 4, 2023
11 Jun 10, 2022
3 Mar 23, 2022
0 May 2, 2022
29 Oct 3, 2022
2 Jan 18, 2022
1 Apr 9, 2022
0 Mar 25, 2022
2 Nov 4, 2021
0 Jan 14, 2022
32 Dec 20, 2022
0 Dec 4, 2021
11 Nov 9, 2022