1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>phpCAS: CAS Basic client features (CAS 1.0, Service Tickets)</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.6.3 -->
11
<div class="navigation" id="top">
14
<li><a href="index.html"><span>Main Page</span></a></li>
15
<li><a href="pages.html"><span>Related Pages</span></a></li>
16
<li><a href="modules.html"><span>Modules</span></a></li>
17
<li><a href="annotated.html"><span>Classes</span></a></li>
18
<li><a href="files.html"><span>Files</span></a></li>
19
<li><a href="examples.html"><span>Examples</span></a></li>
23
<div class="contents">
24
<h1>CAS Basic client features (CAS 1.0, Service Tickets)<br/>
26
[<a class="el" href="group__internal.html">Implementation</a>]</small>
27
</h1><table border="0" cellpadding="0" cellspacing="0">
28
<tr><td colspan="2"><h2>Modules</h2></td></tr>
29
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalProxy.html">CAS Proxy features (CAS 2.0, Proxy Granting Tickets)</a></td></tr>
30
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalCallback.html">Callback from the CAS server</a></td></tr>
31
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalPGTStorage.html">PGT storage</a></td></tr>
32
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalProxied.html">CAS proxied client features (CAS 2.0, Proxy Tickets)</a></td></tr>
33
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalMisc.html">Miscellaneous</a></td></tr>
34
<tr><td colspan="2"><h2>Functions</h2></td></tr>
35
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gacc7692242bf95b8429d704de40a6cd52">CASClient::getST</a> ()</td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gaca73a8a7c4adb1175c4ba0e3812979db">CASClient::setST</a> ($st)</td></tr>
37
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga76f2832ba150597409e47421aaaaa35e">CASClient::hasST</a> ()</td></tr>
38
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga3afdd7ea1d4d753fafcdff49c51c8e09">CASClient::setCasServerCert</a> ($cert)</td></tr>
39
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gac12c73488d65c5f7f34b39084926c688">CASClient::setCasServerCACert</a> ($cert)</td></tr>
40
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga94d0237a67f4c82da1d92c5c4e73aece">CASClient::setNoCasServerValidation</a> ()</td></tr>
41
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gacf3f1b530d4e029b3124558cc74d56cb">CASClient::validateST</a> ($validate_url, &$text_response, &$tree_response)</td></tr>
42
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gac6ca61806e87cf911dd9b3bf2eeae689">CASClient::validateSA</a> ($validate_url, &$text_response, &$tree_response)</td></tr>
43
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gaad406bd72b79e3636328673e9905dee6">CASClient::setSessionAttributes</a> ($text_response)</td></tr>
44
<tr><td colspan="2"><h2>Variables</h2></td></tr>
45
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gad790c032504597c075875197f64cc73b">CASClient::$_st</a></td></tr>
46
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga28b7a83796b4972a2fbc0d3791e0185c">CASClient::$_cas_server_cert</a></td></tr>
47
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gaa78eb6b7d01c48e6d236c513e9b33e45">CASClient::$_cas_server_ca_cert</a></td></tr>
48
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga563b04790a9c60dbcff5ddb8e9741715">CASClient::$_no_cas_server_validation</a></td></tr>
50
<hr/><h2>Function Documentation</h2>
51
<a class="anchor" id="gacc7692242bf95b8429d704de40a6cd52"></a><!-- doxytag: member="CASClient::getST" ref="gacc7692242bf95b8429d704de40a6cd52" args="()" -->
53
<div class="memproto">
54
<table class="memname">
56
<td class="memname">CASClient::getST </td>
58
<td class="paramname"></td>
59
<td> ) </td>
60
<td><code> [private, inherited]</code></td>
65
<p>This method returns the Service Ticket provided in the URL of the request. </p>
66
<dl class="return"><dt><b>Returns:</b></dt><dd>The service ticket. </dd></dl>
68
<p>Definition at line <a class="el" href="client_8php_source.html#l01284">1284</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
70
<p>Referenced by <a class="el" href="client_8php_source.html#l00967">CASClient::isAuthenticated()</a>, and <a class="el" href="client_8php_source.html#l01378">CASClient::validateST()</a>.</p>
74
<a class="anchor" id="ga76f2832ba150597409e47421aaaaa35e"></a><!-- doxytag: member="CASClient::hasST" ref="ga76f2832ba150597409e47421aaaaa35e" args="()" -->
76
<div class="memproto">
77
<table class="memname">
79
<td class="memname">CASClient::hasST </td>
81
<td class="paramname"></td>
82
<td> ) </td>
83
<td><code> [private, inherited]</code></td>
88
<p>This method tells if a Service Ticket was stored. </p>
89
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if a Service Ticket has been stored. </dd></dl>
91
<p>Definition at line <a class="el" href="client_8php_source.html#l01300">1300</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
93
<p>Referenced by <a class="el" href="client_8php_source.html#l00967">CASClient::isAuthenticated()</a>.</p>
97
<a class="anchor" id="gac12c73488d65c5f7f34b39084926c688"></a><!-- doxytag: member="CASClient::setCasServerCACert" ref="gac12c73488d65c5f7f34b39084926c688" args="($cert)" -->
99
<div class="memproto">
100
<table class="memname">
102
<td class="memname">CASClient::setCasServerCACert </td>
104
<td class="paramtype">$ </td>
105
<td class="paramname"> <em>cert</em></td>
106
<td> ) </td>
107
<td><code> [inherited]</code></td>
112
<p>Set the CA certificate of the CAS server.</p>
113
<dl><dt><b>Parameters:</b></dt><dd>
114
<table border="0" cellspacing="2" cellpadding="0">
115
<tr><td valign="top"></td><td valign="top"><em>$cert</em> </td><td>the PEM certificate of the CA that emited the cert of the server </td></tr>
120
<p>Definition at line <a class="el" href="client_8php_source.html#l01352">1352</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
124
<a class="anchor" id="ga3afdd7ea1d4d753fafcdff49c51c8e09"></a><!-- doxytag: member="CASClient::setCasServerCert" ref="ga3afdd7ea1d4d753fafcdff49c51c8e09" args="($cert)" -->
125
<div class="memitem">
126
<div class="memproto">
127
<table class="memname">
129
<td class="memname">CASClient::setCasServerCert </td>
131
<td class="paramtype">$ </td>
132
<td class="paramname"> <em>cert</em></td>
133
<td> ) </td>
134
<td><code> [inherited]</code></td>
139
<p>Set the certificate of the CAS server.</p>
140
<dl><dt><b>Parameters:</b></dt><dd>
141
<table border="0" cellspacing="2" cellpadding="0">
142
<tr><td valign="top"></td><td valign="top"><em>$cert</em> </td><td>the PEM certificate </td></tr>
147
<p>Definition at line <a class="el" href="client_8php_source.html#l01342">1342</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
151
<a class="anchor" id="ga94d0237a67f4c82da1d92c5c4e73aece"></a><!-- doxytag: member="CASClient::setNoCasServerValidation" ref="ga94d0237a67f4c82da1d92c5c4e73aece" args="()" -->
152
<div class="memitem">
153
<div class="memproto">
154
<table class="memname">
156
<td class="memname">CASClient::setNoCasServerValidation </td>
158
<td class="paramname"></td>
159
<td> ) </td>
160
<td><code> [inherited]</code></td>
165
<p>Set no SSL validation for the CAS server. </p>
167
<p>Definition at line <a class="el" href="client_8php_source.html#l01360">1360</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
171
<a class="anchor" id="gaad406bd72b79e3636328673e9905dee6"></a><!-- doxytag: member="CASClient::setSessionAttributes" ref="gaad406bd72b79e3636328673e9905dee6" args="($text_response)" -->
172
<div class="memitem">
173
<div class="memproto">
174
<table class="memname">
176
<td class="memname">CASClient::setSessionAttributes </td>
178
<td class="paramtype">$ </td>
179
<td class="paramname"> <em>text_response</em></td>
180
<td> ) </td>
181
<td><code> [private, inherited]</code></td>
186
<p>This method will parse the DOM and pull out the attributes from the SAML payload and put them into an array, then put the array into the session.</p>
187
<dl><dt><b>Parameters:</b></dt><dd>
188
<table border="0" cellspacing="2" cellpadding="0">
189
<tr><td valign="top"></td><td valign="top"><em>$text_response</em> </td><td>the SAML payload. </td></tr>
193
<dl class="return"><dt><b>Returns:</b></dt><dd>bool TRUE when successfull and FALSE if no attributes a found </dd></dl>
195
<p>Definition at line <a class="el" href="client_8php_source.html#l01586">1586</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
197
<p>References <a class="el" href="CAS_8php_source.html#l00569">phpCAS::trace()</a>, <a class="el" href="CAS_8php_source.html#l00577">phpCAS::traceBegin()</a>, and <a class="el" href="CAS_8php_source.html#l00604">phpCAS::traceEnd()</a>.</p>
201
<a class="anchor" id="gaca73a8a7c4adb1175c4ba0e3812979db"></a><!-- doxytag: member="CASClient::setST" ref="gaca73a8a7c4adb1175c4ba0e3812979db" args="($st)" -->
202
<div class="memitem">
203
<div class="memproto">
204
<table class="memname">
206
<td class="memname">CASClient::setST </td>
208
<td class="paramtype">$ </td>
209
<td class="paramname"> <em>st</em></td>
210
<td> ) </td>
211
<td><code> [private, inherited]</code></td>
216
<p>This method stores the Service Ticket. </p>
217
<dl><dt><b>Parameters:</b></dt><dd>
218
<table border="0" cellspacing="2" cellpadding="0">
219
<tr><td valign="top"></td><td valign="top"><em>$st</em> </td><td>The Service Ticket. </td></tr>
224
<p>Definition at line <a class="el" href="client_8php_source.html#l01292">1292</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
226
<p>Referenced by <a class="el" href="client_8php_source.html#l01058">CASClient::wasPreviouslyAuthenticated()</a>.</p>
230
<a class="anchor" id="gac6ca61806e87cf911dd9b3bf2eeae689"></a><!-- doxytag: member="CASClient::validateSA" ref="gac6ca61806e87cf911dd9b3bf2eeae689" args="($validate_url, &$text_response, &$tree_response)" -->
231
<div class="memitem">
232
<div class="memproto">
233
<table class="memname">
235
<td class="memname">CASClient::validateSA </td>
237
<td class="paramtype">$ </td>
238
<td class="paramname"> <em>validate_url</em>, </td>
241
<td class="paramkey"></td>
243
<td class="paramtype">&$ </td>
244
<td class="paramname"> <em>text_response</em>, </td>
247
<td class="paramkey"></td>
249
<td class="paramtype">&$ </td>
250
<td class="paramname"> <em>tree_response</em></td><td> </td>
255
<td></td><td></td><td><code> [private, inherited]</code></td>
260
<p>This method is used to validate a SAML TICKET; halt on failure, and sets $validate_url, $text_reponse and $tree_response on success. These parameters are used later by <a class="el" href="group__internalPGTStorage.html#gaff6d96062187548ffba93dd7edbca563">CASClient::validatePGT()</a> for CAS proxies.</p>
261
<dl><dt><b>Parameters:</b></dt><dd>
262
<table border="0" cellspacing="2" cellpadding="0">
263
<tr><td valign="top"></td><td valign="top"><em>$validate_url</em> </td><td>the URL of the request to the CAS server. </td></tr>
264
<tr><td valign="top"></td><td valign="top"><em>$text_response</em> </td><td>the response of the CAS server, as is (XML text). </td></tr>
265
<tr><td valign="top"></td><td valign="top"><em>$tree_response</em> </td><td>the response of the CAS server, as a DOM XML tree.</td></tr>
269
<dl class="return"><dt><b>Returns:</b></dt><dd>bool TRUE when successfull, halt otherwise by calling <a class="el" href="group__internalMisc.html#ga4dda8e03389ad8a515d4e45cb42859ca">CASClient::authError()</a>. </dd></dl>
271
<p>Definition at line <a class="el" href="client_8php_source.html#l01508">1508</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
273
<p>References <a class="el" href="CAS_8php_source.html#l00569">phpCAS::trace()</a>, and <a class="el" href="CAS_8php_source.html#l00577">phpCAS::traceBegin()</a>.</p>
277
<a class="anchor" id="gacf3f1b530d4e029b3124558cc74d56cb"></a><!-- doxytag: member="CASClient::validateST" ref="gacf3f1b530d4e029b3124558cc74d56cb" args="($validate_url, &$text_response, &$tree_response)" -->
278
<div class="memitem">
279
<div class="memproto">
280
<table class="memname">
282
<td class="memname">CASClient::validateST </td>
284
<td class="paramtype">$ </td>
285
<td class="paramname"> <em>validate_url</em>, </td>
288
<td class="paramkey"></td>
290
<td class="paramtype">&$ </td>
291
<td class="paramname"> <em>text_response</em>, </td>
294
<td class="paramkey"></td>
296
<td class="paramtype">&$ </td>
297
<td class="paramname"> <em>tree_response</em></td><td> </td>
302
<td></td><td></td><td><code> [private, inherited]</code></td>
307
<p>This method is used to validate a ST; halt on failure, and sets $validate_url, $text_reponse and $tree_response on success. These parameters are used later by <a class="el" href="group__internalPGTStorage.html#gaff6d96062187548ffba93dd7edbca563">CASClient::validatePGT()</a> for CAS proxies. Used for all CAS 1.0 validations </p>
308
<dl><dt><b>Parameters:</b></dt><dd>
309
<table border="0" cellspacing="2" cellpadding="0">
310
<tr><td valign="top"></td><td valign="top"><em>$validate_url</em> </td><td>the URL of the request to the CAS server. </td></tr>
311
<tr><td valign="top"></td><td valign="top"><em>$text_response</em> </td><td>the response of the CAS server, as is (XML text). </td></tr>
312
<tr><td valign="top"></td><td valign="top"><em>$tree_response</em> </td><td>the response of the CAS server, as a DOM XML tree.</td></tr>
316
<dl class="return"><dt><b>Returns:</b></dt><dd>bool TRUE when successfull, halt otherwise by calling <a class="el" href="group__internalMisc.html#ga4dda8e03389ad8a515d4e45cb42859ca">CASClient::authError()</a>. </dd></dl>
318
<p>Definition at line <a class="el" href="client_8php_source.html#l01378">1378</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
320
<p>References <a class="el" href="client_8php_source.html#l02708">CASClient::authError()</a>, <a class="el" href="client_8php_source.html#l01782">CASClient::getCallbackURL()</a>, <a class="el" href="client_8php_source.html#l00426">CASClient::getServerServiceValidateURL()</a>, <a class="el" href="client_8php_source.html#l01284">CASClient::getST()</a>, <a class="el" href="client_8php_source.html#l01667">CASClient::isProxy()</a>, <a class="el" href="client_8php_source.html#l02149">CASClient::readURL()</a>, <a class="el" href="client_8php_source.html#l00779">CASClient::setUser()</a>, <a class="el" href="CAS_8php_source.html#l00569">phpCAS::trace()</a>, and <a class="el" href="CAS_8php_source.html#l00577">phpCAS::traceBegin()</a>.</p>
324
<hr/><h2>Variable Documentation</h2>
325
<a class="anchor" id="gaa78eb6b7d01c48e6d236c513e9b33e45"></a><!-- doxytag: member="CASClient::$_cas_server_ca_cert" ref="gaa78eb6b7d01c48e6d236c513e9b33e45" args="" -->
326
<div class="memitem">
327
<div class="memproto">
328
<table class="memname">
330
<td class="memname">CASClient::$_cas_server_ca_cert<code> [private, inherited]</code></td>
335
<p>the certificate of the CAS server CA. </p>
337
<p>Definition at line <a class="el" href="client_8php_source.html#l01327">1327</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
341
<a class="anchor" id="ga28b7a83796b4972a2fbc0d3791e0185c"></a><!-- doxytag: member="CASClient::$_cas_server_cert" ref="ga28b7a83796b4972a2fbc0d3791e0185c" args="" -->
342
<div class="memitem">
343
<div class="memproto">
344
<table class="memname">
346
<td class="memname">CASClient::$_cas_server_cert<code> [private, inherited]</code></td>
351
<p>the certificate of the CAS server. </p>
353
<p>Definition at line <a class="el" href="client_8php_source.html#l01319">1319</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
357
<a class="anchor" id="ga563b04790a9c60dbcff5ddb8e9741715"></a><!-- doxytag: member="CASClient::$_no_cas_server_validation" ref="ga563b04790a9c60dbcff5ddb8e9741715" args="" -->
358
<div class="memitem">
359
<div class="memproto">
360
<table class="memname">
362
<td class="memname">CASClient::$_no_cas_server_validation<code> [private, inherited]</code></td>
367
<p>Set to true not to validate the CAS server. </p>
369
<p>Definition at line <a class="el" href="client_8php_source.html#l01335">1335</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
373
<a class="anchor" id="gad790c032504597c075875197f64cc73b"></a><!-- doxytag: member="CASClient::$_st" ref="gad790c032504597c075875197f64cc73b" args="" -->
374
<div class="memitem">
375
<div class="memproto">
376
<table class="memname">
378
<td class="memname">CASClient::$_st<code> [private, inherited]</code></td>
383
<p>the Service Ticket provided in the URL of the request if present (empty otherwise). Written by <a class="el" href="group__internalConfig.html#ga8835a61f1bd234295466079e8b3c83af">CASClient::CASClient()</a>, read by <a class="el" href="group__internalBasic.html#gacc7692242bf95b8429d704de40a6cd52">CASClient::getST()</a> and <a class="el" href="group__internalProxy.html#ga432d879c0441763b4c1c1582bf1bc44c">CASClient::hasPGT()</a>. </p>
385
<p>Definition at line <a class="el" href="client_8php_source.html#l01277">1277</a> of file <a class="el" href="client_8php_source.html">client.php</a>.</p>
390
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jul 12 08:31:30 2010 for phpCAS by
391
<a href="http://www.doxygen.org/index.html">
392
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>