pzampino commented on code in PR #615: URL: https://github.com/apache/knox/pull/615#discussion_r941771125
########## gateway-server/src/main/java/org/apache/knox/gateway/session/control/InMemoryConcurrentSessionVerifier.java: ########## @@ -0,0 +1,169 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * http://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.apache.knox.gateway.session.control; + + +import org.apache.commons.lang3.StringUtils; +import org.apache.knox.gateway.config.GatewayConfig; +import org.apache.knox.gateway.services.ServiceLifecycleException; +import org.apache.knox.gateway.services.security.token.impl.JWT; + +import java.util.Collections; +import java.util.Date; +import java.util.HashSet; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReentrantLock; + +public class InMemoryConcurrentSessionVerifier implements ConcurrentSessionVerifier { + private Set<String> privilegedUsers; + private Set<String> nonPrivilegedUsers; + private int privilegedUserConcurrentSessionLimit; + private int nonPrivilegedUserConcurrentSessionLimit; + private Map<String, Set<SessionJWT>> concurrentSessionCounter; + private final Lock sessionCountModifyLock = new ReentrantLock(); + + @Override + public boolean verifySessionForUser(String username, JWT jwtToken) { + if (!privilegedUsers.contains(username) && !nonPrivilegedUsers.contains(username)) { + return true; + } + + sessionCountModifyLock.lock(); + try { + int validTokenNumber = countValidTokensForUser(username); + if (privilegedUserCheckLimitReached(username, validTokenNumber) || nonPrivilegedUserCheckLimitReached(username, validTokenNumber)) { + return false; + } + concurrentSessionCounter.putIfAbsent(username, new HashSet<>()); + concurrentSessionCounter.compute(username, (key, sessionTokenSet) -> addTokenForUser(sessionTokenSet, jwtToken)); + } finally { + sessionCountModifyLock.unlock(); + } + return true; + } + + private int countValidTokensForUser(String username) { + return (int) concurrentSessionCounter + .getOrDefault(username, Collections.emptySet()) + .stream() + .filter(each -> !each.hasExpired()) + .count(); + } + + private boolean privilegedUserCheckLimitReached(String username, int validTokenNumber) { + if (privilegedUserConcurrentSessionLimit < 0) { + return false; + } + return privilegedUsers.contains(username) && (validTokenNumber >= privilegedUserConcurrentSessionLimit); + } + + private boolean nonPrivilegedUserCheckLimitReached(String username, int validTokenNumber) { + if (nonPrivilegedUserConcurrentSessionLimit < 0) { + return false; + } + return nonPrivilegedUsers.contains(username) && (validTokenNumber >= nonPrivilegedUserConcurrentSessionLimit); + } + + @Override + public void sessionEndedForUser(String username, String token) { + if (StringUtils.isNotBlank(token)) { + sessionCountModifyLock.lock(); + try { + concurrentSessionCounter.computeIfPresent(username, (key, sessionTokenSet) -> removeTokenFromUser(sessionTokenSet, token)); + } finally { + sessionCountModifyLock.unlock(); + } + } + } + + private Set<SessionJWT> removeTokenFromUser(Set<SessionJWT> sessionTokenSet, String token) { + sessionTokenSet.removeIf(sessionToken -> sessionToken.getToken().equals(token)); + if (sessionTokenSet.isEmpty()) { + return null; + } + return sessionTokenSet; + } + + private Set<SessionJWT> addTokenForUser(Set<SessionJWT> sessionTokenSet, JWT jwtToken) { + sessionTokenSet.add(new SessionJWT(jwtToken)); + return sessionTokenSet; + } + + @Override + public void init(GatewayConfig config, Map<String, String> options) throws ServiceLifecycleException { + this.privilegedUsers = config.getPrivilegedUsers(); + this.nonPrivilegedUsers = config.getNonPrivilegedUsers(); Review Comment: Does this represent a configured set of non-privileged users for whom a concurrent session limit will be applied? If so, why can't any user who is NOT configured as a member of the privileged users set be treated as a non-privileged user? Why do we need a separate configuration for these non-privileged users? What happens to those users who are in neither configured set? Do they get as many sessions as they want? ########## gateway-server/src/main/java/org/apache/knox/gateway/session/control/InMemoryConcurrentSessionVerifier.java: ########## @@ -0,0 +1,169 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * http://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.apache.knox.gateway.session.control; + + +import org.apache.commons.lang3.StringUtils; +import org.apache.knox.gateway.config.GatewayConfig; +import org.apache.knox.gateway.services.ServiceLifecycleException; +import org.apache.knox.gateway.services.security.token.impl.JWT; + +import java.util.Collections; +import java.util.Date; +import java.util.HashSet; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReentrantLock; + +public class InMemoryConcurrentSessionVerifier implements ConcurrentSessionVerifier { + private Set<String> privilegedUsers; + private Set<String> nonPrivilegedUsers; + private int privilegedUserConcurrentSessionLimit; + private int nonPrivilegedUserConcurrentSessionLimit; + private Map<String, Set<SessionJWT>> concurrentSessionCounter; + private final Lock sessionCountModifyLock = new ReentrantLock(); + + @Override + public boolean verifySessionForUser(String username, JWT jwtToken) { + if (!privilegedUsers.contains(username) && !nonPrivilegedUsers.contains(username)) { + return true; + } + + sessionCountModifyLock.lock(); + try { + int validTokenNumber = countValidTokensForUser(username); + if (privilegedUserCheckLimitReached(username, validTokenNumber) || nonPrivilegedUserCheckLimitReached(username, validTokenNumber)) { + return false; + } + concurrentSessionCounter.putIfAbsent(username, new HashSet<>()); + concurrentSessionCounter.compute(username, (key, sessionTokenSet) -> addTokenForUser(sessionTokenSet, jwtToken)); + } finally { + sessionCountModifyLock.unlock(); + } + return true; + } + + private int countValidTokensForUser(String username) { + return (int) concurrentSessionCounter + .getOrDefault(username, Collections.emptySet()) + .stream() + .filter(each -> !each.hasExpired()) + .count(); + } + + private boolean privilegedUserCheckLimitReached(String username, int validTokenNumber) { + if (privilegedUserConcurrentSessionLimit < 0) { + return false; + } + return privilegedUsers.contains(username) && (validTokenNumber >= privilegedUserConcurrentSessionLimit); + } + + private boolean nonPrivilegedUserCheckLimitReached(String username, int validTokenNumber) { + if (nonPrivilegedUserConcurrentSessionLimit < 0) { + return false; + } + return nonPrivilegedUsers.contains(username) && (validTokenNumber >= nonPrivilegedUserConcurrentSessionLimit); + } + + @Override + public void sessionEndedForUser(String username, String token) { + if (StringUtils.isNotBlank(token)) { + sessionCountModifyLock.lock(); + try { + concurrentSessionCounter.computeIfPresent(username, (key, sessionTokenSet) -> removeTokenFromUser(sessionTokenSet, token)); Review Comment: I think this could result in a NullPointerException if the username is null. It may be good to validate that parameter along with the token? ########## gateway-spi/src/main/java/org/apache/knox/gateway/session/control/ConcurrentSessionVerifier.java: ########## @@ -0,0 +1,28 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * http://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.apache.knox.gateway.session.control; + +import org.apache.knox.gateway.services.Service; +import org.apache.knox.gateway.services.security.token.impl.JWT; + +public interface ConcurrentSessionVerifier extends Service { + boolean verifySessionForUser(String username, JWT JWToken); Review Comment: This verify method answers the question of whether or not the specified user is permitted to have a[nother] session? Some javadoc may be helpful here. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
