org.shoulder.security.authentication.sms.SmsCodeAuthenticationToken Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shoulder-security Show documentation

Shoulder 基础模块，基于 Spring Security + Spring Boot Web的安全模块，除了提供用户认证、授权、会话管理等基础功能，还允许轻松更换认证模式，如 Session / Token（JWT）模式切换。

There is a newer version: 0.8.1

package org.shoulder.security.authentication.sms;

import org.springframework.security.authentication.AbstractAuthenticationToken;
import org.springframework.security.authentication.AuthenticationManager;
import org.springframework.security.authentication.AuthenticationProvider;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.SpringSecurityCoreVersion;

import java.util.Collection;

/**
 * 手机号码认证 token
 * 参考 {@link org.springframework.security.authentication.UsernamePasswordAuthenticationToken}
 *
 * @author lym
 */
public class SmsCodeAuthenticationToken extends AbstractAuthenticationToken {

	private static final long serialVersionUID = SpringSecurityCoreVersion.SERIAL_VERSION_UID;

	// 实例属性
	// ================================================================================================

	private final Object principal;

	// 构造器
	// ===================================================================================================

	/**
	 * 构建一个未授权的 SmsCodeAuthenticationToken
	 */
	public SmsCodeAuthenticationToken(String phoneNumber) {
		super(null);
		this.principal = phoneNumber;
		setAuthenticated(false);
	}

	/**
	 * 创建一个认证过的 token。该方法只应被
	 * {@link AuthenticationManager} 或 {@link AuthenticationProvider} 的实现类调用
	 *
	 * @param principal		用户信息
	 * @param authorities	授权信息
	 */
	public SmsCodeAuthenticationToken(Object principal,
                                      Collection authorities) {
		super(authorities);
		this.principal = principal;
		super.setAuthenticated(true); // must use super, as we override
	}

	// ========================================================================================================

	/** sms 无证明信息 */
	@Override
	public Object getCredentials() {
		return null;
	}

	/** 标志凭证 */
	@Override
	public Object getPrincipal() {
		return this.principal;
	}

	@Override
	public void setAuthenticated(boolean isAuthenticated) throws IllegalArgumentException {
		if (isAuthenticated) {
			throw new IllegalArgumentException(
					"Cannot set this token to trusted - use constructor which takes a GrantedAuthority list instead");
		}
		super.setAuthenticated(false);
	}

}