libsecurity_ssl/lib/cipherSpecs.h

   1 /*
   2  * Copyright (c) 1999-2001,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  * cipherSpecs.h - SSLCipherSpec declarations
  26  */
  27
  28 #ifndef _CIPHER_SPECS_H_
  29 #define _CIPHER_SPECS_H_
  30
  31 #include <stdint.h>
  32 #include "CipherSuite.h"
  33
  34 #include "sslContext.h"
  35 #include "cryptType.h"
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /* Cipher Algorithm */
  42 typedef enum {
  43     SSL_CipherAlgorithmNull,
  44     SSL_CipherAlgorithmRC2_128,
  45     SSL_CipherAlgorithmRC4_128,
  46     SSL_CipherAlgorithmDES_CBC,
  47     SSL_CipherAlgorithm3DES_CBC,
  48     SSL_CipherAlgorithmAES_128_CBC,
  49     SSL_CipherAlgorithmAES_256_CBC,
  50     SSL_CipherAlgorithmAES_128_GCM,
  51     SSL_CipherAlgorithmAES_256_GCM,
  52 } SSL_CipherAlgorithm;
  53
  54 SSL_CipherAlgorithm sslCipherSuiteGetSymmetricCipherAlgorithm(SSLCipherSuite cipherSuite);
  55
  56 /*
  57  * Build ctx->validCipherSuites as a copy of all known CipherSpecs.
  58  */
  59 extern OSStatus sslBuildCipherSuiteArray(SSLContext *ctx);
  60
  61 /*
  62  * Initialize ctx->selectedCipherSpec based on ctx->selectedCipher.
  63  * ctx->selectedCipher MUST be a valid supported cipherSuite.
  64  */
  65 void InitCipherSpec(SSLContext *ctx);
  66
  67 /*
  68  * Given a valid ctx->selectedCipher and ctx->validCipherSuites, set
  69  * ctx->selectedCipherSpec as appropriate. Return an error if
  70  * ctx->selectedCipher could not be set as the current ctx->selectedCipherSpec.
  71  */
  72 OSStatus FindCipherSpec(SSLContext *ctx);
  73
  74 /*
  75  * Determine if an SSLCipherSuite is SSLv2 only.
  76  */
  77 #define CIPHER_SUITE_IS_SSLv2(suite)    ((suite & 0xff00) == 0xff00)
  78
  79 #ifdef __cplusplus
  80 }
  81 #endif
  82
  83 #endif  /* _CIPHER_SPECS_H_ */