diff options
Diffstat (limited to 'doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins')
6 files changed, 295 insertions, 298 deletions
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 index 856f7b5..f1f59a9 100644 --- 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 @@ -3,7 +3,7 @@ <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>
+ <title>Shibboleth Discovery Service 1.1.1 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>
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 index 2c26dfd..09d4e41 100644 --- 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 @@ -3,7 +3,7 @@ <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>
+ <title>Shibboleth Discovery Service 1.1.1 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>
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 index 9a234f3..8b1fa09 100644 --- 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 @@ -36,154 +36,152 @@ <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="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.opensaml.samlext.idpdisco.DiscoveryResponse; +<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject; +<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="33" href="#33">33</a> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em> +<a name="35" href="#35">35</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="36" href="#36">36</a> <em class="jxr_javadoccomment"> * and that it is correct.</em> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * </em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em> +<a name="41" href="#41">41</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="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"> * Log for the warning. </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> Logger LOG = LoggerFactory.getLogger(BindingFilter.<strong class="jxr_keyword">class</strong>.getName()); +<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"> * Set if we just want to warn on failure.</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">final</strong> <strong class="jxr_keyword">boolean</strong> warnOnFailure; +<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"> * Only the protected constructor should be visible.</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> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">BindingFilter</a>() { +<a name="57" href="#57">57</a> <strong class="jxr_keyword">this</strong>.warnOnFailure = false; +<a name="58" href="#58">58</a> } +<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"> * Initialize the filter.</em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param warn do we warn or do we fail if we see badness?</em> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em> +<a name="64" href="#64">64</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="65" href="#65">65</a> <strong class="jxr_keyword">this</strong>.warnOnFailure = warn; +<a name="66" href="#66">66</a> } +<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"> * Apply the filter.</em> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @param metadata what to filter.</em> +<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @throws FilterException if it sees any missed or bad bindings.</em> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em> +<a name="74" href="#74">74</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="75" href="#75">75</a> +<a name="76" href="#76">76</a> <strong class="jxr_keyword">if</strong> (metadata instanceof EntitiesDescriptor) { +<a name="77" href="#77">77</a> +<a name="78" href="#78">78</a> checkEntities((EntitiesDescriptor) metadata); <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="80" href="#80">80</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (metadata instanceof EntityDescriptor) { +<a name="81" href="#81">81</a> EntityDescriptor entity = (EntityDescriptor) metadata; +<a name="82" href="#82">82</a> +<a name="83" href="#83">83</a> <strong class="jxr_keyword">if</strong> (!checkEntity(entity)) { +<a name="84" href="#84">84</a> <strong class="jxr_keyword">if</strong> (warnOnFailure) { +<a name="85" href="#85">85</a> LOG.warn(<span class="jxr_string">"Badly formatted binding for "</span> + entity.getEntityID()); +<a name="86" href="#86">86</a> } <strong class="jxr_keyword">else</strong> { +<a name="87" href="#87">87</a> LOG.error(<span class="jxr_string">"Badly formatted binding for top level entity "</span> + entity.getEntityID()); +<a name="88" href="#88">88</a> } +<a name="89" href="#89">89</a> } +<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> <em class="jxr_javadoccomment">/**</em> +<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * If the entity has an SP characteristic, and it has a DS endpoint</em> +<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * then check its binding.</em> +<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * </em> +<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @param entity what to check.</em> +<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @return true if all is OK.</em> +<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em> +<a name="100" href="#100">100</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> checkEntity(EntityDescriptor entity) { +<a name="101" href="#101">101</a> List<RoleDescriptor> roles = entity.getRoleDescriptors(); +<a name="102" href="#102">102</a> +<a name="103" href="#103">103</a> <strong class="jxr_keyword">for</strong> (RoleDescriptor role:roles) { +<a name="104" href="#104">104</a> +<a name="105" href="#105">105</a> <em class="jxr_comment">//</em> +<a name="106" href="#106">106</a> <em class="jxr_comment">// Check every role</em> <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="108" href="#108">108</a> <strong class="jxr_keyword">if</strong> (role instanceof SPSSODescriptor) { +<a name="109" href="#109">109</a> +<a name="110" href="#110">110</a> <em class="jxr_comment">//</em> +<a name="111" href="#111">111</a> <em class="jxr_comment">// Grab hold of all the extensions for SPSSO descriptors</em> <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="113" href="#113">113</a> +<a name="114" href="#114">114</a> Extensions exts = role.getExtensions(); +<a name="115" href="#115">115</a> <strong class="jxr_keyword">if</strong> (exts != <strong class="jxr_keyword">null</strong>) { +<a name="116" href="#116">116</a> <em class="jxr_comment">//</em> +<a name="117" href="#117">117</a> <em class="jxr_comment">// We have some children check them form <DiscoveryResponse></em> <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="119" href="#119">119</a> List<XMLObject> children = exts.getOrderedChildren(); +<a name="120" href="#120">120</a> +<a name="121" href="#121">121</a> <strong class="jxr_keyword">for</strong> (XMLObject obj : children) { +<a name="122" href="#122">122</a> <strong class="jxr_keyword">if</strong> (obj instanceof DiscoveryResponse) { +<a name="123" href="#123">123</a> <em class="jxr_comment">//</em> +<a name="124" href="#124">124</a> <em class="jxr_comment">// And check or the binding</em> <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> } +<a name="126" href="#126">126</a> DiscoveryResponse ds = (DiscoveryResponse) obj; +<a name="127" href="#127">127</a> String binding = ds.getBinding(); +<a name="128" href="#128">128</a> +<a name="129" href="#129">129</a> <strong class="jxr_keyword">if</strong> (!DiscoveryResponse.IDP_DISCO_NS.equals(binding)) { +<a name="130" href="#130">130</a> <strong class="jxr_keyword">return</strong> false; +<a name="131" href="#131">131</a> } +<a name="132" href="#132">132</a> } +<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> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="138" href="#138">138</a> } +<a name="139" href="#139">139</a> +<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">/**</em> +<a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * Check an EntitiesDescriptor call checkentities for the Entities and ourselves</em> +<a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * recursively for the EntitesDescriptors.</em> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * </em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @param entities what to check.</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> <strong class="jxr_keyword">void</strong> checkEntities(EntitiesDescriptor entities) { +<a name="147" href="#147">147</a> List<EntitiesDescriptor> childEntities = entities.getEntitiesDescriptors(); +<a name="148" href="#148">148</a> List<EntityDescriptor> children = entities.getEntityDescriptors(); +<a name="149" href="#149">149</a> +<a name="150" href="#150">150</a> <strong class="jxr_keyword">if</strong> (children != <strong class="jxr_keyword">null</strong>) { +<a name="151" href="#151">151</a> Iterator<EntityDescriptor> itr; +<a name="152" href="#152">152</a> EntityDescriptor entity; +<a name="153" href="#153">153</a> itr = children.iterator(); +<a name="154" href="#154">154</a> +<a name="155" href="#155">155</a> <strong class="jxr_keyword">while</strong> (itr.hasNext()) { +<a name="156" href="#156">156</a> entity = itr.next(); +<a name="157" href="#157">157</a> <strong class="jxr_keyword">if</strong> (!checkEntity(entity)) { +<a name="158" href="#158">158</a> <strong class="jxr_keyword">if</strong> (warnOnFailure) { +<a name="159" href="#159">159</a> LOG.warn(<span class="jxr_string">"Badly formatted binding for "</span> + entity.getEntityID()); +<a name="160" href="#160">160</a> } <strong class="jxr_keyword">else</strong> { +<a name="161" href="#161">161</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="162" href="#162">162</a> itr.remove(); +<a name="163" href="#163">163</a> } +<a name="164" href="#164">164</a> } +<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> <strong class="jxr_keyword">if</strong> (childEntities != <strong class="jxr_keyword">null</strong>) { +<a name="169" href="#169">169</a> <strong class="jxr_keyword">for</strong> (EntitiesDescriptor descriptor : childEntities) { +<a name="170" href="#170">170</a> checkEntities(descriptor); +<a name="171" href="#171">171</a> } +<a name="172" href="#172">172</a> } +<a name="173" href="#173">173</a> } +<a name="174" href="#174">174</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 index 270ec3e..d0b7acc 100644 --- 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 @@ -41,157 +41,156 @@ <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> } +<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.XMLConstants; +<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-57. Explicit </em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * </em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em> +<a name="42" href="#42">42</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="43" href="#43">43</a> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Log for any messages.</em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em> +<a name="47" href="#47">47</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="48" href="#48">48</a> +<a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Set if this is a blacklist.</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em> +<a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> excludeEntries; +<a name="53" href="#53">53</a> +<a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * The list of entities.</em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em> +<a name="57" href="#57">57</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Set<String> filterEntities; +<a name="58" href="#58">58</a> +<a name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * The name of the filter (needed for debug).</em> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em> +<a name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String filterName; +<a name="63" href="#63">63</a> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Only the protected constructor should be visible.</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em> +<a name="67" href="#67">67</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html">ListFilter</a>() { +<a name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>.excludeEntries = false; +<a name="69" href="#69">69</a> <strong class="jxr_keyword">this</strong>.filterEntities = <strong class="jxr_keyword">new</strong> HashSet<String>(0); +<a name="70" href="#70">70</a> <strong class="jxr_keyword">this</strong>.filterName = <span class="jxr_string">"anonymous"</span>; +<a name="71" href="#71">71</a> } +<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"> * Initialize the filter.</em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @param config the configuration</em> +<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> *</em> +<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * The configuration looks liken this</em> +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * <code> <Filter identifier="WhiteList" </em> +<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * type ="edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter"</em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * excludeEntries = "true" ></em> +<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * <EntityId>foo</EntityId></em> +<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * [...]</em> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * </Filter></em> +<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * </code></em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em> +<a name="86" href="#86">86</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html">ListFilter</a>(Element config) { +<a name="87" href="#87">87</a> String excludeEntriesValue; +<a name="88" href="#88">88</a> <strong class="jxr_keyword">this</strong>.filterEntities = <strong class="jxr_keyword">new</strong> HashSet<String>(10); +<a name="89" href="#89">89</a> <strong class="jxr_keyword">this</strong>.filterName = config.getAttribute(<span class="jxr_string">"identifier"</span>); +<a name="90" href="#90">90</a> excludeEntriesValue = config.getAttribute(<span class="jxr_string">"excludeEntries"</span>); +<a name="91" href="#91">91</a> +<a name="92" href="#92">92</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == excludeEntriesValue || 0 == excludeEntriesValue.length()) { +<a name="93" href="#93">93</a> <strong class="jxr_keyword">this</strong>.excludeEntries = <strong class="jxr_keyword">true</strong>; +<a name="94" href="#94">94</a> } <strong class="jxr_keyword">else</strong> { +<a name="95" href="#95">95</a> <strong class="jxr_keyword">this</strong>.excludeEntries = Boolean.getBoolean(excludeEntriesValue); +<a name="96" href="#96">96</a> } +<a name="97" href="#97">97</a> +<a name="98" href="#98">98</a> NodeList itemElements = config.getElementsByTagNameNS(XMLConstants.CONFIG_NS, <span class="jxr_string">"EntityId"</span>); +<a name="99" href="#99">99</a> +<a name="100" href="#100">100</a> <strong class="jxr_keyword">if</strong> (excludeEntries) { +<a name="101" href="#101">101</a> LOG.debug(<span class="jxr_string">"Populating blacklist "</span> + filterName); +<a name="102" href="#102">102</a> } <strong class="jxr_keyword">else</strong> { +<a name="103" href="#103">103</a> LOG.debug(<span class="jxr_string">"Populating whitelist "</span> + filterName); +<a name="104" href="#104">104</a> } +<a name="105" href="#105">105</a> +<a name="106" href="#106">106</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < itemElements.getLength(); i++) { +<a name="107" href="#107">107</a> Element element = (Element) itemElements.item(i); +<a name="108" href="#108">108</a> String entityId = element.getTextContent(); +<a name="109" href="#109">109</a> +<a name="110" href="#110">110</a> LOG.debug(<span class="jxr_string">"\t"</span> + entityId); +<a name="111" href="#111">111</a> <strong class="jxr_keyword">this</strong>.filterEntities.add(entityId); +<a name="112" href="#112">112</a> } +<a name="113" href="#113">113</a> } +<a name="114" href="#114">114</a> +<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">/**</em> +<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Apply the filter.</em> +<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)</em> +<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @param metadata what to filter.</em> +<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @throws FilterException if it sees any missed or bad bindings.</em> +<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em> +<a name="121" href="#121">121</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="122" href="#122">122</a> +<a name="123" href="#123">123</a> <strong class="jxr_keyword">if</strong> (metadata instanceof EntitiesDescriptor) { +<a name="124" href="#124">124</a> filterEntities((EntitiesDescriptor)metadata); +<a name="125" href="#125">125</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (metadata instanceof EntityDescriptor) { +<a name="126" href="#126">126</a> EntityDescriptor entity = (EntityDescriptor) metadata; +<a name="127" href="#127">127</a> String entityName = entity.getEntityID(); +<a name="128" href="#128">128</a> +<a name="129" href="#129">129</a> <strong class="jxr_keyword">if</strong> (excludeEntries) { +<a name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> (filterEntities.contains(entityName)) { +<a name="131" href="#131">131</a> LOG.error(<span class="jxr_string">"Metadata provider contains a single <EntityDescriptor> ("</span> + entityName + +<a name="132" href="#132">132</a> <span class="jxr_string">") which is in exclude list"</span>); +<a name="133" href="#133">133</a> } +<a name="134" href="#134">134</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!filterEntities.contains(entity.getEntityID())) { +<a name="135" href="#135">135</a> LOG.error(<span class="jxr_string">"Metadata provider contains a single <EntityDescriptor> ("</span> + entityName + +<a name="136" href="#136">136</a> <span class="jxr_string">") which is not on include list"</span>); +<a name="137" href="#137">137</a> } +<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> <em class="jxr_javadoccomment">/**</em> +<a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * Filter an EntitiesDescriptor . We do this explictly for the Entities and call ourselves</em> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * recursively for the EntitesDescriptors.</em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * </em> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @param entities what to check.</em> +<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> */</em> +<a name="147" href="#147">147</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> filterEntities(EntitiesDescriptor entities) { +<a name="148" href="#148">148</a> String entitiesName = entities.getName(); +<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> <em class="jxr_comment">//</em> +<a name="153" href="#153">153</a> <em class="jxr_comment">// Go through and apply the filter</em> +<a name="154" href="#154">154</a> <em class="jxr_comment">//</em> +<a name="155" href="#155">155</a> +<a name="156" href="#156">156</a> <strong class="jxr_keyword">if</strong> (children != <strong class="jxr_keyword">null</strong>) { +<a name="157" href="#157">157</a> Iterator<EntityDescriptor> itr; +<a name="158" href="#158">158</a> EntityDescriptor entity; +<a name="159" href="#159">159</a> itr = children.iterator(); +<a name="160" href="#160">160</a> +<a name="161" href="#161">161</a> <strong class="jxr_keyword">while</strong> (itr.hasNext()) { +<a name="162" href="#162">162</a> entity = itr.next(); +<a name="163" href="#163">163</a> String entityName = entity.getEntityID(); +<a name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> (excludeEntries) { +<a name="165" href="#165">165</a> +<a name="166" href="#166">166</a> <strong class="jxr_keyword">if</strong> (filterEntities.contains(entityName)) { +<a name="167" href="#167">167</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="168" href="#168">168</a> itr.remove(); +<a name="169" href="#169">169</a> } +<a name="170" href="#170">170</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!filterEntities.contains(entityName)) { +<a name="171" href="#171">171</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="172" href="#172">172</a> itr.remove(); +<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> +<a name="177" href="#177">177</a> <strong class="jxr_keyword">if</strong> (childEntities != <strong class="jxr_keyword">null</strong>) { +<a name="178" href="#178">178</a> <strong class="jxr_keyword">for</strong> (EntitiesDescriptor descriptor : childEntities) { +<a name="179" href="#179">179</a> filterEntities(descriptor); +<a name="180" href="#180">180</a> } +<a name="181" href="#181">181</a> } +<a name="182" href="#182">182</a> } +<a name="183" href="#183">183</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 index 5eb51b5..b7af423 100644 --- 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 @@ -3,7 +3,7 @@ <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>
+ <title>Shibboleth Discovery Service 1.1.1 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins.provider</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="style" />
</head>
<body>
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 index 2f91e22..206dc1d 100644 --- 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 @@ -3,7 +3,7 @@ <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>
+ <title>Shibboleth Discovery Service 1.1.1 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins.provider</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="style" />
</head>
<body>
|