OFCryptographicHash.h

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFObject.h"
 
OF_ASSUME_NONNULL_BEGIN

@protocol OFCryptographicHash <OFObject, OFCopying>
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic) size_t digestSize;
@property (class, readonly, nonatomic) size_t blockSize;
#endif

@property (readonly, nonatomic) size_t digestSize;

@property (readonly, nonatomic) size_t blockSize;

@property (readonly, nonatomic) bool allowsSwappableMemory;

@property (readonly, nonatomic, getter=isCalculated) bool calculated;

@property (readonly, nonatomic) const unsigned char *digest
    OF_RETURNS_INNER_POINTER;

+ (instancetype)hashWithAllowsSwappableMemory: (bool)allowsSwappableMemory;

+ (size_t)digestSize;

+ (size_t)blockSize;

- (instancetype)initWithAllowsSwappableMemory: (bool)allowsSwappableMemory;
 
- (instancetype)init OF_UNAVAILABLE;

- (void)updateWithBuffer: (const void *)buffer length: (size_t)length;

- (void)calculate;

- (void)reset;
@end
 
OF_ASSUME_NONNULL_END