libsecurity_keychain/lib/SecPolicyPriv.h

   1 /*
   2  * Copyright (c) 2003-2010 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         @header SecPolicy
  26         The functions provided in SecPolicy implement a representation of a particular trust policy.
  27 */
  28
  29 #ifndef _SECURITY_SECPOLICYPRIV_H_
  30 #define _SECURITY_SECPOLICYPRIV_H_
  31
  32 #include <Security/SecPolicy.h>
  33 #include <CoreFoundation/CFArray.h>
  34
  35
  36 #if defined(__cplusplus)
  37 extern "C" {
  38 #endif
  39
  40 /*!
  41         @function SecPolicyCopy
  42         @abstract Returns a copy of a policy reference based on certificate type and OID.
  43         @param certificateType A certificate type.
  44         @param policyOID The OID of the policy you want to find. This is a required parameter. See oidsalg.h to see a list of policy OIDs.
  45         @param policy The returned policy reference. This is a required parameter.
  46         @result A result code.  See "Security Error Codes" (SecBase.h).
  47         @discussion This function is deprecated in Mac OS X 10.7 and later;
  48         to obtain a policy reference, use one of the SecPolicyCreate* functions in SecPolicy.h.
  49 */
  50 OSStatus SecPolicyCopy(CSSM_CERT_TYPE certificateType, const CSSM_OID *policyOID, SecPolicyRef* policy)
  51         DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
  52
  53 /*!
  54         @function SecPolicyCopyAll
  55         @abstract Returns an array of all known policies based on certificate type.
  56     @param certificateType A certificate type. This is a optional parameter. Pass CSSM_CERT_UNKNOWN if the certificate type is unknown.
  57     @param policies The returned array of policies. This is a required parameter.
  58     @result A result code.  See "Security Error Codes" (SecBase.h).
  59         @discussion This function is deprecated in Mac OS X 10.7 and later;
  60         to obtain a policy reference, use one of the SecPolicyCreate* functions in SecPolicy.h. (Note: there is normally
  61         no reason to iterate over multiple disjointed policies, except to provide a way to edit trust settings for each
  62         policy, as is done in certain certificate UI views. In that specific case, your code should call SecPolicyCreateWithOID
  63         for each desired policy from the list of supported OID constants in SecPolicy.h.)
  64 */
  65 OSStatus SecPolicyCopyAll(CSSM_CERT_TYPE certificateType, CFArrayRef* policies)
  66         DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
  67
  68 #if defined(__cplusplus)
  69 }
  70 #endif
  71
  72 #endif /* !_SECURITY_SECPOLICYPRIV_H_ */