Authorizes and preauthorizes rights synchronously.
- macOS 10.0+
An authorization reference referring to the authorization session.
A pointer to a set of authorization rights you create. Pass
NULLif the application requires no rights at this time.
Data used when authorizing or preauthorizing rights. Not used in OS X v10.2 and earlier. In macOS 10.3 and later, you can pass icon or prompt data to be used in the authentication dialog box. In macOS 10.4 and later, you can also pass a user name and password in order to authorize a user without displaying the authentication dialog box. Possible values for this parameter are listed in
Security. The data passed in this parameter is not stored in the authorization reference; it is used only during authorization. If you are not passing any data in this parameter, pass the constant
.framework/Headers/Authorization Tags .h
Authorization Empty Environment
A bit mask for specifying authorization options. Use the following option sets.
Pass the constant
kif no options are necessary.
Authorization Flag Defaults
Authorization Flag Partial Rights
kmasks to request partial rights. You can also specify the
Authorization Flag Extend Rights
kmask to allow user interaction.
Authorization Flag Interaction Allowed
kmask to prevent the Security Server from preserving the rights obtained during this call.
Authorization Flag Destroy Rights
A pointer to a newly allocated
Authorizationstructure. On return, this structure contains the rights granted by the Security framework. If you do not require this information, pass
NULL. If you specify the
kmask in the
Authorization Flag Pre Authorize
flagsparameter, the method returns all the requested rights, including those not granted, but the flags of the rights that could not be preauthorized include the
Authorization Flag Can Not Pre Authorize
Free the memory associated with this set by calling the function
Free Item Set
A result code. See Authorization Services Result Codes.
There are three main reasons to use this function. The first reason is to preauthorize rights by specifying the
k masks as authorization options. Preauthorization is most useful when a right has a zero timeout. For example, you can preauthorize in the application and if it succeeds, call the helper tool and request authorization. This eliminates calling the helper tool if the Security Server cannot later authorize the specified rights.
The second reason to use this function is to authorize rights before performing a privileged operation by specifying the
k masks as authorization options.
The third reason to use this function is to authorize partial rights. By specifying the
k masks as authorization options, the Security Server grants all rights it can authorize. On return, the authorized set contains all the rights.
If you do not specify the
k mask and the Security Server requires user interaction, then the status of this function on return is