《跟我学Shiro》笔记05-编码加密

Java Java Shiro

创建时间:2018-04-12 20:12

字数:2.9k 阅读:

编码/解码
散列算法
加密/解密
PasswordService/CredentialsMatcher

原文地址：第五章编码/加密——《跟我学Shiro》
目录贴：跟我学Shiro目录贴
源码：https://github.com/zhangkaitao/shiro-example

编码/解码

Shiro 提供了 base64 和 16 进制字符串编码/解码的 API 支持，方便一些编码解码操作。Shiro 内部的一些数据的存储/表示都使用了 base64 和 16 进制字符串。

@Test
public void testBase64() {
    String str = "hello";
    String base64Encoded = Base64.encodeToString(str.getBytes());
    String str2 = Base64.decodeToString(base64Encoded);
    Assert.assertEquals(str, str2);
}

@Test
public void testHex() {
    String str = "hello";
    String base64Encoded = Hex.encodeToString(str.getBytes());
    String str2 = new String(Hex.decode(base64Encoded.getBytes()));
    Assert.assertEquals(str, str2);
}

// CodecSupport 类，提供了 toBytes(str, "utf-8") / toString(bytes, "utf-8")用于在 byte 数组与 String 之间转换。
@Test
public void testCodecSupport() {
    String str = "hello";
    byte[] bytes = CodecSupport.toBytes(str, "utf-8");
    String str2 = CodecSupport.toString(bytes, "utf-8");
    Assert.assertEquals(str, str2);
}

散列算法

散列算法一般用于生成数据的摘要信息，是一种不可逆的算法，一般适合存储密码之类的数据，常见的散列算法如 MD5、SHA 等。一般进行散列时最好提供一个 salt（盐），比如加密密码 admin，产生的散列值是 21232f297a57a5a743894a0e4a801fc3，可以到一些 md5 解密网站很容易的通过散列值得到密码 admin，即如果直接对密码进行散列相对来说破解更容易，此时我们可以加一些只有系统知道的干扰数据，如用户名和 ID（即盐）；这样散列的对象是 密码 + 用户名 + ID，这样生成的散列值相对来说更难破解。

@Test
public void testMd5Sha() {
    String str = "hello";
    String salt = "123";
    String md5 = new Md5Hash(str, salt).toString(); // 还可以转换为 toBase64()/toHex()
    System.out.println(md5);

    String sha1 = new Sha1Hash(str, salt).toString();
    System.out.println(sha1);

    String sha256 = new Sha256Hash(str, salt).toString();
    String sha384 = new Sha384Hash(str, salt).toString();
    String sha512 = new Sha512Hash(str, salt).toString();

    // Shiro 还提供了通用的散列支持，内部使用 Java 的 MessageDigest
    String simpleHash = new SimpleHash("SHA-1", str, salt).toString();
}

为了方便使用，Shiro 提供了 HashService，默认提供了 DefaultHashService 实现。

@Test
public void testHashService() {
    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(ByteSource.Util.bytes("hello"))
            .setSalt(ByteSource.Util.bytes("123")).setIterations(2).build();
    String hex = hashService.computeHash(request).toHex();
    System.out.println(hex);
}

首先创建一个 DefaultHashService，默认使用 SHA-512 算法；
可以通过 hashAlgorithmName 属性修改算法；
可以通过 privateSalt 设置一个私盐，其在散列时自动与用户传入的公盐混合产生一个新盐；
可以通过 generatePublicSalt 属性在用户没有传入公盐的情况下是否生成公盐；
可以设置 randomNumberGenerator 用于生成公盐；
可以设置 hashIterations 属性来修改默认加密迭代次数；
需要构建一个 HashRequest，传入算法、数据、公盐、迭代次数。

@Test
public void testRandom() {
    // 生成随机数
    SecureRandomNumberGenerator randomNumberGenerator = new SecureRandomNumberGenerator();
    randomNumberGenerator.setSeed("123".getBytes()); // 生成随机数的种子，这么设置可以使得每次生成的一样，如果不需要这样，注释即可。
    System.out.println(randomNumberGenerator.nextBytes().toHex());  // 23ae809ddacaf96af0fd78ed04b6a265
}

加密/解密

Shiro 还提供对称式加密/解密算法的支持，如 AES、Blowfish 等；当前还没有提供对非对称加密/解密算法支持，未来版本可能提供。

AES 仅支持 16, 24 或 32 字节的密钥大小，一般为 16 字节，https://stackoverflow.com/questions/29354133/how-to-fix-invalid-aes-key-length

如果要支持24 或 32 字节的密钥大小，https://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters

String text = "hello";

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

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

    // 加密 这里的 key 只能是 16, 24 或 32 位 key.getEncoded() 可以替换为 "1234567812345678".getBytes()
    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);
}

@Test
public void testBlowfishCipherService() {
    BlowfishCipherService blowfishCipherService = new BlowfishCipherService();
    blowfishCipherService.setKeySize(128);

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

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

@Test
public void testDefaultBlockCipherService() throws Exception {

    // 对称加密，使用 Java 的 JCA（javax.crypto.Cipher）加密 API，常见的如 'AES', 'Blowfish'
    DefaultBlockCipherService cipherService = new DefaultBlockCipherService("AES");
    cipherService.setKeySize(128);

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

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

加密/解密相关知识可参考 snowolf 的博客 http://snowolf.iteye.com/category/68576

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（更强大）。

DefaultPasswordService 配合 PasswordMatcher 实现简单的密码加密与验证服务

定义 Realm

public class MyRealm extends AuthorizingRealm {

    private PasswordService passwordService;

    public void setPasswordService(PasswordService passwordService) {
        this.passwordService = passwordService;
    }

    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
        return null;
    }

    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {

        return new SimpleAuthenticationInfo(
                "wu",
                passwordService.encryptPassword("123"),
                getName());
    }
}

为了方便，直接注入一个 passwordService 来加密密码，实际使用时需要在 Service 层使用 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.zhangkaitao.shiro.chapter5.hash.realm.MyRealm
myRealm.passwordService=$passwordService
myRealm.credentialsMatcher=$passwordMatcher
securityManager.realms=$myRealm

passwordService 使用 DefaultPasswordService，如果有必要也可以自定义；
hashService 定义散列密码使用的 HashService，默认使用 DefaultHashService（默认 SHA-512 算法）；
hashFormat 用于对散列出的值进行格式化，默认使用 Shiro1CryptFormat，另外提供了 Base64Format 和 HexFormat，对于有 salt 的密码请自定义实现 ParsableHashFormat 然后把 salt 格式化到散列值中；
hashFormatFactory 用于根据散列值得到散列的密码和 salt；因为如果使用如 SHA 算法，那么会生成一个 salt，此 salt 需要保存到散列后的值中以便之后与传入的密码比较时使用；默认使用 DefaultHashFormatFactory；
passwordMatcher 使用 PasswordMatcher，其是一个 CredentialsMatcher 实现；
将 credentialsMatcher 赋值给 myRealm，myRealm 间接继承了 AuthenticatingRealm，其在调用 getAuthenticationInfo 方法获取到 AuthenticationInfo 信息后，会使用 credentialsMatcher 来验证凭据是否匹配，如果不匹配将抛出 IncorrectCredentialsException 异常。

测试用例

@Test
public void testPasswordServiceWithMyRealm() {
    login("classpath:shiro-passwordservice.ini", "wu", "123");
}

HashedCredentialsMatcher 实现密码验证服务

Shiro 提供了 CredentialsMatcher 的散列实现 HashedCredentialsMatcher，和之前的 PasswordMatcher 不同的是，它只用于密码验证，且可以提供自己的盐，而不是随机生成盐，且生成密码散列值的算法需要自己写，因为能提供自己的盐。

生成密码散列值

此处我们使用 MD5 算法，"密码+盐（用户名+随机数）" 的方式生成散列值：

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

    SimpleHash hash = new SimpleHash(algorithmName, password, salt1 + salt2, hashIterations);
    String encodedPassword = hash.toHex();

    Assert.assertEquals(hash.getSalt()+"", Base64.encodeToString((salt1+salt2).getBytes()));
}

如果要写用户模块，需要在新增用户/重置密码时使用如上算法保存密码，将生成的密码及 salt2 存入数据库（因为我们的散列算法是：md5(md5(密码+username+salt2))）。

使用 JdbcRealm

如果使用 JdbcRealm，需要修改获取用户信息（包括盐）的 sql：select password, password_salt from users where username = ?，而我们的盐是由 username+password_salt 组成，所以需要通过如下 ini 配置（shiro-jdbc-hashedCredentialsMatcher.ini）修改：

[main]
credentialsMatcher=org.apache.shiro.authc.credential.HashedCredentialsMatcher
credentialsMatcher.hashAlgorithmName=md5
credentialsMatcher.hashIterations=2
credentialsMatcher.storedCredentialsHexEncoded=true

dataSource=com.alibaba.druid.pool.DruidDataSource
dataSource.driverClassName=com.mysql.jdbc.Driver
dataSource.url=jdbc:mysql://localhost:3306/shiro
dataSource.username=root
dataSource.password=123456

jdbcRealm=org.apache.shiro.realm.jdbc.JdbcRealm
jdbcRealm.dataSource=$dataSource
jdbcRealm.permissionsLookupEnabled=true
jdbcRealm.saltStyle=COLUMN
jdbcRealm.authenticationQuery=select password, concat(username,password_salt) from users where username = ?
jdbcRealm.credentialsMatcher=$credentialsMatcher
securityManager.realms=$jdbcRealm

saltStyle 表示使用密码+盐的机制，authenticationQuery 第一列是密码，第二列是盐；
通过 authenticationQuery 指定密码及盐查询 SQL；

此处还要注意 Shiro 默认使用了 apache commons BeanUtils，默认是不进行 Enum 类型转型的，此时需要自己注册一个 Enum 转换器 BeanUtilsBean.getInstance().getConvertUtils().register(new EnumConverter(), JdbcRealm.SaltStyle.class);，如下：

@Test
public void testHashedCredentialsMatcherWithJdbcRealm() {

    BeanUtilsBean.getInstance().getConvertUtils().register(new EnumConverter(), JdbcRealm.SaltStyle.class);

    // 使用 testGeneratePassword 生成的散列密码
    login("classpath:shiro-jdbc-hashedCredentialsMatcher.ini", "liu", "123");
}

private class EnumConverter extends AbstractConverter {
    @Override
    protected String convertToString(final Object value) throws Throwable {
        return ((Enum) value).name();
    }
    @Override
    protected Object convertToType(final Class type, final Object value) throws Throwable {
        return Enum.valueOf(type, value.toString());
    }

    @Override
    protected Class getDefaultType() {
        return null;
    }
}

使用自定义 Realm

生成 Realm

public class MyRealm2 extends AuthorizingRealm {

    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
        return null;
    }

    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
        String username = "liu"; // 用户名及 salt1
        String salt2 = "0072273a5d87322163795118fdd7c45e";
        String password = "be320beca57748ab9632c4121ccac0db"; // 加密后的密码，将上文中 testGeneratePassword() 方法，salt2 改为固定，即可得到该值
        SimpleAuthenticationInfo ai = new SimpleAuthenticationInfo(username, password, getName());
        ai.setCredentialsSalt(ByteSource.Util.bytes(username+salt2)); // 盐是用户名+随机数
        return ai;
    }
}

此处就是把生成密码散列值中生成的相应数据组装为 SimpleAuthenticationInfo，通过 SimpleAuthenticationInfo 的 credentialsSalt 设置盐，HashedCredentialsMatcher 会自动识别这个盐。

ini配置

; shiro-hashedCredentialsMatcher.ini
[main]
credentialsMatcher=org.apache.shiro.authc.credential.HashedCredentialsMatcher
credentialsMatcher.hashAlgorithmName=md5
credentialsMatcher.hashIterations=2
credentialsMatcher.storedCredentialsHexEncoded=true

myRealm=com.github.zhangkaitao.shiro.chapter5.hash.realm.MyRealm2
myRealm.credentialsMatcher=$credentialsMatcher
securityManager.realms=$myRealm

通过 credentialsMatcher.hashAlgorithmName=md5 指定散列算法为 md5，需要和生成密码时的一样；
credentialsMatcher.hashIterations=2，散列迭代次数，需要和生成密码时的意义；
credentialsMatcher.storedCredentialsHexEncoded=true 表示是否存储散列后的密码为 16 进制，需要和生成密码时的一样，默认是 base64；

此处最需要注意的就是 HashedCredentialsMatcher 的算法需要和生成密码时的算法一样。另外 HashedCredentialsMatcher 会自动根据 AuthenticationInfo 的类型是否是 SaltedAuthenticationInfo 来获取 credentialsSalt 盐。

测试方法

@Test
public void testHashedCredentialsMatcherWithMyRealm2() {
    // 使用 testGeneratePassword 生成的散列密码
    login("classpath:shiro-hashedCredentialsMatcher.ini", "liu", "123");
}

密码重试次数限制

如在 1 个小时内密码最多重试 5 次，如果尝试次数超过 5 次就锁定 1 小时，1 小时后可再次重试，如果还是重试失败，可以锁定如 1 天，以此类推，防止密码被暴力破解。我们通过继承 HashedCredentialsMatcher，且使用 Ehcache 记录重试次数和超时时间。

// com.github.zhangkaitao.shiro.chapter5.hash.credentials.RetryLimitHashedCredentialsMatcher
public class RetryLimitHashedCredentialsMatcher extends HashedCredentialsMatcher {

    private Ehcache passwordRetryCache;

    public RetryLimitHashedCredentialsMatcher() {
        CacheManager cacheManager = CacheManager.newInstance(CacheManager.class.getClassLoader().getResource("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;
    }
}

<!-- ehcache.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<ehcache name="es">
    <diskStore path="java.io.tmpdir"/>
    <!-- 登录记录缓存 锁定 10 分钟 -->
    <cache name="passwordRetryCache"
           maxEntriesLocalHeap="2000"
           eternal="false"
           timeToIdleSeconds="3600"
           timeToLiveSeconds="0"
           overflowToDisk="false"
           statistics="true">
    </cache>
</ehcache>

如上代码逻辑比较简单，即如果密码输入正确清除 cache 中的记录；否则 cache 中的重试次数 +1，如果超出 5 次那么抛出异常表示超出重试次数了。

ini 配置文件

[main]
credentialsMatcher=com.github.zhangkaitao.shiro.chapter5.hash.credentials.RetryLimitHashedCredentialsMatcher
credentialsMatcher.hashAlgorithmName=md5
credentialsMatcher.hashIterations=2
credentialsMatcher.storedCredentialsHexEncoded=true

myRealm=com.github.zhangkaitao.shiro.chapter5.hash.realm.MyRealm2
myRealm.credentialsMatcher=$credentialsMatcher
securityManager.realms=$myRealm

测试

@Test(expected = ExcessiveAttemptsException.class)
public void testRetryLimitHashedCredentialsMatcherWithMyRealm() {
    for(int i = 1; i <= 5; i++) {
        try {
            login("classpath:shiro-retryLimitHashedCredentialsMatcher.ini", "liu", "234");
        } catch (Exception e) {/*ignore*/}
    }
    login("classpath:shiro-retryLimitHashedCredentialsMatcher.ini", "liu", "234");
}

转载请注明来源，欢迎对文章中的引用来源进行考证，欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论，也可以邮件至 bin07280@qq.com