User-Defined Function

Programming Guides › Programming Guide for C › Authorization API › Authorization Function Declarations › User-Defined Function

User-Defined Function

The Policy Server calls a user-defined function to perform a custom policy, rule, or response operation.

You can assign the function any name. Through the active expression that you define in the Administrative UI, you advise SiteMinder of the function name and the name of the shared library where the function resides.

Syntax

int SM_EXTERN <func-spec> (
   const Sm_Api_Context_t*          lpApiContext,
   const Sm_Api_UserContext_t*      lpUserContext,
   const Sm_Api_RequestContext_t*   lpReqContext,
   const char*                      lpszParam,
   const int                        nBytesOutBuf,
   char*                            lpszOutBuf,
   const int                        nBytesErrBuf,
   char*                            lpszErrBuf
);

Parameter	I/O	Description
lpApiContext	I	Pointer to the API context structure.
lpUserContext	I	Pointer to the user context structure.
lpReqContext	I	Pointer to the request context structure.
lpszParam	I	Pointer to the buffer containing the null-terminated parameter string specified in <Param-String>.
nBytesOutBuf	I	Maximum size of the output result buffer (4097 bytes).
lpszOutBuf	O	Output buffer for the result to send to SiteMinder.
nBytesErrBuf	I	Maximum size of the output error buffer (4097 bytes).
lpszErrBuf	O	Output buffer to receive error text. SiteMinder displays the error text in the debug log file.

Returns

Upon successful execution, the function returns a value greater than 0—that is, the total number of bytes in the result buffer lpszOutBuf.
If an error occurs, the function returns -1 and stores the applicable error message in the error buffer lpszErrBuf.
When used for an Active Rule, a return value of 0 (an empty string was passed back in lpszOutbuf) results in one of the following actions:
- With Allow Access rules, the rule does not fire.
- With Deny Access rules, the rule fires.

Email CA about this topic