Synopsis

session_start();
require_once('plexcel.php');

bool plexcel_sso(resource $px, array $options=NULL)

Description

The plexcel_sso function authenticates a web client using Kerberos Single Sign-On (SSO).

Note: It is recommended that general purpose web applications use the plexcel_preamble or possibly the plexcel_authenticate function instead. They provide higher-level, more feature-full interfaces.

Note: This function is defined in plexcel.php which requires that sessions be initialized. Therefore, this function must be preceded by a call to session_start() and require_once('plexcel.php') .

The plexcel_sso function calls die

Initially, a client will not supply the required Authorization header token. In this case, this function will set a response header, set the status to 401 Unauthorized and call die . If the client supports SSO, it should then re-submit it's request with the required token and be authenticated. This means that this function will be called twice for each request . For performance reasons, it is strongly recommended that this function be invoked before any code that is not absolutely necessary.

The $px parameter is the Plexcel context resource being authenticated.

The optional $options parameter it is an array of options used by the higher-level plexcel_authenticate and plexcel_preamble functions to set a JavaScript redirect for clients that do not support SSO.

Returns

The plexcel_sso function returns TRUE if the client was successfully authenticated. Otherwise, FALSE is returned in which case plexcel_status should be consulted.

Example

The following PHP script illustrates how to authenticate a client using the plexcel_sso function.

<?php
session_start();
require_once('../plexcel.php');

$px = plexcel_new(NULL, NULL);

        if (plexcel_sso($px) == FALSE)
      
    die('<pre>' . plexcel_status($px) . '</pre>');

echo 'You have been successfully authenticated.';
?>

See also

plexcel_preamble | plexcel_authenticate