libsecurity_ssl/lib/tls_hmac.h

   1 /*
   2  * Copyright (c) 2002,2005-2007,2010-2012 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*
  25  * tls_hmac.h - Declarations of HMAC routines used by TLS
  26  */
  27
  28 #ifndef _TLS_HMAC_H_
  29 #define _TLS_HMAC_H_
  30
  31 #ifdef  __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #include "ssl.h"
  36 #include "sslPriv.h"
  37
  38 /* forward declaration of HMAC object */
  39 struct                                          HMACReference;
  40
  41 /* Opaque reference to an HMAC session context */
  42 struct                      HMACContext;
  43 typedef struct HMACContext  *HMACContextRef;
  44
  45 /* The HMAC algorithms we support */
  46 typedef enum {
  47         HA_Null = 0,            // i.e., uninitialized
  48         HA_SHA1,
  49         HA_MD5,
  50     HA_SHA256,
  51     HA_SHA384
  52 } HMAC_Algs;
  53
  54 /* For convenience..the max size of HMAC, in bytes, this module will ever return */
  55 #define TLS_HMAC_MAX_SIZE               48
  56
  57 /* Create an HMAC session */
  58 typedef OSStatus (*HMAC_AllocFcn) (
  59         const struct HMACReference      *hmac,
  60         SSLContext                                      *ctx,
  61         const void                                      *keyPtr,
  62         size_t                      keyLen,
  63         HMACContextRef                          *hmacCtx);                      // RETURNED
  64
  65 /* Free a session */
  66 typedef OSStatus (*HMAC_FreeFcn) (
  67         HMACContextRef  hmacCtx);
  68
  69 /* Reusable init, using same key */
  70 typedef OSStatus (*HMAC_InitFcn) (
  71         HMACContextRef  hmacCtx);
  72
  73 /* normal crypt ops */
  74 typedef OSStatus (*HMAC_UpdateFcn) (
  75         HMACContextRef  hmacCtx,
  76         const void              *data,
  77         size_t          dataLen);
  78
  79 typedef OSStatus (*HMAC_FinalFcn) (
  80         HMACContextRef  hmacCtx,
  81         void                    *hmac,                  // mallocd by caller
  82         size_t          *hmacLen);              // IN/OUT
  83
  84 /* one-shot */
  85 typedef OSStatus (*HMAC_HmacFcn) (
  86         HMACContextRef  hmacCtx,
  87         const void              *data,
  88         size_t          dataLen,
  89         void                    *hmac,                  // mallocd by caller
  90         size_t          *hmacLen);              // IN/OUT
  91
  92 typedef struct HMACReference {
  93         size_t          macSize;
  94         HMAC_Algs               alg;
  95         HMAC_AllocFcn   alloc;
  96         HMAC_FreeFcn    free;
  97         HMAC_InitFcn    init;
  98         HMAC_UpdateFcn  update;
  99         HMAC_FinalFcn   final;
 100         HMAC_HmacFcn    hmac;
 101 } HMACReference;
 102
 103 extern const HMACReference TlsHmacNull;
 104 extern const HMACReference TlsHmacSHA1;
 105 extern const HMACReference TlsHmacMD5;
 106 extern const HMACReference TlsHmacSHA256;
 107 extern const HMACReference TlsHmacSHA384;
 108
 109 #ifdef  __cplusplus
 110 }
 111 #endif
 112 #endif  /* _TLS_HMAC_H_ */