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
|
* file.
*/
#import "OFObject.h"
OF_ASSUME_NONNULL_BEGIN
/*!
* @protocol OFCryptoHash OFCryptoHash.h ObjFW/OFCryptoHash.h
*
* @brief A protocol for classes providing cryptographic hash functions.
*
* A cryptographic hash implementing this protocol can be copied. The entire
* state is copied, allowing to calculate a new hash from there. This is
* especially useful for generating many hashes with a common prefix.
*/
@protocol OFCryptoHash <OFObject, OFCopying>
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic) size_t digestSize;
@property (class, readonly, nonatomic) size_t blockSize;
#endif
/*!
* @brief The digest size of the cryptographic hash, in bytes.
*/
@property (readonly, nonatomic) size_t digestSize;
/*!
* @brief The block size of the cryptographic hash, in bytes.
*/
@property (readonly, nonatomic) size_t blockSize;
/*!
* @brief Whether data may be stored in swappable memory.
*/
@property (readonly, nonatomic) bool allowsSwappableMemory;
/*!
* @brief A boolean whether the hash has already been calculated.
*/
@property (readonly, nonatomic, getter=isCalculated) bool calculated;
/*!
* @brief A buffer containing the cryptographic hash.
*
* The size of the buffer depends on the hash used. The buffer is part of the
* receiver's memory pool.
*/
@property (readonly, nonatomic) const unsigned char *digest
OF_RETURNS_INNER_POINTER;
/*!
* @brief Creates a new cryptographic hash.
*
* @return A new autoreleased cryptographic hash
*/
+ (instancetype)cryptoHashWithAllowsSwappableMemory:
(bool)allowsSwappableMemory;
/*!
* @brief Returns the digest size of the cryptographic hash, in bytes.
*
* @return The digest size of the cryptographic hash, in bytes
*/
+ (size_t)digestSize;
/*!
* @brief Returns the block size of the cryptographic hash, in bytes.
*
* @return The block size of the cryptographic hash, in bytes
*/
+ (size_t)blockSize;
/*!
* @brief Initializes an already allocated cryptographic hash.
*
* @return An initialized cryptographic hash
*/
- (instancetype)initWithAllowsSwappableMemory: (bool)allowsSwappableMemory;
- (instancetype)init OF_UNAVAILABLE;
/*!
* @brief Adds a buffer to the cryptographic hash to be calculated.
*
* @param buffer The buffer which should be included into the calculation
* @param length The length of the buffer
*/
- (void)updateWithBuffer: (const void *)buffer
length: (size_t)length;
/*!
* @brief Resets all state so that a new hash can be calculated.
*
* @warning This invalidates any pointer previously returned by @ref digest. If
* you are still interested in the previous digest, you need to memcpy
* it yourself before calling @ref reset!
*/
- (void)reset;
@end
OF_ASSUME_NONNULL_END
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
|
* file.
*/
#import "OFObject.h"
OF_ASSUME_NONNULL_BEGIN
/**
* @protocol OFCryptoHash OFCryptoHash.h ObjFW/OFCryptoHash.h
*
* @brief A protocol for classes providing cryptographic hash functions.
*
* A cryptographic hash implementing this protocol can be copied. The entire
* state is copied, allowing to calculate a new hash from there. This is
* especially useful for generating many hashes with a common prefix.
*/
@protocol OFCryptoHash <OFObject, OFCopying>
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic) size_t digestSize;
@property (class, readonly, nonatomic) size_t blockSize;
#endif
/**
* @brief The digest size of the cryptographic hash, in bytes.
*/
@property (readonly, nonatomic) size_t digestSize;
/**
* @brief The block size of the cryptographic hash, in bytes.
*/
@property (readonly, nonatomic) size_t blockSize;
/**
* @brief Whether data may be stored in swappable memory.
*/
@property (readonly, nonatomic) bool allowsSwappableMemory;
/**
* @brief A boolean whether the hash has already been calculated.
*/
@property (readonly, nonatomic, getter=isCalculated) bool calculated;
/**
* @brief A buffer containing the cryptographic hash.
*
* The size of the buffer depends on the hash used. The buffer is part of the
* receiver's memory pool.
*/
@property (readonly, nonatomic) const unsigned char *digest
OF_RETURNS_INNER_POINTER;
/**
* @brief Creates a new cryptographic hash.
*
* @return A new autoreleased cryptographic hash
*/
+ (instancetype)cryptoHashWithAllowsSwappableMemory:
(bool)allowsSwappableMemory;
/**
* @brief Returns the digest size of the cryptographic hash, in bytes.
*
* @return The digest size of the cryptographic hash, in bytes
*/
+ (size_t)digestSize;
/**
* @brief Returns the block size of the cryptographic hash, in bytes.
*
* @return The block size of the cryptographic hash, in bytes
*/
+ (size_t)blockSize;
/**
* @brief Initializes an already allocated cryptographic hash.
*
* @return An initialized cryptographic hash
*/
- (instancetype)initWithAllowsSwappableMemory: (bool)allowsSwappableMemory;
- (instancetype)init OF_UNAVAILABLE;
/**
* @brief Adds a buffer to the cryptographic hash to be calculated.
*
* @param buffer The buffer which should be included into the calculation
* @param length The length of the buffer
*/
- (void)updateWithBuffer: (const void *)buffer
length: (size_t)length;
/**
* @brief Resets all state so that a new hash can be calculated.
*
* @warning This invalidates any pointer previously returned by @ref digest. If
* you are still interested in the previous digest, you need to memcpy
* it yourself before calling @ref reset!
*/
- (void)reset;
@end
OF_ASSUME_NONNULL_END
|