OSX/libsecurity_authorization/lib/AuthorizationPriv.h

   1 /*
   2  * Copyright (c) 2002-2004,2011-2014 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 /*
  26  *  AuthorizationPriv.h -- Authorization SPIs
  27  *  Private APIs for implementing access control in applications and daemons.
  28  *
  29  */
  30
  31 #ifndef _SECURITY_AUTHORIZATIONPRIV_H_
  32 #define _SECURITY_AUTHORIZATIONPRIV_H_
  33
  34 #include <Security/Authorization.h>
  35 #include <Security/AuthSession.h>
  36 #include <sys/types.h>  // uid_t
  37 #include <mach/message.h>
  38
  39 #if defined(__cplusplus)
  40 extern "C" {
  41 #endif
  42
  43
  44 /*!
  45         @header AuthorizationPriv
  46         Version 1.1 04/2003
  47
  48         This header contains private APIs for authorization services.
  49         This is the private extension of <Security/Authorization.h>, a public header file.
  50 */
  51
  52 /*!
  53         @enum Private (for now) AuthorizationFlags
  54 */
  55 enum {
  56         kAuthorizationFlagLeastPrivileged               = (1 << 5),
  57         kAuthorizationFlagSheet                                 = (1 << 6),
  58         kAuthorizationFlagIgnorePasswordOnly    = (1 << 7),
  59 };
  60
  61 /*!
  62     @function AuthorizationCreateWithAuditToken
  63     @abstract Create a AuthorizationRef for the process that sent the mach message
  64         represented by the audit token. Requires root.
  65     @param token The audit token of a mach message
  66     @param environment (input/optional) An AuthorizationItemSet containing environment state used when making the autorization decision.  See the AuthorizationEnvironment type for details.
  67     @param flags (input) options specified by the AuthorizationFlags enum.  set all unused bits to zero to allow for future expansion.
  68     @param authorization (output) A pointer to an AuthorizationRef to be returned.  When the returned AuthorizationRef is no longer needed AuthorizationFree should be called to prevent anyone from using the acquired rights.
  69
  70     @result errAuthorizationSuccess 0 authorization or all requested rights succeeded.
  71
  72     errAuthorizationDenied -60005 The authorization for one or more of the requested rights was denied.
  73 */
  74
  75 OSStatus AuthorizationCreateWithAuditToken(audit_token_t token,
  76     const AuthorizationEnvironment * _Nullable environment,
  77     AuthorizationFlags flags,
  78     AuthorizationRef _Nullable * _Nonnull authorization);
  79
  80 /*!
  81     @function AuthorizationExecuteWithPrivilegesExternalForm
  82     Run an executable tool with enhanced privileges after passing
  83     suitable authorization procedures.
  84
  85     @param extForm authorization in external form that is used to authorize
  86     access to the enhanced privileges. It is also passed to the tool for
  87     further access control.
  88     @param pathToTool Full pathname to the tool that should be executed
  89     with enhanced privileges.
  90     @param flags Option bits (reserved). Must be zero.
  91     @param arguments An argv-style vector of strings to be passed to the tool.
  92     @param communicationsPipe Assigned a UNIX stdio FILE pointer for
  93     a bidirectional pipe to communicate with the tool. The tool will have
  94     this pipe as its standard I/O channels (stdin/stdout). If NULL, do not
  95     establish a communications pipe.
  96
  97     @discussion This function has been deprecated and should no longer be used.
  98     Use a launchd-launched helper tool and/or the Service Mangement framework
  99     for this functionality.
 100 */
 101
 102 OSStatus AuthorizationExecuteWithPrivilegesExternalForm(const AuthorizationExternalForm * _Nonnull extForm,
 103     const char * _Nonnull pathToTool,
 104     AuthorizationFlags flags,
 105     char * _Nonnull const * _Nonnull arguments,
 106     FILE * _Nullable * _Nonnull communicationsPipe) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_1,__MAC_10_7,__IPHONE_NA,__IPHONE_NA);
 107
 108 /*!
 109  @function AuthorizationExecuteWithPrivileges
 110  Run an executable tool with enhanced privileges after passing
 111  suitable authorization procedures.
 112  @param authorization An authorization reference that is used to authorize
 113  access to the enhanced privileges. It is also passed to the tool for
 114  further access control.
 115  @param pathToTool Full pathname to the tool that should be executed
 116  with enhanced privileges.
 117  @param options Option bits (reserved). Must be zero.
 118  @param arguments An argv-style vector of strings to be passed to the tool.
 119  @param communicationsPipe Assigned a UNIX stdio FILE pointer for
 120  a bidirectional pipe to communicate with the tool. The tool will have
 121  this pipe as its standard I/O channels (stdin/stdout). If NULL, do not
 122  establish a communications pipe.
 123
 124  @discussion This function has been deprecated and should no longer be used.
 125  Use a launchd-launched helper tool and/or the Service Mangement framework
 126  for this functionality.
 127  */
 128 OSStatus AuthorizationExecuteWithPrivileges(AuthorizationRef _Nonnull authorization,
 129                                                                                                 const char * _Nonnull pathToTool,
 130                                                                                                 AuthorizationFlags options,
 131                                                                                                 char * __nonnull const * __nonnull arguments,
 132                                                                                                 FILE * __nullable * __nullable communicationsPipe) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_1,__MAC_10_7,__IPHONE_NA,__IPHONE_NA);
 133
 134 /*!
 135  @function AuthorizationPreauthorizeCredentials
 136  Tries to preauthorize provided credentials by authorizationhost PAM. No user interface will be shown.
 137  Credentials is set of the context items which will be passed to the authorizationhost.
 138  */
 139 OSStatus AuthorizationPreauthorizeCredentials(AuthorizationRef _Nonnull authorization,
 140                                                                                           const AuthorizationItemSet * __nonnull credentials) __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_NA);
 141
 142 /*!
 143  @function AuthorizationCopyPrivilegedReference
 144  From within a tool launched via the AuthorizationExecuteWithPrivileges function
 145  ONLY, retrieve the AuthorizationRef originally passed to that function.
 146  While AuthorizationExecuteWithPrivileges already verified the authorization to
 147  launch your tool, the tool may want to avail itself of any additional pre-authorizations
 148  the caller may have obtained through that reference.
 149
 150  @discussion This function has been deprecated and should no longer be used.
 151  Use a launchd-launched helper tool and/or the Service Mangement framework
 152  for this functionality.
 153  */
 154 OSStatus AuthorizationCopyPrivilegedReference(AuthorizationRef __nullable * __nonnull authorization,
 155                                                                                                   AuthorizationFlags flags) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_1,__MAC_10_7,__IPHONE_NA,__IPHONE_NA);
 156
 157 /*
 158     @function AuthorizationDismiss
 159     @abstract Dismisses all Authorization dialogs associated to the calling process.
 160         Any active authorization requests will be canceled and return errAuthorizationDenied
 161 */
 162
 163 OSStatus AuthorizationDismiss(void);
 164
 165 /*!
 166         @function SessionSetDistinguishedUser
 167         This function allows the creator of a (new) security session to associate an arbitrary
 168         UNIX user identity (uid) with the session. This uid can be retrieved with
 169         SessionGetDistinguishedUser by anyone who knows the session's id, and may also
 170         be used by the system for identification (but not authentication) purposes.
 171
 172         This call can only be made by the process that created the session, and only
 173         once.
 174
 175         This is a private API, and is subject to change.
 176
 177         @param session (input) Session-id for which to set the uid. Can be one of the
 178         special constants defined in AuthSession.h.
 179         @param user (input) The uid to set.
 180  */
 181 OSStatus SessionSetDistinguishedUser(SecuritySessionId session, uid_t user);
 182
 183
 184 /*!
 185         @function SessionGetDistinguishedUser
 186         Retrieves the distinguished uid of a session as set by the session creator
 187         using the SessionSetDistinguishedUser call.
 188
 189         @param session (input) Session-id for which to set the uid. Can be one of the
 190         special constants defined in AuthSession.h.
 191         @param user (output) Will receive the uid. Unchanged on error.
 192  */
 193 OSStatus SessionGetDistinguishedUser(SecuritySessionId session, uid_t * _Nonnull user);
 194
 195 /*!
 196         @function SessionSetUserPreferences
 197         Set preferences from current application context for session (for use during agent interactions).
 198
 199         @param session (input) Session-id for which to set the user preferences. Can be one of the special constants defined in AuthSession.h.
 200  */
 201 OSStatus SessionSetUserPreferences(SecuritySessionId session);
 202
 203
 204 /*!
 205     @function AuthorizationEnableSmartCard
 206     Enable or disable system login using smartcard or get current status.
 207
 208     @param authRef (input) The authorization object on which this operation is performed.
 209     @param enable (input) desired smartcard login support state, TRUE to enable, FALSE to disable
 210  */
 211 OSStatus AuthorizationEnableSmartCard(AuthorizationRef _Nonnull authRef, Boolean enable);
 212
 213 #if defined(__cplusplus)
 214 }
 215 #endif
 216
 217 #endif /* !_SECURITY_AUTHORIZATIONPRIV_H_ */