SecurityTests/clxutils/clAppUtils/keyPicker.h

   1 /*
   2  * Copyright (c) 2004-2006 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  * keyPicker.h - select a key pair from a keychain
  26  */
  27
  28 #ifndef _KEY_PICKER_H_
  29 #define _KEY_PICKER_H_
  30
  31 #include <Security/Security.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /*
  38  * Obtain either public key hash or PrintName for a given SecKeychainItem. Works on public keys,
  39  * private keys, identities, and certs. Caller must release the returned result.
  40  */
  41 typedef enum {
  42         WA_Hash,
  43         WA_PrintName
  44 } WhichAttr;
  45
  46 OSStatus getKcItemAttr(
  47         SecKeychainItemRef kcItem,
  48         WhichAttr whichAttr,
  49         CFDataRef *rtnAttr);            // RETURNED
  50
  51 OSStatus keyPicker(
  52         SecKeychainRef  kcRef,          // NULL means the default list
  53         SecKeyRef               *pubKey,        // RETURNED
  54         SecKeyRef               *privKey);  // RETURNED
  55
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif  /* _KEY_PICKER_H_ */
  62