SecurityTests/clxutils/dotMacArchive/identSearch.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  * identSearch.h - search for identity whose cert has specified email address
  26  */
  27
  28 #ifndef _IDENT_SEARCH_H_
  29 #define _IDENT_SEARCH_H_
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #include <Security/Security.h>
  36
  37 /*
  38  * Find an identity whose cert has specified email address.
  39  * Returns errSecItemNotFound if no matching identity found, noErr if
  40  * we found one.
  41  */
  42 OSStatus findIdentity(
  43         const void                      *emailAddress,          // UTF8 encoded email address
  44         unsigned                        emailAddressLen,
  45         SecKeychainRef          kcRef,                          // keychain to search, or NULL to search all
  46         SecIdentityRef          *idRef);                        // RETURNED
  47
  48 #ifdef __cplusplus
  49 }
  50 #endif
  51
  52 #endif  /* _IDENT_SEARCH_H_ */
  53