OSX/libsecurity_apple_csp/lib/DH_utils.h

   1 /*
   2  * Copyright (c) 2000-2001,2011,2014 Apple Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18
  19 /*
  20  * DH_utils.h
  21  */
  22 #ifndef _DH_UTILS_H_
  23 #define _DH_UTILS_H_
  24
  25 #include <openssl/dh.h>
  26 #include <AppleCSPSession.h>
  27 #include <security_cdsa_utilities/context.h>
  28
  29 #ifdef  __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 void throwDh(
  34         const char *op);
  35
  36 /*
  37  * Given a Context:
  38  * -- obtain CSSM key (there must only be one)
  39  * -- validate keyClass - MUST be private! (DH public keys are never found
  40  *    in contexts.)
  41  * -- validate keyUsage
  42  * -- convert to DH *, allocating the DH key if necessary
  43  */
  44 DH *contextToDhKey(
  45         const Context           &context,
  46         AppleCSPSession         &session,
  47         CSSM_ATTRIBUTE_TYPE     attr,             // CSSM_ATTRIBUTE_KEY for normal private key
  48                                                                           // CSSM_ATTRIBUTE_PUBLIC_KEY for public key
  49         CSSM_KEYCLASS           keyClass,         // CSSM_KEYCLASS_{PUBLIC,PRIVATE}_KEY
  50         CSSM_KEYUSE                     usage,            // CSSM_KEYUSE_ENCRYPT,
  51                                                                           //    CSSM_KEYUSE_SIGN, etc.
  52         bool                            &mallocdKey); // RETURNED
  53
  54 /*
  55  * Convert a CssmKey to an DH * key. May result in the creation of a new
  56  * DH (when cssmKey is a raw key); allocdKey is true in that case
  57  * in which case the caller generally has to free the allocd key).
  58  */
  59 DH *cssmKeyToDh(
  60         const CssmKey   &cssmKey,
  61         AppleCSPSession &session,
  62         bool                    &allocdKey);    // RETURNED
  63
  64 /*
  65  * Convert a raw CssmKey to a newly alloc'd DH *.
  66  */
  67 DH *rawCssmKeyToDh(
  68         const CssmKey   &cssmKey);
  69
  70
  71 #ifdef  __cplusplus
  72 }
  73 #endif
  74
  75 #endif  /*_DH_UTILS_H_ */