Shiro框架編碼/解碼（五）

在涉及到密碼存儲問題上，應該加密/生成密碼摘要存儲，而不是存儲明文密碼。比如之前的600w csdn賬號泄露對用戶可能造成很大損失，因此應加密/生成不可逆的摘要方式存儲。

一、編碼/解碼

Shiro提供了base64和16進制字符串編碼/解碼的API支持，方便一些編碼解碼操作。Shiro內部的一些數據的存儲/表示都使用了base64和16進制字符串。

String str = "hello";  
String base64Encoded = Base64.encodeToString(str.getBytes());  
String str2 = Base64.decodeToString(base64Encoded);  
Assert.assertEquals(str, str2);

通過如上方式可以進行base64編碼/解碼操作，更多API請參考其Javadoc。

String str = "hello";  
String base64Encoded = Hex.encodeToString(str.getBytes());  
String str2 = new String(Hex.decode(base64Encoded.getBytes()));  
Assert.assertEquals(str, str2);

通過如上方式可以進行16進制字符串編碼/解碼操作，更多API請參考其Javadoc。

還有一個可能經常用到的類CodecSupport，提供了toBytes(str, “utf-8”) / toString(bytes, “utf-8”)用於在byte數組/String之間轉換。

二、散列算法

散列算法一般用於生成數據的摘要信息，是一種不可逆的算法，一般適合存儲密碼之類的數據，常見的散列算法如MD5、SHA等。一般進行散列時最好提供一個salt（鹽），比如加密密碼“admin”，產生的散列值是“21232f297a57a5a743894a0e4a801fc3”，可以到一些md5解密網站很容易的通過散列值得到密碼“admin”，即如果直接對密碼進行散列相對來說破解更容易，此時我們可以加一些只有系統知道的干擾數據，如用戶名和ID（即鹽）；這樣散列的對象是“密碼+用戶名+ID”，這樣生成的散列值相對來說更難破解。

String str = "hello";  
String salt = "123";  
String md5 = new Md5Hash(str, salt).toString();//還可以轉換爲 toBase64()/toHex()

如上代碼通過鹽“123”MD5散列“hello”。另外散列時還可以指定散列次數，如2次表示：md5(md5(str))：“new Md5Hash(str, salt, 2).toString()”。

String str = "hello";  
String salt = "123";  
String sha1 = new Sha256Hash(str, salt).toString();

使用SHA256算法生成相應的散列數據，另外還有如SHA1、SHA512算法。

Shiro還提供了通用的散列支持：

String str = "hello";  
String salt = "123";  
//內部使用MessageDigest  
String simpleHash = new SimpleHash("SHA-1", str, salt).toString();

通過調用SimpleHash時指定散列算法，其內部使用了Java的MessageDigest實現。

爲了方便使用，Shiro提供了HashService，默認提供了DefaultHashService實現。

DefaultHashService hashService = new DefaultHashService();//默認算法SHA-512  
hashService.setHashAlgorithmName("SHA-512");
hashService.setPrivateSalt(new SimpleByteSource("123"));//私鹽，默認無  
hashService.setGeneratePublicSalt(true);//是否生成公鹽，默認false  
hashService.setRandomNumberGenerator(new SecureRandomNumberGenerator());//用於生成公鹽。默認就這個  
hashService.setHashIterations(1);//生成Hash值的迭代次數 

HashRequest request = new HashRequest.Builder().setAlgorithmName("MD5").setSource("hello").setSalt("123").setIterations(2).build();
String hex = hashService.computeHash(request).toHex();
System.out.println(hex);

1、首先創建一個DefaultHashService，默認使用SHA-512算法；
2、可以通過hashAlgorithmName屬性修改算法；
3、可以通過privateSalt設置一個私鹽，其在散列時自動與用戶傳入的公鹽混合產生一個新鹽；
4、可以通過generatePublicSalt屬性在用戶沒有傳入公鹽的情況下是否生成公鹽；
5、可以設置randomNumberGenerator用於生成公鹽；
6、可以設置hashIterations屬性來修改默認加密迭代次數；
7、需要構建一個HashRequest，傳入算法、數據、公鹽、迭代次數。

SecureRandomNumberGenerator用於生成一個隨機數：

SecureRandomNumberGenerator random = new SecureRandomNumberGenerator();
random.setSeed("123".getBytes());
System.out.println(random.nextBytes().toHex());

三、加密/解密

Shiro還提供對稱式加密/解密算法的支持，如AES、Blowfish等；當前還沒有提供對非對稱加密/解密算法支持，未來版本可能提供。

AES算法實現：

@Test
public void testAesCipherService() {
    AesCipherService aesCipherService = new AesCipherService();
    aesCipherService.setKeySize(128);//設置key長度

    //生成key
    Key key = aesCipherService.generateNewKey();

    String text = "hello";

    //加密
    String encrptText = aesCipherService.encrypt(text.getBytes(), key.getEncoded()).toHex();
    //解密
    String text2 = new String(aesCipherService.decrypt(Hex.decode(encrptText), key.getEncoded()).getBytes());

    Assert.assertEquals(text, text2);
}

更多算法請參考示例com.github.crystal.chapter05.CodecAndCryptoTest

四、PasswordService/CredentialsMatcher

Shiro提供了PasswordService及CredentialsMatcher用於提供加密密碼及驗證密碼服務。

public interface PasswordService {  
    //輸入明文密碼得到密文密碼  
    String encryptPassword(Object plaintextPassword) throws IllegalArgumentException;  
}

public interface CredentialsMatcher {  
    //匹配用戶輸入的token的憑證（未加密）與系統提供的憑證（已加密）  
    boolean doCredentialsMatch(AuthenticationToken token, AuthenticationInfo info);  
}

Shiro默認提供了PasswordService實現DefaultPasswordService；CredentialsMatcher實現PasswordMatcher及HashedCredentialsMatcher（更強大）。

4.1 DefaultPasswordService配合PasswordMatcher實現簡單的密碼加密與驗證服務

1、定義Realm（com.github.crystal.chapter05.realm.MyRealm）

public class MyRealm extends AuthorizingRealm {  
    private PasswordService passwordService;  
    public void setPasswordService(PasswordService passwordService) {  
        this.passwordService = passwordService;  
    }  
     //省略doGetAuthorizationInfo，具體看代碼   
    @Override  
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {  
        return new SimpleAuthenticationInfo(  
                "crystal",  
                passwordService.encryptPassword("123"),  
                getName());  
    }  
}

爲了方便，直接注入一個passwordService來加密密碼，實際使用時需要在Service層使用passwordService加密密碼並存到數據庫。

2、ini配置（shiro-passwordservice.ini）

[main]  
passwordService=org.apache.shiro.authc.credential.DefaultPasswordService  
hashService=org.apache.shiro.crypto.hash.DefaultHashService  
passwordService.hashService=$hashService  
hashFormat=org.apache.shiro.crypto.hash.format.Shiro1CryptFormat  
passwordService.hashFormat=$hashFormat  
hashFormatFactory=org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory  
passwordService.hashFormatFactory=$hashFormatFactory  

passwordMatcher=org.apache.shiro.authc.credential.PasswordMatcher  
passwordMatcher.passwordService=$passwordService  

myRealm=com.github.crystal.chapter05.realm.MyRealm
myRealm.passwordService=$passwordService  
myRealm.credentialsMatcher=$passwordMatcher  
securityManager.realms=$myRealm

2.1、passwordService使用DefaultPasswordService，如果有必要也可以自定義；
2.2、hashService定義散列密碼使用的HashService，默認使用DefaultHashService（默認SHA-256算法）；
2.3、hashFormat用於對散列出的值進行格式化，默認使用Shiro1CryptFormat，另外提供了Base64Format和HexFormat，對於有salt的密碼請自定義實現ParsableHashFormat然後把salt格式化到散列值中；
2.4、hashFormatFactory用於根據散列值得到散列的密碼和salt；因爲如果使用如SHA算法，那麼會生成一個salt，此salt需要保存到散列後的值中以便之後與傳入的密碼比較時使用；默認使用DefaultHashFormatFactory；
2.5、passwordMatcher使用PasswordMatcher，其是一個CredentialsMatcher實現；
2.6、將credentialsMatcher賦值給myRealm，myRealm間接繼承了AuthenticatingRealm，其在調用getAuthenticationInfo方法獲取到AuthenticationInfo信息後，會使用credentialsMatcher來驗證憑據是否匹配，如果不匹配將拋出IncorrectCredentialsException異常。

3、測試用例請參考（com.github.crystal.chapter05.PasswordTest）

另外可以參考配置shiro-jdbc-passwordservice.ini，提供了JdbcRealm的測試用例，測試前請先調用sql/shiro-init-data.sql初始化用戶數據。

如上方式的缺點是：salt保存在散列值中；沒有實現如密碼重試次數限制

4.2 HashedCredentialsMatcher實現密碼驗證服務

Shiro提供了CredentialsMatcher的散列實現HashedCredentialsMatcher，和之前的PasswordMatcher不同的是，它只用於密碼驗證，且可以提供自己的鹽，而不是隨機生成鹽，且生成密碼散列值的算法需要自己寫，因爲能提供自己的鹽。

1、生成密碼散列值
此處我們使用MD5算法，“密碼+鹽（用戶名+隨機數）”的方式生成散列值：

@Test
public void testGeneratePassword() {
    String algorithmName = "md5";
    String username = "crystal";
    String password = "123";
    String salt1 = username;
    String salt2 = new SecureRandomNumberGenerator().nextBytes().toHex();
    int hashIterations = 2;

    SimpleHash simpleHash = new SimpleHash(algorithmName, password, salt1 + salt2, hashIterations);
    String encodedPassword  = simpleHash.toHex();
    System.out.println(salt2);
    System.out.println(encodedPassword);
}

如果要寫用戶模塊，需要在新增用戶/重置密碼時使用如上算法保存密碼，將生成的密碼及salt2存入數據庫（因爲我們的散列算法是：md5(md5(密碼+username+salt2))）。

2、生成Realm（com.github.crystal.chapter05.realm.MyRealm2）

@Override
protected AuthenticationInfo doGetAuthenticationInfo(
        AuthenticationToken token) throws AuthenticationException {
    String username = "crystal"; //用戶名及salt1  
    String password = "f4779950a9e8d273be61d99647890e7c"; //加密後的密碼  
    String salt2 = "0186fc445fdd96885b8cfd5924ee50e8";  
    SimpleAuthenticationInfo ai = new SimpleAuthenticationInfo(username, password, getName());  
    ai.setCredentialsSalt(ByteSource.Util.bytes(username+salt2)); //鹽是用戶名+隨機數  
    return ai;  
}

此處就是把步驟1中生成的相應數據組裝爲SimpleAuthenticationInfo，通過SimpleAuthenticationInfo的credentialsSalt設置鹽，HashedCredentialsMatcher會自動識別這個鹽。

如果使用JdbcRealm，需要修改獲取用戶信息（包括鹽）的sql：“select password, password_salt from users where username = ?”，而我們的鹽是由username+password_salt組成，所以需要通過如下ini配置（shiro-jdbc-hashedCredentialsMatcher.ini）修改：

jdbcRealm.saltStyle=COLUMN  
jdbcRealm.authenticationQuery=select password, concat(username,password_salt) from users where username = ?  
jdbcRealm.credentialsMatcher=$credentialsMatcher

1、saltStyle表示使用密碼+鹽的機制，authenticationQuery第一列是密碼，第二列是鹽；
2、通過authenticationQuery指定密碼及鹽查詢SQL；

注意：Shiro默認使用了apache commons BeanUtils，默認是不進行Enum類型轉型的，此時需要自己註冊一個Enum轉換器“BeanUtilsBean.getInstance().getConvertUtils().register(new EnumConverter(), JdbcRealm.SaltStyle.class);”具體請參考示例“com.github.crystal.chapter05.PasswordTest”中的代碼。或者重寫JdbcRealm。

另外可以參考配置shiro-jdbc-passwordservice.ini，提供了JdbcRealm的測試用例，測試前請先調用sql/shiro-init-data.sql初始化用戶數據。

3、ini配置（shiro-hashedCredentialsMatcher.ini）

[main]  
credentialsMatcher=org.apache.shiro.authc.credential.HashedCredentialsMatcher  
credentialsMatcher.hashAlgorithmName=md5  
credentialsMatcher.hashIterations=2  
credentialsMatcher.storedCredentialsHexEncoded=true  
myRealm=com.github.crystal.chapter05.realm.MyRealm2  
myRealm.credentialsMatcher=$credentialsMatcher  
securityManager.realms=$myRealm

此處最需要注意的就是HashedCredentialsMatcher的算法需要和生成密碼時的算法一樣。另外HashedCredentialsMatcher會自動根據AuthenticationInfo的類型是否是SaltedAuthenticationInfo來獲取credentialsSalt鹽。

4、測試用例請參考（com.github.crystal.chapter05.PasswordTest）

4.3 密碼重試次數限制

如在1個小時內密碼最多重試5次，如果嘗試次數超過5次就鎖定1小時，1小時後可再次重試，如果還是重試失敗，可以鎖定如1天，以此類推，防止密碼被暴力破解。我們通過繼承HashedCredentialsMatcher，且使用Ehcache記錄重試次數和超時時間。
com.github.crystal.chapter05.credentials.RetryLimitHashedCredentialsMatcher

public class RetryLimitHashedCredentialsMatcher extends HashedCredentialsMatcher {

    private Ehcache passwordRetryCache;

    public RetryLimitHashedCredentialsMatcher() {
        CacheManager cacheManager = CacheManager.newInstance(CacheManager.class.getClassLoader().getResource("chapter05/ehcache.xml"));
        passwordRetryCache = cacheManager.getCache("passwordRetryCache");
    }

    @Override
    public boolean doCredentialsMatch(AuthenticationToken token,
            AuthenticationInfo info) {
        String username = (String)token.getPrincipal();  
        //retry count + 1  
        Element element = passwordRetryCache.get(username);  
        if(element == null) {  
            element = new Element(username , new AtomicInteger(0));  
            passwordRetryCache.put(element);  
        }  
        AtomicInteger retryCount = (AtomicInteger)element.getObjectValue();  
        if(retryCount.incrementAndGet() > 5) {  
            //if retry count > 5 throw  
            throw new ExcessiveAttemptsException();  
        }  

        boolean matches = super.doCredentialsMatch(token, info);  
        if(matches) {  
            //clear retry count  
            passwordRetryCache.remove(username);  
        }  
        return matches;  
    }
}

如上代碼邏輯比較簡單，即如果密碼輸入正確清除cache中的記錄；否則cache中的重試次數+1，如果超出5次那麼拋出異常表示超出重試次數了。

實例源代碼：shiro-learn

caoyue_new

發佈了60 篇原創文章 · 獲贊 5 · 訪問量 7萬+

私信關注

Shiro框架編碼/解碼（五）

一、編碼/解碼

二、散列算法

三、加密/解密

四、PasswordService/CredentialsMatcher

4.1 DefaultPasswordService配合PasswordMatcher實現簡單的密碼加密與驗證服務

4.2 HashedCredentialsMatcher實現密碼驗證服務

4.3 密碼重試次數限制

[轉帖]使用NMT和pmap解決JVM資源泄漏問題原創

Python實現大麥網搶票的四大關鍵技術點解析

Python 安裝庫指令大全

salesforce零基礎學習（一百三十八）零碎知識點小總結（十）

一款開源的.NET程序集反編譯、編輯和調試神器

關於接口協議，你必須要知道這些！

基於 Milvus + LlamaIndex 實現高級 RAG

【2024-05-21】以茶會友

java 深入理解註解

Shiro框架授權（三）

Shiro框架與Web集成（七）

Hibernate 框架檢索策略

Java同步工具類（一）

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結