diff options
| author | Leif Johansson <leifj@klapautius.mnt.se> | 2009-07-28 10:34:52 +0200 |
|---|---|---|
| committer | Leif Johansson <leifj@klapautius.mnt.se> | 2009-07-28 10:34:52 +0200 |
| commit | 0a90384a9c7d840e88d9636271e8393a514647a0 (patch) | |
| tree | 007540e79ec2a2e0e81bd0bd21e6eef9fc8bb205 /doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins | |
Import shibboleth ds 1.1.0v1.1.0upstreamds.swamid.se
Diffstat (limited to 'doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins')
11 files changed, 1477 insertions, 0 deletions
diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html new file mode 100644 index 0000000..0c6391a --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html @@ -0,0 +1,173 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> +<head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>Plugin xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em> +<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> */</em> +<a name="16" href="#16">16</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins; +<a name="17" href="#17">17</a> +<a name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a name="21" href="#21">21</a> +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; +<a name="24" href="#24">24</a> +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataProvider; +<a name="26" href="#26">26</a> +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.IdPSite; +<a name="28" href="#28">28</a> +<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * </em> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * The Plugin interface is used to affect the 'hints' that the WAYF offers to the users. </em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * The WAYF can register any number of plugins. Each plugin is called when the metadata is loaded or realoaded</em> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * (so it can do any indexing) and at the three entry points into the WAYF - Lookup (main entry), Search and Select.</em> +<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Plugins are called in the order in which they are declared to the WAYF. </em> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Each plugin is called once when the user has made a selection.</em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * For Search and Lookup, each plugin is called multiple times, once for each metadata provider which has </em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * been declared to this particular WAYF instance. The plugin can return a context which is handed to subsequent calls.</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * The idea is that each plugin can affect the displayed lists of IdPs. As a reminder the WAYF displays two lists of </em> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * IdPs - the complete list, displayed either as a single list or a list of lists, and the hint list (which was</em> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * previously only populated from the _saml_idp cookie. In the search case the WAYF displays a third list of</em> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * the search hits. </em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * When the plugin in called it is given the current set of potential IdPs as a Map from EntityID to {@link IdPSite}</em> +<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * and lists representing the current hint list and search results. A Plugin can remove an entry from </em> +<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * the map or the lists. Additionally it can insert an IdPSite found in the Map into the hint or search lists.</em> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Thus the plugin can restrict the number of sites that the WAYF instance displays in the 'complete list' and</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * can add or remove IdPs from the hint list.</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * At any stage the plugin can take control of the current request and redirect or forward it. It signals that</em> +<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * it has done this to the WAYF by means of an exception.</em> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * <p> </em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * The _saml_idp cookie handling code is written as a WAYF plugin. Other plugins have been written to allow IdPs</em> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * to be presented as hints based on the client's IP address or to redirect back to the SP once the choice of</em> +<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * IdP has been made.</em> +<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * Object implementing this interface are created during WAYF discovery service initialization. There are </em> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * expected to implement a constructor which takes a {@link org.w3c.dom.Element} as the only parameter and they are </em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * created via this constructor, with the parameter being the appropriate section of the WAYF configuration file </em> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * </em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @version Discussion</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em> +<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> { +<a name="68" href="#68">68</a> +<a name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Whenever the WAYF discoveres that the metadata is stale, it reloads it and calls each plugin at this method.</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * </em> +<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @param metadata - where to get the data from.</em> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @return the value which will be provided as input to subsequent calls to {@link #lookup Lookup} and </em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * {@link #search Search}</em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> +<a name="76" href="#76">76</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> refreshMetadata(MetadataProvider metadata); +<a name="77" href="#77">77</a> +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em> +<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * The WAYF calls each plugin at this entry point when it is first contacted. </em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * </em> +<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @param req - Describes the current request. A Plugin might use it to find any appropriate cookies </em> +<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param res - Describes the current response. A Plugin might use it to redirect a the request. </em> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata.</em> +<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @param context Any processing context returned from a previous call.</em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param validIdps The list of IdPs which is currently views as possibly matches for the pattern. </em> +<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * The Key is the EntityId for the IdP and the value the object which describes </em> +<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * the Idp </em> +<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @param idpList The set of Idps which are currently considered as potential hints. </em> +<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls</em> +<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request (for instance it has</em> +<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * issues a redirect)</em> +<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> *</em> +<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * Each plugin is called multiple times,</em> +<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * once for each metadata provider which is registered (Depending on the precise configuration of the WAYF</em> +<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * metadata providers whose metadata does not include the target may be dropped). Initially the plugin is</em> +<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * called with a context parameter of <code>null</code>. In subsequent calls, the value returned from</em> +<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * the previous call is passed in as the context parameter. </em> +<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * </em> +<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * The plugin may remove IdPSite objects from the validIdps list.</em> +<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * </em> +<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * The plugin may add or remove them to the idpList. IdPSite Objects which are to be added to the idpList </em> +<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * should be looked up by EntityIdName in validIdps by EntityId. Hence any metadata processing shoudl </em> +<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * store the entityID. </em> +<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * </em> +<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em> +<a name="106" href="#106">106</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> lookup(HttpServletRequest req, +<a name="107" href="#107">107</a> HttpServletResponse res, +<a name="108" href="#108">108</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="109" href="#109">109</a> Map<String, IdPSite> validIdps, +<a name="110" href="#110">110</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context, +<a name="111" href="#111">111</a> List<IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled; +<a name="112" href="#112">112</a> +<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">/**</em> +<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * This method is called when the user specified a search operation. The processing is similar to </em> +<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * that described for {@link #lookup lookup}.</em> +<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Two additional paramaters are provided, the search parameter which was provided, and the current </em> +<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * proposed list of candidate IdPs. The plugin is at liberty to alter both the list of hints and the </em> +<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * list of valid IdPs. </em> +<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * </em> +<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. The Plugin could use it to find any appropriate cookies </em> +<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param res Describes the result - this is needed if (for instance) a plung needs to change cookie values</em> +<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata</em> +<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @param pattern The Search pattern provided</em> +<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @param validIdps The list of IdPs which is currently views as possibly matches for the pattern. </em> +<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * The Key is the Idp Name an the value the idp</em> +<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @param context Any processing context returned from a previous call.</em> +<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @param searchResult the resukt of any search</em> +<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @param idpList The set of Idps which are currently considered as potential hints. Each Idp is associated</em> +<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * with a numeric weight, where the lower the number is the more likely the IdP is to be a candidate. </em> +<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * As descibed above the WAYF uses this to provide hint list to the GUI (or even to dispatch </em> +<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * immediately to the IdP). </em> +<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls</em> +<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request (for instance it has</em> +<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * issues a redirect)</em> +<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em> +<a name="136" href="#136">136</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> search(HttpServletRequest req, +<a name="137" href="#137">137</a> HttpServletResponse res, +<a name="138" href="#138">138</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="139" href="#139">139</a> String pattern, +<a name="140" href="#140">140</a> Map<String, IdPSite> validIdps, +<a name="141" href="#141">141</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context, +<a name="142" href="#142">142</a> Collection<IdPSite> searchResult, +<a name="143" href="#143">143</a> List<IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled; +<a name="144" href="#144">144</a> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">/**</em> +<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * This method is called, for every plugin, after a user has selected an IdP. The plugin is expected </em> +<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * to use it to update any in memory state (via the {@link PluginMetadataParameter} parameter or permananent </em> +<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * state (for instance by writing back a cookie.</em> +<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. </em> +<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * @param res Describes the current response</em> +<a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata</em> +<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request (for instance it has</em> +<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * issues a redirect)</em> +<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> */</em> +<a name="155" href="#155">155</a> <strong class="jxr_keyword">void</strong> selected(HttpServletRequest req, +<a name="156" href="#156">156</a> HttpServletResponse res, +<a name="157" href="#157">157</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="158" href="#158">158</a> String idP) <strong class="jxr_keyword">throws</strong> WayfRequestHandled; +<a name="159" href="#159">159</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html new file mode 100644 index 0000000..23967b7 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html @@ -0,0 +1,45 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> +<head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>PluginContext xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em> +<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> */</em> +<a name="16" href="#16">16</a> +<a name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins; +<a name="18" href="#18">18</a> +<a name="19" href="#19">19</a> <em class="jxr_javadoccomment">/**</em> +<a name="20" href="#20">20</a> <em class="jxr_javadoccomment"> * This is a marker interface.</em> +<a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * Objects which implement PluginContext are passed between sucessive calls to a plugins implementations of</em> +<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * {@link Plugin#lookup lookup} and {@link Plugin#search search} as the plugin </em> +<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * is called for each {@link org.opensaml.saml2.metadata.provider.MetadataProvider}.</em> +<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * @version Discussion</em> +<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> */</em> +<a name="29" href="#29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> { +<a name="30" href="#30">30</a> +<a name="31" href="#31">31</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html new file mode 100644 index 0000000..e07d9e0 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> +<head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>PluginMetadataParameter xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em> +<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> */</em> +<a name="16" href="#16">16</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins; +<a name="17" href="#17">17</a> +<a name="18" href="#18">18</a> +<a name="19" href="#19">19</a> <em class="jxr_javadoccomment">/**</em> +<a name="20" href="#20">20</a> <em class="jxr_javadoccomment"> * The PluginParameter is a marker interface which a WAYF {@link Plugin} can use to associate extra information </em> +<a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * with the metadata. Each plugin returns a PluginParameter from {@link Plugin#refreshMetadata RefreshMetadata}</em> +<a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * and this is in turn presented back to then Plugin when it is called during WAYF processing. </em> +<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * @version Discussion</em> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> *</em> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> */</em> +<a name="28" href="#28">28</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> { +<a name="29" href="#29">29</a> +<a name="30" href="#30">30</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html new file mode 100644 index 0000000..bb9d473 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html @@ -0,0 +1,31 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> +<head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>WayfRequestHandled xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins; +<a name="2" href="#2">2</a> +<a name="3" href="#3">3</a> <em class="jxr_javadoccomment">/**</em> +<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * </em> +<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * This Exception can be signalled by a plugin to indicate to the WAYF that it has handled the </em> +<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * request and all processing should stop.</em> +<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * </em> +<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> */</em> +<a name="10" href="#10">10</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html">WayfRequestHandled</a> <strong class="jxr_keyword">extends</strong> Exception { +<a name="11" href="#11">11</a> +<a name="12" href="#12">12</a> <em class="jxr_javadoccomment">/**</em> +<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * Required Serialization constant.</em> +<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> */</em> +<a name="15" href="#15">15</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 3022489208153734092L; +<a name="16" href="#16">16</a> +<a name="17" href="#17">17</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html new file mode 100644 index 0000000..856f7b5 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html @@ -0,0 +1,33 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">edu.internet2.middleware.shibboleth.wayf.plugins</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="Plugin.html" target="classFrame">Plugin</a>
+ </li>
+ <li>
+ <a href="PluginContext.html" target="classFrame">PluginContext</a>
+ </li>
+ <li>
+ <a href="PluginMetadataParameter.html" target="classFrame">PluginMetadataParameter</a>
+ </li>
+ <li>
+ <a href="WayfRequestHandled.html" target="classFrame">WayfRequestHandled</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html new file mode 100644 index 0000000..2c26dfd --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html @@ -0,0 +1,82 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package edu.internet2.middleware.shibboleth.wayf.plugins</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="Plugin.html" target="classFrame">Plugin</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="PluginContext.html" target="classFrame">PluginContext</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="PluginMetadataParameter.html" target="classFrame">PluginMetadataParameter</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="WayfRequestHandled.html" target="classFrame">WayfRequestHandled</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © 2006-2009 Internet2. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html new file mode 100644 index 0000000..9a234f3 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html @@ -0,0 +1,190 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> +<head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>BindingFilter xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> +<a name="2" href="#2">2</a> <em class="jxr_comment"> * Copyright 2008 University Corporation for Advanced Internet Development, Inc.</em> +<a name="3" href="#3">3</a> <em class="jxr_comment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_comment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_comment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_comment"> */</em> +<a name="16" href="#16">16</a> +<a name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins.provider; +<a name="18" href="#18">18</a> +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="21" href="#21">21</a> +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.common.Extensions; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntitiesDescriptor; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntityDescriptor; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.RoleDescriptor; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.SPSSODescriptor; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.FilterException; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataFilter; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject; +<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="32" href="#32">32</a> +<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseImpl; +<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.HandlerConfig; +<a name="35" href="#35">35</a> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * See SDSJ-48. If we get a DS endpoint then we need to check that the binding is provided</em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * and that it is correct.</em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * </em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em> +<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">BindingFilter</a> implements MetadataFilter { +<a name="44" href="#44">44</a> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Log for the warning. </em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em> +<a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(BindingFilter.<strong class="jxr_keyword">class</strong>.getName()); +<a name="49" href="#49">49</a> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Set if we just want to warn on failure.</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> +<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> warnOnFailure; +<a name="54" href="#54">54</a> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * Only the protected constructor should be visible.</em> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> +<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">BindingFilter</a>() { +<a name="59" href="#59">59</a> <strong class="jxr_keyword">this</strong>.warnOnFailure = false; +<a name="60" href="#60">60</a> } +<a name="61" href="#61">61</a> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Initialize the filter.</em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param warn do we warn or do we fail if we see badness?</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> +<a name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">BindingFilter</a>(<strong class="jxr_keyword">boolean</strong> warn) { +<a name="67" href="#67">67</a> <strong class="jxr_keyword">this</strong>.warnOnFailure = warn; +<a name="68" href="#68">68</a> } +<a name="69" href="#69">69</a> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Apply the filter.</em> +<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)</em> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @param metadata what to filter.</em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @throws FilterException if it sees any missed or bad bindings.</em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> +<a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doFilter(XMLObject metadata) <strong class="jxr_keyword">throws</strong> FilterException { +<a name="77" href="#77">77</a> +<a name="78" href="#78">78</a> <strong class="jxr_keyword">if</strong> (metadata instanceof EntitiesDescriptor) { +<a name="79" href="#79">79</a> +<a name="80" href="#80">80</a> checkEntities((EntitiesDescriptor) metadata); +<a name="81" href="#81">81</a> +<a name="82" href="#82">82</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (metadata instanceof EntityDescriptor) { +<a name="83" href="#83">83</a> EntityDescriptor entity = (EntityDescriptor) metadata; +<a name="84" href="#84">84</a> +<a name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> (!checkEntity(entity)) { +<a name="86" href="#86">86</a> <strong class="jxr_keyword">if</strong> (warnOnFailure) { +<a name="87" href="#87">87</a> LOG.warn(<span class="jxr_string">"Badly formatted binding for "</span> + entity.getEntityID()); +<a name="88" href="#88">88</a> } <strong class="jxr_keyword">else</strong> { +<a name="89" href="#89">89</a> LOG.error(<span class="jxr_string">"Badly formatted binding for top level entity "</span> + entity.getEntityID()); +<a name="90" href="#90">90</a> } +<a name="91" href="#91">91</a> } +<a name="92" href="#92">92</a> } +<a name="93" href="#93">93</a> } +<a name="94" href="#94">94</a> +<a name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em> +<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * If the entity has an SP characteristic, and it has a DS endpoint</em> +<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * then check its binding.</em> +<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * </em> +<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @param entity what to check.</em> +<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @return true if all is OK.</em> +<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> */</em> +<a name="102" href="#102">102</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> checkEntity(EntityDescriptor entity) { +<a name="103" href="#103">103</a> List<RoleDescriptor> roles = entity.getRoleDescriptors(); +<a name="104" href="#104">104</a> +<a name="105" href="#105">105</a> <strong class="jxr_keyword">for</strong> (RoleDescriptor role:roles) { +<a name="106" href="#106">106</a> +<a name="107" href="#107">107</a> <em class="jxr_comment">//</em> +<a name="108" href="#108">108</a> <em class="jxr_comment">// Check every role</em> +<a name="109" href="#109">109</a> <em class="jxr_comment">//</em> +<a name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (role instanceof SPSSODescriptor) { +<a name="111" href="#111">111</a> +<a name="112" href="#112">112</a> <em class="jxr_comment">//</em> +<a name="113" href="#113">113</a> <em class="jxr_comment">// Grab hold of all the extensions for SPSSO descriptors</em> +<a name="114" href="#114">114</a> <em class="jxr_comment">//</em> +<a name="115" href="#115">115</a> +<a name="116" href="#116">116</a> Extensions exts = role.getExtensions(); +<a name="117" href="#117">117</a> <strong class="jxr_keyword">if</strong> (exts != <strong class="jxr_keyword">null</strong>) { +<a name="118" href="#118">118</a> <em class="jxr_comment">//</em> +<a name="119" href="#119">119</a> <em class="jxr_comment">// We have some children check them form <DiscoveryResponse></em> +<a name="120" href="#120">120</a> <em class="jxr_comment">//</em> +<a name="121" href="#121">121</a> List<XMLObject> children = exts.getOrderedChildren(); +<a name="122" href="#122">122</a> +<a name="123" href="#123">123</a> <strong class="jxr_keyword">for</strong> (XMLObject obj : children) { +<a name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> (obj instanceof DiscoveryResponseImpl) { +<a name="125" href="#125">125</a> <em class="jxr_comment">//</em> +<a name="126" href="#126">126</a> <em class="jxr_comment">// And check or the binding</em> +<a name="127" href="#127">127</a> <em class="jxr_comment">//</em> +<a name="128" href="#128">128</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a> ds = (DiscoveryResponseImpl) obj; +<a name="129" href="#129">129</a> String binding = ds.getBinding(); +<a name="130" href="#130">130</a> +<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (!DiscoveryResponseImpl.METADATA_NS.equals(binding)) { +<a name="132" href="#132">132</a> <strong class="jxr_keyword">return</strong> false; +<a name="133" href="#133">133</a> } +<a name="134" href="#134">134</a> } +<a name="135" href="#135">135</a> } +<a name="136" href="#136">136</a> } +<a name="137" href="#137">137</a> } +<a name="138" href="#138">138</a> } +<a name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="140" href="#140">140</a> } +<a name="141" href="#141">141</a> +<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Check an EntitiesDescriptor call checkentities for the Entities and ourselves</em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * recursively for the EntitesDescriptors.</em> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * </em> +<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @param entities what to check.</em> +<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em> +<a name="148" href="#148">148</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkEntities(EntitiesDescriptor entities) { +<a name="149" href="#149">149</a> List<EntitiesDescriptor> childEntities = entities.getEntitiesDescriptors(); +<a name="150" href="#150">150</a> List<EntityDescriptor> children = entities.getEntityDescriptors(); +<a name="151" href="#151">151</a> +<a name="152" href="#152">152</a> <strong class="jxr_keyword">if</strong> (children != <strong class="jxr_keyword">null</strong>) { +<a name="153" href="#153">153</a> Iterator<EntityDescriptor> itr; +<a name="154" href="#154">154</a> EntityDescriptor entity; +<a name="155" href="#155">155</a> itr = children.iterator(); +<a name="156" href="#156">156</a> +<a name="157" href="#157">157</a> <strong class="jxr_keyword">while</strong> (itr.hasNext()) { +<a name="158" href="#158">158</a> entity = itr.next(); +<a name="159" href="#159">159</a> <strong class="jxr_keyword">if</strong> (!checkEntity(entity)) { +<a name="160" href="#160">160</a> <strong class="jxr_keyword">if</strong> (warnOnFailure) { +<a name="161" href="#161">161</a> LOG.warn(<span class="jxr_string">"Badly formatted binding for "</span> + entity.getEntityID()); +<a name="162" href="#162">162</a> } <strong class="jxr_keyword">else</strong> { +<a name="163" href="#163">163</a> LOG.error(<span class="jxr_string">"Badly formatted binding for "</span> + entity.getEntityID() + <span class="jxr_string">". Entity has been removed"</span>); +<a name="164" href="#164">164</a> itr.remove(); +<a name="165" href="#165">165</a> } +<a name="166" href="#166">166</a> } +<a name="167" href="#167">167</a> } +<a name="168" href="#168">168</a> } +<a name="169" href="#169">169</a> +<a name="170" href="#170">170</a> <strong class="jxr_keyword">if</strong> (childEntities != <strong class="jxr_keyword">null</strong>) { +<a name="171" href="#171">171</a> <strong class="jxr_keyword">for</strong> (EntitiesDescriptor descriptor : childEntities) { +<a name="172" href="#172">172</a> checkEntities(descriptor); +<a name="173" href="#173">173</a> } +<a name="174" href="#174">174</a> } +<a name="175" href="#175">175</a> } +<a name="176" href="#176">176</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html new file mode 100644 index 0000000..270ec3e --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html @@ -0,0 +1,198 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> +<head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>ListFilter xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> +<a name="2" href="#2">2</a> <em class="jxr_comment"> * Copyright 2008 University Corporation for Advanced Internet Development, Inc.</em> +<a name="3" href="#3">3</a> <em class="jxr_comment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_comment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_comment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_comment"> */</em> +<a name="16" href="#16">16</a> +<a name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins.provider; +<a name="18" href="#18">18</a> +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Set; +<a name="23" href="#23">23</a> +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntitiesDescriptor; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntityDescriptor; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.FilterException; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataFilter; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList; +<a name="33" href="#33">33</a> +<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.HandlerConfig; +<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.XMLConstants; +<a name="36" href="#36">36</a> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * See SDSJ-57. Explicit </em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * </em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em> +<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html">ListFilter</a> implements MetadataFilter { +<a name="44" href="#44">44</a> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Log for any messages.</em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em> +<a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(ListFilter.<strong class="jxr_keyword">class</strong>.getName()); +<a name="49" href="#49">49</a> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Set if this is a blacklist.</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> +<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> excludeEntries; +<a name="54" href="#54">54</a> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * The list of entities.</em> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> +<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Set<String> filterEntities; +<a name="59" href="#59">59</a> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * The name of the filter (needed for debug).</em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em> +<a name="63" href="#63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String filterName; +<a name="64" href="#64">64</a> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Only the protected constructor should be visible.</em> +<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em> +<a name="68" href="#68">68</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html">ListFilter</a>() { +<a name="69" href="#69">69</a> <strong class="jxr_keyword">this</strong>.excludeEntries = false; +<a name="70" href="#70">70</a> <strong class="jxr_keyword">this</strong>.filterEntities = <strong class="jxr_keyword">new</strong> HashSet<String>(0); +<a name="71" href="#71">71</a> <strong class="jxr_keyword">this</strong>.filterName = <span class="jxr_string">"anonymous"</span>; +<a name="72" href="#72">72</a> } +<a name="73" href="#73">73</a> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * Initialize the filter.</em> +<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * @param config the configuration</em> +<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em> +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * The configuration looks liken this</em> +<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * <code> <Filter identifier="WhiteList" </em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * type ="edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter"</em> +<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * excludeEntries = "true" ></em> +<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <EntityId>foo</EntityId></em> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * [...]</em> +<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * </Filter></em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * </code></em> +<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em> +<a name="87" href="#87">87</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html">ListFilter</a>(Element config) { +<a name="88" href="#88">88</a> String excludeEntriesValue; +<a name="89" href="#89">89</a> <strong class="jxr_keyword">this</strong>.filterEntities = <strong class="jxr_keyword">new</strong> HashSet<String>(10); +<a name="90" href="#90">90</a> <strong class="jxr_keyword">this</strong>.filterName = config.getAttribute(<span class="jxr_string">"identifier"</span>); +<a name="91" href="#91">91</a> excludeEntriesValue = config.getAttribute(<span class="jxr_string">"excludeEntries"</span>); +<a name="92" href="#92">92</a> +<a name="93" href="#93">93</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == excludeEntriesValue || 0 == excludeEntriesValue.length()) { +<a name="94" href="#94">94</a> <strong class="jxr_keyword">this</strong>.excludeEntries = <strong class="jxr_keyword">true</strong>; +<a name="95" href="#95">95</a> } <strong class="jxr_keyword">else</strong> { +<a name="96" href="#96">96</a> <strong class="jxr_keyword">this</strong>.excludeEntries = Boolean.getBoolean(excludeEntriesValue); +<a name="97" href="#97">97</a> } +<a name="98" href="#98">98</a> +<a name="99" href="#99">99</a> NodeList itemElements = config.getElementsByTagNameNS(XMLConstants.CONFIG_NS, <span class="jxr_string">"EntityId"</span>); +<a name="100" href="#100">100</a> +<a name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> (excludeEntries) { +<a name="102" href="#102">102</a> LOG.debug(<span class="jxr_string">"Populating blacklist "</span> + filterName); +<a name="103" href="#103">103</a> } <strong class="jxr_keyword">else</strong> { +<a name="104" href="#104">104</a> LOG.debug(<span class="jxr_string">"Populating whitelist "</span> + filterName); +<a name="105" href="#105">105</a> } +<a name="106" href="#106">106</a> +<a name="107" href="#107">107</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < itemElements.getLength(); i++) { +<a name="108" href="#108">108</a> Element element = (Element) itemElements.item(i); +<a name="109" href="#109">109</a> String entityId = element.getTextContent(); +<a name="110" href="#110">110</a> +<a name="111" href="#111">111</a> LOG.debug(<span class="jxr_string">"\t"</span> + entityId); +<a name="112" href="#112">112</a> <strong class="jxr_keyword">this</strong>.filterEntities.add(entityId); +<a name="113" href="#113">113</a> } +<a name="114" href="#114">114</a> } +<a name="115" href="#115">115</a> +<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">/**</em> +<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * Apply the filter.</em> +<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)</em> +<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param metadata what to filter.</em> +<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @throws FilterException if it sees any missed or bad bindings.</em> +<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em> +<a name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doFilter(XMLObject metadata) <strong class="jxr_keyword">throws</strong> FilterException { +<a name="123" href="#123">123</a> +<a name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> (metadata instanceof EntitiesDescriptor) { +<a name="125" href="#125">125</a> filterEntities((EntitiesDescriptor)metadata); +<a name="126" href="#126">126</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (metadata instanceof EntityDescriptor) { +<a name="127" href="#127">127</a> EntityDescriptor entity = (EntityDescriptor) metadata; +<a name="128" href="#128">128</a> String entityName = entity.getEntityID(); +<a name="129" href="#129">129</a> +<a name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> (excludeEntries) { +<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (filterEntities.contains(entityName)) { +<a name="132" href="#132">132</a> LOG.error(<span class="jxr_string">"Metadata provider contains a single <EntityDescriptor> ("</span> + entityName + +<a name="133" href="#133">133</a> <span class="jxr_string">") which is in exclude list"</span>); +<a name="134" href="#134">134</a> } +<a name="135" href="#135">135</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!filterEntities.contains(entity.getEntityID())) { +<a name="136" href="#136">136</a> LOG.error(<span class="jxr_string">"Metadata provider contains a single <EntityDescriptor> ("</span> + entityName + +<a name="137" href="#137">137</a> <span class="jxr_string">") which is not on include list"</span>); +<a name="138" href="#138">138</a> } +<a name="139" href="#139">139</a> } +<a name="140" href="#140">140</a> } +<a name="141" href="#141">141</a> +<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Filter an EntitiesDescriptor . We do this explictly for the Entities and call ourselves</em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * recursively for the EntitesDescriptors.</em> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * </em> +<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @param entities what to check.</em> +<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em> +<a name="148" href="#148">148</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> filterEntities(EntitiesDescriptor entities) { +<a name="149" href="#149">149</a> String entitiesName = entities.getName(); +<a name="150" href="#150">150</a> List<EntitiesDescriptor> childEntities = entities.getEntitiesDescriptors(); +<a name="151" href="#151">151</a> List<EntityDescriptor> children = entities.getEntityDescriptors(); +<a name="152" href="#152">152</a> +<a name="153" href="#153">153</a> <em class="jxr_comment">//</em> +<a name="154" href="#154">154</a> <em class="jxr_comment">// Go through and apply the filter</em> +<a name="155" href="#155">155</a> <em class="jxr_comment">//</em> +<a name="156" href="#156">156</a> +<a name="157" href="#157">157</a> <strong class="jxr_keyword">if</strong> (children != <strong class="jxr_keyword">null</strong>) { +<a name="158" href="#158">158</a> Iterator<EntityDescriptor> itr; +<a name="159" href="#159">159</a> EntityDescriptor entity; +<a name="160" href="#160">160</a> itr = children.iterator(); +<a name="161" href="#161">161</a> +<a name="162" href="#162">162</a> <strong class="jxr_keyword">while</strong> (itr.hasNext()) { +<a name="163" href="#163">163</a> entity = itr.next(); +<a name="164" href="#164">164</a> String entityName = entity.getEntityID(); +<a name="165" href="#165">165</a> <strong class="jxr_keyword">if</strong> (excludeEntries) { +<a name="166" href="#166">166</a> +<a name="167" href="#167">167</a> <strong class="jxr_keyword">if</strong> (filterEntities.contains(entityName)) { +<a name="168" href="#168">168</a> LOG.debug(<span class="jxr_string">"Filter "</span> + filterName + <span class="jxr_string">": Removing blacklisted "</span> + entityName + <span class="jxr_string">" from "</span> + entitiesName); +<a name="169" href="#169">169</a> itr.remove(); +<a name="170" href="#170">170</a> } +<a name="171" href="#171">171</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!filterEntities.contains(entityName)) { +<a name="172" href="#172">172</a> LOG.debug(<span class="jxr_string">"Filter "</span> + filterName + <span class="jxr_string">": Removing non-whitelisted "</span> + entityName + <span class="jxr_string">" from "</span> + entitiesName); +<a name="173" href="#173">173</a> itr.remove(); +<a name="174" href="#174">174</a> } +<a name="175" href="#175">175</a> } +<a name="176" href="#176">176</a> } +<a name="177" href="#177">177</a> +<a name="178" href="#178">178</a> <strong class="jxr_keyword">if</strong> (childEntities != <strong class="jxr_keyword">null</strong>) { +<a name="179" href="#179">179</a> <strong class="jxr_keyword">for</strong> (EntitiesDescriptor descriptor : childEntities) { +<a name="180" href="#180">180</a> filterEntities(descriptor); +<a name="181" href="#181">181</a> } +<a name="182" href="#182">182</a> } +<a name="183" href="#183">183</a> } +<a name="184" href="#184">184</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html new file mode 100644 index 0000000..9e6528e --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html @@ -0,0 +1,558 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> +<head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>SamlCookiePlugin xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins.provider; +<a name="2" href="#2">2</a> +<a name="3" href="#3">3</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException; +<a name="4" href="#4">4</a> <strong class="jxr_keyword">import</strong> java.net.URLDecoder; +<a name="5" href="#5">5</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder; +<a name="6" href="#6">6</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a name="7" href="#7">7</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a name="8" href="#8">8</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a name="9" href="#9">9</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="10" href="#10">10</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a name="11" href="#11">11</a> +<a name="12" href="#12">12</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.Cookie; +<a name="13" href="#13">13</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; +<a name="14" href="#14">14</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; +<a name="15" href="#15">15</a> +<a name="16" href="#16">16</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.Logger; +<a name="17" href="#17">17</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataProvider; +<a name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.util.Base64; +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a name="20" href="#20">20</a> +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.IdPSite; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.WayfException; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.Plugin; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.WayfRequestHandled; +<a name="28" href="#28">28</a> +<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * This is a test implementation of the saml cookie lookup stuff to </em> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * see whether it fits the plugin architecture.</em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * </em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em> +<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> */</em> +<a name="36" href="#36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlCookiePlugin</a> implements <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> { +<a name="37" href="#37">37</a> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * The parameter which controls the cache.</em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em> +<a name="41" href="#41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PARAMETER_NAME = <span class="jxr_string">"cache"</span>; +<a name="42" href="#42">42</a> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Parameter to say make it last a long time.</em> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> +<a name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PARAMETER_PERM = <span class="jxr_string">"perm"</span>; +<a name="47" href="#47">47</a> +<a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em> +<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Parameter to say just keep this as long as the brower is open.</em> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em> +<a name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PARAMETER_SESSION = <span class="jxr_string">"session"</span>; +<a name="52" href="#52">52</a> +<a name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em> +<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Handle for logging. </em> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> +<a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Logger log = Logger.getLogger(SamlCookiePlugin.<strong class="jxr_keyword">class</strong>.getName()); +<a name="57" href="#57">57</a> +<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em> +<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * As specified in the SAML2 profiles specification.</em> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em> +<a name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String COOKIE_NAME = <span class="jxr_string">"_saml_idp"</span>; +<a name="62" href="#62">62</a> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * By default we keep the cookie around for a week.</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> +<a name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_CACHE_EXPIRATION = 6048000; +<a name="67" href="#67">67</a> +<a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em> +<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Do we always go where the cookie tells us, or do we just provide the cookie as a hint.</em> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em> +<a name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> alwaysFollow; +<a name="72" href="#72">72</a> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Is our job to clean up the cookie. </em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> +<a name="76" href="#76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> deleteCookie; +<a name="77" href="#77">77</a> +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em> +<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Lipservice towards having a common domain cookie. </em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em> +<a name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> String cacheDomain; +<a name="82" href="#82">82</a> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em> +<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * How long the cookie our will be active? </em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em> +<a name="86" href="#86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> cacheExpiration; +<a name="87" href="#87">87</a> +<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em> +<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * This constructor is called during wayf initialization with it's</em> +<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * own little bit of XML config.</em> +<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * </em> +<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @param element - further information to be gleaned from the DOM.</em> +<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em> +<a name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlCookiePlugin</a>(Element element) { +<a name="95" href="#95">95</a> <em class="jxr_comment">/*</em> +<a name="96" href="#96">96</a> <em class="jxr_comment"> * <Plugin idenfifier="WayfCookiePlugin" </em> +<a name="97" href="#97">97</a> <em class="jxr_comment"> * type="edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin"</em> +<a name="98" href="#98">98</a> <em class="jxr_comment"> * alwaysFollow = "FALSE"</em> +<a name="99" href="#99">99</a> <em class="jxr_comment"> * deleteCookie = "FALSE"</em> +<a name="100" href="#100">100</a> <em class="jxr_comment"> * cacheExpiration = "number" </em> +<a name="101" href="#101">101</a> <em class="jxr_comment"> * cacheDomain = "string"/> </em> +<a name="102" href="#102">102</a> <em class="jxr_comment"> */</em> +<a name="103" href="#103">103</a> log.info(<span class="jxr_string">"New plugin"</span>); +<a name="104" href="#104">104</a> String s; +<a name="105" href="#105">105</a> +<a name="106" href="#106">106</a> s = element.getAttribute(<span class="jxr_string">"alwaysFollow"</span>); +<a name="107" href="#107">107</a> <strong class="jxr_keyword">if</strong> (s != <strong class="jxr_keyword">null</strong> && !s.equals(<span class="jxr_string">""</span>) ) { +<a name="108" href="#108">108</a> alwaysFollow = Boolean.valueOf(s).booleanValue(); +<a name="109" href="#109">109</a> } <strong class="jxr_keyword">else</strong> { +<a name="110" href="#110">110</a> alwaysFollow = <strong class="jxr_keyword">true</strong>; +<a name="111" href="#111">111</a> } +<a name="112" href="#112">112</a> +<a name="113" href="#113">113</a> s = element.getAttribute(<span class="jxr_string">"deleteCookie"</span>); +<a name="114" href="#114">114</a> <strong class="jxr_keyword">if</strong> (s != <strong class="jxr_keyword">null</strong> && !s.equals(<span class="jxr_string">""</span>)) { +<a name="115" href="#115">115</a> deleteCookie = Boolean.valueOf(s).booleanValue(); +<a name="116" href="#116">116</a> } <strong class="jxr_keyword">else</strong> { +<a name="117" href="#117">117</a> deleteCookie = false; +<a name="118" href="#118">118</a> } +<a name="119" href="#119">119</a> +<a name="120" href="#120">120</a> s = element.getAttribute(<span class="jxr_string">"cacheDomain"</span>); +<a name="121" href="#121">121</a> <strong class="jxr_keyword">if</strong> ((s != <strong class="jxr_keyword">null</strong>) && !s.equals(<span class="jxr_string">""</span>)) { +<a name="122" href="#122">122</a> cacheDomain = s; +<a name="123" href="#123">123</a> } <strong class="jxr_keyword">else</strong> { +<a name="124" href="#124">124</a> cacheDomain = <span class="jxr_string">""</span>; +<a name="125" href="#125">125</a> } +<a name="126" href="#126">126</a> +<a name="127" href="#127">127</a> s = element.getAttribute(<span class="jxr_string">"cacheExpiration"</span>); +<a name="128" href="#128">128</a> <strong class="jxr_keyword">if</strong> ((s != <strong class="jxr_keyword">null</strong>) && !s.equals(<span class="jxr_string">""</span>)) { +<a name="129" href="#129">129</a> +<a name="130" href="#130">130</a> <strong class="jxr_keyword">try</strong> { +<a name="131" href="#131">131</a> +<a name="132" href="#132">132</a> cacheExpiration = Integer.parseInt(s); +<a name="133" href="#133">133</a> } <strong class="jxr_keyword">catch</strong> (NumberFormatException ex) { +<a name="134" href="#134">134</a> +<a name="135" href="#135">135</a> log.error(<span class="jxr_string">"Invalid CacheExpiration value - "</span> + s); +<a name="136" href="#136">136</a> cacheExpiration = DEFAULT_CACHE_EXPIRATION; +<a name="137" href="#137">137</a> } +<a name="138" href="#138">138</a> } <strong class="jxr_keyword">else</strong> { +<a name="139" href="#139">139</a> cacheExpiration = DEFAULT_CACHE_EXPIRATION; +<a name="140" href="#140">140</a> } +<a name="141" href="#141">141</a> } +<a name="142" href="#142">142</a> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Create a plugin with the hard-wired default settings.</em> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em> +<a name="146" href="#146">146</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlCookiePlugin</a>() { +<a name="147" href="#147">147</a> alwaysFollow = false; +<a name="148" href="#148">148</a> deleteCookie = false; +<a name="149" href="#149">149</a> cacheExpiration = DEFAULT_CACHE_EXPIRATION; +<a name="150" href="#150">150</a> } +<a name="151" href="#151">151</a> +<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">/**</em> +<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * This is the 'hook' in the lookup part of Discovery Service processing. </em> +<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * </em> +<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * @param req - Describes the current request. Used to find any appropriate cookies </em> +<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * @param res - Describes the current response. Used to redirect the request. </em> +<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * @param parameter - Describes the metadata.</em> +<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * @param context - Any processing context returned from a previous call. We set this on first call and</em> +<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * use non null to indicate that we don't go there again.</em> +<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param validIdps The list of IdPs which is currently views as possibly matches for the pattern. </em> +<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * The Key is the EntityId for the IdP and the value the object which describes </em> +<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * the Idp </em> +<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @param idpList The set of Idps which are currently considered as potential hints. </em> +<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls</em> +<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request.</em> +<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * issues a redirect)</em> +<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * </em> +<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#lookup</em> +<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> */</em> +<a name="170" href="#170">170</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> lookup(HttpServletRequest req, +<a name="171" href="#171">171</a> HttpServletResponse res, +<a name="172" href="#172">172</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="173" href="#173">173</a> Map<String, IdPSite> validIdps, +<a name="174" href="#174">174</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context, +<a name="175" href="#175">175</a> List <IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled { +<a name="176" href="#176">176</a> +<a name="177" href="#177">177</a> <strong class="jxr_keyword">if</strong> (context != <strong class="jxr_keyword">null</strong>) { +<a name="178" href="#178">178</a> <em class="jxr_comment">//</em> +<a name="179" href="#179">179</a> <em class="jxr_comment">// We only need to be called once</em> +<a name="180" href="#180">180</a> <em class="jxr_comment">//</em> +<a name="181" href="#181">181</a> <strong class="jxr_keyword">return</strong> context; +<a name="182" href="#182">182</a> } +<a name="183" href="#183">183</a> +<a name="184" href="#184">184</a> <strong class="jxr_keyword">if</strong> (deleteCookie) { +<a name="185" href="#185">185</a> deleteCookie(req, res); +<a name="186" href="#186">186</a> <em class="jxr_comment">//</em> +<a name="187" href="#187">187</a> <em class="jxr_comment">// Only need to be called once - so set up a parameter</em> +<a name="188" href="#188">188</a> <em class="jxr_comment">//</em> +<a name="189" href="#189">189</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">Context</a>() ; +<a name="190" href="#190">190</a> } +<a name="191" href="#191">191</a> List <String> idps = getIdPCookie(req, res, cacheDomain).getIdPList(); +<a name="192" href="#192">192</a> +<a name="193" href="#193">193</a> <strong class="jxr_keyword">for</strong> (String idpName : idps) { +<a name="194" href="#194">194</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> idp = validIdps.get(idpName); +<a name="195" href="#195">195</a> <strong class="jxr_keyword">if</strong> (idp != <strong class="jxr_keyword">null</strong>) { +<a name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (alwaysFollow) { +<a name="197" href="#197">197</a> <strong class="jxr_keyword">try</strong> { +<a name="198" href="#198">198</a> DiscoveryServiceHandler.forwardRequest(req, res, idp); +<a name="199" href="#199">199</a> } <strong class="jxr_keyword">catch</strong> (WayfException e) { +<a name="200" href="#200">200</a> <em class="jxr_comment">// Do nothing we are going to throw anyway</em> +<a name="201" href="#201">201</a> ; +<a name="202" href="#202">202</a> } +<a name="203" href="#203">203</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html">WayfRequestHandled</a>(); +<a name="204" href="#204">204</a> } +<a name="205" href="#205">205</a> <em class="jxr_comment">//</em> +<a name="206" href="#206">206</a> <em class="jxr_comment">// This IDP is ok </em> +<a name="207" href="#207">207</a> <em class="jxr_comment">//</em> +<a name="208" href="#208">208</a> idpList.add(idp); +<a name="209" href="#209">209</a> } +<a name="210" href="#210">210</a> } +<a name="211" href="#211">211</a> +<a name="212" href="#212">212</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="213" href="#213">213</a> } +<a name="214" href="#214">214</a> +<a name="215" href="#215">215</a> <em class="jxr_javadoccomment">/**</em> +<a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * Plugin point which is called when the data is refreshed.</em> +<a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * @param metadata - where to get the data from.</em> +<a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * @return the value which will be provided as input to subsequent calls</em> +<a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#refreshMetadata</em> +<a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> */</em> +<a name="221" href="#221">221</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> refreshMetadata(MetadataProvider metadata) { +<a name="222" href="#222">222</a> <em class="jxr_comment">//</em> +<a name="223" href="#223">223</a> <em class="jxr_comment">// We don't care about metadata - we are given all that we need</em> +<a name="224" href="#224">224</a> <em class="jxr_comment">//</em> +<a name="225" href="#225">225</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="226" href="#226">226</a> } +<a name="227" href="#227">227</a> +<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">/**</em> +<a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * Plgin point for searching.</em> +<a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * </em> +<a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled </em> +<a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. </em> +<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @param res Describes the current response.</em> +<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata.</em> +<a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * @param pattern What we are searchign for. </em> +<a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @param validIdps The list of IdPs which is currently views as possibly matches for the pattern. </em> +<a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * The Key is the EntityId for the IdP and the value the object which describes </em> +<a name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * the Idp </em> +<a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * @param context Any processing context returned from a previous call. We set this on first call and</em> +<a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * use non null to indicate that we don't go there again.</em> +<a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * @param searchResult What the search yielded. </em> +<a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * @param idpList The set of Idps which are currently considered as potential hints. </em> +<a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls.</em> +<a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#search</em> +<a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request.</em> +<a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * </em> +<a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> */</em> +<a name="248" href="#248">248</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> search(HttpServletRequest req, +<a name="249" href="#249">249</a> HttpServletResponse res, +<a name="250" href="#250">250</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="251" href="#251">251</a> String pattern, +<a name="252" href="#252">252</a> Map<String, IdPSite> validIdps, +<a name="253" href="#253">253</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context, +<a name="254" href="#254">254</a> Collection<IdPSite> searchResult, +<a name="255" href="#255">255</a> List<IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled { +<a name="256" href="#256">256</a> <em class="jxr_comment">//</em> +<a name="257" href="#257">257</a> <em class="jxr_comment">// Don't distinguish between lookup and search</em> +<a name="258" href="#258">258</a> <em class="jxr_comment">//</em> +<a name="259" href="#259">259</a> <strong class="jxr_keyword">return</strong> lookup(req, res, parameter, validIdps, context, idpList); +<a name="260" href="#260">260</a> } +<a name="261" href="#261">261</a> +<a name="262" href="#262">262</a> <em class="jxr_javadoccomment">/**</em> +<a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * Plugin point for selection.</em> +<a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * </em> +<a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#selected(javax.servlet.http.HttpServletRequest.</em> +<a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * javax.servlet.http.HttpServletResponse, </em> +<a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, </em> +<a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * java.lang.String)</em> +<a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. </em> +<a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * @param res Describes the current response.</em> +<a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata.</em> +<a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * @param idP Describes the idp.</em> +<a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * </em> +<a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> */</em> +<a name="275" href="#275">275</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> selected(HttpServletRequest req, HttpServletResponse res, +<a name="276" href="#276">276</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, String idP) { +<a name="277" href="#277">277</a> +<a name="278" href="#278">278</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a> cookie = getIdPCookie(req, res, cacheDomain); +<a name="279" href="#279">279</a> String param = req.getParameter(PARAMETER_NAME); +<a name="280" href="#280">280</a> +<a name="281" href="#281">281</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == param || param.equals(<span class="jxr_string">""</span>)) { +<a name="282" href="#282">282</a> <strong class="jxr_keyword">return</strong>; +<a name="283" href="#283">283</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (param.equalsIgnoreCase(PARAMETER_SESSION)) { +<a name="284" href="#284">284</a> cookie.addIdPName(idP, -1); +<a name="285" href="#285">285</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (param.equalsIgnoreCase(PARAMETER_PERM)) { +<a name="286" href="#286">286</a> cookie.addIdPName(idP, cacheExpiration); +<a name="287" href="#287">287</a> } +<a name="288" href="#288">288</a> } +<a name="289" href="#289">289</a> +<a name="290" href="#290">290</a> <em class="jxr_comment">//</em> +<a name="291" href="#291">291</a> <em class="jxr_comment">// Private classes for internal use</em> +<a name="292" href="#292">292</a> <em class="jxr_comment">//</em> +<a name="293" href="#293">293</a> +<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em> +<a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * This is just a marker tag.</em> +<a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> */</em> +<a name="297" href="#297">297</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">Context</a> implements <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> {} +<a name="298" href="#298">298</a> +<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em> +<a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * Class to abstract away the saml cookie for us.</em> +<a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> */</em> +<a name="302" href="#302">302</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a> { +<a name="303" href="#303">303</a> +<a name="304" href="#304">304</a> +<a name="305" href="#305">305</a> <em class="jxr_javadoccomment">/**</em> +<a name="306" href="#306">306</a> <em class="jxr_javadoccomment"> * The associated request.</em> +<a name="307" href="#307">307</a> <em class="jxr_javadoccomment"> */</em> +<a name="308" href="#308">308</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> HttpServletRequest req; +<a name="309" href="#309">309</a> <em class="jxr_javadoccomment">/**</em> +<a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * The associated response.</em> +<a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> */</em> +<a name="312" href="#312">312</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> HttpServletResponse res; +<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">/**</em> +<a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * The associated domain.</em> +<a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> */</em> +<a name="316" href="#316">316</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String domain; +<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">/**</em> +<a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * The IdPs.</em> +<a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> */</em> +<a name="320" href="#320">320</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List <String> idPList = <strong class="jxr_keyword">new</strong> ArrayList<String>(); +<a name="321" href="#321">321</a> +<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">/**</em> +<a name="323" href="#323">323</a> <em class="jxr_javadoccomment"> * Constructs a <code>SamlIdPCookie</code> from the provided string (which is the raw data. </em> +<a name="324" href="#324">324</a> <em class="jxr_javadoccomment"> * </em> +<a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * @param codedData</em> +<a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * the information read from the cookie</em> +<a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * @param request Describes the current request. </em> +<a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * @param response Describes the current response.</em> +<a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * @param domainName - if non null the domain for any *created* cookie.</em> +<a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> */</em> +<a name="331" href="#331">331</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a>(String codedData, +<a name="332" href="#332">332</a> HttpServletRequest request, +<a name="333" href="#333">333</a> HttpServletResponse response, +<a name="334" href="#334">334</a> String domainName) { +<a name="335" href="#335">335</a> +<a name="336" href="#336">336</a> <strong class="jxr_keyword">this</strong>.req = request; +<a name="337" href="#337">337</a> <strong class="jxr_keyword">this</strong>.res = response; +<a name="338" href="#338">338</a> <strong class="jxr_keyword">this</strong>.domain = domainName; +<a name="339" href="#339">339</a> +<a name="340" href="#340">340</a> <strong class="jxr_keyword">int</strong> start; +<a name="341" href="#341">341</a> <strong class="jxr_keyword">int</strong> end; +<a name="342" href="#342">342</a> +<a name="343" href="#343">343</a> <strong class="jxr_keyword">if</strong> (codedData == <strong class="jxr_keyword">null</strong> || codedData.equals(<span class="jxr_string">""</span>)) { +<a name="344" href="#344">344</a> log.info(<span class="jxr_string">"Empty cookie"</span>); +<a name="345" href="#345">345</a> <strong class="jxr_keyword">return</strong>; +<a name="346" href="#346">346</a> } +<a name="347" href="#347">347</a> <em class="jxr_comment">//</em> +<a name="348" href="#348">348</a> <em class="jxr_comment">// An earlier version saved the cookie without URL encoding it, hence there may be </em> +<a name="349" href="#349">349</a> <em class="jxr_comment">// spaces which in turn means we may be quoted. Strip any quotes.</em> +<a name="350" href="#350">350</a> <em class="jxr_comment">//</em> +<a name="351" href="#351">351</a> <strong class="jxr_keyword">if</strong> (codedData.charAt(0) == '"' && codedData.charAt(codedData.length()-1) == '"') { +<a name="352" href="#352">352</a> codedData = codedData.substring(1,codedData.length()-1); +<a name="353" href="#353">353</a> } +<a name="354" href="#354">354</a> +<a name="355" href="#355">355</a> <strong class="jxr_keyword">try</strong> { +<a name="356" href="#356">356</a> codedData = URLDecoder.decode(codedData, <span class="jxr_string">"UTF-8"</span>); +<a name="357" href="#357">357</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { +<a name="358" href="#358">358</a> log.error(<span class="jxr_string">"could not decode cookie"</span>); +<a name="359" href="#359">359</a> <strong class="jxr_keyword">return</strong>; +<a name="360" href="#360">360</a> } +<a name="361" href="#361">361</a> +<a name="362" href="#362">362</a> start = 0; +<a name="363" href="#363">363</a> end = codedData.indexOf(' ', start); +<a name="364" href="#364">364</a> <strong class="jxr_keyword">while</strong> (end > 0) { +<a name="365" href="#365">365</a> String value = codedData.substring(start, end); +<a name="366" href="#366">366</a> start = end + 1; +<a name="367" href="#367">367</a> end = codedData.indexOf(' ', start); +<a name="368" href="#368">368</a> <strong class="jxr_keyword">if</strong> (!value.equals(<span class="jxr_string">""</span>)) { +<a name="369" href="#369">369</a> idPList.add(<strong class="jxr_keyword">new</strong> String(Base64.decode(value))); +<a name="370" href="#370">370</a> } +<a name="371" href="#371">371</a> } +<a name="372" href="#372">372</a> <strong class="jxr_keyword">if</strong> (start < codedData.length()) { +<a name="373" href="#373">373</a> String value = codedData.substring(start); +<a name="374" href="#374">374</a> <strong class="jxr_keyword">if</strong> (!value.equals(<span class="jxr_string">""</span>)) { +<a name="375" href="#375">375</a> idPList.add(<strong class="jxr_keyword">new</strong> String(Base64.decode(value))); +<a name="376" href="#376">376</a> } +<a name="377" href="#377">377</a> } +<a name="378" href="#378">378</a> } +<a name="379" href="#379">379</a> <em class="jxr_javadoccomment">/**</em> +<a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * Create a SamlCookie with no data inside.</em> +<a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * @param domainName - if non null, the domain of the new cookie </em> +<a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * @param request Describes the current request. </em> +<a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> * @param response Describes the current response.</em> +<a name="384" href="#384">384</a> <em class="jxr_javadoccomment"> *</em> +<a name="385" href="#385">385</a> <em class="jxr_javadoccomment"> */</em> +<a name="386" href="#386">386</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a>(HttpServletRequest request, HttpServletResponse response, String domainName) { +<a name="387" href="#387">387</a> <strong class="jxr_keyword">this</strong>.req = request; +<a name="388" href="#388">388</a> <strong class="jxr_keyword">this</strong>.res = response; +<a name="389" href="#389">389</a> <strong class="jxr_keyword">this</strong>.domain = domainName; +<a name="390" href="#390">390</a> } +<a name="391" href="#391">391</a> +<a name="392" href="#392">392</a> <em class="jxr_javadoccomment">/**</em> +<a name="393" href="#393">393</a> <em class="jxr_javadoccomment"> * Add the specified Shibboleth IdP Name to the cookie list or move to </em> +<a name="394" href="#394">394</a> <em class="jxr_javadoccomment"> * the front and then write it back.</em> +<a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * </em> +<a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> * We always add to the front (and remove from wherever it was)</em> +<a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * </em> +<a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> * @param idPName - The name to be added</em> +<a name="399" href="#399">399</a> <em class="jxr_javadoccomment"> * @param expiration - The expiration of the cookie or zero if it is to be unchanged</em> +<a name="400" href="#400">400</a> <em class="jxr_javadoccomment"> */</em> +<a name="401" href="#401">401</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addIdPName(String idPName, <strong class="jxr_keyword">int</strong> expiration) { +<a name="402" href="#402">402</a> +<a name="403" href="#403">403</a> idPList.remove(idPName); +<a name="404" href="#404">404</a> idPList.add(0, idPName); +<a name="405" href="#405">405</a> +<a name="406" href="#406">406</a> writeCookie(expiration); +<a name="407" href="#407">407</a> } +<a name="408" href="#408">408</a> +<a name="409" href="#409">409</a> <em class="jxr_javadoccomment">/**</em> +<a name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * Delete the <b>entire<\b> cookie contents</em> +<a name="411" href="#411">411</a> <em class="jxr_javadoccomment"> */</em> +<a name="412" href="#412">412</a> +<a name="413" href="#413">413</a> +<a name="414" href="#414">414</a> <em class="jxr_javadoccomment">/**</em> +<a name="415" href="#415">415</a> <em class="jxr_javadoccomment"> * Remove origin from the cachedata and write it back.</em> +<a name="416" href="#416">416</a> <em class="jxr_javadoccomment"> * </em> +<a name="417" href="#417">417</a> <em class="jxr_javadoccomment"> * @param origin what to remove.</em> +<a name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * @param expiration How long it will live.</em> +<a name="419" href="#419">419</a> <em class="jxr_javadoccomment"> */</em> +<a name="420" href="#420">420</a> +<a name="421" href="#421">421</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> deleteIdPName(String origin, <strong class="jxr_keyword">int</strong> expiration) { +<a name="422" href="#422">422</a> idPList.remove(origin); +<a name="423" href="#423">423</a> writeCookie(expiration); +<a name="424" href="#424">424</a> } +<a name="425" href="#425">425</a> +<a name="426" href="#426">426</a> <em class="jxr_javadoccomment">/**</em> +<a name="427" href="#427">427</a> <em class="jxr_javadoccomment"> * Write back the cookie.</em> +<a name="428" href="#428">428</a> <em class="jxr_javadoccomment"> * </em> +<a name="429" href="#429">429</a> <em class="jxr_javadoccomment"> * @param expiration How long it will live</em> +<a name="430" href="#430">430</a> <em class="jxr_javadoccomment"> */</em> +<a name="431" href="#431">431</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeCookie(<strong class="jxr_keyword">int</strong> expiration) { +<a name="432" href="#432">432</a> Cookie cookie = getCookie(req); +<a name="433" href="#433">433</a> +<a name="434" href="#434">434</a> <strong class="jxr_keyword">if</strong> (idPList.size() == 0) { +<a name="435" href="#435">435</a> <em class="jxr_comment">//</em> +<a name="436" href="#436">436</a> <em class="jxr_comment">// Nothing to write, so delete the cookie</em> +<a name="437" href="#437">437</a> <em class="jxr_comment">//</em> +<a name="438" href="#438">438</a> cookie.setPath(<span class="jxr_string">"/"</span>); +<a name="439" href="#439">439</a> cookie.setMaxAge(0); +<a name="440" href="#440">440</a> res.addCookie(cookie); +<a name="441" href="#441">441</a> <strong class="jxr_keyword">return</strong>; +<a name="442" href="#442">442</a> } +<a name="443" href="#443">443</a> +<a name="444" href="#444">444</a> <em class="jxr_comment">//</em> +<a name="445" href="#445">445</a> <em class="jxr_comment">// Otherwise encode up the cookie</em> +<a name="446" href="#446">446</a> <em class="jxr_comment">//</em> +<a name="447" href="#447">447</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(); +<a name="448" href="#448">448</a> Iterator <String> it = idPList.iterator(); +<a name="449" href="#449">449</a> +<a name="450" href="#450">450</a> <strong class="jxr_keyword">while</strong> (it.hasNext()) { +<a name="451" href="#451">451</a> String next = it.next(); +<a name="452" href="#452">452</a> String what = <strong class="jxr_keyword">new</strong> String(Base64.encodeBytes(next.getBytes())); +<a name="453" href="#453">453</a> buffer.append(what).append(' '); +<a name="454" href="#454">454</a> } +<a name="455" href="#455">455</a> +<a name="456" href="#456">456</a> String value; +<a name="457" href="#457">457</a> <strong class="jxr_keyword">try</strong> { +<a name="458" href="#458">458</a> value = URLEncoder.encode(buffer.toString(), <span class="jxr_string">"UTF-8"</span>); +<a name="459" href="#459">459</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { +<a name="460" href="#460">460</a> log.error(<span class="jxr_string">"Could not encode cookie"</span>); +<a name="461" href="#461">461</a> <strong class="jxr_keyword">return</strong>; +<a name="462" href="#462">462</a> } +<a name="463" href="#463">463</a> +<a name="464" href="#464">464</a> <strong class="jxr_keyword">if</strong> (cookie == <strong class="jxr_keyword">null</strong>) { +<a name="465" href="#465">465</a> cookie = <strong class="jxr_keyword">new</strong> Cookie(COOKIE_NAME, value); +<a name="466" href="#466">466</a> } <strong class="jxr_keyword">else</strong> { +<a name="467" href="#467">467</a> cookie.setValue(value); +<a name="468" href="#468">468</a> } +<a name="469" href="#469">469</a> cookie.setComment(<span class="jxr_string">"Used to cache selection of a user's Shibboleth IdP"</span>); +<a name="470" href="#470">470</a> cookie.setPath(<span class="jxr_string">"/"</span>); +<a name="471" href="#471">471</a> +<a name="472" href="#472">472</a> +<a name="473" href="#473">473</a> cookie.setMaxAge(expiration); +<a name="474" href="#474">474</a> +<a name="475" href="#475">475</a> <strong class="jxr_keyword">if</strong> (domain != <strong class="jxr_keyword">null</strong> && domain != <span class="jxr_string">""</span>) { +<a name="476" href="#476">476</a> cookie.setDomain(domain); +<a name="477" href="#477">477</a> } +<a name="478" href="#478">478</a> res.addCookie(cookie); +<a name="479" href="#479">479</a> +<a name="480" href="#480">480</a> } +<a name="481" href="#481">481</a> +<a name="482" href="#482">482</a> <em class="jxr_javadoccomment">/**</em> +<a name="483" href="#483">483</a> <em class="jxr_javadoccomment"> * Return the list of Idps for this cookie.</em> +<a name="484" href="#484">484</a> <em class="jxr_javadoccomment"> * @return The list.</em> +<a name="485" href="#485">485</a> <em class="jxr_javadoccomment"> */</em> +<a name="486" href="#486">486</a> <strong class="jxr_keyword">public</strong> List <String> getIdPList() { +<a name="487" href="#487">487</a> <strong class="jxr_keyword">return</strong> idPList; +<a name="488" href="#488">488</a> } +<a name="489" href="#489">489</a> } +<a name="490" href="#490">490</a> +<a name="491" href="#491">491</a> <em class="jxr_javadoccomment">/**</em> +<a name="492" href="#492">492</a> <em class="jxr_javadoccomment"> * Extract the cookie from a request.</em> +<a name="493" href="#493">493</a> <em class="jxr_javadoccomment"> * @param req the request.</em> +<a name="494" href="#494">494</a> <em class="jxr_javadoccomment"> * @return the cookie.</em> +<a name="495" href="#495">495</a> <em class="jxr_javadoccomment"> */</em> +<a name="496" href="#496">496</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Cookie getCookie(HttpServletRequest req) { +<a name="497" href="#497">497</a> +<a name="498" href="#498">498</a> Cookie[] cookies = req.getCookies(); +<a name="499" href="#499">499</a> <strong class="jxr_keyword">if</strong> (cookies != <strong class="jxr_keyword">null</strong>) { +<a name="500" href="#500">500</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < cookies.length; i++) { +<a name="501" href="#501">501</a> <strong class="jxr_keyword">if</strong> (cookies[i].getName().equals(COOKIE_NAME)) { +<a name="502" href="#502">502</a> <strong class="jxr_keyword">return</strong> cookies[i]; +<a name="503" href="#503">503</a> } +<a name="504" href="#504">504</a> } +<a name="505" href="#505">505</a> } +<a name="506" href="#506">506</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="507" href="#507">507</a> } +<a name="508" href="#508">508</a> +<a name="509" href="#509">509</a> <em class="jxr_javadoccomment">/**</em> +<a name="510" href="#510">510</a> <em class="jxr_javadoccomment"> * Delete the cookie from the response.</em> +<a name="511" href="#511">511</a> <em class="jxr_javadoccomment"> * @param req The request.</em> +<a name="512" href="#512">512</a> <em class="jxr_javadoccomment"> * @param res The response.</em> +<a name="513" href="#513">513</a> <em class="jxr_javadoccomment"> */</em> +<a name="514" href="#514">514</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> deleteCookie(HttpServletRequest req, HttpServletResponse res) { +<a name="515" href="#515">515</a> Cookie cookie = getCookie(req); +<a name="516" href="#516">516</a> +<a name="517" href="#517">517</a> <strong class="jxr_keyword">if</strong> (cookie == <strong class="jxr_keyword">null</strong>) { +<a name="518" href="#518">518</a> <strong class="jxr_keyword">return</strong>; +<a name="519" href="#519">519</a> } +<a name="520" href="#520">520</a> +<a name="521" href="#521">521</a> cookie.setPath(<span class="jxr_string">"/"</span>); +<a name="522" href="#522">522</a> cookie.setMaxAge(0); +<a name="523" href="#523">523</a> res.addCookie(cookie); +<a name="524" href="#524">524</a> } +<a name="525" href="#525">525</a> <em class="jxr_javadoccomment">/**</em> +<a name="526" href="#526">526</a> <em class="jxr_javadoccomment"> * Load up the cookie and convert it into a SamlIdPCookie. If there is no</em> +<a name="527" href="#527">527</a> <em class="jxr_javadoccomment"> * underlying cookie return a null one.</em> +<a name="528" href="#528">528</a> <em class="jxr_javadoccomment"> * @param req The request.</em> +<a name="529" href="#529">529</a> <em class="jxr_javadoccomment"> * @param res The response.</em> +<a name="530" href="#530">530</a> <em class="jxr_javadoccomment"> * @param domain - if this is set then any <b>created</b> cookies are set to this domain</em> +<a name="531" href="#531">531</a> <em class="jxr_javadoccomment"> * @return the new object. </em> +<a name="532" href="#532">532</a> <em class="jxr_javadoccomment"> */</em> +<a name="533" href="#533">533</a> +<a name="534" href="#534">534</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a> getIdPCookie(HttpServletRequest req, HttpServletResponse res, String domain) { +<a name="535" href="#535">535</a> Cookie cookie = getCookie(req); +<a name="536" href="#536">536</a> +<a name="537" href="#537">537</a> <strong class="jxr_keyword">if</strong> (cookie == <strong class="jxr_keyword">null</strong>) { +<a name="538" href="#538">538</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a>(req, res, domain); +<a name="539" href="#539">539</a> } <strong class="jxr_keyword">else</strong> { +<a name="540" href="#540">540</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a>(cookie.getValue(), req, res, domain); +<a name="541" href="#541">541</a> } +<a name="542" href="#542">542</a> } +<a name="543" href="#543">543</a> } +<a name="544" href="#544">544</a> +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html new file mode 100644 index 0000000..5eb51b5 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html @@ -0,0 +1,36 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins.provider</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">edu.internet2.middleware.shibboleth.wayf.plugins.provider</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="BindingFilter.html" target="classFrame">BindingFilter</a>
+ </li>
+ <li>
+ <a href="SamlCookiePlugin.html" target="classFrame">Context</a>
+ </li>
+ <li>
+ <a href="ListFilter.html" target="classFrame">ListFilter</a>
+ </li>
+ <li>
+ <a href="SamlCookiePlugin.html" target="classFrame">SamlCookiePlugin</a>
+ </li>
+ <li>
+ <a href="SamlCookiePlugin.html" target="classFrame">SamlIdPCookie</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html new file mode 100644 index 0000000..2f91e22 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html @@ -0,0 +1,87 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins.provider</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package edu.internet2.middleware.shibboleth.wayf.plugins.provider</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="BindingFilter.html" target="classFrame">BindingFilter</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SamlCookiePlugin.html" target="classFrame">Context</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="ListFilter.html" target="classFrame">ListFilter</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SamlCookiePlugin.html" target="classFrame">SamlCookiePlugin</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SamlCookiePlugin.html" target="classFrame">SamlIdPCookie</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © 2006-2009 Internet2. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file |