OSX/include/security_keychain/TrustKeychains.h

   1 /*
   2  * Copyright (c) 2009,2011-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  * TrustKeychains.h - manages the standard keychains searched for trusted certificates.
  26  */
  27
  28 #ifndef _TRUST_KEYCHAINS_H_
  29 #define _TRUST_KEYCHAINS_H_
  30
  31 #include <security_utilities/threading.h>
  32 #include <Security/cssmtype.h>
  33 /*
  34 #if defined(__cplusplus)
  35 extern "C" {
  36 #endif
  37 */
  38
  39 /*!
  40  @function SecTrustKeychainsGetMutex
  41  @abstract Get the global mutex for accessing trust keychains during an evaluation
  42  @param result On return, a reference to the global mutex which manages access to trust keychains
  43  @discussion This function is intended to be used by C++ implementation layers to share a
  44  common global mutex for managing access to trust keychains (i.e. the root certificate store).
  45  */
  46 RecursiveMutex& SecTrustKeychainsGetMutex();
  47
  48 /*
  49 #if defined(__cplusplus)
  50 }
  51 #endif
  52 */
  53
  54 #endif  /* _TRUST_KEYCHAINS_H_ */
  55