You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ws.apache.org by co...@apache.org on 2011/10/03 17:16:11 UTC
svn commit: r1178426 [25/40] - in /webservices/wss4j/site: ./ apidocs/
apidocs/org/apache/ws/security/ apidocs/org/apache/ws/security/action/
apidocs/org/apache/ws/security/action/class-use/
apidocs/org/apache/ws/security/class-use/ apidocs/org/apache/...
Modified: webservices/wss4j/site/xref/org/apache/ws/security/components/crypto/package-frame.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/components/crypto/package-frame.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/components/crypto/package-frame.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/components/crypto/package-frame.html Mon Oct 3 15:15:52 2011
@@ -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.6.2 Reference Package org.apache.ws.security.components.crypto</title>
+ <title>WSS4J 1.6.3 Reference Package org.apache.ws.security.components.crypto</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: webservices/wss4j/site/xref/org/apache/ws/security/components/crypto/package-summary.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/components/crypto/package-summary.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/components/crypto/package-summary.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/components/crypto/package-summary.html Mon Oct 3 15:15:52 2011
@@ -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.6.2 Reference Package org.apache.ws.security.components.crypto</title>
+ <title>WSS4J 1.6.3 Reference Package org.apache.ws.security.components.crypto</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: webservices/wss4j/site/xref/org/apache/ws/security/conversation/dkalgo/package-frame.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/conversation/dkalgo/package-frame.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/conversation/dkalgo/package-frame.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/conversation/dkalgo/package-frame.html Mon Oct 3 15:15:52 2011
@@ -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.6.2 Reference Package org.apache.ws.security.conversation.dkalgo</title>
+ <title>WSS4J 1.6.3 Reference Package org.apache.ws.security.conversation.dkalgo</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: webservices/wss4j/site/xref/org/apache/ws/security/conversation/dkalgo/package-summary.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/conversation/dkalgo/package-summary.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/conversation/dkalgo/package-summary.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/conversation/dkalgo/package-summary.html Mon Oct 3 15:15:52 2011
@@ -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.6.2 Reference Package org.apache.ws.security.conversation.dkalgo</title>
+ <title>WSS4J 1.6.3 Reference Package org.apache.ws.security.conversation.dkalgo</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: webservices/wss4j/site/xref/org/apache/ws/security/conversation/package-frame.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/conversation/package-frame.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/conversation/package-frame.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/conversation/package-frame.html Mon Oct 3 15:15:52 2011
@@ -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.6.2 Reference Package org.apache.ws.security.conversation</title>
+ <title>WSS4J 1.6.3 Reference Package org.apache.ws.security.conversation</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: webservices/wss4j/site/xref/org/apache/ws/security/conversation/package-summary.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/conversation/package-summary.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/conversation/package-summary.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/conversation/package-summary.html Mon Oct 3 15:15:52 2011
@@ -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.6.2 Reference Package org.apache.ws.security.conversation</title>
+ <title>WSS4J 1.6.3 Reference Package org.apache.ws.security.conversation</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: webservices/wss4j/site/xref/org/apache/ws/security/handler/package-frame.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/handler/package-frame.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/handler/package-frame.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/handler/package-frame.html Mon Oct 3 15:15:52 2011
@@ -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.6.2 Reference Package org.apache.ws.security.handler</title>
+ <title>WSS4J 1.6.3 Reference Package org.apache.ws.security.handler</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: webservices/wss4j/site/xref/org/apache/ws/security/handler/package-summary.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/handler/package-summary.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/handler/package-summary.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/handler/package-summary.html Mon Oct 3 15:15:52 2011
@@ -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.6.2 Reference Package org.apache.ws.security.handler</title>
+ <title>WSS4J 1.6.3 Reference Package org.apache.ws.security.handler</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecDerivedKeyBase.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecDerivedKeyBase.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecDerivedKeyBase.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecDerivedKeyBase.html Mon Oct 3 15:15:52 2011
@@ -37,293 +37,299 @@
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.conversation.dkalgo.AlgoFactory;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.conversation.dkalgo.DerivationAlgorithm;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.DerivedKeyToken;
-<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.Reference;
-<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.SecurityTokenReference;
-<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.Base64;
-<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.WSSecurityUtil;
-<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document;
-<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
-<a name="36" href="#36">36</a>
-<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
-<a name="38" href="#38">38</a>
-<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
-<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Base class for DerivedKey encryption and signature</em>
-<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em>
-<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @author Ruchith Fernando (ruchith.fernando@gmail.com)</em>
-<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @author Davanum Srinivas (dims@yahoo.com)</em>
-<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @author Werner Dittmann (werner@apache.org)</em>
-<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em>
-<a name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/ws/security/message/WSSecDerivedKeyBase.html">WSSecDerivedKeyBase</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/ws/security/message/WSSecSignatureBase.html">WSSecSignatureBase</a> {
-<a name="47" href="#47">47</a>
-<a name="48" href="#48">48</a> <strong class="jxr_keyword">protected</strong> Document document;
-<a name="49" href="#49">49</a>
-<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em>
-<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Session key used as the secret in key derivation</em>
-<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
-<a name="53" href="#53">53</a> <strong class="jxr_keyword">protected</strong> byte[] ephemeralKey;
-<a name="54" href="#54">54</a>
-<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em>
-<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * DerivedKeyToken of this builder</em>
-<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em>
-<a name="58" href="#58">58</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/ws/security/message/token/DerivedKeyToken.html">DerivedKeyToken</a> dkt = <strong class="jxr_keyword">null</strong>;
-<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"> * Raw bytes of the derived key</em>
-<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em>
-<a name="63" href="#63">63</a> <strong class="jxr_keyword">protected</strong> byte[] derivedKeyBytes = <strong class="jxr_keyword">null</strong>;
-<a name="64" href="#64">64</a>
-<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em>
-<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * wsu:Id of the wsc:DerivedKeyToken</em>
-<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em>
-<a name="68" href="#68">68</a> <strong class="jxr_keyword">protected</strong> String dktId = <strong class="jxr_keyword">null</strong>;
-<a name="69" href="#69">69</a>
-<a name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em>
-<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Client's label value</em>
-<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em>
-<a name="73" href="#73">73</a> <strong class="jxr_keyword">protected</strong> String clientLabel = ConversationConstants.DEFAULT_LABEL;
-<a name="74" href="#74">74</a>
-<a name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em>
-<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * Service's label value</em>
-<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em>
-<a name="78" href="#78">78</a> <strong class="jxr_keyword">protected</strong> String serviceLabel = ConversationConstants.DEFAULT_LABEL;
-<a name="79" href="#79">79</a>
-<a name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em>
-<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * soap:Envelope element</em>
-<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em>
-<a name="83" href="#83">83</a> <strong class="jxr_keyword">protected</strong> Element envelope = <strong class="jxr_keyword">null</strong>;
-<a name="84" href="#84">84</a>
-<a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em>
-<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * The Token identifier of the token that the <code>DerivedKeyToken</code> </em>
-<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * is (or to be) derived from.</em>
-<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em>
-<a name="89" href="#89">89</a> <strong class="jxr_keyword">protected</strong> String tokenIdentifier = <strong class="jxr_keyword">null</strong>;
-<a name="90" href="#90">90</a>
-<a name="91" href="#91">91</a> <em class="jxr_javadoccomment">/**</em>
-<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * True if the tokenIdentifier is a direct reference to a key identifier</em>
-<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * instead of a URI to a key</em>
-<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> */</em>
-<a name="95" href="#95">95</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> tokenIdDirectId;
-<a name="96" href="#96">96</a>
-<a name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em>
-<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * The derived key will change depending on the sig/encr algorithm.</em>
-<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * Therefore the child classes are expected to provide this value.</em>
-<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @return the derived key length</em>
-<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em>
-<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> */</em>
-<a name="103" href="#103">103</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getDerivedKeyLength() <strong class="jxr_keyword">throws</strong> WSSecurityException;
-<a name="104" href="#104">104</a>
-<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">/**</em>
-<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * The wsse:SecurityTokenReference element to be used</em>
-<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em>
-<a name="108" href="#108">108</a> <strong class="jxr_keyword">protected</strong> Element strElem;
-<a name="109" href="#109">109</a>
-<a name="110" href="#110">110</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> wscVersion = ConversationConstants.DEFAULT_VERSION;
-<a name="111" href="#111">111</a>
-<a name="112" href="#112">112</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> derivedKeyLength = -1;
-<a name="113" href="#113">113</a>
-<a name="114" href="#114">114</a> <strong class="jxr_keyword">private</strong> String customValueType;
-<a name="115" href="#115">115</a>
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.KerberosSecurity;
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.Reference;
+<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.SecurityTokenReference;
+<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.Base64;
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.WSSecurityUtil;
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document;
+<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
+<a name="37" href="#37">37</a>
+<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
+<a name="39" href="#39">39</a>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment">/**</em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Base class for DerivedKey encryption and signature</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @author Ruchith Fernando (ruchith.fernando@gmail.com)</em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @author Davanum Srinivas (dims@yahoo.com)</em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @author Werner Dittmann (werner@apache.org)</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
+<a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/ws/security/message/WSSecDerivedKeyBase.html">WSSecDerivedKeyBase</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/ws/security/message/WSSecSignatureBase.html">WSSecSignatureBase</a> {
+<a name="48" href="#48">48</a>
+<a name="49" href="#49">49</a> <strong class="jxr_keyword">protected</strong> Document document;
+<a name="50" href="#50">50</a>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Session key used as the secret in key derivation</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em>
+<a name="54" href="#54">54</a> <strong class="jxr_keyword">protected</strong> byte[] ephemeralKey;
+<a name="55" href="#55">55</a>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * DerivedKeyToken of this builder</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
+<a name="59" href="#59">59</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/ws/security/message/token/DerivedKeyToken.html">DerivedKeyToken</a> dkt = <strong class="jxr_keyword">null</strong>;
+<a name="60" href="#60">60</a>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Raw bytes of the derived key</em>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em>
+<a name="64" href="#64">64</a> <strong class="jxr_keyword">protected</strong> byte[] derivedKeyBytes = <strong class="jxr_keyword">null</strong>;
+<a name="65" href="#65">65</a>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * wsu:Id of the wsc:DerivedKeyToken</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
+<a name="69" href="#69">69</a> <strong class="jxr_keyword">protected</strong> String dktId = <strong class="jxr_keyword">null</strong>;
+<a name="70" href="#70">70</a>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * Client's label value</em>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
+<a name="74" href="#74">74</a> <strong class="jxr_keyword">protected</strong> String clientLabel = ConversationConstants.DEFAULT_LABEL;
+<a name="75" href="#75">75</a>
+<a name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Service's label value</em>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> */</em>
+<a name="79" href="#79">79</a> <strong class="jxr_keyword">protected</strong> String serviceLabel = ConversationConstants.DEFAULT_LABEL;
+<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"> * soap:Envelope element</em>
+<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em>
+<a name="84" href="#84">84</a> <strong class="jxr_keyword">protected</strong> Element envelope = <strong class="jxr_keyword">null</strong>;
+<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"> * The Token identifier of the token that the <code>DerivedKeyToken</code> </em>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * is (or to be) derived from.</em>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> */</em>
+<a name="90" href="#90">90</a> <strong class="jxr_keyword">protected</strong> String tokenIdentifier = <strong class="jxr_keyword">null</strong>;
+<a name="91" href="#91">91</a>
+<a name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em>
+<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * True if the tokenIdentifier is a direct reference to a key identifier</em>
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * instead of a URI to a key</em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em>
+<a name="96" href="#96">96</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> tokenIdDirectId;
+<a name="97" href="#97">97</a>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em>
+<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * The derived key will change depending on the sig/encr algorithm.</em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * Therefore the child classes are expected to provide this value.</em>
+<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * @return the derived key length</em>
+<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em>
+<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> */</em>
+<a name="104" href="#104">104</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getDerivedKeyLength() <strong class="jxr_keyword">throws</strong> WSSecurityException;
+<a name="105" href="#105">105</a>
+<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">/**</em>
+<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * The wsse:SecurityTokenReference element to be used</em>
+<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> */</em>
+<a name="109" href="#109">109</a> <strong class="jxr_keyword">protected</strong> Element strElem;
+<a name="110" href="#110">110</a>
+<a name="111" href="#111">111</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> wscVersion = ConversationConstants.DEFAULT_VERSION;
+<a name="112" href="#112">112</a>
+<a name="113" href="#113">113</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> derivedKeyLength = -1;
+<a name="114" href="#114">114</a>
+<a name="115" href="#115">115</a> <strong class="jxr_keyword">private</strong> String customValueType;
<a name="116" href="#116">116</a>
-<a name="117" href="#117">117</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecDerivedKeyBase.html">WSSecDerivedKeyBase</a>() {
-<a name="118" href="#118">118</a> <strong class="jxr_keyword">super</strong>();
-<a name="119" href="#119">119</a> }
-<a name="120" href="#120">120</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecDerivedKeyBase.html">WSSecDerivedKeyBase</a>(<a href="../../../../../org/apache/ws/security/WSSConfig.html">WSSConfig</a> config) {
-<a name="121" href="#121">121</a> <strong class="jxr_keyword">super</strong>(config);
-<a name="122" href="#122">122</a> }
-<a name="123" href="#123">123</a>
-<a name="124" href="#124">124</a>
-<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">/**</em>
-<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @param ephemeralKey The ephemeralKey to set.</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> <strong class="jxr_keyword">void</strong> setExternalKey(byte[] ephemeralKey, String tokenIdentifier) {
-<a name="129" href="#129">129</a> <strong class="jxr_keyword">this</strong>.ephemeralKey = ephemeralKey;
-<a name="130" href="#130">130</a> <strong class="jxr_keyword">this</strong>.tokenIdentifier = tokenIdentifier;
-<a name="131" href="#131">131</a> }
-<a name="132" href="#132">132</a>
-<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">/**</em>
-<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @param ephemeralKey The ephemeralKey to set.</em>
-<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em>
-<a name="136" href="#136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setExternalKey(byte[] ephemeralKey, Element strElem) {
-<a name="137" href="#137">137</a> <strong class="jxr_keyword">this</strong>.ephemeralKey = ephemeralKey;
-<a name="138" href="#138">138</a> <strong class="jxr_keyword">this</strong>.strElem = strElem;
-<a name="139" href="#139">139</a> }
-<a name="140" href="#140">140</a>
-<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em>
-<a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @return Returns the tokenIdentifier.</em>
-<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> */</em>
-<a name="144" href="#144">144</a> <strong class="jxr_keyword">public</strong> String getTokenIdentifier() {
-<a name="145" href="#145">145</a> <strong class="jxr_keyword">return</strong> tokenIdentifier;
-<a name="146" href="#146">146</a> }
-<a name="147" href="#147">147</a>
-<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">/**</em>
-<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * Get the id generated during <code>prepare()</code>.</em>
-<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * </em>
-<a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * Returns the the value of wsu:Id attribute of the DerivedKeyToken element.</em>
-<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * </em>
-<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * @return Return the wsu:Id of this token or null if <code>prepare()</code></em>
-<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * was not called before.</em>
-<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> */</em>
-<a name="156" href="#156">156</a> <strong class="jxr_keyword">public</strong> String getId() {
-<a name="157" href="#157">157</a> <strong class="jxr_keyword">return</strong> dktId;
-<a name="158" href="#158">158</a> }
-<a name="159" href="#159">159</a>
-<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">/**</em>
-<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * Set the label value of the client.</em>
-<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @param clientLabel</em>
-<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> */</em>
-<a name="164" href="#164">164</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setClientLabel(String clientLabel) {
-<a name="165" href="#165">165</a> <strong class="jxr_keyword">this</strong>.clientLabel = clientLabel;
-<a name="166" href="#166">166</a> }
-<a name="167" href="#167">167</a>
-<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">/**</em>
-<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * Set the label value of the service.</em>
-<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * @param serviceLabel</em>
-<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> */</em>
-<a name="172" href="#172">172</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setServiceLabel(String serviceLabel) {
-<a name="173" href="#173">173</a> <strong class="jxr_keyword">this</strong>.serviceLabel = serviceLabel;
-<a name="174" href="#174">174</a> }
-<a name="175" href="#175">175</a>
-<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">/**</em>
-<a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * Initialize a WSSec Derived key.</em>
-<a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * </em>
-<a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * The method prepares and initializes a WSSec derived key structure after the</em>
-<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * relevant information was set. This method also creates and initializes the</em>
-<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * derived token using the ephemeral key. After preparation references</em>
-<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * can be added, encrypted and signed as required.</em>
-<a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * </em>
-<a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * This method does not add any element to the security header. This must be</em>
-<a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * done explicitly.</em>
-<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * </em>
-<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * @param doc The unsigned SOAP envelope as <code>Document</code></em>
-<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em>
-<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> */</em>
-<a name="190" href="#190">190</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare(Document doc) <strong class="jxr_keyword">throws</strong> WSSecurityException, ConversationException {
-<a name="191" href="#191">191</a>
-<a name="192" href="#192">192</a> document = doc;
-<a name="193" href="#193">193</a>
-<a name="194" href="#194">194</a> <em class="jxr_comment">// Create the derived keys</em>
-<a name="195" href="#195">195</a> <em class="jxr_comment">// At this point figure out the key length according to the symencAlgo</em>
-<a name="196" href="#196">196</a> <strong class="jxr_keyword">int</strong> offset = 0;
-<a name="197" href="#197">197</a> <strong class="jxr_keyword">int</strong> length = getDerivedKeyLength();
-<a name="198" href="#198">198</a> byte[] label;
-<a name="199" href="#199">199</a> <strong class="jxr_keyword">try</strong> {
-<a name="200" href="#200">200</a> label = (clientLabel + serviceLabel).getBytes(<span class="jxr_string">"UTF-8"</span>);
-<a name="201" href="#201">201</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) {
-<a name="202" href="#202">202</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(<span class="jxr_string">"UTF-8 encoding is not supported"</span>, e);
-<a name="203" href="#203">203</a> }
-<a name="204" href="#204">204</a> byte[] nonce = WSSecurityUtil.generateNonce(16);
-<a name="205" href="#205">205</a>
-<a name="206" href="#206">206</a> byte[] seed = <strong class="jxr_keyword">new</strong> byte[label.length + nonce.length];
-<a name="207" href="#207">207</a> System.arraycopy(label, 0, seed, 0, label.length);
-<a name="208" href="#208">208</a> System.arraycopy(nonce, 0, seed, label.length, nonce.length);
-<a name="209" href="#209">209</a>
-<a name="210" href="#210">210</a> <a href="../../../../../org/apache/ws/security/conversation/ConversationConstants.html">DerivationAlgorithm</a> algo =
-<a name="211" href="#211">211</a> AlgoFactory.getInstance(ConversationConstants.DerivationAlgorithm.P_SHA_1);
-<a name="212" href="#212">212</a>
-<a name="213" href="#213">213</a> derivedKeyBytes = algo.createKey(ephemeralKey, seed, offset, length);
-<a name="214" href="#214">214</a>
-<a name="215" href="#215">215</a> <em class="jxr_comment">// Add the DKTs</em>
-<a name="216" href="#216">216</a> dkt = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/DerivedKeyToken.html">DerivedKeyToken</a>(wscVersion, document);
-<a name="217" href="#217">217</a> dktId = getWsConfig().getIdAllocator().createId(<span class="jxr_string">"DK-"</span>, dkt);
-<a name="218" href="#218">218</a>
-<a name="219" href="#219">219</a> dkt.setOffset(offset);
-<a name="220" href="#220">220</a> dkt.setLength(length);
-<a name="221" href="#221">221</a> dkt.setNonce(Base64.encode(nonce));
-<a name="222" href="#222">222</a> dkt.setID(dktId);
-<a name="223" href="#223">223</a>
-<a name="224" href="#224">224</a> <strong class="jxr_keyword">if</strong> (strElem == <strong class="jxr_keyword">null</strong>) {
-<a name="225" href="#225">225</a> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> secRef = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a>(document);
-<a name="226" href="#226">226</a> String strUri = getWsConfig().getIdAllocator().createSecureId(<span class="jxr_string">"STR-"</span>, secRef);
-<a name="227" href="#227">227</a> secRef.setID(strUri);
-<a name="228" href="#228">228</a>
-<a name="229" href="#229">229</a> <strong class="jxr_keyword">switch</strong> (keyIdentifierType) {
-<a name="230" href="#230">230</a> <strong class="jxr_keyword">case</strong> WSConstants.CUSTOM_KEY_IDENTIFIER:
-<a name="231" href="#231">231</a> secRef.setKeyIdentifier(customValueType, tokenIdentifier);
-<a name="232" href="#232">232</a> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML_KI_VALUE_TYPE.equals(customValueType)) {
-<a name="233" href="#233">233</a> secRef.addTokenType(WSConstants.WSS_SAML_TOKEN_TYPE);
-<a name="234" href="#234">234</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML2_KI_VALUE_TYPE.equals(customValueType)) {
-<a name="235" href="#235">235</a> secRef.addTokenType(WSConstants.WSS_SAML2_TOKEN_TYPE);
-<a name="236" href="#236">236</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_ENC_KEY_VALUE_TYPE.equals(customValueType)) {
-<a name="237" href="#237">237</a> secRef.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE);
-<a name="238" href="#238">238</a> }
-<a name="239" href="#239">239</a> <strong class="jxr_keyword">break</strong>;
-<a name="240" href="#240">240</a> <strong class="jxr_keyword">default</strong>:
-<a name="241" href="#241">241</a> <a href="../../../../../org/apache/ws/security/message/token/Reference.html">Reference</a> ref = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/Reference.html">Reference</a>(document);
-<a name="242" href="#242">242</a>
-<a name="243" href="#243">243</a> <strong class="jxr_keyword">if</strong> (tokenIdDirectId) {
-<a name="244" href="#244">244</a> ref.setURI(tokenIdentifier);
-<a name="245" href="#245">245</a> } <strong class="jxr_keyword">else</strong> {
-<a name="246" href="#246">246</a> ref.setURI(<span class="jxr_string">"#"</span> + tokenIdentifier);
-<a name="247" href="#247">247</a> }
-<a name="248" href="#248">248</a> <strong class="jxr_keyword">if</strong> (customValueType != <strong class="jxr_keyword">null</strong> && !<span class="jxr_string">""</span>.equals(customValueType)) {
-<a name="249" href="#249">249</a> ref.setValueType(customValueType);
-<a name="250" href="#250">250</a> }
-<a name="251" href="#251">251</a> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML_KI_VALUE_TYPE.equals(customValueType)) {
-<a name="252" href="#252">252</a> secRef.addTokenType(WSConstants.WSS_SAML_TOKEN_TYPE);
-<a name="253" href="#253">253</a> ref.setValueType(customValueType);
-<a name="254" href="#254">254</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML2_KI_VALUE_TYPE.equals(customValueType)) {
-<a name="255" href="#255">255</a> secRef.addTokenType(WSConstants.WSS_SAML2_TOKEN_TYPE);
-<a name="256" href="#256">256</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_ENC_KEY_VALUE_TYPE.equals(customValueType)) {
-<a name="257" href="#257">257</a> secRef.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE);
-<a name="258" href="#258">258</a> ref.setValueType(customValueType);
-<a name="259" href="#259">259</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!WSConstants.WSS_USERNAME_TOKEN_VALUE_TYPE.equals(customValueType)) {
-<a name="260" href="#260">260</a> secRef.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE);
-<a name="261" href="#261">261</a> }
-<a name="262" href="#262">262</a>
-<a name="263" href="#263">263</a> secRef.setReference(ref);
-<a name="264" href="#264">264</a> }
-<a name="265" href="#265">265</a>
-<a name="266" href="#266">266</a> dkt.setSecurityTokenReference(secRef);
-<a name="267" href="#267">267</a> } <strong class="jxr_keyword">else</strong> {
-<a name="268" href="#268">268</a> dkt.setSecurityTokenReference(strElem);
-<a name="269" href="#269">269</a> }
-<a name="270" href="#270">270</a> }
-<a name="271" href="#271">271</a>
-<a name="272" href="#272">272</a>
-<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">/**</em>
-<a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> * Prepend the DerivedKey element to the elements already in the Security</em>
-<a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * header.</em>
-<a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * </em>
-<a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * The method can be called any time after <code>prepare()</code>. This</em>
-<a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * allows to insert the DerivedKey element at any position in the Security</em>
-<a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * header.</em>
-<a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * </em>
-<a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * @param secHeader The security header that holds the Signature element.</em>
-<a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> */</em>
-<a name="283" href="#283">283</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prependDKElementToHeader(<a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) {
-<a name="284" href="#284">284</a> WSSecurityUtil.prependChildElement(
-<a name="285" href="#285">285</a> secHeader.getSecurityHeader(), dkt.getElement()
-<a name="286" href="#286">286</a> );
-<a name="287" href="#287">287</a> }
-<a name="288" href="#288">288</a>
-<a name="289" href="#289">289</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> appendDKElementToHeader(<a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) {
-<a name="290" href="#290">290</a> Element secHeaderElement = secHeader.getSecurityHeader();
-<a name="291" href="#291">291</a> secHeaderElement.appendChild(dkt.getElement());
-<a name="292" href="#292">292</a> }
-<a name="293" href="#293">293</a>
-<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em>
-<a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * @param wscVersion The wscVersion to set.</em>
-<a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> */</em>
-<a name="297" href="#297">297</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setWscVersion(<strong class="jxr_keyword">int</strong> wscVersion) {
-<a name="298" href="#298">298</a> <strong class="jxr_keyword">this</strong>.wscVersion = wscVersion;
-<a name="299" href="#299">299</a> }
-<a name="300" href="#300">300</a>
-<a name="301" href="#301">301</a> <strong class="jxr_keyword">public</strong> Element getdktElement() {
-<a name="302" href="#302">302</a> <strong class="jxr_keyword">return</strong> dkt.getElement();
-<a name="303" href="#303">303</a> }
-<a name="304" href="#304">304</a>
-<a name="305" href="#305">305</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDerivedKeyLength(<strong class="jxr_keyword">int</strong> keyLength) {
-<a name="306" href="#306">306</a> derivedKeyLength = keyLength;
-<a name="307" href="#307">307</a> }
-<a name="308" href="#308">308</a>
-<a name="309" href="#309">309</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCustomValueType(String customValueType) {
-<a name="310" href="#310">310</a> <strong class="jxr_keyword">this</strong>.customValueType = customValueType;
-<a name="311" href="#311">311</a> }
-<a name="312" href="#312">312</a>
-<a name="313" href="#313">313</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTokenIdDirectId(<strong class="jxr_keyword">boolean</strong> b) {
-<a name="314" href="#314">314</a> tokenIdDirectId = b;
-<a name="315" href="#315">315</a> }
-<a name="316" href="#316">316</a> }
+<a name="117" href="#117">117</a>
+<a name="118" href="#118">118</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecDerivedKeyBase.html">WSSecDerivedKeyBase</a>() {
+<a name="119" href="#119">119</a> <strong class="jxr_keyword">super</strong>();
+<a name="120" href="#120">120</a> }
+<a name="121" href="#121">121</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecDerivedKeyBase.html">WSSecDerivedKeyBase</a>(<a href="../../../../../org/apache/ws/security/WSSConfig.html">WSSConfig</a> config) {
+<a name="122" href="#122">122</a> <strong class="jxr_keyword">super</strong>(config);
+<a name="123" href="#123">123</a> }
+<a name="124" href="#124">124</a>
+<a name="125" href="#125">125</a>
+<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">/**</em>
+<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @param ephemeralKey The ephemeralKey to set.</em>
+<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em>
+<a name="129" href="#129">129</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setExternalKey(byte[] ephemeralKey, String tokenIdentifier) {
+<a name="130" href="#130">130</a> <strong class="jxr_keyword">this</strong>.ephemeralKey = ephemeralKey;
+<a name="131" href="#131">131</a> <strong class="jxr_keyword">this</strong>.tokenIdentifier = tokenIdentifier;
+<a name="132" href="#132">132</a> }
+<a name="133" href="#133">133</a>
+<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">/**</em>
+<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @param ephemeralKey The ephemeralKey to set.</em>
+<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> */</em>
+<a name="137" href="#137">137</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setExternalKey(byte[] ephemeralKey, Element strElem) {
+<a name="138" href="#138">138</a> <strong class="jxr_keyword">this</strong>.ephemeralKey = ephemeralKey;
+<a name="139" href="#139">139</a> <strong class="jxr_keyword">this</strong>.strElem = strElem;
+<a name="140" href="#140">140</a> }
+<a name="141" href="#141">141</a>
+<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em>
+<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @return Returns the tokenIdentifier.</em>
+<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> */</em>
+<a name="145" href="#145">145</a> <strong class="jxr_keyword">public</strong> String getTokenIdentifier() {
+<a name="146" href="#146">146</a> <strong class="jxr_keyword">return</strong> tokenIdentifier;
+<a name="147" href="#147">147</a> }
+<a name="148" href="#148">148</a>
+<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">/**</em>
+<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * Get the id generated during <code>prepare()</code>.</em>
+<a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * </em>
+<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * Returns the the value of wsu:Id attribute of the DerivedKeyToken element.</em>
+<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * </em>
+<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * @return Return the wsu:Id of this token or null if <code>prepare()</code></em>
+<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * was not called before.</em>
+<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> */</em>
+<a name="157" href="#157">157</a> <strong class="jxr_keyword">public</strong> String getId() {
+<a name="158" href="#158">158</a> <strong class="jxr_keyword">return</strong> dktId;
+<a name="159" href="#159">159</a> }
+<a name="160" href="#160">160</a>
+<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">/**</em>
+<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * Set the label value of the client.</em>
+<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @param clientLabel</em>
+<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> */</em>
+<a name="165" href="#165">165</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setClientLabel(String clientLabel) {
+<a name="166" href="#166">166</a> <strong class="jxr_keyword">this</strong>.clientLabel = clientLabel;
+<a name="167" href="#167">167</a> }
+<a name="168" href="#168">168</a>
+<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">/**</em>
+<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * Set the label value of the service.</em>
+<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @param serviceLabel</em>
+<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> */</em>
+<a name="173" href="#173">173</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setServiceLabel(String serviceLabel) {
+<a name="174" href="#174">174</a> <strong class="jxr_keyword">this</strong>.serviceLabel = serviceLabel;
+<a name="175" href="#175">175</a> }
+<a name="176" href="#176">176</a>
+<a name="177" href="#177">177</a> <em class="jxr_javadoccomment">/**</em>
+<a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * Initialize a WSSec Derived key.</em>
+<a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * </em>
+<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * The method prepares and initializes a WSSec derived key structure after the</em>
+<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * relevant information was set. This method also creates and initializes the</em>
+<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * derived token using the ephemeral key. After preparation references</em>
+<a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * can be added, encrypted and signed as required.</em>
+<a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * </em>
+<a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * This method does not add any element to the security header. This must be</em>
+<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * done explicitly.</em>
+<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * </em>
+<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @param doc The unsigned SOAP envelope as <code>Document</code></em>
+<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em>
+<a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> */</em>
+<a name="191" href="#191">191</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare(Document doc) <strong class="jxr_keyword">throws</strong> WSSecurityException, ConversationException {
+<a name="192" href="#192">192</a>
+<a name="193" href="#193">193</a> document = doc;
+<a name="194" href="#194">194</a>
+<a name="195" href="#195">195</a> <em class="jxr_comment">// Create the derived keys</em>
+<a name="196" href="#196">196</a> <em class="jxr_comment">// At this point figure out the key length according to the symencAlgo</em>
+<a name="197" href="#197">197</a> <strong class="jxr_keyword">int</strong> offset = 0;
+<a name="198" href="#198">198</a> <strong class="jxr_keyword">int</strong> length = getDerivedKeyLength();
+<a name="199" href="#199">199</a> byte[] label;
+<a name="200" href="#200">200</a> <strong class="jxr_keyword">try</strong> {
+<a name="201" href="#201">201</a> label = (clientLabel + serviceLabel).getBytes(<span class="jxr_string">"UTF-8"</span>);
+<a name="202" href="#202">202</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) {
+<a name="203" href="#203">203</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(<span class="jxr_string">"UTF-8 encoding is not supported"</span>, e);
+<a name="204" href="#204">204</a> }
+<a name="205" href="#205">205</a> byte[] nonce = WSSecurityUtil.generateNonce(16);
+<a name="206" href="#206">206</a>
+<a name="207" href="#207">207</a> byte[] seed = <strong class="jxr_keyword">new</strong> byte[label.length + nonce.length];
+<a name="208" href="#208">208</a> System.arraycopy(label, 0, seed, 0, label.length);
+<a name="209" href="#209">209</a> System.arraycopy(nonce, 0, seed, label.length, nonce.length);
+<a name="210" href="#210">210</a>
+<a name="211" href="#211">211</a> <a href="../../../../../org/apache/ws/security/conversation/ConversationConstants.html">DerivationAlgorithm</a> algo =
+<a name="212" href="#212">212</a> AlgoFactory.getInstance(ConversationConstants.DerivationAlgorithm.P_SHA_1);
+<a name="213" href="#213">213</a>
+<a name="214" href="#214">214</a> derivedKeyBytes = algo.createKey(ephemeralKey, seed, offset, length);
+<a name="215" href="#215">215</a>
+<a name="216" href="#216">216</a> <em class="jxr_comment">// Add the DKTs</em>
+<a name="217" href="#217">217</a> dkt = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/DerivedKeyToken.html">DerivedKeyToken</a>(wscVersion, document);
+<a name="218" href="#218">218</a> dktId = getWsConfig().getIdAllocator().createId(<span class="jxr_string">"DK-"</span>, dkt);
+<a name="219" href="#219">219</a>
+<a name="220" href="#220">220</a> dkt.setOffset(offset);
+<a name="221" href="#221">221</a> dkt.setLength(length);
+<a name="222" href="#222">222</a> dkt.setNonce(Base64.encode(nonce));
+<a name="223" href="#223">223</a> dkt.setID(dktId);
+<a name="224" href="#224">224</a>
+<a name="225" href="#225">225</a> <strong class="jxr_keyword">if</strong> (strElem == <strong class="jxr_keyword">null</strong>) {
+<a name="226" href="#226">226</a> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> secRef = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a>(document);
+<a name="227" href="#227">227</a> String strUri = getWsConfig().getIdAllocator().createSecureId(<span class="jxr_string">"STR-"</span>, secRef);
+<a name="228" href="#228">228</a> secRef.setID(strUri);
+<a name="229" href="#229">229</a>
+<a name="230" href="#230">230</a> <strong class="jxr_keyword">switch</strong> (keyIdentifierType) {
+<a name="231" href="#231">231</a> <strong class="jxr_keyword">case</strong> WSConstants.CUSTOM_KEY_IDENTIFIER:
+<a name="232" href="#232">232</a> secRef.setKeyIdentifier(customValueType, tokenIdentifier);
+<a name="233" href="#233">233</a> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML_KI_VALUE_TYPE.equals(customValueType)) {
+<a name="234" href="#234">234</a> secRef.addTokenType(WSConstants.WSS_SAML_TOKEN_TYPE);
+<a name="235" href="#235">235</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML2_KI_VALUE_TYPE.equals(customValueType)) {
+<a name="236" href="#236">236</a> secRef.addTokenType(WSConstants.WSS_SAML2_TOKEN_TYPE);
+<a name="237" href="#237">237</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_ENC_KEY_VALUE_TYPE.equals(customValueType)) {
+<a name="238" href="#238">238</a> secRef.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE);
+<a name="239" href="#239">239</a> }
+<a name="240" href="#240">240</a> <strong class="jxr_keyword">break</strong>;
+<a name="241" href="#241">241</a> <strong class="jxr_keyword">default</strong>:
+<a name="242" href="#242">242</a> <a href="../../../../../org/apache/ws/security/message/token/Reference.html">Reference</a> ref = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/Reference.html">Reference</a>(document);
+<a name="243" href="#243">243</a>
+<a name="244" href="#244">244</a> <strong class="jxr_keyword">if</strong> (tokenIdDirectId) {
+<a name="245" href="#245">245</a> ref.setURI(tokenIdentifier);
+<a name="246" href="#246">246</a> } <strong class="jxr_keyword">else</strong> {
+<a name="247" href="#247">247</a> ref.setURI(<span class="jxr_string">"#"</span> + tokenIdentifier);
+<a name="248" href="#248">248</a> }
+<a name="249" href="#249">249</a> <strong class="jxr_keyword">if</strong> (customValueType != <strong class="jxr_keyword">null</strong> && !<span class="jxr_string">""</span>.equals(customValueType)) {
+<a name="250" href="#250">250</a> ref.setValueType(customValueType);
+<a name="251" href="#251">251</a> }
+<a name="252" href="#252">252</a> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML_KI_VALUE_TYPE.equals(customValueType)) {
+<a name="253" href="#253">253</a> secRef.addTokenType(WSConstants.WSS_SAML_TOKEN_TYPE);
+<a name="254" href="#254">254</a> ref.setValueType(customValueType);
+<a name="255" href="#255">255</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML2_KI_VALUE_TYPE.equals(customValueType)) {
+<a name="256" href="#256">256</a> secRef.addTokenType(WSConstants.WSS_SAML2_TOKEN_TYPE);
+<a name="257" href="#257">257</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_ENC_KEY_VALUE_TYPE.equals(customValueType)) {
+<a name="258" href="#258">258</a> secRef.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE);
+<a name="259" href="#259">259</a> ref.setValueType(customValueType);
+<a name="260" href="#260">260</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (KerberosSecurity.isKerberosToken(customValueType)) {
+<a name="261" href="#261">261</a> secRef.addTokenType(customValueType);
+<a name="262" href="#262">262</a> ref.setValueType(customValueType);
+<a name="263" href="#263">263</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSC_SCT.equals(customValueType)) {
+<a name="264" href="#264">264</a> ref.setValueType(customValueType);
+<a name="265" href="#265">265</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!WSConstants.WSS_USERNAME_TOKEN_VALUE_TYPE.equals(customValueType)) {
+<a name="266" href="#266">266</a> secRef.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE);
+<a name="267" href="#267">267</a> }
+<a name="268" href="#268">268</a>
+<a name="269" href="#269">269</a> secRef.setReference(ref);
+<a name="270" href="#270">270</a> }
+<a name="271" href="#271">271</a>
+<a name="272" href="#272">272</a> dkt.setSecurityTokenReference(secRef);
+<a name="273" href="#273">273</a> } <strong class="jxr_keyword">else</strong> {
+<a name="274" href="#274">274</a> dkt.setSecurityTokenReference(strElem);
+<a name="275" href="#275">275</a> }
+<a name="276" href="#276">276</a> }
+<a name="277" href="#277">277</a>
+<a name="278" href="#278">278</a>
+<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">/**</em>
+<a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * Prepend the DerivedKey element to the elements already in the Security</em>
+<a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * header.</em>
+<a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * </em>
+<a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * The method can be called any time after <code>prepare()</code>. This</em>
+<a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * allows to insert the DerivedKey element at any position in the Security</em>
+<a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * header.</em>
+<a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * </em>
+<a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * @param secHeader The security header that holds the Signature element.</em>
+<a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> */</em>
+<a name="289" href="#289">289</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prependDKElementToHeader(<a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) {
+<a name="290" href="#290">290</a> WSSecurityUtil.prependChildElement(
+<a name="291" href="#291">291</a> secHeader.getSecurityHeader(), dkt.getElement()
+<a name="292" href="#292">292</a> );
+<a name="293" href="#293">293</a> }
+<a name="294" href="#294">294</a>
+<a name="295" href="#295">295</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> appendDKElementToHeader(<a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) {
+<a name="296" href="#296">296</a> Element secHeaderElement = secHeader.getSecurityHeader();
+<a name="297" href="#297">297</a> secHeaderElement.appendChild(dkt.getElement());
+<a name="298" href="#298">298</a> }
+<a name="299" href="#299">299</a>
+<a name="300" href="#300">300</a> <em class="jxr_javadoccomment">/**</em>
+<a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> * @param wscVersion The wscVersion to set.</em>
+<a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> */</em>
+<a name="303" href="#303">303</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setWscVersion(<strong class="jxr_keyword">int</strong> wscVersion) {
+<a name="304" href="#304">304</a> <strong class="jxr_keyword">this</strong>.wscVersion = wscVersion;
+<a name="305" href="#305">305</a> }
+<a name="306" href="#306">306</a>
+<a name="307" href="#307">307</a> <strong class="jxr_keyword">public</strong> Element getdktElement() {
+<a name="308" href="#308">308</a> <strong class="jxr_keyword">return</strong> dkt.getElement();
+<a name="309" href="#309">309</a> }
+<a name="310" href="#310">310</a>
+<a name="311" href="#311">311</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDerivedKeyLength(<strong class="jxr_keyword">int</strong> keyLength) {
+<a name="312" href="#312">312</a> derivedKeyLength = keyLength;
+<a name="313" href="#313">313</a> }
+<a name="314" href="#314">314</a>
+<a name="315" href="#315">315</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCustomValueType(String customValueType) {
+<a name="316" href="#316">316</a> <strong class="jxr_keyword">this</strong>.customValueType = customValueType;
+<a name="317" href="#317">317</a> }
+<a name="318" href="#318">318</a>
+<a name="319" href="#319">319</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTokenIdDirectId(<strong class="jxr_keyword">boolean</strong> b) {
+<a name="320" href="#320">320</a> tokenIdDirectId = b;
+<a name="321" href="#321">321</a> }
+<a name="322" href="#322">322</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>