22.12.2012 Views

Front cover - IBM Redbooks

Front cover - IBM Redbooks

Front cover - IBM Redbooks

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

This is a guide to setting the output variables and return codes for common<br />

authentication scenarios where eventData points to the FilterAuthenticate<br />

structure:<br />

Scenario 1: The filter was able to authenticate the user.<br />

Set eventData → authName to the canonical name, set eventData →<br />

authType to kAuthenticBasic or kAuthenticClientCert, and the return code to<br />

kFilterHandledEvent.<br />

Scenario 2: The filter was not able to authenticate the user, and other filters<br />

or Domino should go ahead and attempt their own authentication.<br />

Set the return code to kFilterNotHandled.<br />

Scenario 3: The filter was not able to authenticate the user, and other filters<br />

or Domino should not attempt their own authentication.<br />

Set eventData → authType to kNotAuthentic, and the return code to<br />

kFilterHandledEvent.<br />

kFilterResponse Event<br />

This event occurs when the HTTP stack is about to send the HTTP response<br />

headers to the client. This gives a chance to the filter to change the response that<br />

is sent to the client. This is not completely implemented in the current version of<br />

DSAPI. pEventData is a pointer to an instance of the structure FilterResponse.<br />

kFilterRawWrite Event<br />

This event occurs when the HTTP stack is about to send the HTTP response<br />

data to the client. This gives a chance to the filter to change the response data<br />

that is sent to the client. This is not completely implemented in the current<br />

version of DSAPI. pEventData is a pointer to an instance of the structure<br />

FilterRawWrite<br />

Of the events described here, for constructing a custom SSO implementation we<br />

are primarily concerned with kFilterAuthenticate, kFilterUserNameList, and the<br />

kFilterAuthorized. Note that the kFilterAuthUser may also be used in place of<br />

kFilterAuthenticate, although this is the R5 event that is supported in Domino 6<br />

for backwards compatibility. New DSAPI filters should use the kFilterAuthenticate<br />

event.<br />

Running and Programming Considerations<br />

The DSAPI functions are included in the Lotus C API Toolkit that can be<br />

downloaded from:<br />

http://www.lotus.com/ldd<br />

Chapter 7. Single sign-on 301

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!