lib/SecTask.h

   1 /*
   2  * Copyright (c) 2008-2009 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 _SECURITY_SECTASK_H_
  25 #define _SECURITY_SECTASK_H_
  26
  27 #include <CoreFoundation/CoreFoundation.h>
  28 #include <mach/message.h>
  29 #include <Security/SecCode.h>
  30
  31 #if defined(__cplusplus)
  32 extern "C" {
  33 #endif
  34
  35 /*!
  36     @typedef SecTaskRef
  37     @abstract CFType used for representing a task
  38 */
  39 typedef struct __SecTask *SecTaskRef;
  40
  41 /*!
  42     @function SecTaskGetTypeID
  43     @abstract Returns the type ID for CF instances of SecTask.
  44     @result A CFTypeID for SecTask
  45 */
  46 CFTypeID SecTaskGetTypeID(void);
  47
  48 /*!
  49     @function SecTaskCreateWithAuditToken
  50     @abstract Create a SecTask object for the task that sent the mach message
  51     represented by the audit token.
  52     @param token The audit token of a mach message
  53     @result The newly created SecTask object or NULL on error.  The caller must
  54     CFRelease the returned object.
  55 */
  56 SecTaskRef SecTaskCreateWithAuditToken(CFAllocatorRef allocator, audit_token_t token);
  57
  58 /*!
  59     @function SecTaskCopyValueForEntitlement
  60     @abstract Returns the value of a single entitlement for the represented
  61     task.
  62     @param task A previously created SecTask object
  63     @param entitlement The name of the entitlement to be fetched
  64     @param error On a NULL return, this may be contain a CFError describing
  65     the problem.  This argument may be NULL if the caller is not interested in
  66     detailed errors.
  67     @result The value of the specified entitlement for the process or NULL if
  68     the entitlement value could not be retrieved.  The type of the returned
  69     value will depend on the entitlement specified.  The caller must release
  70     the returned object.
  71     @discussion A NULL return may indicate an error, or it may indicate that
  72     the entitlement is simply not present.  In the latter case, no CFError is
  73     returned.
  74 */
  75 CFTypeRef SecTaskCopyValueForEntitlement(SecTaskRef task, CFStringRef entitlement, CFErrorRef *error);
  76
  77 /*!
  78     @function SecTaskCopyValuesForEntitlements
  79     @abstract Returns the values of multiple entitlements for the represented
  80     task.
  81     @param task A previously created SecTask object
  82     @param entitlements An array of entitlement names to be fetched
  83     @param error On a NULL return, this will contain a CFError describing
  84     the problem.  This argument may be NULL if the caller is not interested in
  85     detailed errors.  If a requested entitlement is not present for the
  86     returned dictionary, the entitlement is not set on the task.  The caller
  87     must CFRelease the returned value
  88 */
  89 CFDictionaryRef SecTaskCopyValuesForEntitlements(SecTaskRef task, CFArrayRef entitlements, CFErrorRef *error);
  90
  91 #if defined(__cplusplus)
  92 }
  93 #endif
  94
  95 #endif /* !_SECURITY_SECTASK_H_ */