Address SessionLimitStrategy

Closes gh-16206
This commit is contained in:
Claudenir Machado
2024-12-05 12:50:38 +00:00
committed by Josh Cummings
parent 6bc6946ad9
commit 1864577e98
14 changed files with 627 additions and 15 deletions

View File

@@ -33,6 +33,7 @@ import org.springframework.security.core.session.SessionRegistry;
import org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter;
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
import org.springframework.security.web.session.ConcurrentSessionFilter;
import org.springframework.security.web.session.SessionLimit;
import org.springframework.security.web.session.SessionManagementFilter;
import org.springframework.util.Assert;
@@ -76,7 +77,7 @@ public class ConcurrentSessionControlAuthenticationStrategy
private boolean exceptionIfMaximumExceeded = false;
private int maximumSessions = 1;
private SessionLimit sessionLimit = SessionLimit.of(1);
/**
* @param sessionRegistry the session registry which should be updated when the
@@ -130,7 +131,7 @@ public class ConcurrentSessionControlAuthenticationStrategy
* @return either -1 meaning unlimited, or a positive integer to limit (never zero)
*/
protected int getMaximumSessionsForThisUser(Authentication authentication) {
return this.maximumSessions;
return this.sessionLimit.apply(authentication);
}
/**
@@ -172,15 +173,24 @@ public class ConcurrentSessionControlAuthenticationStrategy
}
/**
* Sets the <tt>maxSessions</tt> property. The default value is 1. Use -1 for
* Sets the <tt>sessionLimit</tt> property. The default value is 1. Use -1 for
* unlimited sessions.
* @param maximumSessions the maximum number of permitted sessions a user can have
* open simultaneously.
*/
public void setMaximumSessions(int maximumSessions) {
Assert.isTrue(maximumSessions != 0,
"MaximumLogins must be either -1 to allow unlimited logins, or a positive integer to specify a maximum");
this.maximumSessions = maximumSessions;
this.sessionLimit = SessionLimit.of(maximumSessions);
}
/**
* Sets the <tt>sessionLimit</tt> property. The default value is 1. Use -1 for
* unlimited sessions.
* @param sessionLimit the session limit strategy
* @since 6.5
*/
public void setMaximumSessions(SessionLimit sessionLimit) {
Assert.notNull(sessionLimit, "sessionLimit cannot be null");
this.sessionLimit = sessionLimit;
}
/**

View File

@@ -0,0 +1,49 @@
/*
* Copyright 2015-2024 the original author or 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 org.springframework.security.web.session;
import java.util.function.Function;
import org.springframework.security.core.Authentication;
import org.springframework.util.Assert;
/**
* Represents the maximum number of sessions allowed. Use {@link #UNLIMITED} to indicate
* that there is no limit.
*
* @author Claudenir Freitas
* @since 6.5
*/
public interface SessionLimit extends Function<Authentication, Integer> {
/**
* Represents unlimited sessions.
*/
SessionLimit UNLIMITED = (authentication) -> -1;
/**
* Creates a {@link SessionLimit} that always returns the given value for any user
* @param maxSessions the maximum number of sessions allowed
* @return a {@link SessionLimit} instance that returns the given value.
*/
static SessionLimit of(int maxSessions) {
Assert.isTrue(maxSessions != 0,
"MaximumLogins must be either -1 to allow unlimited logins, or a positive integer to specify a maximum");
return (authentication) -> maxSessions;
}
}