ObjFW
Instance Methods | Class Methods | Properties | List of all members
OFHMAC Class Reference

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

#import <ObjFW/OFHMAC.h>

Inheritance diagram for OFHMAC:
OFObject <OFObject>

Instance Methods

(id) - initWithHashClass:
 Initialized an already allocated OFHMAC with the specified hashing algorithm. More...
 
(void) - setKey:length:
 Sets the key for the HMAC. More...
 
(void) - updateWithBuffer:length:
 Adds a buffer to the HMAC to be calculated. More...
 
(const unsigned char *) - digest
 Returns a buffer containing the HMAC. More...
 
(size_t) - digestSize
 Returns the size of the digest. More...
 
(void) - reset
 Resets the HMAC so that it can be calculated for a new message. More...
 
(void) - zero
 This is like reset, but also zeroes the hashed key and all state. More...
 
- Instance Methods inherited from OFObject
(id) - init
 Initializes an already allocated object. More...
 
(OFString *) - className
 Returns the name of the object's class. More...
 
(OFString *) - description
 Returns a description for the object. More...
 
(void *) - allocMemoryWithSize:
 Allocates memory and stores it in the object's memory pool. More...
 
(void *) - allocMemoryWithSize:count:
 Allocates memory for the specified number of items and stores it in the object's memory pool. More...
 
(nullable void *) - resizeMemory:size:
 Resizes memory in the object's memory pool to the specified size. More...
 
(nullable void *) - resizeMemory:size:count:
 Resizes memory in the object's memory pool to the specific number of items of the specified size. More...
 
(void) - freeMemory:
 Frees allocated memory and removes it from the object's memory pool. More...
 
(void) - dealloc
 Deallocates the object. More...
 
(void) - performSelector:afterDelay:
 Performs the specified selector after the specified delay. More...
 
(void) - performSelector:withObject:afterDelay:
 Performs the specified selector with the specified object after the specified delay. More...
 
(void) - performSelector:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:waitUntilDone:
 Performs the specified selector on the specified thread. More...
 
(void) - performSelector:onThread:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified object. More...
 
(void) - performSelector:onThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:waitUntilDone:
 Performs the specified selector on the main thread. More...
 
(void) - performSelectorOnMainThread:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified object. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelector:onThread:afterDelay:
 Performs the specified selector on the specified thread after the specified delay. More...
 
(void) - performSelector:onThread:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified object after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(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. More...
 
(void) - doesNotRecognizeSelector:
 Handles messages which are not understood by the receiver. More...
 
(OFString *) - stringBySerializing
 Creates a string by serializing the receiver. More...
 
- Instance Methods inherited from <OFObject>
(bool) - isKindOfClass:
 Returns a boolean whether the object of the specified kind. More...
 
(bool) - isMemberOfClass:
 Returns a boolean whether the object is a member of the specified class. More...
 
(bool) - respondsToSelector:
 Returns a boolean whether the object responds to the specified selector. More...
 
(nullable IMP) - methodForSelector:
 Returns the implementation for the specified selector. More...
 
(nullable const char *) - typeEncodingForSelector:
 Returns the type encoding for the specified selector. More...
 
(nullable id) - performSelector:
 Performs the specified selector. More...
 
(nullable id) - performSelector:withObject:
 Performs the specified selector with the specified object. More...
 
(nullable id) - performSelector:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(uint32_t) - hash
 Calculates a hash for the object. More...
 
(id) - retain
 Increases the retain count. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(id) - autorelease
 Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...
 
(id) - self
 Returns the receiver. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
(bool) - allowsWeakReference
 Returns whether the class allows weak references. More...
 
(bool) - retainWeakReference
 Retain a weak reference to this object. More...
 

Class Methods

(instancetype) + HMACWithHashClass:
 Returns a new OFHMAC with the specified hashing algorithm. More...
 
- Class Methods inherited from OFObject
(void) + load
 A method which is called once when the class is loaded into the runtime. More...
 
(void) + unload
 A method which is called when the class is unloaded from the runtime. More...
 
(void) + initialize
 A method which is called the moment before the first call to the class is being made. More...
 
(id) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object. More...
 
(id) + new
 Allocates memory for a new instance and calls init on it. More...
 
(Class) + class
 Returns the class. More...
 
(OFString *) + className
 Returns the name of the class as a string. More...
 
(bool) + isSubclassOfClass:
 Returns a boolean whether the class is a subclass of the specified class. More...
 
(Class) + superclass
 Returns the superclass of the class. More...
 
(bool) + instancesRespondToSelector:
 Checks whether instances of the class respond to a given selector. More...
 
(bool) + conformsToProtocol:
 Checks whether the class conforms to a given protocol. More...
 
(nullable IMP) + instanceMethodForSelector:
 Returns the implementation of the instance method for the specified selector. More...
 
(nullable const char *) + typeEncodingForInstanceSelector:
 Returns the type encoding of the instance method for the specified selector. More...
 
(OFString *) + description
 Returns a description for the class, which is usually the class name. More...
 
(nullable IMP) + replaceClassMethod:withMethodFromClass:
 Replaces a class method with a class method from another class. More...
 
(nullable IMP) + replaceInstanceMethod:withMethodFromClass:
 Replaces an instance method with an instance method from another class. More...
 
(nullable IMP) + replaceClassMethod:withImplementation:typeEncoding:
 Replaces or adds a class method. More...
 
(nullable IMP) + replaceInstanceMethod:withImplementation:typeEncoding:
 Replaces or adds an instance method. More...
 
(void) + inheritMethodsFromClass:
 Adds all methods from the specified class to the class that is the receiver. More...
 
(BOOL) + resolveClassMethod:
 Try to resolve the specified class method. More...
 
(BOOL) + resolveInstanceMethod:
 Try to resolve the specified instance method. More...
 
(id) + copy
 Returns the class. More...
 

Properties

Class< OFCryptoHashhashClass
 

Detailed Description

A class which provides methods to calculate an HMAC.

Method Documentation

◆ digest()

- (const unsigned char *) digest

Returns 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.

Returns
A buffer containing the hash

◆ digestSize()

- (size_t) digestSize

Returns the size of the digest.

Returns
The size of the digest.

◆ HMACWithHashClass:()

+ (instancetype) HMACWithHashClass: (Class <OFCryptoHash>)  hashClass

Returns a new OFHMAC with the specified hashing algorithm.

Parameters
hashClassThe class of the hashing algorithm
Returns
A new, autoreleased OFHMAC

◆ initWithHashClass:()

- (id) initWithHashClass: (Class <OFCryptoHash>)  hashClass

Initialized an already allocated OFHMAC with the specified hashing algorithm.

Parameters
hashClassThe class of the hashing algorithm
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
keyThe key for the HMAC
lengthThe 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
bufferThe buffer which should be included into the calculation
lengthThe length of the buffer

◆ 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

◆ hashClass

- (Class<OFCryptoHash>) hashClass
readnonatomicassign

The class for the cryptographic hash used by the HMAC.


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