AuthorizationPluginCreate

Declaration

OSStatus AuthorizationPluginCreate(const AuthorizationCallbacks *callbacks, AuthorizationPluginRef*outPlugin, const AuthorizationPluginInterface **outPluginInterface);

Parameters

• callbacks:

  A pointer to an Authorizationcallbacks structure containing entry points to the Security Server.

• outPlugin:

  On input, a pointer that you can assign, on output, to a reference value that you define. The authorization engine passes this reference back to you in any subsequent calls to your functions outPluginInterface->MechanismCreate (Mechanismcreate) and outPluginInterface->PluginDestroy (Mechanismdestroy) so that you can identify the instance of the plug-in affected.

• outPluginInterface:

  On input, a pointer that you assign, on output, to a structure containing entry points in the plug-in. This structure remains valid until the authorization engine calls outPluginInterface->PluginDestroy.

Mentioned in

• Extending authorization services with plug-ins

Return Value

A result code. Returns errAuthorizationSuccess (no error) if the function completes successfully and errAuthorizationInternal (Security Server internal error) if any error occurs.

Discussion

This function is the main entry point to the plug-in. The authorization engine calls this function only once. The plug-in receives an AuthorizationCallbacks structure containing the entry points to the Security Server’s functions and returns an AuthorizationPluginInterface structure containing the entry points to all of the plug-in’s routines. Both of these structures contain version numbers. The authorization engine matches the version of its interface to the version in your plug-in’s AuthorizationPluginInterface structure in order to ensure that older plug-ins will continue to function correctly after the Security Server is updated.

If your plug-in is running in macOS 10.5 or later and displays a window before the user has logged in, ensure you set the canBecomeVisibleWithoutLogin property of NSWindow to true.