YYKit源码探究(二) —— NSString分类之Hash(一)

版本记录

版本号 时间
V1.0 2018.03.20

前言

iOS圈内有几个人大家基本都知道,比如说王巍、唐巧,还有YYKit框架的作者现任职于滴滴的郭曜源 - ibireme等。这里有一篇唐巧对他的专访,还有他的 GitHub - Yaoyuan博客,这里贴出来框架YYKit 框架。接下来几篇我们就一起来看一下这个框架。感兴趣的可以看上面写的几篇。
1. YYKit源码探究(一) —— 基本概览

回顾

上一篇我们进行了YYKit的整体了解,这一篇我们就看一下NSString分类NSString+YYAdd


基本结构

下面我们就看一下NSString分类NSString+YYAdd的架构,如下图所示。

其实这里面包含了六个部分:

  • Hash
  • Encode and decode
  • Drawing
  • Regular Expression
  • NSNumber Compatible
  • Utilities

Hash

下面我们就看一下Hash这部分的接口。

/**
 Returns a lowercase NSString for md2 hash.
 */
- (nullable NSString *)md2String;

/**
 Returns a lowercase NSString for md4 hash.
 */
- (nullable NSString *)md4String;

/**
 Returns a lowercase NSString for md5 hash.
 */
- (nullable NSString *)md5String;

/**
 Returns a lowercase NSString for sha1 hash.
 */
- (nullable NSString *)sha1String;

/**
 Returns a lowercase NSString for sha224 hash.
 */
- (nullable NSString *)sha224String;

/**
 Returns a lowercase NSString for sha256 hash.
 */
- (nullable NSString *)sha256String;

/**
 Returns a lowercase NSString for sha384 hash.
 */
- (nullable NSString *)sha384String;

/**
 Returns a lowercase NSString for sha512 hash.
 */
- (nullable NSString *)sha512String;

/**
 Returns a lowercase NSString for hmac using algorithm md5 with key.
 @param key The hmac key.
 */
- (nullable NSString *)hmacMD5StringWithKey:(NSString *)key;

/**
 Returns a lowercase NSString for hmac using algorithm sha1 with key.
 @param key The hmac key.
 */
- (nullable NSString *)hmacSHA1StringWithKey:(NSString *)key;

/**
 Returns a lowercase NSString for hmac using algorithm sha224 with key.
 @param key The hmac key.
 */
- (nullable NSString *)hmacSHA224StringWithKey:(NSString *)key;

/**
 Returns a lowercase NSString for hmac using algorithm sha256 with key.
 @param key The hmac key.
 */
- (nullable NSString *)hmacSHA256StringWithKey:(NSString *)key;

/**
 Returns a lowercase NSString for hmac using algorithm sha384 with key.
 @param key The hmac key.
 */
- (nullable NSString *)hmacSHA384StringWithKey:(NSString *)key;

/**
 Returns a lowercase NSString for hmac using algorithm sha512 with key.
 @param key The hmac key.
 */
- (nullable NSString *)hmacSHA512StringWithKey:(NSString *)key;

/**
 Returns a lowercase NSString for crc32 hash.
 */
- (nullable NSString *)crc32String;

其实这部分接口做的是两部分的功能:

  • 对字符串进行md2、md4、md5、sha1、sha224、sha256、sha384、sha512进行加密。
  • 对字符串进行md4、md5、sha1、sha224、sha256、sha384、sha512与指定的key进行加密。
  • 进行crc32加密。

下面我们就对指定的两个具有代表性的方法实现进行说明和解析。


sha512

首先我们看一下这个方法的接口调用示例和实现。

1. 接口调用示例

/**
 Returns a lowercase NSString for sha512 hash.
 */
- (nullable NSString *)sha512String;

下面我们就调用一下

NSString *str = @"abcdefgh";
NSString *sha512Str = [str sha512String];
NSLog(@"sha512Str = %@", sha512Str);
NSLog(@"sha512Str length = %ld", sha512Str.length);

接着看一下输出结果

2018-03-16 14:37:09.867891+0800 JJWebImage[28481:3808722] sha512Str = a3a8c81bc97c2560010d7389bc88aac974a104e0e2381220c6e084c4dccd1d2d17d4f86db31c2a851dc80e6681d74733c55dcd03dd96f6062cdda12a291ae6ce
2018-03-16 14:38:51.437735+0800 JJWebImage[28488:3809777] sha512Str length = 128

可以看见,加密后数据为128位十六进制说,换算成二进制数就是512位。

2. 接口实现

下面我们就看一下接口的实现。

- (nullable NSString *)sha512String;
- (NSString *)sha512String {
    return [[self dataUsingEncoding:NSUTF8StringEncoding] sha512String];
}

这里首先调用的就是系统的NSString接口dataUsingEncoding:方法,将NSString转化为NSData对象,- (nullable NSData *)dataUsingEncoding:(NSStringEncoding)encoding;

下面这里就是调用NSData+YYAdd分类里面的方法sha512String,将NSData对象进行加密后转化为NSString对象。

- (NSString *)sha512String {
    unsigned char result[CC_SHA512_DIGEST_LENGTH];
    CC_SHA512(self.bytes, (CC_LONG)self.length, result);
    NSMutableString *hash = [NSMutableString
                             stringWithCapacity:CC_SHA512_DIGEST_LENGTH * 2];
    for (int i = 0; i < CC_SHA512_DIGEST_LENGTH; i++) {
        [hash appendFormat:@"%02x", result[i]];
    }
    return hash;
}

上面就是简单的实现,其他sha224等的实现都是类似的。


带key的sha512

首先我们看一下这个方法的接口调用示例和实现。

1. 接口调用示例

/**
 Returns a lowercase NSString for hmac using algorithm sha512 with key.
 @param key The hmac key.
 */
- (nullable NSString *)hmacSHA512StringWithKey:(NSString *)key;

看一下下面这个简单例子

NSString *str = @"abcdefgh";
NSString *sha512Str = [str hmacSHA512StringWithKey:@"zzz"];
NSLog(@"sha512Str = %@", sha512Str);
NSLog(@"sha512Str length = %ld", sha512Str.length);

看下面输出结果

2018-03-16 15:25:29.825692+0800 JJWebImage[95751:6030222] sha512Str = e64db1c1b01c362931b283d28cfbf6baafd807c10cf07328cda9b37fb73b4571a76beb15d7dc6d16888d593a233974679af8a49e0543edbfeab8790eb86bb5c9
2018-03-16 15:25:29.825955+0800 JJWebImage[95751:6030222] sha512Str length = 128

2. 接口实现

下面我们就看一下接口的实现。

/**
 Returns a lowercase NSString for hmac using algorithm sha512 with key.
 @param key The hmac key.
 */
- (nullable NSString *)hmacSHA512StringWithKey:(NSString *)key;
- (NSString *)hmacSHA512StringWithKey:(NSString *)key {
    return [[self dataUsingEncoding:NSUTF8StringEncoding]
            hmacSHA512StringWithKey:key];
}

下面就是NSData的分类里面了

- (NSString *)hmacSHA512StringWithKey:(NSString *)key {
    return [self hmacStringUsingAlg:kCCHmacAlgSHA512 withKey:key];
}
- (NSString *)hmacStringUsingAlg:(CCHmacAlgorithm)alg withKey:(NSString *)key {
    size_t size;
    switch (alg) {
        case kCCHmacAlgMD5: size = CC_MD5_DIGEST_LENGTH; break;
        case kCCHmacAlgSHA1: size = CC_SHA1_DIGEST_LENGTH; break;
        case kCCHmacAlgSHA224: size = CC_SHA224_DIGEST_LENGTH; break;
        case kCCHmacAlgSHA256: size = CC_SHA256_DIGEST_LENGTH; break;
        case kCCHmacAlgSHA384: size = CC_SHA384_DIGEST_LENGTH; break;
        case kCCHmacAlgSHA512: size = CC_SHA512_DIGEST_LENGTH; break;
        default: return nil;
    }
    unsigned char result[size];
    const char *cKey = [key cStringUsingEncoding:NSUTF8StringEncoding];
    CCHmac(alg, cKey, strlen(cKey), self.bytes, self.length, result);
    NSMutableString *hash = [NSMutableString stringWithCapacity:size * 2];
    for (int i = 0; i < size; i++) {
        [hash appendFormat:@"%02x", result[i]];
    }
    return hash;
}

这个也很好理解,和上面不带key的方法实现相比,不同的是这里用的是系统方法CCHmac

后记

本篇讲述的是NSString分类中的Hash部分接口,包括接口的调用示例以及接口的实现方法。喜欢的给个关注和赞,谢谢~~~

推荐阅读更多精彩内容