You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ws.apache.org by di...@apache.org on 2005/03/09 17:38:07 UTC
cvs commit: ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/saml package-frame.html package-summary.html SAMLIssuer.html SAMLIssuerFactory.html SAMLIssuerImpl.html
dims 2005/03/09 08:38:07
Added: targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/saml
package-frame.html package-summary.html
SAMLIssuer.html SAMLIssuerFactory.html
SAMLIssuerImpl.html
Log:
wss4j updates
Revision Changes Path
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/saml/package-frame.html
Index: package-frame.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"></meta>
<title>Apache WSS4J 1.0 Reference Package org.apache.ws.security.saml</title>
<link rel="stylesheet" href="../../../../../stylesheet.css" type="text/css" title="style"></link>
</head>
<body>
<h3>
<a href="package-summary.html" target="classFrame">org.apache.ws.security.saml</a>
</h3>
<h3>Classes</h3>
<ul>
<li>
<a href="SAMLIssuer.html" target="classFrame">SAMLIssuer</a>
</li>
<li>
<a href="SAMLIssuerFactory.html" target="classFrame">SAMLIssuerFactory</a>
</li>
<li>
<a href="SAMLIssuerImpl.html" target="classFrame">SAMLIssuerImpl</a>
</li>
</ul>
</body>
</html>
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/saml/package-summary.html
Index: package-summary.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"></meta>
<title>Apache WSS4J 1.0 Reference Package </title>
<link rel="stylesheet" href="../../../../../stylesheet.css" type="text/css" title="style"></link>
</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 org.apache.ws.security.saml</h2>
<table class="summary">
<thead>
<tr>
<th>Class Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="SAMLIssuer.html" target="classFrame">SAMLIssuer</a>
</td>
</tr>
<tr>
<td>
<a href="SAMLIssuerFactory.html" target="classFrame">SAMLIssuerFactory</a>
</td>
</tr>
<tr>
<td>
<a href="SAMLIssuerImpl.html" target="classFrame">SAMLIssuerImpl</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></hr>
Copyright © Apache Web Services. All Rights Reserved.
</body>
</html>
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/saml/SAMLIssuer.html
Index: SAMLIssuer.html
===================================================================
<!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" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SAMLIssuer xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/ws/security/saml/SAMLIssuer.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * Copyright 2003-2004 The Apache Software Foundation.</em>
<a name="3" href="#3">3</a> <em class="comment"> *</em>
<a name="4" href="#4">4</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a> <em class="comment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a> <em class="comment"> *</em>
<a name="8" href="#8">8</a> <em class="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="comment"> *</em>
<a name="10" href="#10">10</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a> <em class="comment"> * limitations under the License.</em>
<a name="15" href="#15">15</a> <em class="comment"> *</em>
<a name="16" href="#16">16</a> <em class="comment"> */</em>
<a name="17" href="#17">17</a>
<a name="18" href="#18">18</a> <strong>package</strong> <a href="../../../../../org/apache/ws/security/saml/package-summary.html">org.apache.ws.security.saml</a>;
<a name="19" href="#19">19</a>
<a name="20" href="#20">20</a> <strong>import</strong> org.apache.ws.security.components.crypto.Crypto;
<a name="21" href="#21">21</a> <strong>import</strong> org.opensaml.SAMLAssertion;
<a name="22" href="#22">22</a> <strong>import</strong> org.w3c.dom.Document;
<a name="23" href="#23">23</a>
<a name="24" href="#24">24</a> <em>/**<em>*</em></em>
<a name="25" href="#25">25</a> <em> * Builds a WS SAML Assertion and inserts it into the SOAP Envelope.</em>
<a name="26" href="#26">26</a> <em> * Refer to the WS specification, SAML Token profile</em>
<a name="27" href="#27">27</a> <em> *</em>
<a name="28" href="#28">28</a> <em> * @author Davanum Srinivas (dims@yahoo.com).</em>
<a name="29" href="#29">29</a> <em> */</em>
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuer.html">SAMLIssuer</a> {
<a name="32" href="#32">32</a>
<a name="33" href="#33">33</a> <em>/**<em>*</em></em>
<a name="34" href="#34">34</a> <em> * Creates a new <code>SAMLAssertion</code>.</em>
<a name="35" href="#35">35</a> <em> * <p/></em>
<a name="36" href="#36">36</a> <em> * A complete <code>SAMLAssertion</code> is constructed.</em>
<a name="37" href="#37">37</a> <em> *</em>
<a name="38" href="#38">38</a> <em> * @return SAMLAssertion</em>
<a name="39" href="#39">39</a> <em> */</em>
<a name="40" href="#40">40</a> <strong>public</strong> SAMLAssertion newAssertion();
<a name="41" href="#41">41</a>
<a name="42" href="#42">42</a> <em>/**<em>*</em></em>
<a name="43" href="#43">43</a> <em> * @param userCrypto The userCrypto to set.</em>
<a name="44" href="#44">44</a> <em> */</em>
<a name="45" href="#45">45</a> <strong>public</strong> <strong>void</strong> setUserCrypto(<a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> userCrypto);
<a name="46" href="#46">46</a>
<a name="47" href="#47">47</a> <em>/**<em>*</em></em>
<a name="48" href="#48">48</a> <em> * @param username The username to set.</em>
<a name="49" href="#49">49</a> <em> */</em>
<a name="50" href="#50">50</a> <strong>public</strong> <strong>void</strong> setUsername(String username);
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <em>/**<em>*</em></em>
<a name="53" href="#53">53</a> <em> * @return Returns the issuerCrypto.</em>
<a name="54" href="#54">54</a> <em> */</em>
<a name="55" href="#55">55</a> <strong>public</strong> <a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> getIssuerCrypto();
<a name="56" href="#56">56</a>
<a name="57" href="#57">57</a> <em>/**<em>*</em></em>
<a name="58" href="#58">58</a> <em> * @return Returns the issuerKeyName.</em>
<a name="59" href="#59">59</a> <em> */</em>
<a name="60" href="#60">60</a> <strong>public</strong> String getIssuerKeyName();
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <em>/**<em>*</em></em>
<a name="63" href="#63">63</a> <em> * @return Returns the issuerKeyPassword.</em>
<a name="64" href="#64">64</a> <em> */</em>
<a name="65" href="#65">65</a> <strong>public</strong> String getIssuerKeyPassword();
<a name="66" href="#66">66</a>
<a name="67" href="#67">67</a> <em>/**<em>*</em></em>
<a name="68" href="#68">68</a> <em> * @return Returns the senderVouches.</em>
<a name="69" href="#69">69</a> <em> */</em>
<a name="70" href="#70">70</a> <strong>public</strong> <strong>boolean</strong> isSenderVouches();
<a name="71" href="#71">71</a>
<a name="72" href="#72">72</a> <em>/**<em>*</em></em>
<a name="73" href="#73">73</a> <em> * @param instanceDoc The instanceDoc to set.</em>
<a name="74" href="#74">74</a> <em> */</em>
<a name="75" href="#75">75</a> <strong>public</strong> <strong>void</strong> setInstanceDoc(Document instanceDoc);
<a name="76" href="#76">76</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/saml/SAMLIssuerFactory.html
Index: SAMLIssuerFactory.html
===================================================================
<!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" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SAMLIssuerFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/ws/security/saml/SAMLIssuerFactory.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * Copyright 2003-2004 The Apache Software Foundation.</em>
<a name="3" href="#3">3</a> <em class="comment"> *</em>
<a name="4" href="#4">4</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a> <em class="comment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a> <em class="comment"> *</em>
<a name="8" href="#8">8</a> <em class="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="comment"> *</em>
<a name="10" href="#10">10</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a> <em class="comment"> * limitations under the License.</em>
<a name="15" href="#15">15</a> <em class="comment"> *</em>
<a name="16" href="#16">16</a> <em class="comment"> */</em>
<a name="17" href="#17">17</a>
<a name="18" href="#18">18</a> <strong>package</strong> <a href="../../../../../org/apache/ws/security/saml/package-summary.html">org.apache.ws.security.saml</a>;
<a name="19" href="#19">19</a>
<a name="20" href="#20">20</a> <strong>import</strong> org.apache.commons.logging.Log;
<a name="21" href="#21">21</a> <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="22" href="#22">22</a> <strong>import</strong> org.apache.ws.security.util.Loader;
<a name="23" href="#23">23</a> <strong>import</strong> org.apache.ws.security.saml.SAMLIssuer;
<a name="24" href="#24">24</a>
<a name="25" href="#25">25</a> <strong>import</strong> java.lang.reflect.Constructor;
<a name="26" href="#26">26</a> <strong>import</strong> java.net.URL;
<a name="27" href="#27">27</a> <strong>import</strong> java.util.Properties;
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <em>/**<em>*</em></em>
<a name="30" href="#30">30</a> <em> * CryptoFactory.</em>
<a name="31" href="#31">31</a> <em> * <p/></em>
<a name="32" href="#32">32</a> <em> *</em>
<a name="33" href="#33">33</a> <em> * @author Davanum Srinivas (dims@yahoo.com).</em>
<a name="34" href="#34">34</a> <em> */</em>
<a name="35" href="#35">35</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuerFactory.html">SAMLIssuerFactory</a> {
<a name="36" href="#36">36</a> <strong>private</strong> <strong>static</strong> Log log = LogFactory.getLog(SAMLIssuerFactory.<strong>class</strong>);
<a name="37" href="#37">37</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String defaultSAMLClassName =
<a name="38" href="#38">38</a> <span class="string">"org.apache.ws.security.saml.WSSSAMLIssuerImpl"</span>;
<a name="39" href="#39">39</a>
<a name="40" href="#40">40</a> <em>/**<em>*</em></em>
<a name="41" href="#41">41</a> <em> * getInstance</em>
<a name="42" href="#42">42</a> <em> * <p/></em>
<a name="43" href="#43">43</a> <em> * Returns an instance of SAMLIssuer. This method uses the file</em>
<a name="44" href="#44">44</a> <em> * <code>saml.properties</code> to determine which implementation to</em>
<a name="45" href="#45">45</a> <em> * use. Thus the property <code>org.apache.ws.security.saml.issuerClass</code></em>
<a name="46" href="#46">46</a> <em> * must define the classname of the SAMLIssuer implementation. The file</em>
<a name="47" href="#47">47</a> <em> * may contain other property definitions as well. These properties are</em>
<a name="48" href="#48">48</a> <em> * handed over to the SAMLIssuer implementation. The file</em>
<a name="49" href="#49">49</a> <em> * <code>saml.properties</code> is loaded with the</em>
<a name="50" href="#50">50</a> <em> * <code>Loader.getResource()</code> method.</em>
<a name="51" href="#51">51</a> <em> * <p/></em>
<a name="52" href="#52">52</a> <em> *</em>
<a name="53" href="#53">53</a> <em> * @return The SAMLIssuer implementation was defined</em>
<a name="54" href="#54">54</a> <em> */</em>
<a name="55" href="#55">55</a> <strong>public</strong> <strong>static</strong> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuer.html">SAMLIssuer</a> getInstance() {
<a name="56" href="#56">56</a> <strong>return</strong> getInstance(<span class="string">"saml.properties"</span>);
<a name="57" href="#57">57</a> }
<a name="58" href="#58">58</a>
<a name="59" href="#59">59</a> <em>/**<em>*</em></em>
<a name="60" href="#60">60</a> <em> * getInstance</em>
<a name="61" href="#61">61</a> <em> * <p/></em>
<a name="62" href="#62">62</a> <em> * Returns an instance of SAMLIssuer. The properties are handed over the the SAMLIssuer</em>
<a name="63" href="#63">63</a> <em> * implementation. The porperties can be <code>null</code>. It is depenend on the</em>
<a name="64" href="#64">64</a> <em> * SAMLIssuer implementation how the initialization is done in this case.</em>
<a name="65" href="#65">65</a> <em> * <p/></em>
<a name="66" href="#66">66</a> <em> *</em>
<a name="67" href="#67">67</a> <em> * @param samlClassName This is the SAMLIssuer implementation class. No default is</em>
<a name="68" href="#68">68</a> <em> * provided here.</em>
<a name="69" href="#69">69</a> <em> * @param properties The Properties that are forwarded to the SAMLIssuer implementaion.</em>
<a name="70" href="#70">70</a> <em> * These properties are dependend on the SAMLIssuer implementatin</em>
<a name="71" href="#71">71</a> <em> * @return The SAMLIssuer implementation or null if no samlClassName was defined</em>
<a name="72" href="#72">72</a> <em> */</em>
<a name="73" href="#73">73</a> <strong>public</strong> <strong>static</strong> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuer.html">SAMLIssuer</a> getInstance(String samlClassName,
<a name="74" href="#74">74</a> Properties properties) {
<a name="75" href="#75">75</a> <strong>return</strong> loadClass(samlClassName, properties);
<a name="76" href="#76">76</a> }
<a name="77" href="#77">77</a>
<a name="78" href="#78">78</a> <em>/**<em>*</em></em>
<a name="79" href="#79">79</a> <em> * getInstance</em>
<a name="80" href="#80">80</a> <em> * <p/></em>
<a name="81" href="#81">81</a> <em> * Returns an instance of SAMLIssuer. This method uses the specifed filename</em>
<a name="82" href="#82">82</a> <em> * to load a property file. This file shall use the property</em>
<a name="83" href="#83">83</a> <em> * <code>org.apache.ws.security.saml.issuerClass</code></em>
<a name="84" href="#84">84</a> <em> * to define the classname of the SAMLIssuer implementation. The file</em>
<a name="85" href="#85">85</a> <em> * may contain other property definitions as well. These properties are</em>
<a name="86" href="#86">86</a> <em> * handed over to the SAMLIssuer implementation. The specified file</em>
<a name="87" href="#87">87</a> <em> * is loaded with the <code>Loader.getResource()</code> method.</em>
<a name="88" href="#88">88</a> <em> * <p/></em>
<a name="89" href="#89">89</a> <em> *</em>
<a name="90" href="#90">90</a> <em> * @param propFilename The name of the property file to load</em>
<a name="91" href="#91">91</a> <em> * @return The SAMLIssuer implementation that was defined</em>
<a name="92" href="#92">92</a> <em> */</em>
<a name="93" href="#93">93</a> <strong>public</strong> <strong>static</strong> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuer.html">SAMLIssuer</a> getInstance(String propFilename) {
<a name="94" href="#94">94</a> Properties properties = <strong>null</strong>;
<a name="95" href="#95">95</a> String samlClassName = <strong>null</strong>;
<a name="96" href="#96">96</a>
<a name="97" href="#97">97</a> <strong>if</strong> ((samlClassName == <strong>null</strong>) || (samlClassName.length() == 0)) {
<a name="98" href="#98">98</a> properties = getProperties(propFilename);
<a name="99" href="#99">99</a> samlClassName =
<a name="100" href="#100">100</a> properties.getProperty(<span class="string">"org.apache.ws.security.saml.issuerClass"</span>,
<a name="101" href="#101">101</a> defaultSAMLClassName);
<a name="102" href="#102">102</a> }
<a name="103" href="#103">103</a> <strong>return</strong> loadClass(samlClassName, properties);
<a name="104" href="#104">104</a> }
<a name="105" href="#105">105</a>
<a name="106" href="#106">106</a> <strong>private</strong> <strong>static</strong> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuer.html">SAMLIssuer</a> loadClass(String samlClassName,
<a name="107" href="#107">107</a> Properties properties) {
<a name="108" href="#108">108</a> Class samlIssuerClass = <strong>null</strong>;
<a name="109" href="#109">109</a> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuer.html">SAMLIssuer</a> samlIssuer = <strong>null</strong>;
<a name="110" href="#110">110</a> <strong>try</strong> {
<a name="111" href="#111">111</a> <em class="comment">// instruct the class loader to load the crypto implementation</em>
<a name="112" href="#112">112</a> samlIssuerClass = java.lang.Class.forName(samlClassName);
<a name="113" href="#113">113</a> } <strong>catch</strong> (ClassNotFoundException e) {
<a name="114" href="#114">114</a> <strong>throw</strong> <strong>new</strong> RuntimeException(samlClassName + <span class="string">" Not Found"</span>);
<a name="115" href="#115">115</a> }
<a name="116" href="#116">116</a> log.info(<span class="string">"Using Crypto Engine ["</span> + samlClassName + <span class="string">"]"</span>);
<a name="117" href="#117">117</a> <strong>try</strong> {
<a name="118" href="#118">118</a> Class[] <strong>class</strong>es = <strong>new</strong> Class[]{Properties.<strong>class</strong>};
<a name="119" href="#119">119</a> Constructor c = samlIssuerClass.getConstructor(classes);
<a name="120" href="#120">120</a> samlIssuer =
<a name="121" href="#121">121</a> (<a href="../../../../../org/apache/ws/security/saml/SAMLIssuer.html">SAMLIssuer</a>) c.<strong>new</strong>Instance(<strong>new</strong> Object[]{properties});
<a name="122" href="#122">122</a> <strong>return</strong> samlIssuer;
<a name="123" href="#123">123</a> } <strong>catch</strong> (java.lang.Exception e) {
<a name="124" href="#124">124</a> e.printStackTrace();
<a name="125" href="#125">125</a> log.error(e);
<a name="126" href="#126">126</a> }
<a name="127" href="#127">127</a> <strong>try</strong> {
<a name="128" href="#128">128</a> <em class="comment">// try to instantiate the Crypto subclass</em>
<a name="129" href="#129">129</a> samlIssuer = (SAMLIssuer) samlIssuerClass.newInstance();
<a name="130" href="#130">130</a> <strong>return</strong> samlIssuer;
<a name="131" href="#131">131</a> } <strong>catch</strong> (java.lang.Exception e) {
<a name="132" href="#132">132</a> e.printStackTrace();
<a name="133" href="#133">133</a> log.error(e);
<a name="134" href="#134">134</a> <strong>throw</strong> <strong>new</strong> RuntimeException(samlClassName + <span class="string">" cannot create instance"</span>);
<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> <em>/**<em>*</em></em>
<a name="139" href="#139">139</a> <em> * Gets the properties for SAML issuer.</em>
<a name="140" href="#140">140</a> <em> * The functions loads the property file via</em>
<a name="141" href="#141">141</a> <em> * {@link Loader.getResource(String)}, thus the property file</em>
<a name="142" href="#142">142</a> <em> * should be accesible via the classpath</em>
<a name="143" href="#143">143</a> <em> *</em>
<a name="144" href="#144">144</a> <em> * @param propFilename the properties file to load</em>
<a name="145" href="#145">145</a> <em> * @return a <code>Properties</code> object loaded from the filename</em>
<a name="146" href="#146">146</a> <em> */</em>
<a name="147" href="#147">147</a> <strong>private</strong> <strong>static</strong> Properties getProperties(String propFilename) {
<a name="148" href="#148">148</a> Properties properties = <strong>new</strong> Properties();
<a name="149" href="#149">149</a> <strong>try</strong> {
<a name="150" href="#150">150</a> URL url = Loader.getResource(propFilename);
<a name="151" href="#151">151</a> properties.load(url.openStream());
<a name="152" href="#152">152</a> } <strong>catch</strong> (Exception e) {
<a name="153" href="#153">153</a> log.debug(<span class="string">"Cannot find SAML property file: "</span> + propFilename);
<a name="154" href="#154">154</a> <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"SAMLIssuerFactory: Cannot load properties: "</span> + propFilename);
<a name="155" href="#155">155</a> }
<a name="156" href="#156">156</a> <strong>return</strong> properties;
<a name="157" href="#157">157</a> }
<a name="158" href="#158">158</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/saml/SAMLIssuerImpl.html
Index: SAMLIssuerImpl.html
===================================================================
<!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" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SAMLIssuerImpl xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/ws/security/saml/SAMLIssuerImpl.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * Copyright 2003-2004 The Apache Software Foundation.</em>
<a name="3" href="#3">3</a> <em class="comment"> *</em>
<a name="4" href="#4">4</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a> <em class="comment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a> <em class="comment"> *</em>
<a name="8" href="#8">8</a> <em class="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="comment"> *</em>
<a name="10" href="#10">10</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a> <em class="comment"> * limitations under the License.</em>
<a name="15" href="#15">15</a> <em class="comment"> *</em>
<a name="16" href="#16">16</a> <em class="comment"> */</em>
<a name="17" href="#17">17</a> <strong>package</strong> <a href="../../../../../org/apache/ws/security/saml/package-summary.html">org.apache.ws.security.saml</a>;
<a name="18" href="#18">18</a>
<a name="19" href="#19">19</a> <strong>import</strong> org.apache.commons.logging.Log;
<a name="20" href="#20">20</a> <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="21" href="#21">21</a> <strong>import</strong> org.apache.ws.security.WSSecurityException;
<a name="22" href="#22">22</a> <strong>import</strong> org.apache.ws.security.saml.SAMLIssuer;
<a name="23" href="#23">23</a> <strong>import</strong> org.apache.ws.security.components.crypto.Crypto;
<a name="24" href="#24">24</a> <strong>import</strong> org.apache.ws.security.components.crypto.CryptoFactory;
<a name="25" href="#25">25</a> <strong>import</strong> org.apache.xml.security.exceptions.XMLSecurityException;
<a name="26" href="#26">26</a> <strong>import</strong> org.apache.xml.security.keys.KeyInfo;
<a name="27" href="#27">27</a> <strong>import</strong> org.apache.xml.security.keys.content.X509Data;
<a name="28" href="#28">28</a> <strong>import</strong> org.apache.xml.security.signature.XMLSignature;
<a name="29" href="#29">29</a> <strong>import</strong> org.opensaml.SAMLAssertion;
<a name="30" href="#30">30</a> <strong>import</strong> org.opensaml.SAMLAuthenticationStatement;
<a name="31" href="#31">31</a> <strong>import</strong> org.opensaml.SAMLException;
<a name="32" href="#32">32</a> <strong>import</strong> org.opensaml.SAMLNameIdentifier;
<a name="33" href="#33">33</a> <strong>import</strong> org.opensaml.SAMLStatement;
<a name="34" href="#34">34</a> <strong>import</strong> org.opensaml.SAMLSubject;
<a name="35" href="#35">35</a> <strong>import</strong> org.w3c.dom.Document;
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> <strong>import</strong> java.security.cert.X509Certificate;
<a name="38" href="#38">38</a> <strong>import</strong> java.util.Arrays;
<a name="39" href="#39">39</a> <strong>import</strong> java.util.Collection;
<a name="40" href="#40">40</a> <strong>import</strong> java.util.Date;
<a name="41" href="#41">41</a> <strong>import</strong> java.util.Properties;
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <em>/**<em>*</em></em>
<a name="44" href="#44">44</a> <em> * Builds a WS SAML Assertion and inserts it into the SOAP Envelope. Refer to</em>
<a name="45" href="#45">45</a> <em> * the WS specification, SAML Token profile</em>
<a name="46" href="#46">46</a> <em> *</em>
<a name="47" href="#47">47</a> <em> * @author Davanum Srinivas (dims@yahoo.com).</em>
<a name="48" href="#48">48</a> <em> */</em>
<a name="49" href="#49">49</a> <strong>public</strong> <strong>class</strong> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuerImpl.html">SAMLIssuerImpl</a> implements <a href="../../../../../org/apache/ws/security/saml/SAMLIssuer.html">SAMLIssuer</a> {
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <strong>private</strong> <strong>static</strong> Log log = LogFactory.getLog(SAMLIssuerImpl.<strong>class</strong>.getName());
<a name="52" href="#52">52</a>
<a name="53" href="#53">53</a> <strong>private</strong> SAMLAssertion sa = <strong>null</strong>;
<a name="54" href="#54">54</a>
<a name="55" href="#55">55</a> <strong>private</strong> Document instanceDoc = <strong>null</strong>;
<a name="56" href="#56">56</a>
<a name="57" href="#57">57</a> <strong>private</strong> Properties properties = <strong>null</strong>;
<a name="58" href="#58">58</a>
<a name="59" href="#59">59</a> <strong>private</strong> <a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> issuerCrypto = <strong>null</strong>;
<a name="60" href="#60">60</a> <strong>private</strong> String issuerKeyPassword = <strong>null</strong>;
<a name="61" href="#61">61</a> <strong>private</strong> String issuerKeyName = <strong>null</strong>;
<a name="62" href="#62">62</a>
<a name="63" href="#63">63</a> <strong>private</strong> <strong>boolean</strong> senderVouches = <strong>true</strong>;
<a name="64" href="#64">64</a>
<a name="65" href="#65">65</a> <strong>private</strong> String[] confirmationMethods = <strong>new</strong> String[1];
<a name="66" href="#66">66</a> <strong>private</strong> <a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> userCrypto = <strong>null</strong>;
<a name="67" href="#67">67</a> <strong>private</strong> String username = <strong>null</strong>;
<a name="68" href="#68">68</a>
<a name="69" href="#69">69</a> <em>/**<em>*</em></em>
<a name="70" href="#70">70</a> <em> * Constructor.</em>
<a name="71" href="#71">71</a> <em> */</em>
<a name="72" href="#72">72</a> <strong>public</strong> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuerImpl.html">SAMLIssuerImpl</a>() {
<a name="73" href="#73">73</a> }
<a name="74" href="#74">74</a>
<a name="75" href="#75">75</a> <strong>public</strong> <a href="../../../../../org/apache/ws/security/saml/SAMLIssuerImpl.html">SAMLIssuerImpl</a>(Properties prop) {
<a name="76" href="#76">76</a> <em class="comment">/*</em>
<a name="77" href="#77">77</a> <em class="comment"> * if no properties .. just return an instance, the rest will be done</em>
<a name="78" href="#78">78</a> <em class="comment"> * later or this instance is just used to handle certificate</em>
<a name="79" href="#79">79</a> <em class="comment"> * conversions in this implementatio</em>
<a name="80" href="#80">80</a> <em class="comment"> */</em>
<a name="81" href="#81">81</a> <strong>if</strong> (prop == <strong>null</strong>) {
<a name="82" href="#82">82</a> <strong>return</strong>;
<a name="83" href="#83">83</a> }
<a name="84" href="#84">84</a> properties = prop;
<a name="85" href="#85">85</a>
<a name="86" href="#86">86</a> String cryptoProp =
<a name="87" href="#87">87</a> properties.getProperty(<span class="string">"org.apache.ws.security.saml.issuer.cryptoProp.file"</span>);
<a name="88" href="#88">88</a> <strong>if</strong> (cryptoProp != <strong>null</strong>) {
<a name="89" href="#89">89</a> issuerCrypto = CryptoFactory.getInstance(cryptoProp);
<a name="90" href="#90">90</a> issuerKeyName =
<a name="91" href="#91">91</a> properties.getProperty(<span class="string">"org.apache.ws.security.saml.issuer.key.name"</span>);
<a name="92" href="#92">92</a> issuerKeyPassword =
<a name="93" href="#93">93</a> properties.getProperty(<span class="string">"org.apache.ws.security.saml.issuer.key.password"</span>);
<a name="94" href="#94">94</a> }
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> <strong>if</strong> (<span class="string">"senderVouches"</span>
<a name="97" href="#97">97</a> .equals(properties.getProperty(<span class="string">"org.apache.ws.security.saml.confirmationMethod"</span>))) {
<a name="98" href="#98">98</a> confirmationMethods[0] = SAMLSubject.CONF_SENDER_VOUCHES;
<a name="99" href="#99">99</a> } <strong>else</strong> <strong>if</strong> (
<a name="100" href="#100">100</a> <span class="string">"keyHolder"</span>.equals(properties.getProperty(<span class="string">"org.apache.ws.security.saml.confirmationMethod"</span>))) {
<a name="101" href="#101">101</a> confirmationMethods[0] = SAMLSubject.CONF_HOLDER_KEY;
<a name="102" href="#102">102</a> senderVouches = false;
<a name="103" href="#103">103</a> } <strong>else</strong> {
<a name="104" href="#104">104</a> <em class="comment">// throw something here - this is a mandatory property</em>
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a> }
<a name="107" href="#107">107</a>
<a name="108" href="#108">108</a> <em>/**<em>*</em></em>
<a name="109" href="#109">109</a> <em> * Creates a new <code>SAMLAssertion</code>.</em>
<a name="110" href="#110">110</a> <em> * <p/></em>
<a name="111" href="#111">111</a> <em> * <p/></em>
<a name="112" href="#112">112</a> <em> * A complete <code>SAMLAssertion</code> is constructed.</em>
<a name="113" href="#113">113</a> <em> *</em>
<a name="114" href="#114">114</a> <em> * @return SAMLAssertion</em>
<a name="115" href="#115">115</a> <em> */</em>
<a name="116" href="#116">116</a> <strong>public</strong> SAMLAssertion newAssertion() { <em class="comment">// throws Exception {</em>
<a name="117" href="#117">117</a> log.debug(<span class="string">"Begin add SAMLAssertion token..."</span>);
<a name="118" href="#118">118</a>
<a name="119" href="#119">119</a> <em class="comment">/*</em>
<a name="120" href="#120">120</a> <em class="comment"> * if (senderVouches == false && userCrypto == null) { throw</em>
<a name="121" href="#121">121</a> <em class="comment"> * exception("need user crypto data to insert key") }</em>
<a name="122" href="#122">122</a> <em class="comment"> */</em>
<a name="123" href="#123">123</a> <em class="comment">// Issuer must enable crypto fubctions to get the issuer's certificate</em>
<a name="124" href="#124">124</a> String issuer =
<a name="125" href="#125">125</a> properties.getProperty(<span class="string">"org.apache.ws.security.saml.issuer"</span>);
<a name="126" href="#126">126</a> String name =
<a name="127" href="#127">127</a> properties.getProperty(<span class="string">"org.apache.ws.security.saml.subjectNameId.name"</span>);
<a name="128" href="#128">128</a> String qualifier =
<a name="129" href="#129">129</a> properties.getProperty(<span class="string">"org.apache.ws.security.saml.subjectNameId.qualifier"</span>);
<a name="130" href="#130">130</a> <strong>try</strong> {
<a name="131" href="#131">131</a> SAMLNameIdentifier nameId =
<a name="132" href="#132">132</a> <strong>new</strong> SAMLNameIdentifier(name, qualifier, <span class="string">""</span>);
<a name="133" href="#133">133</a> String subjectIP = <strong>null</strong>;
<a name="134" href="#134">134</a> String authMethod = <strong>null</strong>;
<a name="135" href="#135">135</a> <strong>if</strong> (<span class="string">"password"</span>
<a name="136" href="#136">136</a> .equals(properties.getProperty(<span class="string">"org.apache.ws.security.saml.authenticationMethod"</span>))) {
<a name="137" href="#137">137</a> authMethod =
<a name="138" href="#138">138</a> SAMLAuthenticationStatement.AuthenticationMethod_Password;
<a name="139" href="#139">139</a> }
<a name="140" href="#140">140</a> Date authInstant = <strong>new</strong> Date();
<a name="141" href="#141">141</a> Collection bindings = <strong>null</strong>;
<a name="142" href="#142">142</a>
<a name="143" href="#143">143</a> SAMLSubject subject =
<a name="144" href="#144">144</a> <strong>new</strong> SAMLSubject(nameId,
<a name="145" href="#145">145</a> Arrays.asList(confirmationMethods),
<a name="146" href="#146">146</a> <strong>null</strong>,
<a name="147" href="#147">147</a> <strong>null</strong>);
<a name="148" href="#148">148</a> SAMLStatement[] statements =
<a name="149" href="#149">149</a> {
<a name="150" href="#150">150</a> <strong>new</strong> SAMLAuthenticationStatement(subject,
<a name="151" href="#151">151</a> authMethod,
<a name="152" href="#152">152</a> authInstant,
<a name="153" href="#153">153</a> subjectIP,
<a name="154" href="#154">154</a> <strong>null</strong>,
<a name="155" href="#155">155</a> bindings)};
<a name="156" href="#156">156</a> sa =
<a name="157" href="#157">157</a> <strong>new</strong> SAMLAssertion(issuer,
<a name="158" href="#158">158</a> <strong>null</strong>,
<a name="159" href="#159">159</a> <strong>null</strong>,
<a name="160" href="#160">160</a> <strong>null</strong>,
<a name="161" href="#161">161</a> <strong>null</strong>,
<a name="162" href="#162">162</a> Arrays.asList(statements));
<a name="163" href="#163">163</a>
<a name="164" href="#164">164</a> <strong>if</strong> (!senderVouches) {
<a name="165" href="#165">165</a> KeyInfo ki = <strong>new</strong> KeyInfo(instanceDoc);
<a name="166" href="#166">166</a> <strong>try</strong> {
<a name="167" href="#167">167</a> X509Certificate[] certs =
<a name="168" href="#168">168</a> userCrypto.getCertificates(username);
<a name="169" href="#169">169</a> X509Data certElem = <strong>new</strong> X509Data(instanceDoc);
<a name="170" href="#170">170</a> certElem.addCertificate(certs[0]);
<a name="171" href="#171">171</a> ki.add(certElem);
<a name="172" href="#172">172</a> } <strong>catch</strong> (WSSecurityException e) {
<a name="173" href="#173">173</a> <strong>return</strong> <strong>null</strong>;
<a name="174" href="#174">174</a> } <strong>catch</strong> (XMLSecurityException e) {
<a name="175" href="#175">175</a> <strong>return</strong> <strong>null</strong>;
<a name="176" href="#176">176</a> }
<a name="177" href="#177">177</a> subject.setKeyInfo(ki);
<a name="178" href="#178">178</a> <em class="comment">// prepare to sign the SAML token</em>
<a name="179" href="#179">179</a> <strong>try</strong> {
<a name="180" href="#180">180</a> X509Certificate[] issuerCerts =
<a name="181" href="#181">181</a> issuerCrypto.getCertificates(issuerKeyName);
<a name="182" href="#182">182</a>
<a name="183" href="#183">183</a> String sigAlgo = XMLSignature.ALGO_ID_SIGNATURE_RSA;
<a name="184" href="#184">184</a> String pubKeyAlgo =
<a name="185" href="#185">185</a> issuerCerts[0].getPublicKey().getAlgorithm();
<a name="186" href="#186">186</a> log.debug(<span class="string">"automatic sig algo detection: "</span> + pubKeyAlgo);
<a name="187" href="#187">187</a> <strong>if</strong> (pubKeyAlgo.equalsIgnoreCase(<span class="string">"DSA"</span>)) {
<a name="188" href="#188">188</a> sigAlgo = XMLSignature.ALGO_ID_SIGNATURE_DSA;
<a name="189" href="#189">189</a> }
<a name="190" href="#190">190</a> java.security.Key issuerPK =
<a name="191" href="#191">191</a> issuerCrypto.getPrivateKey(issuerKeyName,
<a name="192" href="#192">192</a> issuerKeyPassword);
<a name="193" href="#193">193</a> sa.sign(sigAlgo, issuerPK, Arrays.asList(issuerCerts));
<a name="194" href="#194">194</a> } <strong>catch</strong> (WSSecurityException e1) {
<a name="195" href="#195">195</a> e1.printStackTrace();
<a name="196" href="#196">196</a> <strong>return</strong> <strong>null</strong>;
<a name="197" href="#197">197</a> } <strong>catch</strong> (Exception e1) {
<a name="198" href="#198">198</a> e1.printStackTrace();
<a name="199" href="#199">199</a> <strong>return</strong> <strong>null</strong>;
<a name="200" href="#200">200</a> }
<a name="201" href="#201">201</a> }
<a name="202" href="#202">202</a> } <strong>catch</strong> (SAMLException ex) {
<a name="203" href="#203">203</a> ex.printStackTrace();
<a name="204" href="#204">204</a> <strong>throw</strong> <strong>new</strong> RuntimeException(ex.toString());
<a name="205" href="#205">205</a> }
<a name="206" href="#206">206</a> <strong>return</strong> sa;
<a name="207" href="#207">207</a> }
<a name="208" href="#208">208</a>
<a name="209" href="#209">209</a> <em>/**<em>*</em></em>
<a name="210" href="#210">210</a> <em> * @param userCrypto The userCrypto to set.</em>
<a name="211" href="#211">211</a> <em> */</em>
<a name="212" href="#212">212</a> <strong>public</strong> <strong>void</strong> setUserCrypto(<a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> userCrypto) {
<a name="213" href="#213">213</a> <strong>this</strong>.userCrypto = userCrypto;
<a name="214" href="#214">214</a> }
<a name="215" href="#215">215</a>
<a name="216" href="#216">216</a> <em>/**<em>*</em></em>
<a name="217" href="#217">217</a> <em> * @param username The username to set.</em>
<a name="218" href="#218">218</a> <em> */</em>
<a name="219" href="#219">219</a> <strong>public</strong> <strong>void</strong> setUsername(String username) {
<a name="220" href="#220">220</a> <strong>this</strong>.username = username;
<a name="221" href="#221">221</a> }
<a name="222" href="#222">222</a>
<a name="223" href="#223">223</a> <em>/**<em>*</em></em>
<a name="224" href="#224">224</a> <em> * @return Returns the issuerCrypto.</em>
<a name="225" href="#225">225</a> <em> */</em>
<a name="226" href="#226">226</a> <strong>public</strong> <a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> getIssuerCrypto() {
<a name="227" href="#227">227</a> <strong>return</strong> issuerCrypto;
<a name="228" href="#228">228</a> }
<a name="229" href="#229">229</a>
<a name="230" href="#230">230</a> <em>/**<em>*</em></em>
<a name="231" href="#231">231</a> <em> * @return Returns the issuerKeyName.</em>
<a name="232" href="#232">232</a> <em> */</em>
<a name="233" href="#233">233</a> <strong>public</strong> String getIssuerKeyName() {
<a name="234" href="#234">234</a> <strong>return</strong> issuerKeyName;
<a name="235" href="#235">235</a> }
<a name="236" href="#236">236</a>
<a name="237" href="#237">237</a> <em>/**<em>*</em></em>
<a name="238" href="#238">238</a> <em> * @return Returns the issuerKeyPassword.</em>
<a name="239" href="#239">239</a> <em> */</em>
<a name="240" href="#240">240</a> <strong>public</strong> String getIssuerKeyPassword() {
<a name="241" href="#241">241</a> <strong>return</strong> issuerKeyPassword;
<a name="242" href="#242">242</a> }
<a name="243" href="#243">243</a>
<a name="244" href="#244">244</a> <em>/**<em>*</em></em>
<a name="245" href="#245">245</a> <em> * @return Returns the senderVouches.</em>
<a name="246" href="#246">246</a> <em> */</em>
<a name="247" href="#247">247</a> <strong>public</strong> <strong>boolean</strong> isSenderVouches() {
<a name="248" href="#248">248</a> <strong>return</strong> senderVouches;
<a name="249" href="#249">249</a> }
<a name="250" href="#250">250</a>
<a name="251" href="#251">251</a> <em>/**<em>*</em></em>
<a name="252" href="#252">252</a> <em> * @param instanceDoc The instanceDoc to set.</em>
<a name="253" href="#253">253</a> <em> */</em>
<a name="254" href="#254">254</a> <strong>public</strong> <strong>void</strong> setInstanceDoc(Document instanceDoc) {
<a name="255" href="#255">255</a> <strong>this</strong>.instanceDoc = instanceDoc;
<a name="256" href="#256">256</a> }
<a name="257" href="#257">257</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>