libsecurity_ssl/lib/sslKeychain.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  * sslKeychain.h - Apple Keychain routines
  26  */
  27
  28 #ifndef _SSL_KEYCHAIN_H_
  29 #define _SSL_KEYCHAIN_H_
  30
  31
  32 #include "sslContext.h"
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 #ifdef USE_SSLCERTIFICATE
  39 /*
  40  * Given an array of certs (as KCItemRefs) and a destination
  41  * SSLCertificate:
  42  *
  43  * -- free destCerts if we have any
  44  * -- Get raw cert data, convert to array of SSLCertificates in *destCert
  45  * -- get pub, priv keys from certRef[0], store in *pubKey, *privKey
  46  * -- validate cert chain
  47  *
  48  */
  49 OSStatus
  50 parseIncomingCerts(
  51         SSLContext              *ctx,
  52         CFArrayRef              certs,
  53         SSLCertificate  **destCert,             /* &ctx->{localCert,encryptCert} */
  54         SSLPubKey       **pubKey,               /* &ctx->signingPubKey, etc. */
  55         SecKeyRef               *privKeyRef,    /* &ctx->signingPrivKeyRef, etc. */
  56         CSSM_ALGORITHMS *signerAlg);    /* optionally returned */
  57 #else
  58
  59 OSStatus
  60 parseIncomingCerts(
  61         SSLContext                      *ctx,
  62         CFArrayRef                      certs,
  63         CFArrayRef                      *destCertChain, /* &ctx->{localCertChain,encryptCertChain} */
  64         SSLPubKey                       **pubKey,               /* &ctx->signingPubKey, etc. */
  65         SSLPrivKey                      **privKeyRef,   /* &ctx->signingPrivKeyRef, etc. */
  66         CFIndex                 *signerAlg);            /* optional */
  67
  68 #endif
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif
  73
  74 #endif  /* _SSL_KEYCHAIN_H_ */