org.springframework.security.web.authentication.preauth.websphere.WebSpherePreAuthenticatedWebAuthenticationDetailsSource Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-security-web Show documentation
spring-security-web
There is a newer version: 6.3.3
/*
 * Copyright 2002-2016 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.authentication.preauth.websphere;

import java.util.Collection;
import java.util.List;

import jakarta.servlet.http.HttpServletRequest;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.core.log.LogMessage;
import org.springframework.security.authentication.AuthenticationDetailsSource;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.authority.mapping.Attributes2GrantedAuthoritiesMapper;
import org.springframework.security.core.authority.mapping.SimpleAttributes2GrantedAuthoritiesMapper;
import org.springframework.security.web.authentication.preauth.PreAuthenticatedGrantedAuthoritiesWebAuthenticationDetails;

/**
 * This AuthenticationDetailsSource implementation will set the pre-authenticated granted
 * authorities based on the WebSphere groups for the current WebSphere user, mapped using
 * the configured Attributes2GrantedAuthoritiesMapper.
 *
 * @author Ruud Senden
 */
public class WebSpherePreAuthenticatedWebAuthenticationDetailsSource implements
		AuthenticationDetailsSource {

	private final Log logger = LogFactory.getLog(getClass());

	private Attributes2GrantedAuthoritiesMapper webSphereGroups2GrantedAuthoritiesMapper = new SimpleAttributes2GrantedAuthoritiesMapper();

	private final WASUsernameAndGroupsExtractor wasHelper;

	public WebSpherePreAuthenticatedWebAuthenticationDetailsSource() {
		this(new DefaultWASUsernameAndGroupsExtractor());
	}

	public WebSpherePreAuthenticatedWebAuthenticationDetailsSource(WASUsernameAndGroupsExtractor wasHelper) {
		this.wasHelper = wasHelper;
	}

	@Override
	public PreAuthenticatedGrantedAuthoritiesWebAuthenticationDetails buildDetails(HttpServletRequest context) {
		return new PreAuthenticatedGrantedAuthoritiesWebAuthenticationDetails(context,
				getWebSphereGroupsBasedGrantedAuthorities());
	}

	/**
	 * Get a list of Granted Authorities based on the current user's WebSphere groups.
	 * @return authorities mapped from the user's WebSphere groups.
	 */
	private Collection getWebSphereGroupsBasedGrantedAuthorities() {
		List webSphereGroups = this.wasHelper.getGroupsForCurrentUser();
		Collection userGas = this.webSphereGroups2GrantedAuthoritiesMapper
			.getGrantedAuthorities(webSphereGroups);
		this.logger.debug(
				LogMessage.format("WebSphere groups: %s mapped to Granted Authorities: %s", webSphereGroups, userGas));
		return userGas;
	}

	/**
	 * @param mapper The Attributes2GrantedAuthoritiesMapper to use for converting the WAS
	 * groups to authorities
	 */
	public void setWebSphereGroups2GrantedAuthoritiesMapper(Attributes2GrantedAuthoritiesMapper mapper) {
		this.webSphereGroups2GrantedAuthoritiesMapper = mapper;
	}

}