Modified: webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecUsernameToken.html URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecUsernameToken.html?rev=1040461&r1=1040460&r2=1040461&view=diff ============================================================================== --- webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecUsernameToken.html (original) +++ webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecUsernameToken.html Tue Nov 30 11:10:26 2010 @@ -34,241 +34,267 @@ <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.WSConstants; <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.WSSecurityException; <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.UsernameToken; -<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.WSSecurityUtil; -<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document; -<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; -<a name="30" href="#30">30</a> -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> -<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Builds a WS UsernameToken.</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * </em> -<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Refer to the WS specification, UsernameToken profile</em> -<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * </em> -<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @author Werner Dittmann ([email protected]).</em> -<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em> -<a name="38" href="#38">38</a> -<a name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/ws/security/message/WSSecUsernameToken.html">WSSecUsernameToken</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/ws/security/message/WSSecBase.html">WSSecBase</a> { -<a name="40" href="#40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Log log = LogFactory.getLog(WSSecUsernameToken.<strong class="jxr_keyword">class</strong>.getName()); -<a name="41" href="#41">41</a> -<a name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> String passwordType = WSConstants.PASSWORD_DIGEST; -<a name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/ws/security/message/token/UsernameToken.html">UsernameToken</a> ut = <strong class="jxr_keyword">null</strong>; -<a name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> nonce = false; -<a name="45" href="#45">45</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> created = false; -<a name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> useDerivedKey = false; -<a name="47" href="#47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> useMac = false; -<a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> byte[] saltValue; -<a name="49" href="#49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> iteration = UsernameToken.DEFAULT_ITERATION; -<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> secretKeyLength = WSConstants.WSE_DERIVED_KEY_LEN; -<a name="51" href="#51">51</a> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> -<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * Constructor.</em> -<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em> -<a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecUsernameToken.html">WSSecUsernameToken</a>() { -<a name="56" href="#56">56</a> } -<a name="57" href="#57">57</a> -<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em> -<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Defines how to construct the password element of the</em> -<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * <code>UsernameToken</code>.</em> -<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * </em> -<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param pwType</em> -<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * contains the password type. Only allowed values are</em> -<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * {...@link WSConstants#PASSWORD_DIGEST} and</em> -<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * {...@link WSConstants#PASSWORD_TEXT}.</em> -<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * or null when no password is needed.</em> -<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em> -<a name="68" href="#68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPasswordType(String pwType) { -<a name="69" href="#69">69</a> <strong class="jxr_keyword">this</strong>.passwordType = pwType; -<a name="70" href="#70">70</a> } -<a name="71" href="#71">71</a> -<a name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em> -<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * Add a Nonce element to the UsernameToken.</em> -<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> */</em> -<a name="75" href="#75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addNonce() { -<a name="76" href="#76">76</a> nonce = <strong class="jxr_keyword">true</strong>; -<a name="77" href="#77">77</a> } -<a name="78" href="#78">78</a> -<a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em> -<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Add a Created element to the UsernameToken.</em> -<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> -<a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addCreated() { -<a name="83" href="#83">83</a> created = <strong class="jxr_keyword">true</strong>; -<a name="84" href="#84">84</a> } -<a name="85" href="#85">85</a> -<a name="86" href="#86">86</a> <em class="jxr_javadoccomment">/**</em> -<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * Set the secret key length</em> -<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em> -<a name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSecretKeyLength(<strong class="jxr_keyword">int</strong> length) { -<a name="90" href="#90">90</a> secretKeyLength = length; -<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"> * Get the secret key length</em> -<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em> -<a name="96" href="#96">96</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getSecretKeyLength() { -<a name="97" href="#97">97</a> <strong class="jxr_keyword">return</strong> secretKeyLength; -<a name="98" href="#98">98</a> } -<a name="99" href="#99">99</a> -<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em> -<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Add a derived key to the UsernameToken</em> -<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @param useMac whether the derived key is to be used for a MAC or not</em> -<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @param saltValue The salt value to use</em> -<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param iteration The number of iterations to use in deriving a key</em> -<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em> -<a name="106" href="#106">106</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addDerivedKey(<strong class="jxr_keyword">boolean</strong> useMac, byte[] saltValue, <strong class="jxr_keyword">int</strong> iteration) { -<a name="107" href="#107">107</a> passwordType = <strong class="jxr_keyword">null</strong>; -<a name="108" href="#108">108</a> useDerivedKey = <strong class="jxr_keyword">true</strong>; -<a name="109" href="#109">109</a> <strong class="jxr_keyword">this</strong>.useMac = useMac; -<a name="110" href="#110">110</a> <strong class="jxr_keyword">this</strong>.saltValue = saltValue; -<a name="111" href="#111">111</a> <strong class="jxr_keyword">if</strong> (iteration > 0) { -<a name="112" href="#112">112</a> <strong class="jxr_keyword">this</strong>.iteration = iteration; -<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> -<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em> -<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Get the derived secret key.</em> -<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * </em> -<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * After the <code>prepare()</code> method was called use this method</em> -<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * to compute a derived secret key. If "useDerivedKey" is set, then the returned secret</em> -<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * key is derived as per the UsernameToken 1.1 specification. Otherwise, the generation </em> -<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * of this secret key is according to the WS-Trust specifications.</em> -<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * </em> -<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @return Return the derived secret key of this token or null if <code>prepare()</code></em> -<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * was not called before.</em> -<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> */</em> -<a name="128" href="#128">128</a> <strong class="jxr_keyword">public</strong> byte[] getSecretKey() <strong class="jxr_keyword">throws</strong> WSSecurityException { -<a name="129" href="#129">129</a> <strong class="jxr_keyword">if</strong> (ut == <strong class="jxr_keyword">null</strong>) { -<a name="130" href="#130">130</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<a name="131" href="#131">131</a> } -<a name="132" href="#132">132</a> <strong class="jxr_keyword">if</strong> (useDerivedKey) { -<a name="133" href="#133">133</a> <strong class="jxr_keyword">return</strong> UsernameToken.generateDerivedKey(password, saltValue, iteration); -<a name="134" href="#134">134</a> } -<a name="135" href="#135">135</a> <strong class="jxr_keyword">return</strong> ut.getSecretKey(secretKeyLength); -<a name="136" href="#136">136</a> } -<a name="137" href="#137">137</a> -<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">/**</em> -<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * Get the derived key.</em> -<a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * </em> -<a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * After the <code>prepare()</code> method was called use this method</em> -<a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * to compute a derived key. The generation of this secret key is according</em> -<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * to the UsernameTokenProfile 1.1 specification (section 4 - Key Derivation).</em> -<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * </em> -<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @return Return the derived key of this token or null if <code>prepare()</code></em> -<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * was not called before.</em> -<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em> -<a name="148" href="#148">148</a> <strong class="jxr_keyword">public</strong> byte[] getDerivedKey() <strong class="jxr_keyword">throws</strong> WSSecurityException { -<a name="149" href="#149">149</a> <strong class="jxr_keyword">if</strong> (ut == <strong class="jxr_keyword">null</strong> || !useDerivedKey) { -<a name="150" href="#150">150</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<a name="151" href="#151">151</a> } -<a name="152" href="#152">152</a> <strong class="jxr_keyword">return</strong> UsernameToken.generateDerivedKey(password, saltValue, iteration); -<a name="153" href="#153">153</a> } -<a name="154" href="#154">154</a> -<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">/**</em> -<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * Get the id generated during <code>prepare()</code>.</em> -<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * </em> -<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * Returns the the value of wsu:Id attribute of this UsernameToken. </em> -<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * </em> -<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @return Return the wsu:Id of this token or null if <code>prepare()</code></em> -<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * was not called before.</em> -<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> */</em> -<a name="163" href="#163">163</a> <strong class="jxr_keyword">public</strong> String getId() { -<a name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> (ut == <strong class="jxr_keyword">null</strong>) { -<a name="165" href="#165">165</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<a name="166" href="#166">166</a> } -<a name="167" href="#167">167</a> <strong class="jxr_keyword">return</strong> ut.getID(); -<a name="168" href="#168">168</a> } -<a name="169" href="#169">169</a> -<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">/**</em> -<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * Creates a Username token.</em> -<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * </em> -<a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * The method prepares and initializes a WSSec UsernameToken structure after</em> -<a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * the relevant information was set. A Before calling</em> -<a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * <code>prepare()</code> all parameters such as user, password,</em> -<a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * passwordType etc. must be set. A complete <code>UsernameToken</code> is</em> -<a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * constructed.</em> -<a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * </em> -<a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * @param doc The SOAP envelope as W3C document</em> -<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> */</em> -<a name="181" href="#181">181</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare(Document doc) { -<a name="182" href="#182">182</a> ut = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/UsernameToken.html">UsernameToken</a>(wssConfig.isPrecisionInMilliSeconds(), doc, passwordType); -<a name="183" href="#183">183</a> ut.setName(user); -<a name="184" href="#184">184</a> <strong class="jxr_keyword">if</strong> (useDerivedKey) { -<a name="185" href="#185">185</a> saltValue = ut.addSalt(doc, saltValue, useMac); -<a name="186" href="#186">186</a> ut.addIteration(doc, iteration); -<a name="187" href="#187">187</a> } <strong class="jxr_keyword">else</strong> { -<a name="188" href="#188">188</a> ut.setPassword(password); -<a name="189" href="#189">189</a> } -<a name="190" href="#190">190</a> <strong class="jxr_keyword">if</strong> (nonce) { -<a name="191" href="#191">191</a> ut.addNonce(doc); -<a name="192" href="#192">192</a> } -<a name="193" href="#193">193</a> <strong class="jxr_keyword">if</strong> (created) { -<a name="194" href="#194">194</a> ut.addCreated(wssConfig.isPrecisionInMilliSeconds(), doc); -<a name="195" href="#195">195</a> } -<a name="196" href="#196">196</a> ut.setID(wssConfig.getIdAllocator().createId(<span class="jxr_string">"UsernameToken-"</span>, ut)); -<a name="197" href="#197">197</a> } -<a name="198" href="#198">198</a> -<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">/**</em> -<a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * Prepends the UsernameToken element to the elements already in the</em> -<a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * Security header.</em> -<a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * </em> -<a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * The method can be called any time after <code>prepare()</code>.</em> -<a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * This allows to insert the UsernameToken element at any position in the</em> -<a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * Security header.</em> -<a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * </em> -<a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * @param secHeader The security header that holds the Signature element.</em> -<a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> */</em> -<a name="209" href="#209">209</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prependToHeader(<a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) { -<a name="210" href="#210">210</a> WSSecurityUtil.prependChildElement(secHeader.getSecurityHeader(), ut.getElement()); -<a name="211" href="#211">211</a> } -<a name="212" href="#212">212</a> -<a name="213" href="#213">213</a> <em class="jxr_javadoccomment">/**</em> -<a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * Appends the UsernameToken element to the elements already in the</em> -<a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * Security header.</em> -<a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * </em> -<a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * The method can be called any time after <code>prepare()</code>.</em> -<a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * This allows to insert the UsernameToken element at any position in the</em> -<a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * Security header.</em> -<a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * </em> -<a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * @param secHeader The security header that holds the Signature element.</em> -<a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> */</em> -<a name="223" href="#223">223</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> appendToHeader(<a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) { -<a name="224" href="#224">224</a> Element secHeaderElement = secHeader.getSecurityHeader(); -<a name="225" href="#225">225</a> secHeaderElement.appendChild(ut.getElement()); -<a name="226" href="#226">226</a> } -<a name="227" href="#227">227</a> -<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">/**</em> -<a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * Adds a new <code>UsernameToken</code> to a soap envelope.</em> -<a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * </em> -<a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * Before calling <code>build()</code> all parameters such as user,</em> -<a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * password, passwordType etc. must be set. A complete</em> -<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * <code>UsernameToken</code> is constructed and added to the</em> -<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * <code>wsse:Security</code> header.</em> -<a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * </em> -<a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @param doc The SOAP envelope as W3C document</em> -<a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * @param secHeader The security header inside the SOAP envelope</em> -<a name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * @return Document with UsernameToken added</em> -<a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> */</em> -<a name="240" href="#240">240</a> <strong class="jxr_keyword">public</strong> Document build(Document doc, <a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) { -<a name="241" href="#241">241</a> log.debug(<span class="jxr_string">"Begin add username token..."</span>); -<a name="242" href="#242">242</a> -<a name="243" href="#243">243</a> prepare(doc); -<a name="244" href="#244">244</a> prependToHeader(secHeader); -<a name="245" href="#245">245</a> -<a name="246" href="#246">246</a> <strong class="jxr_keyword">return</strong> doc; -<a name="247" href="#247">247</a> } -<a name="248" href="#248">248</a> -<a name="249" href="#249">249</a> <em class="jxr_javadoccomment">/**</em> -<a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * Returns the <code>UsernameToken</code> element.</em> -<a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * </em> -<a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * The method can be called any time after <code>prepare()</code>.</em> -<a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * This allows to insert the UsernameToken element at any position in the</em> -<a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * Security header.</em> -<a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * </em> -<a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * @return the Username Token element</em> -<a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> */</em> -<a name="258" href="#258">258</a> <strong class="jxr_keyword">public</strong> Element getUsernameTokenElement() { -<a name="259" href="#259">259</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.ut.getElement(); -<a name="260" href="#260">260</a> } -<a name="261" href="#261">261</a> } +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.Base64; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.WSSecurityUtil; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document; +<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a name="31" href="#31">31</a> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * Builds a WS UsernameToken.</em> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * </em> +<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Refer to the WS specification, UsernameToken profile</em> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * </em> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @author Werner Dittmann ([email protected]).</em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em> +<a name="39" href="#39">39</a> +<a name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/ws/security/message/WSSecUsernameToken.html">WSSecUsernameToken</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/ws/security/message/WSSecBase.html">WSSecBase</a> { +<a name="41" href="#41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Log log = LogFactory.getLog(WSSecUsernameToken.<strong class="jxr_keyword">class</strong>.getName()); +<a name="42" href="#42">42</a> +<a name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> String passwordType = WSConstants.PASSWORD_DIGEST; +<a name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/ws/security/message/token/UsernameToken.html">UsernameToken</a> ut = <strong class="jxr_keyword">null</strong>; +<a name="45" href="#45">45</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> nonce = false; +<a name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> created = false; +<a name="47" href="#47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> useDerivedKey = false; +<a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> useMac = false; +<a name="49" href="#49">49</a> <strong class="jxr_keyword">private</strong> byte[] saltValue; +<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> iteration = UsernameToken.DEFAULT_ITERATION; +<a name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> secretKeyLength = WSConstants.WSE_DERIVED_KEY_LEN; +<a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> passwordsAreEncoded = false; +<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"> * Constructor.</em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em> +<a name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecUsernameToken.html">WSSecUsernameToken</a>() { +<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"> * Defines how to construct the password element of the</em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * <code>UsernameToken</code>.</em> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * </em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param pwType</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * contains the password type. Only allowed values are</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * {...@link WSConstants#PASSWORD_DIGEST} and</em> +<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * {...@link WSConstants#PASSWORD_TEXT}.</em> +<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * or null when no password is needed.</em> +<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em> +<a name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPasswordType(String pwType) { +<a name="71" href="#71">71</a> <strong class="jxr_keyword">this</strong>.passwordType = pwType; +<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"> * Add a Nonce element to the UsernameToken.</em> +<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em> +<a name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addNonce() { +<a name="78" href="#78">78</a> nonce = <strong class="jxr_keyword">true</strong>; +<a name="79" href="#79">79</a> } +<a name="80" href="#80">80</a> +<a name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em> +<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * Add a Created element to the UsernameToken.</em> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em> +<a name="84" href="#84">84</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addCreated() { +<a name="85" href="#85">85</a> created = <strong class="jxr_keyword">true</strong>; +<a name="86" href="#86">86</a> } +<a name="87" href="#87">87</a> +<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em> +<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Set the secret key length</em> +<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em> +<a name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSecretKeyLength(<strong class="jxr_keyword">int</strong> length) { +<a name="92" href="#92">92</a> secretKeyLength = length; +<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"> * Get the secret key length</em> +<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> */</em> +<a name="98" href="#98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getSecretKeyLength() { +<a name="99" href="#99">99</a> <strong class="jxr_keyword">return</strong> secretKeyLength; +<a name="100" href="#100">100</a> } +<a name="101" href="#101">101</a> +<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">/**</em> +<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Add a derived key to the UsernameToken</em> +<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param useMac whether the derived key is to be used for a MAC or not</em> +<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @param saltValue The salt value to use</em> +<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @param iteration The number of iterations to use in deriving a key</em> +<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em> +<a name="108" href="#108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addDerivedKey(<strong class="jxr_keyword">boolean</strong> useMac, byte[] saltValue, <strong class="jxr_keyword">int</strong> iteration) { +<a name="109" href="#109">109</a> passwordType = <strong class="jxr_keyword">null</strong>; +<a name="110" href="#110">110</a> useDerivedKey = <strong class="jxr_keyword">true</strong>; +<a name="111" href="#111">111</a> <strong class="jxr_keyword">this</strong>.useMac = useMac; +<a name="112" href="#112">112</a> <strong class="jxr_keyword">this</strong>.saltValue = saltValue; +<a name="113" href="#113">113</a> <strong class="jxr_keyword">if</strong> (iteration > 0) { +<a name="114" href="#114">114</a> <strong class="jxr_keyword">this</strong>.iteration = iteration; +<a name="115" href="#115">115</a> } +<a name="116" href="#116">116</a> } +<a name="117" href="#117">117</a> +<a name="118" href="#118">118</a> +<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">/**</em> +<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * Get the derived secret key.</em> +<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * </em> +<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * After the <code>prepare()</code> method was called use this method</em> +<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * to compute a derived secret key. If "useDerivedKey" is set, then the returned secret</em> +<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * key is derived as per the UsernameToken 1.1 specification. Otherwise, the generation </em> +<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * of this secret key is according to the WS-Trust specifications.</em> +<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * </em> +<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @return Return the derived secret key of this token or null if <code>prepare()</code></em> +<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * was not called before.</em> +<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> */</em> +<a name="130" href="#130">130</a> <strong class="jxr_keyword">public</strong> byte[] getSecretKey() <strong class="jxr_keyword">throws</strong> WSSecurityException { +<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (ut == <strong class="jxr_keyword">null</strong>) { +<a name="132" href="#132">132</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="133" href="#133">133</a> } +<a name="134" href="#134">134</a> <strong class="jxr_keyword">if</strong> (useDerivedKey) { +<a name="135" href="#135">135</a> <strong class="jxr_keyword">if</strong> (passwordsAreEncoded) { +<a name="136" href="#136">136</a> <strong class="jxr_keyword">return</strong> UsernameToken.generateDerivedKey(Base64.decode(password), saltValue, iteration); +<a name="137" href="#137">137</a> } <strong class="jxr_keyword">else</strong> { +<a name="138" href="#138">138</a> <strong class="jxr_keyword">return</strong> UsernameToken.generateDerivedKey(password, saltValue, iteration); +<a name="139" href="#139">139</a> } +<a name="140" href="#140">140</a> } +<a name="141" href="#141">141</a> <strong class="jxr_keyword">return</strong> ut.getSecretKey(secretKeyLength); +<a name="142" href="#142">142</a> } +<a name="143" href="#143">143</a> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">/**</em> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * Get the derived key.</em> +<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * </em> +<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * After the <code>prepare()</code> method was called use this method</em> +<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * to compute a derived key. The generation of this secret key is according</em> +<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * to the UsernameTokenProfile 1.1 specification (section 4 - Key Derivation).</em> +<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * </em> +<a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * @return Return the derived key of this token or null if <code>prepare()</code></em> +<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * was not called before.</em> +<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> */</em> +<a name="154" href="#154">154</a> <strong class="jxr_keyword">public</strong> byte[] getDerivedKey() <strong class="jxr_keyword">throws</strong> WSSecurityException { +<a name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> (ut == <strong class="jxr_keyword">null</strong> || !useDerivedKey) { +<a name="156" href="#156">156</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="157" href="#157">157</a> } +<a name="158" href="#158">158</a> <strong class="jxr_keyword">if</strong> (passwordsAreEncoded) { +<a name="159" href="#159">159</a> <strong class="jxr_keyword">return</strong> UsernameToken.generateDerivedKey(Base64.decode(password), saltValue, iteration); +<a name="160" href="#160">160</a> } <strong class="jxr_keyword">else</strong> { +<a name="161" href="#161">161</a> <strong class="jxr_keyword">return</strong> UsernameToken.generateDerivedKey(password, saltValue, iteration); +<a name="162" href="#162">162</a> } +<a name="163" href="#163">163</a> } +<a name="164" href="#164">164</a> +<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">/**</em> +<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * @param passwordsAreEncoded</em> +<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * whether passwords are encoded</em> +<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> */</em> +<a name="169" href="#169">169</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPasswordsAreEncoded(<strong class="jxr_keyword">boolean</strong> passwordsAreEncoded) { +<a name="170" href="#170">170</a> <strong class="jxr_keyword">this</strong>.passwordsAreEncoded = passwordsAreEncoded; +<a name="171" href="#171">171</a> } +<a name="172" href="#172">172</a> +<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">/**</em> +<a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * @return whether passwords are encoded</em> +<a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> */</em> +<a name="176" href="#176">176</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getPasswordsAreEncoded() { +<a name="177" href="#177">177</a> <strong class="jxr_keyword">return</strong> passwordsAreEncoded; +<a name="178" href="#178">178</a> } +<a name="179" href="#179">179</a> +<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">/**</em> +<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * Get the id generated during <code>prepare()</code>.</em> +<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * </em> +<a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * Returns the the value of wsu:Id attribute of this UsernameToken. </em> +<a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * </em> +<a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * @return Return the wsu:Id of this token or null if <code>prepare()</code></em> +<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * was not called before.</em> +<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> */</em> +<a name="188" href="#188">188</a> <strong class="jxr_keyword">public</strong> String getId() { +<a name="189" href="#189">189</a> <strong class="jxr_keyword">if</strong> (ut == <strong class="jxr_keyword">null</strong>) { +<a name="190" href="#190">190</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="191" href="#191">191</a> } +<a name="192" href="#192">192</a> <strong class="jxr_keyword">return</strong> ut.getID(); +<a name="193" href="#193">193</a> } +<a name="194" href="#194">194</a> +<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">/**</em> +<a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * Creates a Username token.</em> +<a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * </em> +<a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * The method prepares and initializes a WSSec UsernameToken structure after</em> +<a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * the relevant information was set. A Before calling</em> +<a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * <code>prepare()</code> all parameters such as user, password,</em> +<a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * passwordType etc. must be set. A complete <code>UsernameToken</code> is</em> +<a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * constructed.</em> +<a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * </em> +<a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * @param doc The SOAP envelope as W3C document</em> +<a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> */</em> +<a name="206" href="#206">206</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare(Document doc) { +<a name="207" href="#207">207</a> ut = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/UsernameToken.html">UsernameToken</a>(wssConfig.isPrecisionInMilliSeconds(), doc, passwordType); +<a name="208" href="#208">208</a> ut.setPasswordsAreEncoded(passwordsAreEncoded); +<a name="209" href="#209">209</a> ut.setName(user); +<a name="210" href="#210">210</a> <strong class="jxr_keyword">if</strong> (useDerivedKey) { +<a name="211" href="#211">211</a> saltValue = ut.addSalt(doc, saltValue, useMac); +<a name="212" href="#212">212</a> ut.addIteration(doc, iteration); +<a name="213" href="#213">213</a> } <strong class="jxr_keyword">else</strong> { +<a name="214" href="#214">214</a> ut.setPassword(password); +<a name="215" href="#215">215</a> } +<a name="216" href="#216">216</a> <strong class="jxr_keyword">if</strong> (nonce) { +<a name="217" href="#217">217</a> ut.addNonce(doc); +<a name="218" href="#218">218</a> } +<a name="219" href="#219">219</a> <strong class="jxr_keyword">if</strong> (created) { +<a name="220" href="#220">220</a> ut.addCreated(wssConfig.isPrecisionInMilliSeconds(), doc); +<a name="221" href="#221">221</a> } +<a name="222" href="#222">222</a> ut.setID(wssConfig.getIdAllocator().createId(<span class="jxr_string">"UsernameToken-"</span>, ut)); +<a name="223" href="#223">223</a> } +<a name="224" href="#224">224</a> +<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">/**</em> +<a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * Prepends the UsernameToken element to the elements already in the</em> +<a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * Security header.</em> +<a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * </em> +<a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * The method can be called any time after <code>prepare()</code>.</em> +<a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * This allows to insert the UsernameToken element at any position in the</em> +<a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * Security header.</em> +<a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * </em> +<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @param secHeader The security header that holds the Signature element.</em> +<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> */</em> +<a name="235" href="#235">235</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prependToHeader(<a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) { +<a name="236" href="#236">236</a> WSSecurityUtil.prependChildElement(secHeader.getSecurityHeader(), ut.getElement()); +<a name="237" href="#237">237</a> } +<a name="238" href="#238">238</a> +<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">/**</em> +<a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * Appends the UsernameToken element to the elements already in the</em> +<a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * Security header.</em> +<a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * </em> +<a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * The method can be called any time after <code>prepare()</code>.</em> +<a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * This allows to insert the UsernameToken element at any position in the</em> +<a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * Security header.</em> +<a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * </em> +<a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * @param secHeader The security header that holds the Signature element.</em> +<a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> */</em> +<a name="249" href="#249">249</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> appendToHeader(<a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) { +<a name="250" href="#250">250</a> Element secHeaderElement = secHeader.getSecurityHeader(); +<a name="251" href="#251">251</a> secHeaderElement.appendChild(ut.getElement()); +<a name="252" href="#252">252</a> } +<a name="253" href="#253">253</a> +<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">/**</em> +<a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * Adds a new <code>UsernameToken</code> to a soap envelope.</em> +<a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * </em> +<a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * Before calling <code>build()</code> all parameters such as user,</em> +<a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * password, passwordType etc. must be set. A complete</em> +<a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * <code>UsernameToken</code> is constructed and added to the</em> +<a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * <code>wsse:Security</code> header.</em> +<a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * </em> +<a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * @param doc The SOAP envelope as W3C document</em> +<a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * @param secHeader The security header inside the SOAP envelope</em> +<a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * @return Document with UsernameToken added</em> +<a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> */</em> +<a name="266" href="#266">266</a> <strong class="jxr_keyword">public</strong> Document build(Document doc, <a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) { +<a name="267" href="#267">267</a> log.debug(<span class="jxr_string">"Begin add username token..."</span>); +<a name="268" href="#268">268</a> +<a name="269" href="#269">269</a> prepare(doc); +<a name="270" href="#270">270</a> prependToHeader(secHeader); +<a name="271" href="#271">271</a> +<a name="272" href="#272">272</a> <strong class="jxr_keyword">return</strong> doc; +<a name="273" href="#273">273</a> } +<a name="274" href="#274">274</a> +<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">/**</em> +<a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * Returns the <code>UsernameToken</code> element.</em> +<a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * </em> +<a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * The method can be called any time after <code>prepare()</code>.</em> +<a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * This allows to insert the UsernameToken element at any position in the</em> +<a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * Security header.</em> +<a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * </em> +<a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * @return the Username Token element</em> +<a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> */</em> +<a name="284" href="#284">284</a> <strong class="jxr_keyword">public</strong> Element getUsernameTokenElement() { +<a name="285" href="#285">285</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.ut.getElement(); +<a name="286" href="#286">286</a> } +<a name="287" href="#287">287</a> } </pre> <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> </html>
Modified: webservices/wss4j/site/xref/org/apache/ws/security/message/package-frame.html URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/message/package-frame.html?rev=1040461&r1=1040460&r2=1040461&view=diff ============================================================================== --- webservices/wss4j/site/xref/org/apache/ws/security/message/package-frame.html (original) +++ webservices/wss4j/site/xref/org/apache/ws/security/message/package-frame.html Tue Nov 30 11:10:26 2010 @@ -3,7 +3,7 @@ <html xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> - <title>WSS4J 1.5.9 Reference Package org.apache.ws.security.message</title> + <title>WSS4J 1.5.10 Reference Package org.apache.ws.security.message</title> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" /> </head> <body> Modified: webservices/wss4j/site/xref/org/apache/ws/security/message/package-summary.html URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/message/package-summary.html?rev=1040461&r1=1040460&r2=1040461&view=diff ============================================================================== --- webservices/wss4j/site/xref/org/apache/ws/security/message/package-summary.html (original) +++ webservices/wss4j/site/xref/org/apache/ws/security/message/package-summary.html Tue Nov 30 11:10:26 2010 @@ -3,7 +3,7 @@ <html xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> - <title>WSS4J 1.5.9 Reference Package org.apache.ws.security.message</title> + <title>WSS4J 1.5.10 Reference Package org.apache.ws.security.message</title> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" /> </head> <body>
