OSX/libsecurity_transform/lib/SecTransformValidator.h

   1 /*
   2  * Copyright (c) 2010-2011 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 #ifndef _SEC_TRANSFORMVALIDATOR_H__
  25 #define _SEC_TRANSFORMVALIDATOR_H__
  26
  27 #include <Security/SecCustomTransform.h>
  28
  29 CF_EXTERN_C_BEGIN
  30
  31
  32 /*!
  33  @function                      SecTransformCreateValidatorForCFtype
  34
  35  @abstract                      Create a validator that triggers an error when presented a CF type other then expected_type,
  36  or a NULL value if null_allowed is NO.
  37
  38  @result                                A SecTransformAttributeActionBlock suitable for passing to SecTransformSetAttributeAction
  39  with an actyion type of kSecTransformActionAttributeValidation.
  40
  41  @discussion                    If the validator is passed an incorrect CF type it will return a CFError including the
  42  type it was given, the value it was given, the type it expected, and if a NULL value is acceptable as well as
  43  what attribute the value was sent to.
  44  */
  45 CF_EXPORT
  46 SecTransformAttributeActionBlock SecTransformCreateValidatorForCFtype(CFTypeID expected_type, Boolean null_allowed);
  47
  48 CF_EXTERN_C_END
  49
  50 #endif