Skip to content

Add OIDC token validation and Bearer auth #5639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Pantus Oleh (zibet27) wants to merge 1 commit into
base: zibet27/oidc-provider-lifecycle
Choose a base branch
from
Open

Add OIDC token validation and Bearer auth #5639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 210 additions & 0 deletions ktor-server/ktor-server-plugins/ktor-server-auth-oidc/api/ktor-server-auth-oidc.api
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
public final class io/ktor/server/auth/oidc/Oidc {
public static final field Companion Lio/ktor/server/auth/oidc/Oidc$Companion;
public final fun provider (Ljava/lang/String;Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public final fun provider (Ljava/lang/String;Lkotlin/reflect/KClass;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
}

public final class io/ktor/server/auth/oidc/Oidc$Companion : io/ktor/server/application/BaseApplicationPlugin {
Expand All @@ -9,6 +10,42 @@ public final class io/ktor/server/auth/oidc/Oidc$Companion : io/ktor/server/appl
public synthetic fun install (Lio/ktor/util/pipeline/Pipeline;Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;
}

public final class io/ktor/server/auth/oidc/OidcAccessTokenConfig {
public final fun getAudiences ()Ljava/util/Set;
public final fun setAudiences (Ljava/util/Set;)V
}

public final class io/ktor/server/auth/oidc/OidcAuthenticatedContextKt {
public static final fun getProvider (Lio/ktor/server/auth/oidc/OidcProviderContext;)Lio/ktor/server/auth/oidc/OidcProvider;
}

public final class io/ktor/server/auth/oidc/OidcBearerConfig {
public final fun getTokenExtractor ()Lkotlin/jvm/functions/Function1;
public final fun setTokenExtractor (Lkotlin/jvm/functions/Function1;)V
}

public final class io/ktor/server/auth/oidc/OidcBearerContext : io/ktor/server/auth/oidc/OidcProviderContext, io/ktor/server/auth/typesafe/AuthenticatedContext {
public fun principal (Lio/ktor/server/routing/RoutingContext;)Ljava/lang/Object;
public fun provider ()Lio/ktor/server/auth/oidc/OidcProvider;
}

public final class io/ktor/server/auth/oidc/OidcJwtConfig {
public final fun disableJwkCache ()V
public final fun disableJwkRateLimit ()V
public final fun getAllowedAlgorithms ()Ljava/util/Set;
public final fun getClockSkew-UwyO8pc ()J
public final fun getJwkBuilder ()Lkotlin/jvm/functions/Function1;
public final fun getJwkProviderFactory ()Lkotlin/jvm/functions/Function1;
public final fun jwkCache-HG0u8IE (JJ)V
public static synthetic fun jwkCache-HG0u8IE$default (Lio/ktor/server/auth/oidc/OidcJwtConfig;JJILjava/lang/Object;)V
public final fun jwkRateLimit-HG0u8IE (JJ)V
public static synthetic fun jwkRateLimit-HG0u8IE$default (Lio/ktor/server/auth/oidc/OidcJwtConfig;JJILjava/lang/Object;)V
public final fun setAllowedAlgorithms (Ljava/util/Set;)V
public final fun setClockSkew-LRDsOJo (J)V
public final fun setJwkBuilder (Lkotlin/jvm/functions/Function1;)V
public final fun setJwkProviderFactory (Lkotlin/jvm/functions/Function1;)V
}

public final class io/ktor/server/auth/oidc/OidcKt {
public static final fun getOidcMetadataRefreshFailed ()Lio/ktor/events/EventDefinition;
public static final fun openIdConnect (Lio/ktor/server/application/Application;)Lio/ktor/server/auth/oidc/Oidc;
Expand Down Expand Up @@ -39,16 +76,171 @@ public final class io/ktor/server/auth/oidc/OidcPluginConfig {
}

public final class io/ktor/server/auth/oidc/OidcProvider {
public final fun currentJwkProvider ()Lcom/auth0/jwk/JwkProvider;
public final fun currentMetadata ()Lio/ktor/server/auth/oidc/OpenIdProviderMetadata;
public final fun getBearer ()Lio/ktor/server/auth/typesafe/DefaultAuthScheme;
public final fun getIssuer ()Ljava/lang/String;
public final fun getName ()Ljava/lang/String;
}

public final class io/ktor/server/auth/oidc/OidcProviderConfig {
public field issuer Ljava/lang/String;
public final fun accessToken (Lkotlin/jvm/functions/Function1;)V
public final fun bearer (Lkotlin/jvm/functions/Function1;)V
public static synthetic fun bearer$default (Lio/ktor/server/auth/oidc/OidcProviderConfig;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)V
public final fun getIssuer ()Ljava/lang/String;
public final fun getMetadata ()Lio/ktor/server/auth/oidc/OpenIdProviderMetadata;
public final fun getName ()Ljava/lang/String;
public final fun jwt (Lkotlin/jvm/functions/Function1;)V
public final fun setIssuer (Ljava/lang/String;)V
public final fun setMetadata (Lio/ktor/server/auth/oidc/OpenIdProviderMetadata;)V
}

public abstract interface class io/ktor/server/auth/oidc/OidcProviderContext {
public abstract fun provider ()Lio/ktor/server/auth/oidc/OidcProvider;
}

public abstract class io/ktor/server/auth/oidc/OidcToken {
public static final field Companion Lio/ktor/server/auth/oidc/OidcToken$Companion;
public synthetic fun <init> (ILkotlinx/serialization/internal/SerializationConstructorMarker;)V
public static final synthetic fun write$Self (Lio/ktor/server/auth/oidc/OidcToken;Lkotlinx/serialization/encoding/CompositeEncoder;Lkotlinx/serialization/descriptors/SerialDescriptor;)V
}

public final class io/ktor/server/auth/oidc/OidcToken$Access : io/ktor/server/auth/oidc/OidcToken {
public static final field Companion Lio/ktor/server/auth/oidc/OidcToken$Access$Companion;
public final fun getClaims ()Lio/ktor/server/auth/oidc/TokenClaims;
public final fun getClientId ()Ljava/lang/String;
public final fun getUserInfo ()Lio/ktor/server/auth/oidc/OidcToken$UserInfo;
public final fun getValue ()Ljava/lang/String;
}

public final synthetic class io/ktor/server/auth/oidc/OidcToken$Access$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
public static final field INSTANCE Lio/ktor/server/auth/oidc/OidcToken$Access$$serializer;
public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Lio/ktor/server/auth/oidc/OidcToken$Access;
public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Lio/ktor/server/auth/oidc/OidcToken$Access;)V
public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OidcToken$Access$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OidcToken$Companion {
public final fun getSerializersModule ()Lkotlinx/serialization/modules/SerializersModule;
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OidcToken$Id : io/ktor/server/auth/oidc/OidcToken {
public static final field Companion Lio/ktor/server/auth/oidc/OidcToken$Id$Companion;
public final fun getAccessToken ()Ljava/lang/String;
public final fun getAccessTokenClaims ()Lio/ktor/server/auth/oidc/TokenClaims;
public final fun getClaims ()Lio/ktor/server/auth/oidc/TokenClaims;
public final fun getRefreshToken ()Ljava/lang/String;
public final fun getUserInfo ()Lio/ktor/server/auth/oidc/OidcToken$UserInfo;
public final fun getValue ()Ljava/lang/String;
}

public final synthetic class io/ktor/server/auth/oidc/OidcToken$Id$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
public static final field INSTANCE Lio/ktor/server/auth/oidc/OidcToken$Id$$serializer;
public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Lio/ktor/server/auth/oidc/OidcToken$Id;
public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Lio/ktor/server/auth/oidc/OidcToken$Id;)V
public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OidcToken$Id$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OidcToken$Opaque : io/ktor/server/auth/oidc/OidcToken {
public static final field Companion Lio/ktor/server/auth/oidc/OidcToken$Opaque$Companion;
public final fun getIntrospection ()Lio/ktor/server/auth/oidc/OpaqueTokenIntrospection;
public final fun getValue ()Ljava/lang/String;
}

public final synthetic class io/ktor/server/auth/oidc/OidcToken$Opaque$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
public static final field INSTANCE Lio/ktor/server/auth/oidc/OidcToken$Opaque$$serializer;
public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Lio/ktor/server/auth/oidc/OidcToken$Opaque;
public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Lio/ktor/server/auth/oidc/OidcToken$Opaque;)V
public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OidcToken$Opaque$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OidcToken$UserInfo {
public static final field Companion Lio/ktor/server/auth/oidc/OidcToken$UserInfo$Companion;
public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun getEmail ()Ljava/lang/String;
public final fun getEmailVerified ()Ljava/lang/Boolean;
public final fun getFamilyName ()Ljava/lang/String;
public final fun getGivenName ()Ljava/lang/String;
public final fun getName ()Ljava/lang/String;
public final fun getPicture ()Ljava/lang/String;
public final fun getPreferredUsername ()Ljava/lang/String;
public final fun getSubject ()Ljava/lang/String;
}

public final synthetic class io/ktor/server/auth/oidc/OidcToken$UserInfo$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
public static final field INSTANCE Lio/ktor/server/auth/oidc/OidcToken$UserInfo$$serializer;
public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Lio/ktor/server/auth/oidc/OidcToken$UserInfo;
public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Lio/ktor/server/auth/oidc/OidcToken$UserInfo;)V
public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OidcToken$UserInfo$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OpaqueTokenIntrospection {
public static final field Companion Lio/ktor/server/auth/oidc/OpaqueTokenIntrospection$Companion;
public fun <init> (ZLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Long;Ljava/lang/Long;Ljava/lang/Long;Ljava/lang/String;Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Lkotlinx/serialization/json/JsonObject;)V
public synthetic fun <init> (ZLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Long;Ljava/lang/Long;Ljava/lang/Long;Ljava/lang/String;Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Lkotlinx/serialization/json/JsonObject;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun getActive ()Z
public final fun getAudience ()Ljava/util/List;
public final fun getClaims ()Lkotlinx/serialization/json/JsonObject;
public final fun getClientId ()Ljava/lang/String;
public final fun getExpiresAt ()Ljava/lang/Long;
public final fun getIssuedAt ()Ljava/lang/Long;
public final fun getIssuer ()Ljava/lang/String;
public final fun getJwtId ()Ljava/lang/String;
public final fun getNotBefore ()Ljava/lang/Long;
public final fun getScope ()Ljava/lang/String;
public final fun getSubject ()Ljava/lang/String;
public final fun getTokenType ()Ljava/lang/String;
public final fun getUsername ()Ljava/lang/String;
}

public final synthetic class io/ktor/server/auth/oidc/OpaqueTokenIntrospection$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
public static final field INSTANCE Lio/ktor/server/auth/oidc/OpaqueTokenIntrospection$$serializer;
public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Lio/ktor/server/auth/oidc/OpaqueTokenIntrospection;
public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Lio/ktor/server/auth/oidc/OpaqueTokenIntrospection;)V
public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OpaqueTokenIntrospection$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/ktor/server/auth/oidc/OpenIdDiscoveryException : java/lang/RuntimeException {
Expand Down Expand Up @@ -118,3 +310,21 @@ public final class io/ktor/server/auth/oidc/OpenIdProviderMetadataKt {
public static final fun fetchOpenIdMetadata (Lio/ktor/client/HttpClient;Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
}

public final class io/ktor/server/auth/oidc/TokenClaims {
public final fun claim (Ljava/lang/String;)Lkotlinx/serialization/json/JsonElement;
public final fun claimString (Ljava/lang/String;)Ljava/lang/String;
public final fun getAlgorithm ()Ljava/lang/String;
public final fun getAudience ()Ljava/util/List;
public final fun getExpiresAt ()Lkotlin/time/Instant;
public final fun getHeader ()Lkotlinx/serialization/json/JsonObject;
public final fun getIssuedAt ()Lkotlin/time/Instant;
public final fun getIssuer ()Ljava/lang/String;
public final fun getJwtId ()Ljava/lang/String;
public final fun getKeyId ()Ljava/lang/String;
public final fun getNotBefore ()Lkotlin/time/Instant;
public final fun getPayload ()Lkotlinx/serialization/json/JsonObject;
public final fun getSubject ()Ljava/lang/String;
public final fun getType ()Ljava/lang/String;
public final fun headerString (Ljava/lang/String;)Ljava/lang/String;
}

10 changes: 8 additions & 2 deletions ktor-server/ktor-server-plugins/ktor-server-auth-oidc/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,25 @@ plugins {
}

kotlin {
compilerOptions {
freeCompilerArgs.add("-Xcontext-parameters")
}

sourceSets {
jvmMain.dependencies {
api(projects.ktorServerCore)
api(projects.ktorServerAuth)
api(projects.ktorServerAuthJwt)
api(projects.ktorClientCore)
api(projects.ktorClientContentNegotiation)
api(projects.ktorSerializationKotlinxJson)
api(libs.kotlinx.serialization.json)
api(projects.ktorClientContentNegotiation)
api(projects.ktorSerializationKotlinxJson)
}
jvmTest.dependencies {
implementation(projects.ktorServerTestHost)
implementation(projects.ktorServerContentNegotiation)
implementation(projects.ktorServerCio)
implementation(projects.ktorClientMock)
}
}
}
Loading
Loading