SecurityTests/clxutils/krbtool/identPicker.h

   1 /*
   2  * Copyright (c) 2004 Apple Computer, 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  * identPicker.h - Given a keychain, select from possible multiple
  26  *                                 SecIdentityRefs via stdio UI, and cook up a
  27  *                                 CFArray containing that identity and all certs needed
  28  *                                 for cert verification by an SSL peer. The resulting
  29  *                                 CFArrayRef is suitable for passing to SSLSetCertificate().
  30  */
  31
  32 #ifndef _IDENT_PICKER_H_
  33 #define _IDENT_PICKER_H_
  34
  35 #include <Security/Security.h>
  36 #include <CoreFoundation/CoreFoundation.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /*
  43  * Pick an identity, cook up complete cert chain based upon it. The first
  44  * element in the returned array is a SecIdentityRef; the remaining items
  45  * are SecCertificateRefs.
  46  */
  47 OSStatus identPicker(
  48     SecKeychainRef      kc,             // NULL means use default list
  49     SecCertificateRef   trustedAnchor,  // optional additional trusted anchor
  50     bool                includeRoot,    // true --> root is appended to outArray
  51                                         // false --> root not included
  52     CFArrayRef          *outArray);     // created and RETURNED
  53
  54 /*
  55  * Simple version, just returns a SecIdentityRef.
  56  */
  57 OSStatus simpleIdentPicker(
  58     SecKeychainRef      kc,             // NULL means use default list
  59     SecIdentityRef      *ident);        // RETURNED
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif
  64
  65 #endif  /* _IDENT_PICKER_H_ */
  66