Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
package io.micronaut.security.token.jwt.cookie

import io.micronaut.context.ApplicationContext
import io.micronaut.context.exceptions.NoSuchBeanException
import io.micronaut.security.testutils.ApplicationContextSpecification
import io.micronaut.security.token.cookie.AccessTokenCookieConfiguration
import io.micronaut.security.token.cookie.CookieTokenReader
import io.micronaut.security.token.cookie.TokenCookieClearerLogoutHandler
import io.micronaut.security.token.cookie.TokenCookieConfigurationProperties
import io.micronaut.security.token.cookie.TokenCookieLoginHandler
import spock.lang.Unroll

class CookieEnabledSpec extends ApplicationContextSpecification {
Expand Down Expand Up @@ -34,4 +37,42 @@ class CookieEnabledSpec extends ApplicationContextSpecification {

description = clazz.name
}

void "cookie token reader can be enabled without cookie authentication mode"() {
given:
ApplicationContext ctx = ApplicationContext.run([
'micronaut.security.token.cookie.enabled': true,
])

expect:
ctx.containsBean(AccessTokenCookieConfiguration)
ctx.containsBean(TokenCookieConfigurationProperties)
ctx.containsBean(CookieTokenReader)
!ctx.containsBean(TokenCookieLoginHandler)
!ctx.containsBean(TokenCookieClearerLogoutHandler)

cleanup:
ctx.close()
}

@Unroll("without cookie authentication mode or explicit opt-in bean [#description] is not loaded")
void "cookie token beans are not loaded without authentication mode or explicit opt-in"(Class clazz, String description) {
given:
ApplicationContext ctx = ApplicationContext.run([:])

expect:
!ctx.containsBean(clazz)

cleanup:
ctx.close()

where:
clazz << [
AccessTokenCookieConfiguration,
TokenCookieConfigurationProperties,
CookieTokenReader,
]

description = clazz.name
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import io.micronaut.core.util.StringUtils;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.cookie.Cookie;
import io.micronaut.security.authentication.CookieBasedAuthenticationModeCondition;
import io.micronaut.security.token.reader.TokenReader;
import jakarta.inject.Singleton;

Expand All @@ -32,7 +31,7 @@
* @since 1.0
*/
@Requires(classes = HttpRequest.class)
@Requires(condition = CookieBasedAuthenticationModeCondition.class)
@Requires(condition = TokenCookieEnabledCondition.class)
Comment thread
sdelamo marked this conversation as resolved.
@Requires(property = TokenCookieConfigurationProperties.PREFIX + ".enabled", notEquals = StringUtils.FALSE, defaultValue = StringUtils.TRUE)
@Singleton
public class CookieTokenReader implements TokenReader<HttpRequest<?>> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import org.jspecify.annotations.Nullable;
import io.micronaut.core.util.StringUtils;
import io.micronaut.http.cookie.CookieConfiguration;
import io.micronaut.security.authentication.CookieBasedAuthenticationModeCondition;
import io.micronaut.security.token.config.TokenConfigurationProperties;
import java.util.Optional;

Expand All @@ -31,7 +30,7 @@
* @since 1.0
*/
@Requires(classes = CookieConfiguration.class)
@Requires(condition = CookieBasedAuthenticationModeCondition.class)
@Requires(condition = TokenCookieEnabledCondition.class)
@Requires(property = TokenCookieConfigurationProperties.PREFIX + ".enabled", notEquals = StringUtils.FALSE, defaultValue = StringUtils.TRUE)
@ConfigurationProperties(TokenCookieConfigurationProperties.PREFIX)
public class TokenCookieConfigurationProperties extends AbstractAccessTokenCookieConfigurationProperties implements AccessTokenCookieConfiguration {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/*
* Copyright 2017-2026 original authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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 io.micronaut.security.token.cookie;

import io.micronaut.context.condition.Condition;
import io.micronaut.context.condition.ConditionContext;
import io.micronaut.core.value.PropertyResolver;
import io.micronaut.security.authentication.CookieBasedAuthenticationModeCondition;

/**
* Condition that enables access-token cookie reading for cookie authentication modes or explicit opt-in.
*/
final class TokenCookieEnabledCondition implements Condition {

private final CookieBasedAuthenticationModeCondition cookieBasedAuthenticationModeCondition =
new CookieBasedAuthenticationModeCondition();

@Override
public boolean matches(ConditionContext context) {
PropertyResolver propertyResolver = context.getBeanContext().getBean(PropertyResolver.class);
String propertyName = TokenCookieConfigurationProperties.PREFIX + ".enabled";
return propertyResolver.containsProperty(propertyName)
&& propertyResolver.get(propertyName, Boolean.class).orElse(false)
|| cookieBasedAuthenticationModeCondition.matches(context);
Comment thread
sdelamo marked this conversation as resolved.
Outdated
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The following sequence illustrates the authentication flow:
image::jwt-cookie.svg[]

Reading tokens from Cookies is disabled by default. Note that using JWT tokens from cookies requires JWT Authentication to be enabled.
Set `micronaut.security.token.cookie.enabled=true` to read JWT tokens from cookies without enabling Cookie Authentication login and logout handlers.

include::{includedir}configurationProperties/io.micronaut.security.token.cookie.TokenCookieConfigurationProperties.adoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
api:io.micronaut.security.token.cookie.CookieTokenReader[] attempts to read token from a request cookie.

Set `micronaut.security.token.cookie.enabled=true` to enable cookie token reading without enabling the Cookie Authentication login and logout handlers.

The following configuration properties are available to customize how the token will be read from a cookie:

include::{includedir}configurationProperties/io.micronaut.security.token.cookie.TokenCookieConfigurationProperties.adoc[]
Loading