为了方便说明我用springmvc 与springmvc整合shiro来类比。
springmvc中,controler是用来把登录请求交给具体的service层处理的
@Controller
@RequestMapping("/login")
public class LoginHandler {
private static final Logger log = LogManager.getLogger(LoginHandler.class);
@ResponseBody
@RequestMapping("/doLogin")
public String login(User user, Model model) {
//调用service处理请求
}
而整合shiro后,controler不再直接处理登录请求,而是把他交给realm处理,下面代码就是把处理给realm的实现:
public String login(User user, Model model) {
Subject subject = SecurityUtils.getSubject();
UsernamePasswordToken token = null;
String info = null;
if (null != user) {
token = new UsernamePasswordToken(user.getU_name(), subject.getSession().getAttribute("password").toString().trim().toCharArray());
if (subject.getSession().getAttribute("rememberMe").toString().trim().equals("true"))
token.setRememberMe(true);
log.info("记住我: " + subject.getSession().getAttribute("rememberMe"));
}
try {
subject.login(token);
} catch (UnknownAccountException e) {
e.printStackTrace();
info = e.getMessage();
} catch (IncorrectCredentialsException e) {
e.printStackTrace();
info = "密码不匹配(生产环境中应该写:用户名和密码的组合不正确)";
} catch (LockedAccountException e) {
e.printStackTrace();
info = e.getMessage();
}
if (info == null) {
return "true";
}
model.addAttribute("msg", info);
return "false";
}
现在我们安顺序了解
1)Subject
Subject 是 Shiro 的核心对象,基本所有身份验证、授权都是通过 Subject 完成。
1、身份信息获取
Object getPrincipal(); //Primary Principal
PrincipalCollection getPrincipals(); // PrincipalCollection
2、身份验证
void login(AuthenticationToken token) throws AuthenticationException;
boolean isAuthenticated();
boolean isRemembered();
通过 login 登录,如果登录失败将抛出相应的 AuthenticationException,如果登录成功调用 isAuthenticated 就会返回 true,即已经通过身份验证;如果 isRemembered 返回 true,表示是通过记住我功能登录的而不是调用 login 方法登录的。isAuthenticated/isRemembered 是互斥的,即如果其中一个返回 true,另一个返回 false。
3、角色授权验证
boolean hasRole(String roleIdentifier);
boolean[] hasRoles(List<String> roleIdentifiers);
boolean hasAllRoles(Collection<String> roleIdentifiers);
void checkRole(String roleIdentifier) throws AuthorizationException;
void checkRoles(Collection<String> roleIdentifiers) throws AuthorizationException;
void checkRoles(String... roleIdentifiers) throws AuthorizationException;
hasRole 进行角色验证,验证后返回 true/false;而 checkRole 验证失败时抛出 AuthorizationException 异常。
4、权限授权验证
boolean isPermitted(String permission);
boolean isPermitted(Permission permission);
boolean[] isPermitted(String... permissions);
boolean[] isPermitted(List<Permission> permissions);
boolean isPermittedAll(String... permissions);
boolean isPermittedAll(Collection<Permission> permissions);
void checkPermission(String permission) throws AuthorizationException;
void checkPermission(Permission permission) throws AuthorizationException;
void checkPermissions(String... permissions) throws AuthorizationException;
void checkPermissions(Collection<Permission> permissions) throws AuthorizationException;
isPermitted 进行权限验证,验证后返回 true/false;而 checkPermission 验证失败时抛出 AuthorizationException。
5、会话
Session getSession(); //相当于getSession(true)
Session getSession(boolean create);
类似于 Web 中的会话。如果登录成功就相当于建立了会话,接着可以使用 getSession 获取;如果 create=false 如果没有会话将返回 null,而 create=true 如果没有会话会强制创建一个。
6、退出
void logout();
ps:这并不是全部的方法,剩下的请自行了解。
而需要使用subject我们就需要在spring-shiro.xml,web.xml中配置
<!-- spring-shiro.xml 安全管理器 -->
<bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">
<property name="realm" ref="myRealm"/>
...<!-- 具体请看环境准备 或者我的实例 -->
</bean>
<!-- 自定义realm -->
<bean id="myRealm" class="com.zm.web_shiro.realm.CustomRealm">
<!-- 用属性时需要getter,setter service -->
<!-- <property name="userService" ref="userService"/>-->
</bean>
<!-- 注解 @Autowired时使用 -->
<bean id="userService" class="com.zm.web_shiro.service.impl.UserServiceImpl" />
<!-- Shiro的Web过滤器 -->
<bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean">
<property name="securityManager" ref="securityManager"/>
<property name="loginUrl" value="/jsp/login.jsp"/>
<property name="unauthorizedUrl" value="/jsp/unauthorized.jsp"/>
<property name="filterChainDefinitions">
<value>
/index.jsp = anon
/unauthorized.jsp = anon
/jsp/login.jsp = anon
/jsp/admin.jsp = authc,KickoutSessionControlFilter
/jsp/user.jsp = user,KickoutSessionControlFilter
/login/doLogout = logout
/login/code = VcodeControlFilter
/login/** = accessControlFilter
/jsp/** = user,KickoutSessionControlFilter
<!-- 资源 -->
/css/** = anon
/js/** = anon
</value>
</property>
<property name="filters">
<map>
<!-- 拦截器请看后面 -->
<entry key="accessControlFilter" value-ref="accessControlFilter" />
<entry key="KickoutSessionControlFilter" value-ref="KickoutSessionControlFilter" />
<entry key="VcodeControlFilter" value-ref="VcodeControlFilter" />
</map>
</property>
</bean>
<!-- Shiro生命周期处理器 -->
<bean id="lifecycleBeanPostProcessor" class="org.apache.shiro.spring.LifecycleBeanPostProcessor"/>
<!-- web.xml -->
<filter>
<filter-name>shiroFilter</filter-name>
<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
<init-param>
<param-name>targetFilter</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>shiroFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!-- Spring监听器 -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring.xml,classpath:spring-shiro.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
按照以上配置后subject就能使用了,那接下来简单的说下UsernamePasswordToken
2)UsernamePasswordToken
private String username;
private char[] password;
private boolean rememberMe = false;
private String host;
public String getUsername()
public void setUsername(String username)
public char[] getPassword()
public void setPassword(char[] password)
public Object getPrincipal()
public Object getCredentials()
public String getHost()
public void setHost(String host)
public boolean isRememberMe()
public void setRememberMe(boolean rememberMe)
public void clear()
这么一看一目了然,token就是存储用户名和密码的,那么接下来就是realm了
Realm
1)realm是继承AuthorizingRealm来实现的,他需要实现下面两个方法
package com.zm.web_shiro.realm;
/**
* create by zm 2017.12.15
*/
public class CustomRealm extends AuthorizingRealm {
@Autowired
private UserService userService;
private Logger log = LogManager.getLogger(CustomRealm.class);
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
log.info("doGetAuthorizationInfo ----- start !");
//User user = (User)principals.getPrimaryPrincipal();如果principals存放的是对象则用这一行代码
Session session = SecurityUtils.getSubject().getSession();
String username = principals.getPrimaryPrincipal().toString();
log.info("对" + username + "进行授权!");
String role = userService.queryRoleByName(username);
SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
info.addRole(role.trim());
log.info("role => " + role);
List<String> menus = userService.queryMenusByRole(role);
session.setAttribute("menus",menus);
log.info("menus: " + menus.toString());
return info;
}
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
log.info("doGetAuthenticationInfo ----- start !");
String username = token.getPrincipal().toString();
String password = new String((char[])token.getCredentials());
User user = userService.login(new User(username,password));
//System.out.println(user);
if(user!=null){
// 第 1 个参数可以传一个实体对象,然后在认证的环节可以取出
// 第 2 个参数应该传递在数据库中“正确”的数据,然后和 token 中的数据进行匹配
SimpleAuthenticationInfo info = new SimpleAuthenticationInfo(user.getU_name(),user.getU_pwd(),getName());
// 设置盐值
info.setCredentialsSalt(ByteSource.Util.bytes(user.getU_name().getBytes()));
return info;
}
return null;
}
1、CustomRealm 父类 AuthorizingRealm 将获取 Subject 相关信息分成两步:获取身份验证信息(doGetAuthenticationInfo)及授权信息(doGetAuthorizationInfo);
2、doGetAuthenticationInfo 获取身份验证相关信息:首先根据传入的用户名获取 User 信息;然后如果 user 为空,那么抛出没找到帐号异常 UnknownAccountException;如果 user 找到但锁定了抛出锁定异常 LockedAccountException;最后生成 AuthenticationInfo 信息,交给间接父类 AuthenticatingRealm 使用 CredentialsMatcher 进行判断密码是否匹配,如果不匹配将抛出密码错误异常 IncorrectCredentialsException;另外如果密码重试此处太多将抛出超出重试次数异常 ExcessiveAttemptsException;在组装 SimpleAuthenticationInfo 信息时,需要传入:身份信息(用户名)、凭据(密文密码)、盐(username+salt),CredentialsMatcher 使用盐加密传入的明文密码和此处的密文密码进行匹配。
3、doGetAuthorizationInfo 获取授权信息:PrincipalCollection 是一个身份集合,因为我们现在就一个 Realm,所以直接调用 getPrimaryPrincipal 得到之前传入的用户名即可;然后根据用户名调用 UserService 接口获取角色及权限信息。
AuthenticationToken 用于收集用户提交的身份(如用户名)及凭据(如密码):
public interface AuthenticationToken extends Serializable {
Object getPrincipal(); //身份
Object getCredentials(); //凭据
}
AuthenticationInfo 有两个作用:
如果 Realm 是 AuthenticatingRealm 子类,则提供给 AuthenticatingRealm 内部使用的 CredentialsMatcher 进行凭据验证;(如果没有继承它需要在自己的 Realm 中自己实现验证);
提供给 SecurityManager 来创建 Subject(提供身份信息);
PrincipalCollection 用于聚合这些身份信息:
public interface PrincipalCollection extends Iterable, Serializable {
Object getPrimaryPrincipal(); //得到主要的身份
<T> T oneByType(Class<T> type); //根据身份类型获取第一个
<T> Collection<T> byType(Class<T> type); //根据身份类型获取一组
List asList(); //转换为List
Set asSet(); //转换为Set
Collection fromRealm(String realmName); //根据Realm名字获取
Set<String> getRealmNames(); //获取所有身份验证通过的Realm名字
boolean isEmpty(); //判断是否为空
}
AuthorizationInfo 用于聚合授权信息的:
public interface AuthorizationInfo extends Serializable {
Collection<String> getRoles(); //获取角色字符串信息
Collection<String> getStringPermissions(); //获取权限字符串信息
Collection<Permission> getObjectPermissions(); //获取Permission对象信息
}