/* * Copyright (c) 2004 Apple Computer, Inc. All Rights Reserved. * * @APPLE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this * file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_LICENSE_HEADER_END@ */ /*! @header CommonHMAC.h @abstract Keyed Message Authentication Code (HMAC) functions. */ #ifndef _CC_COMMON_HMAC_H_ #define _CC_COMMON_HMAC_H_ #include <CommonCrypto/CommonDigest.h> #include <sys/types.h> #include <Availability.h> #ifdef __cplusplus extern "C" { #endif /*! @enum CCHmacAlgorithm @abstract Algorithms implemented in this module. @constant kCCHmacAlgSHA1 HMAC with SHA1 digest @constant kCCHmacAlgMD5 HMAC with MD5 digest @constant kCCHmacAlgSHA256 HMAC with SHA256 digest @constant kCCHmacAlgSHA384 HMAC with SHA384 digest @constant kCCHmacAlgSHA512 HMAC with SHA512 digest @constant kCCHmacAlgSHA224 HMAC with SHA224 digest */ enum { kCCHmacAlgSHA1, kCCHmacAlgMD5, kCCHmacAlgSHA256, kCCHmacAlgSHA384, kCCHmacAlgSHA512, kCCHmacAlgSHA224 }; typedef uint32_t CCHmacAlgorithm; /*! @typedef CCHmacContext @abstract HMAC context. */ #define CC_HMAC_CONTEXT_SIZE 96 typedef struct { uint32_t ctx[CC_HMAC_CONTEXT_SIZE]; } CCHmacContext; /*! @function CCHmacInit @abstract Initialize an CCHmacContext with provided raw key bytes. @param ctx An HMAC context. @param algorithm HMAC algorithm to perform. @param key Raw key bytes. @param keyLength Length of raw key bytes; can be any length including zero. */ void CCHmacInit( CCHmacContext *ctx, CCHmacAlgorithm algorithm, const void *key, size_t keyLength) __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_2_0); /*! @function CCHmacUpdate @abstract Process some data. @param ctx An HMAC context. @param data Data to process. @param dataLength Length of data to process, in bytes. @discussion This can be called multiple times. */ void CCHmacUpdate( CCHmacContext *ctx, const void *data, size_t dataLength) __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_2_0); /*! @function CCHmacFinal @abstract Obtain the final Message Authentication Code. @param ctx An HMAC context. @param macOut Destination of MAC; allocated by caller. @discussion The length of the MAC written to *macOut is the same as the digest length associated with the HMAC algorithm: kCCHmacSHA1 : CC_SHA1_DIGEST_LENGTH kCCHmacMD5 : CC_MD5_DIGEST_LENGTH */ void CCHmacFinal( CCHmacContext *ctx, void *macOut) __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_2_0); /* * Stateless, one-shot HMAC function. * Output is written to caller-supplied buffer, as in CCHmacFinal(). */ void CCHmac( CCHmacAlgorithm algorithm, /* kCCHmacSHA1, kCCHmacMD5 */ const void *key, size_t keyLength, /* length of key in bytes */ const void *data, size_t dataLength, /* length of data in bytes */ void *macOut) /* MAC written here */ __OSX_AVAILABLE_STARTING(__MAC_10_4, __IPHONE_2_0); #ifdef __cplusplus } #endif #endif /* _CC_COMMON_HMAC_H_ */