A class which provides methods to calculate an HMAC. More...

#include <ObjFW/OFHMAC.h>

Inheritance diagram for OFHMAC:

Instance Methods
(instancetype)	- initWithHashClass:allowsSwappableMemory:
	Initialized an already allocated OFHMAC with the specified hashing algorithm.

(void)	- setKey:length:
	Sets the key for the HMAC.

(void)	- updateWithBuffer:length:
	Adds a buffer to the HMAC to be calculated.

(void)	- calculate
	Performs the final calculation of the HMAC.

(void)	- reset
	Resets the HMAC so that it can be calculated for a new message.

(void)	- zero
	This is like reset, but also zeroes the hashed key and all state.

Instance Methods inherited from OFObject
(instancetype)	- init
	Initializes an already allocated object.

(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.

(void)	- dealloc
	Deallocates the object.

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded.

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.

Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.

(unsigned int)	- retainCount
	Returns the retain count.

(bool)	- isProxy
	Returns whether the object is a proxy object.

(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.

(nullable id)	- performSelector:
	Performs the specified selector.

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(bool)	- isEqual:
	Checks two objects for equality.

(instancetype)	- retain
	Increases the retain count.

(void)	- release
	Decreases the retain count.

(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.

(instancetype)	- self
	Returns the receiver.

(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.

(bool)	- retainWeakReference
	Retain a weak reference to this object.

Class Methods
(instancetype)	+ HMACWithHashClass:allowsSwappableMemory:
	Returns a new OFHMAC with the specified hashing algorithm.

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.

(void)	+ unload
	A method which is called when the class is unloaded from the runtime.

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.

(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.

(Class)	+ class
	Returns the class.

(OFString *)	+ className
	Returns the name of the class as a string.

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.

(nullable Class)	+ superclass
	Returns the superclass of the class.

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.

(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.

(OFString *)	+ description
	Returns a description for the class, which is usually the class name.

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.

(bool)	+ resolveClassMethod:
	Try to resolve the specified class method.

(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.

(id)	+ copy
	Returns the class.

Properties
Class< OFCryptographicHash >	hashClass
	The class for the cryptographic hash used by the HMAC.

bool	allowsSwappableMemory
	Whether data may be stored in swappable memory.

const unsigned char *	digest
	A buffer containing the HMAC.

size_t	digestSize
	The size of the digest.

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object.

Detailed Description

A class which provides methods to calculate an HMAC.

Method Documentation

◆ calculate

- (void) calculate

Performs the final calculation of the HMAC.

Exceptions

OFHashAlreadyCalculatedException The HMAC has already been calculated

◆ HMACWithHashClass:allowsSwappableMemory:

+ (instancetype) HMACWithHashClass:		(Class <OFCryptographicHash>)	hashClass
allowsSwappableMemory:		(bool)	allowsSwappableMemory

Returns a new OFHMAC with the specified hashing algorithm.

Parameters

hashClass	The class of the hashing algorithm
allowsSwappableMemory	Whether data may be stored in swappable memory

Returns: A new, autoreleased OFHMAC

◆ initWithHashClass:allowsSwappableMemory:

- (instancetype) initWithHashClass:		(Class <OFCryptographicHash>)	hashClass
allowsSwappableMemory:		(bool)	allowsSwappableMemory

Initialized an already allocated OFHMAC with the specified hashing algorithm.

Parameters

hashClass	The class of the hashing algorithm
allowsSwappableMemory	Whether data may be stored in swappable memory

Returns: An initialized OFHMAC

◆ reset

- (void) reset

Resets the HMAC so that it can be calculated for a new message.

Note: This does not reset the key so that a new HMAC with the same key can be calculated efficiently. If you want to reset both, use setKey:length:.

Warning: This invalidates any pointer previously returned by digest. If you are still interested in the previous digest, you need to memcpy it yourself before calling reset!

◆ setKey:length:

- (void) setKey:		(const void *)	key
length:		(size_t)	length

Sets the key for the HMAC.

Note: This resets the HMAC!

Warning: This invalidates any pointer previously returned by digest. If you are still interested in the previous digest, you need to memcpy it yourself before calling setKey:length:!

Parameters

key	The key for the HMAC
length	The length of the key for the HMAC

◆ updateWithBuffer:length:

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

Adds a buffer to the HMAC to be calculated.

Parameters

buffer	The buffer which should be included into the calculation
length	The length of the buffer

Exceptions

OFHashAlreadyCalculatedException The HMAC has already been calculated

◆ zero

- (void) zero

This is like reset, but also zeroes the hashed key and all state.

Warning: After calling this, you must set a new key before reusing the HMAC!

Property Documentation

◆ digest

- (const unsigned char *) digest

readnonatomicassign

A buffer containing the HMAC.

The size of the buffer depends on the hash used. The buffer is part of the receiver's memory pool.

Exceptions

OFHashNotCalculatedException The HMAC hasn't been calculated yet

The documentation for this class was generated from the following files:

src/OFHMAC.h
src/OFHMAC.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ calculate

◆ HMACWithHashClass:allowsSwappableMemory:

◆ initWithHashClass:allowsSwappableMemory:

◆ reset

◆ setKey:length:

◆ updateWithBuffer:length:

◆ zero

Property Documentation

◆ digest