Spring security with thymeleaf - zhouted/zhouted.github.io GitHub Wiki

import java.util.Arrays;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.access.AccessDecisionManager;
import org.springframework.security.access.AccessDecisionVoter;
import org.springframework.security.access.vote.AuthenticatedVoter;
import org.springframework.security.access.vote.UnanimousBased;
import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.builders.WebSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.web.access.expression.WebExpressionVoter;
import org.springframework.security.web.authentication.AuthenticationFailureHandler;
import org.springframework.security.web.authentication.logout.LogoutSuccessHandler;
import org.springframework.session.web.http.HttpSessionIdResolver;

@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfig extends WebSecurityConfigurerAdapter {
	@Autowired
	private AuthProviderUsernamePassword authProviderUsernamePassword;
	@Autowired
	private AuthSuccessHandler authSuccessHandler;
	@Autowired
	private AuthFailureHandler authFailureHandler;
	@Autowired
	private ExitSuccessHandler exitSuccessHandler;
	
	@Bean
	protected AuthenticationFailureHandler authenticationFailureHandler() {
		authFailureHandler.setDefaultFailureUrl("/login?error");
		return authFailureHandler;
	}
	
	@Bean
	protected LogoutSuccessHandler logoutSuccessHandler() {
		exitSuccessHandler.setDefaultTargetUrl("/login?logout");
		return exitSuccessHandler;
	}

	private static String[] INGORE_URLS = {"/login", "/error",};

	@Override
	public void configure(WebSecurity webSecurity) {
		webSecurity.ignoring().antMatchers("/static/**");//忽略静态资源
		webSecurity.ignoring().antMatchers("/favicon.ico");
	}

	@Override
	protected void configure(HttpSecurity httpSecurity) throws Exception {
		httpSecurity
			.authorizeRequests()
				.antMatchers(INGORE_URLS).permitAll()
				.anyRequest().authenticated()
				.accessDecisionManager(accessDecisionManager())//如果不需要权限验证，去掉这句即可
		.and()
		    .formLogin()
		        .successHandler(authSuccessHandler)
		        .failureHandler(authFailureHandler)
		        .loginPage("/login")//.permitAll()
		.and()
			.logout()
				.logoutSuccessHandler(logoutSuccessHandler())//.permitAll()
		//.and().rememberMe()
		.and().csrf().disable();
	}
	
	@Override
	protected void configure(AuthenticationManagerBuilder auth) throws Exception {
		auth.authenticationProvider(authProviderUsernamePassword);
		//auth.authenticationProvider(authProvider2);可以增加多个认证方式，比如码验证等
	}

	@Bean
    protected AccessDecisionManager accessDecisionManager() {
        List<AccessDecisionVoter<? extends Object>> decisionVoters = Arrays.asList(
            new WebExpressionVoter(),
            authDecisionVoter(),//new RoleVoter(),
            new AuthenticatedVoter());
        return new UnanimousBased(decisionVoters);
    }
	
	@Bean
	protected AuthDecisionVoter authDecisionVoter() {
		return new AuthDecisionVoter();
	}
	
	@Bean
	public HttpSessionIdResolver httpSessionIdResolver() {
		return new HeaderCookieHttpSessionIdResolver();
	}
}

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.authentication.AuthenticationProvider;
import org.springframework.security.authentication.BadCredentialsException;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.AuthenticationException;
import org.springframework.stereotype.Component;

@Component
public class AuthProviderUsernamePassword implements AuthenticationProvider {
	@Autowired 
	AuthUserService authUserService;

	@Override
	public Authentication authenticate(Authentication authentication) throws AuthenticationException {
        String username = authentication.getName();  
        String password = authentication.getCredentials().toString();  
		AuthUser userDetails = authUserService.loadUserByUsername(username);
        if(userDetails == null){  
            throw new BadCredentialsException("账号或密码错误");  
        }  
        if (!authUserService.checkPassword(userDetails, password)) {  
            throw new BadCredentialsException("账号或密码不正确");  
        }  
        //认证校验通过后，封装UsernamePasswordAuthenticationToken返回  
        return new UsernamePasswordAuthenticationToken(userDetails, password, authUserService.fillUserAuthorities(userDetails));  
	}

	@Override
	public boolean supports(Class<?> authentication) {
		return true;
	}
}

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.security.core.Authentication;
import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
import org.springframework.security.web.savedrequest.HttpSessionRequestCache;
import org.springframework.security.web.savedrequest.RequestCache;
import org.springframework.security.web.savedrequest.SavedRequest;
import org.springframework.stereotype.Component;

@Component
public class AuthSuccessHandler extends SavedRequestAwareAuthenticationSuccessHandler {
	private RequestCache requestCache = new HttpSessionRequestCache();

	@Override
	public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response,
			Authentication authentication) throws ServletException, IOException {
		//登录成功处理，比如记录登录日志
		String ip = request.getRemoteAddr();
		String targetUrl = "";
		SavedRequest savedRequest = requestCache.getRequest(request, response);
		if (savedRequest != null) {
			targetUrl = savedRequest.getRedirectUrl();
		}
		AuthUser aUser = (AuthUser) authentication.getPrincipal();
		System.out.printf("User %s login, ip: %s, url: ", aUser.getUsername(), ip, targetUrl);
		
		if (WebUtils.isAjaxReq(request)) {//ajax登录
			response.sendError(200, "success");
            return;
		}
		super.onAuthenticationSuccess(request, response, authentication);
	}
}

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.security.core.Authentication;
import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
import org.springframework.security.web.savedrequest.HttpSessionRequestCache;
import org.springframework.security.web.savedrequest.RequestCache;
import org.springframework.security.web.savedrequest.SavedRequest;
import org.springframework.stereotype.Component;

@Component
public class AuthFailureHandler extends SimpleUrlAuthenticationFailureHandler {
	@Override
	public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response,
			AuthenticationException exception) throws IOException, ServletException {
		String uaSummary = WebUtils.getUserAgentSummary(request);
		String ip = request.getRemoteAddr();
		String username = request.getParameter("username");
		System.out.printf("User %s login failed, ip: %s, ua: %s", username, ip, uaSummary);
		super.saveException(request, exception);
		if (WebUtils.isAjaxReq(request)) {//ajax登录
		    //为什么用sendError会导致302重定向到login页面?
		    //--When you invoke sendError it will dispatch the request to /error (it the error handling code registered by Spring Boot. However, Spring Security will intercept /error and see that you are not authenticated and thus redirect you to a log in form.
			response.sendError(403, exception.getMessage());
			return;
		}
		response.sendRedirect("login?error");
	}
}

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.security.core.Authentication;
import org.springframework.security.web.authentication.logout.SimpleUrlLogoutSuccessHandler;
import org.springframework.stereotype.Component;

@Component
public class ExitSuccessHandler extends SimpleUrlLogoutSuccessHandler {
	@Override
	public void onLogoutSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication)
			throws IOException, ServletException {
		if (WebUtils.isAjaxReq(request)) {//ajax登录
			response.sendError(200, "success");
			return;
		}
		super.onLogoutSuccess(request, response, authentication);
	}
}

import java.util.List;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.session.web.http.CookieHttpSessionIdResolver;
import org.springframework.session.web.http.HeaderHttpSessionIdResolver;
import org.springframework.session.web.http.HttpSessionIdResolver;

public class HeaderCookieHttpSessionIdResolver implements HttpSessionIdResolver {
	protected HeaderHttpSessionIdResolver headerResolver = HeaderHttpSessionIdResolver.xAuthToken();
	protected CookieHttpSessionIdResolver cookieResolver = new CookieHttpSessionIdResolver();

	@Override
	public List<String> resolveSessionIds(HttpServletRequest request) {
		List<String> sessionIds = headerResolver.resolveSessionIds(request);
		if (sessionIds.isEmpty()) {
			sessionIds = cookieResolver.resolveSessionIds(request);
		}
		return sessionIds;
	}

	@Override
	public void setSessionId(HttpServletRequest request, HttpServletResponse response, String sessionId) {
		headerResolver.setSessionId(request, response, sessionId);
		cookieResolver.setSessionId(request, response, sessionId);
	}

	@Override
	public void expireSession(HttpServletRequest request, HttpServletResponse response) {
		headerResolver.expireSession(request, response);
		cookieResolver.expireSession(request, response);
	}
}

import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import javax.persistence.Id;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.authority.AuthorityUtils;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.util.StringUtils;
import lombok.Data;

@Data
public class AuthUser implements UserDetails, Serializable {
	private static final long serialVersionUID = -1572872798317304041L;
	
	@Id
	private Long id;
	private String username;
	private String password;
	
	private Collection<? extends GrantedAuthority> authorities;

	public Collection<? extends GrantedAuthority> fillPerms(List<String> perms) {
		String authorityString = StringUtils.collectionToCommaDelimitedString(perms);
		authorities = AuthorityUtils.commaSeparatedStringToAuthorityList(authorityString);
		return authorities;
	}

	@Override
	public Collection<? extends GrantedAuthority> getAuthorities() {
		return authorities;
	}

	@Override
	public boolean isAccountNonExpired() {
		return true;
	}

	@Override
	public boolean isAccountNonLocked() {
		return true;
	}

	@Override
	public boolean isCredentialsNonExpired() {
		return true;
	}

	@Override
	public boolean isEnabled() {
		return true;
	}
}

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.joda.time.LocalDateTime;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.stereotype.Service;

@Service
public class AuthUserService implements UserDetailsService {
	@Override
	public AuthUser loadUserByUsername(String username) throws UsernameNotFoundException {
		//读取用户，一般是从数据库读取，这里随便new一个
		AuthUser user = new AuthUser();// userDao.findByUsername(username);
		user.setId(System.currentTimeMillis());
		user.setUsername(username);
		user.setPassword(username);
		return user;
	}
	
	public boolean checkPassword(AuthUser user, String pwd) {
		//判断用户密码，这里简单判断相等
		if (pwd != null && pwd.equals(user.getPassword())) {
			return true;
		}
		return false;
	}

	public Collection<? extends GrantedAuthority> fillUserAuthorities(AuthUser aUser) {
		//获取用户权限，一般从数据库读取，并缓存。这里随便拼凑
		List<String> perms = new ArrayList<>(); //permDao.findPermByUserId(aUser.getId());
		LocalDateTime now = LocalDateTime.now();
		perms.add("P"+now.getHourOfDay());
		perms.add("P"+now.getMinuteOfHour());
		perms.add("P"+now.getSecondOfMinute());
		return aUser.fillPerms(perms);
	}
}

import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class AuthController {
	@RequestMapping("/login")//登录入口
	String login(String username, Model model) {
		model.addAttribute("username", username);
		return "login";
	}
	
	@RequestMapping("/")//主页
	@ResponseBody
	Object home(@AuthenticationPrincipal AuthUser currentUser) {
		return currentUser;
	}
	
	@RequestMapping("/{path}")//测试用
	@ResponseBody
	Object url1(@PathVariable String path) {
        if (path.contains("0")) {//模拟错误
			path = String.valueOf(1/0);
		}
		return path;
	}
}

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.springframework.security.access.AccessDecisionVoter;
import org.springframework.security.access.ConfigAttribute;
import org.springframework.security.access.SecurityConfig;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.web.FilterInvocation;
import org.springframework.util.StringUtils;

public class RbacDecisionVoter implements AccessDecisionVoter<Object> {
	static final String permitAll = "permitAll";
	
	@Override
	public boolean supports(ConfigAttribute attribute) {
		return true;
	}

	@Override
	public boolean supports(Class<?> clazz) {
		return true;
	}

	@Override
	public int vote(Authentication authentication, Object object, Collection<ConfigAttribute> attributes) {
		if (authentication == null) {
			return ACCESS_DENIED;
		}

		if (attributes != null) {
			for (ConfigAttribute attribute : attributes) {
				if (permitAll.equals(attribute.toString())) {// skip permitAll
					return ACCESS_ABSTAIN;
				}
			}
		}

		String requestUrl = ((FilterInvocation) object).getRequestUrl();// 当前请求的URL
		Collection<ConfigAttribute> urlPerms = getPermissionsByUrl(requestUrl);// 能访问URL的权限
		if (urlPerms == null || urlPerms.isEmpty()) {
			return ACCESS_ABSTAIN;
		}

		int result = ACCESS_ABSTAIN;
		Collection<? extends GrantedAuthority> userAuthorities = authentication.getAuthorities(); // 当前用户的权限
		for (ConfigAttribute attribute : urlPerms) {
			String urlPerm = attribute.getAttribute();
			if (StringUtils.isEmpty(urlPerm)) {
				continue;
			}
			
			result = ACCESS_DENIED;
			// Attempt to find a matching granted authority
			for (GrantedAuthority authority : userAuthorities) {
				if (urlPerm.equals(authority.getAuthority())) {
					return ACCESS_GRANTED;
				}
			}
		}
		return result;
	}

	Collection<ConfigAttribute> getPermissionsByUrl(String url) {
		// 获取url的访问权限，一般从数据库读取，并缓存。这里随便拼凑
		if ("/".equals(url)) {
    		return null;//根路径不限权
		}
		String n1 = url.substring(url.length()-1);
		String n2 = url.substring(url.length()-2);
		return SecurityConfig.createList("P"+n1, "P"+n2);
	}
}

import java.util.Map;
import org.springframework.boot.web.servlet.error.DefaultErrorAttributes;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.WebRequest;

@Component
public class CustomErrorAttributes extends DefaultErrorAttributes {
	@Override
	public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
		Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace);
		errorAttributes.put("code", errorAttributes.getOrDefault("status", 0));//自定义code属性
		Throwable error = super.getError(webRequest);
		if (error != null && error.getMessage() != null) {
			String message = (String)errorAttributes.getOrDefault("message", "");
			if (!message.equals(error.getMessage())) {
				errorAttributes.put("message", message+" "+error.getMessage());//增强message属性
			}
		}
		return errorAttributes;
	}
}