Keychain/SecPolicy.h

   1 /*
   2  * Copyright (c) 2002 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18 /*!
  19         @header SecPolicy
  20         The functions provided in SecPolicy implement a representation of a particular trust policy.
  21 */
  22
  23 #ifndef _SECURITY_SECPOLICY_H_
  24 #define _SECURITY_SECPOLICY_H_
  25
  26 #include <Security/SecBase.h>
  27 #include <Security/cssmtype.h>
  28
  29
  30 #if defined(__cplusplus)
  31 extern "C" {
  32 #endif
  33
  34 /*!
  35         @function SecPolicyGetTypeID
  36         @abstract Returns the type identifier of SecPolicy instances.
  37         @result The CFTypeID of SecPolicy instances.
  38 */
  39 CFTypeID SecPolicyGetTypeID(void);
  40
  41 /*!
  42         @function SecPolicyGetOID
  43         @abstract Returns a policy's object identifier.
  44     @param policyRef A policy reference.
  45     @param oid On return, a pointer to the policy's object identifier.
  46     @result A result code.  See "Security Error Codes" (SecBase.h).
  47 */
  48 OSStatus SecPolicyGetOID(SecPolicyRef policyRef, CSSM_OID *oid);
  49
  50 /*!
  51         @function SecPolicyGetValue
  52         @abstract Returns a policy's value.
  53     @param policyRef A policy reference.
  54     @param value On return, a pointer to the policy's value.
  55     @result A result code.  See "Security Error Codes" (SecBase.h).
  56 */
  57 OSStatus SecPolicyGetValue(SecPolicyRef policyRef, CSSM_DATA *value);
  58
  59 /*!
  60         @function SecPolicyGetTPHandle
  61         @abstract Returns the CSSM trust policy handle for the given policy.
  62     @param policyRef A policy reference.
  63     @param tpHandle On return, a pointer to a value of type CSSM_TP_HANDLE.
  64     @result A result code.  See "Security Error Codes" (SecBase.h).
  65 */
  66 OSStatus SecPolicyGetTPHandle(SecPolicyRef policyRef, CSSM_TP_HANDLE *tpHandle);
  67
  68 #if defined(__cplusplus)
  69 }
  70 #endif
  71
  72 #endif /* !_SECURITY_SECPOLICY_H_ */