base.web.ShiroDbRealm.java Source code

Java tutorial

Introduction

Here is the source code for base.web.ShiroDbRealm.java

Source

/*
 * 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 base.web;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authc.SimpleAuthenticationInfo;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.authz.SimpleAuthorizationInfo;
import org.apache.shiro.crypto.hash.DefaultHashService;
import org.apache.shiro.crypto.hash.Hash;
import org.apache.shiro.crypto.hash.HashRequest;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.subject.PrincipalCollection;
import org.apache.shiro.util.ByteSource;
import org.springframework.beans.factory.annotation.Autowired;

import base.bean.Permission;
import base.bean.Role;
import base.bean.User;
import base.service.PermissionService;
import base.service.RoleService;
import base.service.UserService;
import base.util.ConfigUtil;

public class ShiroDbRealm extends AuthorizingRealm {

    @Autowired
    private UserService userService;
    @Autowired
    private RoleService roleService;
    @Autowired
    private PermissionService permissionService;

    /**
     * ?,.
     */
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authcToken)
            throws AuthenticationException {
        UsernamePasswordToken token = (UsernamePasswordToken) authcToken;
        User user = userService.getByUserName(token.getUsername());
        if (user != null) {
            return new SimpleAuthenticationInfo(
                    new ShiroUser(user.getId(), user.getUsername(), user.getName(), user.getSource()),
                    user.getPassword(), getName());
        } else {
            return null;
        }
    }

    /**
     * ?, ???.
     */
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
        ShiroUser shiroUser = (ShiroUser) principals.getPrimaryPrincipal();

        SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
        // roles
        List<Role> roles = roleService.getByUserId(shiroUser.id);
        List<String> stringRoles = new ArrayList<String>(roles.size());
        for (Role role : roles) {
            stringRoles.add(role.getName());
        }
        info.addRoles(stringRoles);

        // permissions
        List<Permission> permissions = permissionService.getByUserId(shiroUser.id);
        Set<String> stringPermissions = new HashSet<String>(permissions.size());
        for (Permission permission : permissions) {
            stringPermissions.add(permission.getValue());
        }
        info.setStringPermissions(stringPermissions);

        return info;
    }

    /**
     * ??spring/shiro.xml?credentialsMatcher <br/>
     * 
     * ?SHA-256Base64?1024<br/>
     * SHA-256Base64??(44?)Hex??64?<br/>
     * ?SHA-384?SHA-512????
     * 
     * @author Junas.Cheung
     */
    public String encrytPassword(String password) {
        // ????
        String hashAlgorithmName = ConfigUtil.getValue("password.hash.algorithm.name");
        int iterations = ConfigUtil.getIntValue("password.iterations");
        boolean isStoredHex = ConfigUtil.getBooleanValue("password.is.stored.hex");
        // 
        DefaultHashService hashService = new DefaultHashService();
        // 
        hashService.setHashAlgorithmName(hashAlgorithmName);
        // 
        hashService.setHashIterations(iterations);
        // ?
        ByteSource byteSource = ByteSource.Util.bytes(password);
        Hash hash = hashService.computeHash(new HashRequest.Builder().setSource(byteSource).build());
        // ?Hash
        return isStoredHex ? hash.toHex() : hash.toBase64();
    }

    /**
     * AuthenticationSubject??????.
     */
    public static class ShiroUser implements Serializable {
        private static final long serialVersionUID = -1373760761780840081L;
        private int id;
        private String username;
        private String name;
        private int source;

        public ShiroUser(int id, String username, String name, int source) {
            this.id = id;
            this.username = username;
            this.name = name;
            this.source = source;
        }

        public String getName() {
            return name;
        }

        public String getUsername() {
            return username;
        }

        public int getId() {
            return id;
        }

        public void setId(int id) {
            this.id = id;
        }

        public void setUsername(String username) {
            this.username = username;
        }

        public void setName(String name) {
            this.name = name;
        }

        public int getSource() {
            return source;
        }

        public void setSource(int source) {
            this.source = source;
        }

        /**
         * <shiro:principal/>.
         */
        @Override
        public String toString() {
            return name;
        }
    }

}