CAS/docs/examples/example_service.php

   1 <?php
   2
   3 /**
   4  * Example for proxied service with session support
   5  *
   6  * PHP Version 5
   7  *
   8  * @file     example_service.php
   9  * @category Authentication
  10  * @package  PhpCAS
  11  * @author   Joachim Fritschi <jfritschi@freenet.de>
  12  * @author   Adam Franco <afranco@middlebury.edu>
  13  * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
  14  * @link     https://wiki.jasig.org/display/CASC/phpCAS
  15  */
  16
  17 // Load the settings from the central config file
  18 require_once 'config.php';
  19 // Load the CAS lib
  20 require_once $phpcas_path . '/CAS.php';
  21
  22 // Uncomment to enable debugging
  23 phpCAS::setDebug();
  24
  25 // Initialize phpCAS
  26 phpCAS::client(CAS_VERSION_2_0, $cas_host, $cas_port, $cas_context);
  27
  28 // For production use set the CA certificate that is the issuer of the cert
  29 // on the CAS server and uncomment the line below
  30 // phpCAS::setCasServerCACert($cas_server_ca_cert_path);
  31
  32 // For quick testing you can disable SSL validation of the CAS server.
  33 // THIS SETTING IS NOT RECOMMENDED FOR PRODUCTION.
  34 // VALIDATING THE CAS SERVER IS CRUCIAL TO THE SECURITY OF THE CAS PROTOCOL!
  35 phpCAS::setNoCasServerValidation();
  36
  37 // If you want your service to be proxied you have to enable it (default
  38 // disabled) and define an accepable list of proxies that are allowed to
  39 // proxy your service.
  40 //
  41 // Add each allowed proxy definition object. For the normal CAS_ProxyChain
  42 // class, the constructor takes an array of proxies to match. The list is in
  43 // reverse just as seen from the service. Proxies have to be defined in reverse
  44 // from the service to the user. If a user hits service A and gets proxied via
  45 // B to service C the list of acceptable on C would be array(B,A). The definition
  46 // of an individual proxy can be either a string or a regexp (preg_match is used)
  47 // that will be matched against the proxy list supplied by the cas server
  48 // when validating the proxy tickets. The strings are compared starting from
  49 // the beginning and must fully match with the proxies in the list.
  50 // Example:
  51 //              phpCAS::allowProxyChain(new CAS_ProxyChain(array(
  52 //                              'https://app.example.com/'
  53 //                      )));
  54 //              phpCAS::allowProxyChain(new CAS_ProxyChain(array(
  55 //                              '/^https:\/\/app[0-9]\.example\.com\/rest\//',
  56 //                              'http://client.example.com/'
  57 //                      )));
  58 phpCAS::allowProxyChain(new CAS_ProxyChain(array($pgtUrlRegexp)));
  59 phpCAS::allowProxyChain(
  60     new CAS_ProxyChain(
  61         array('/^' . $pgtBase . 'example_service_that_proxies.php$/',
  62             '/^' . $pgtBase . 'example_proxy_serviceWeb_chaining.php$/'
  63         )
  64     )
  65 );
  66
  67 // For quick testing or in certain production screnarios you might want to
  68 // allow allow any other valid service to proxy your service. To do so, add
  69 // the "Any" chain:
  70 //              phpcas::allowProxyChain(new CAS_ProxyChain_Any);
  71 // THIS SETTING IS HOWEVER NOT RECOMMENDED FOR PRODUCTION AND HAS SECURITY
  72 // IMPLICATIONS: YOU ARE ALLOWING ANY SERVICE TO ACT ON BEHALF OF A USER
  73 // ON THIS SERVICE.
  74 //phpcas::allowProxyChain(new CAS_ProxyChain_Any);
  75
  76 // force CAS authentication
  77 phpCAS::forceAuthentication();
  78
  79 print '<h1>I am a service that can be proxied.</h1>';
  80
  81 // at this step, the user has been authenticated by the CAS server
  82 // and the user's login name can be read with phpCAS::getUser().
  83 require 'script_info.php';
  84
  85 // for this test, simply print that the authentication was successfull
  86 echo '<p>The user\'s login is <b>' . phpCAS::getUser() . '</b>.</p>';
  87
  88 // increment the number of requests of the session and print it
  89 if (!isset($_SESSION['n'])) {
  90     $_SESSION['n'] = 0;
  91 }
  92 echo '<p>request #' . (++$_SESSION['n']) . '</p>';
  93
  94 ?>