ObjFW
OFHash.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
3  * Jonathan Schleifer <js@webkeks.org>
4  *
5  * All rights reserved.
6  *
7  * This file is part of ObjFW. It may be distributed under the terms of the
8  * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
9  * the packaging of this file.
10  *
11  * Alternatively, it may be distributed under the terms of the GNU General
12  * Public License, either version 2 or 3, which can be found in the file
13  * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
14  * file.
15  */
16 
17 #import "OFObject.h"
18 
19 OF_ASSUME_NONNULL_BEGIN
20 
26 @protocol OFHash <OFObject>
27 #ifdef OF_HAVE_PROPERTIES
28 @property (readonly, getter=isCalculated) bool calculated;
29 #endif
30 
36 + (instancetype)hash;
37 
43 + (size_t)digestSize;
44 
50 + (size_t)blockSize;
51 
58 - (void)updateWithBuffer: (const void*)buffer
59  length: (size_t)length;
60 
69 - (const uint8_t*)digest OF_RETURNS_INNER_POINTER;
70 
76 - (bool)isCalculated;
77 
85 - (void)reset;
86 @end
87 
88 OF_ASSUME_NONNULL_END
instancetype hash()
Creates a new hash.
The root class for all other classes inside ObjFW.
Definition: OFObject.h:364
size_t digestSize()
Returns the digest size of the hash, in bytes.
void reset()
Resets all state so that a new hash can be calculated.
A protocol for classes providing hash functions.
Definition: OFHash.h:26
const uint8_t * digest()
Returns a buffer containing the hash.
bool isCalculated()
Returns a boolean whether the hash has already been calculated.
size_t blockSize()
Returns the block size of the hash, in bytes.