libsecurity_ssl/lib/cryptType.h

   1 /*
   2  * Copyright (c) 1999-2001,2005-2008,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  * cryptType.h - CipherSpec and CipherContext structures
  26  */
  27
  28 #ifndef _CRYPTTYPE_H_
  29 #define _CRYPTTYPE_H_ 1
  30
  31 // #include <Security/CipherSuite.h>
  32 #include "tls_hmac.h"
  33 #include "tls_hashhmac.h"
  34 #include "symCipher.h"
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /*
  41  * An SSLRecordContext contains four of these - one for each of {read,write} and for
  42  * {current, pending}.
  43  */
  44 typedef struct CipherContext
  45 {
  46     const HashHmacReference     *macRef;                        /* HMAC (TLS) or digest (SSL) */
  47     const SSLSymmetricCipher    *symCipher;
  48
  49     /* this is a context which is reused once per record */
  50     HashHmacContext                             macCtx;
  51     /*
  52      * Crypto context (eg: for CommonCrypto-based symmetric ciphers, this will be a CCCryptorRef)
  53      */
  54     SymCipherContext            cipherCtx;
  55
  56     /* encrypt or decrypt. needed in CDSASymmInit, may not be needed anymore (TODO)*/
  57     uint8_t                                             encrypting;
  58
  59     uint64_t                            sequenceNum;
  60     uint8_t                             ready;
  61
  62     /* in SSL2 mode, the macSecret is the same size as the
  63      * cipher key - which is 24 bytes in the 3DES case. */
  64     uint8_t                                             macSecret[48 /* SSL_MAX_DIGEST_LEN */];
  65 } CipherContext;
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif
  70
  71 #endif /* _CRYPTTYPE_H_ */