This repository has been archived by the owner on Sep 20, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
NSStream+CryptoKit.h
171 lines (143 loc) · 7.14 KB
/
NSStream+CryptoKit.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
//
// NSStream+CryptoKit.h
// CryptoKit
//
// Created by Andreas Meingast on 11/06/16.
// Copyright © 2016 Andreas Meingast. All rights reserved.
//
#import <CryptoKit/CryptoKitTypes.h>
NS_ASSUME_NONNULL_BEGIN
@interface NSStream (CryptoKit)
#pragma mark - Digests
/**
* A convenience method for calculating the MD2 digest of contents of the provided inputStream without having to open or
* close the underlying stream manually.
*/
+ (nullable NSData *)md2HashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the MD2 digest of contents of the provided inputStream in human readable form
* without having to open or close the underlying stream manually.
*/
+ (nullable NSString *)md2HexHashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the MD4 digest of contents of the provided inputStream without having to open or
* close the underlying stream manually.
*/
+ (nullable NSData *)md4HashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the MD4 digest of contents of the provided inputStream in human readable form
* without having to open or close the underlying stream manually.
*/
+ (nullable NSString *)md4HexHashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the MD5 digest of contents of the provided inputStream without having to open or
* close the underlying stream manually.
*/
+ (nullable NSData *)md5HashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the MD5 digest of contents of the provided inputStream in human readable form
* without having to open or close the underlying stream manually.
*/
+ (nullable NSString *)md5HexHashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the SHA1 digest of contents of the provided inputStream without having to open
* or close the underlying stream manually.
*/
+ (nullable NSData *)sha1HashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the SHA1 digest of contents of the provided inputStream in human readable form
* without having to open or close the underlying stream manually.
*/
+ (nullable NSString *)sha1HexHashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the SHA224 digest of contents of the provided inputStream without having to open
* or close the underlying stream manually.
*/
+ (nullable NSData *)sha224HashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the SHA224 digest of contents of the provided inputStream in human readable form
* without having to open or close the underlying stream manually.
*/
+ (nullable NSString *)sha224HexHashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the SHA384 digest of contents of the provided inputStream without having to open
* or close the underlying stream manually.
*/
+ (nullable NSData *)sha384HashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the SHA384 digest of contents of the provided inputStream in human readable form
* without having to open or close the underlying stream manually.
*/
+ (nullable NSString *)sha384HexHashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the SHA512 digest of contents of the provided inputStream without having to open
* or close the underlying stream manually.
*/
+ (nullable NSData *)sha512HashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating the SHA512 digest of contents of the provided inputStream in human readable form
* without having to open or close the underlying stream manually.
*/
+ (nullable NSString *)sha512HexHashForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
/**
* A convenience method for calculating digests of contents of the provided inputStream without having to open or close
* the underlying stream manually.
*/
+ (nullable CKDigestBatchResult *)hashesForInputStream:(NSInputStream *)inputStream
error:(NSError *__nullable *)error;
#pragma mark - Encryption
/**
* A convenience method for encrypting inputStreams without having to open or close the underlying streams manually.
*/
+ (BOOL)encryptInputStream:(NSInputStream *)inputStream
toOutputStream:(NSOutputStream *)outputStream
password:(NSString *)password
error:(NSError *__nullable *)error;
/**
* A convenience method for encrypting inputStreams without having to open or close the underlying streams manually.
*/
+ (BOOL)decryptInputStream:(NSInputStream *)inputStream
toOutputStream:(NSOutputStream *)outputStream
password:(NSString *)password
error:(NSError *__nullable *)error;
/**
* A convenience method for re-encrypting inputStreams without having to open or close the underlying streams manually.
*/
+ (BOOL)recryptInputStream:(NSInputStream *)inputStream
toOutputStream:(NSOutputStream *)outputStream
password:(NSString *)password
newPassword:(NSString *)newPassword
error:(NSError *__nullable *)error;
#pragma mark - Partitioning
/**
* A convenience method for partitioning the contents of inputStreams without having to open or close the stream
* manually.
*/
+ (BOOL)disassembleFromInputStream:(NSInputStream *)inputStream
partitionStrategy:(CKPartitionStrategy)partitionStrategy
password:(NSString *)password
chunkHandler:(CKChunkHandler)chunkHandler
error:(NSError *__nullable *)error;
/**
* A convenience method for assembling partitioned file-chunks without having to open or close the stream manually.
*/
+ (BOOL)assembleToOutputStream:(NSOutputStream *)outputStream
password:(NSString *)password
chunkProvider:(CKChunkProvider)chunkProvider
error:(NSError *__nullable *)error;
@end
NS_ASSUME_NONNULL_END