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 [26/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/message/WSSecEncrypt.html
URL: http://svn.apache.org/viewvc/webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecEncrypt.html?rev=1178426&r1=1178425&r2=1178426&view=diff
==============================================================================
--- webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecEncrypt.html (original)
+++ webservices/wss4j/site/xref/org/apache/ws/security/message/WSSecEncrypt.html Mon Oct  3 15:15:52 2011
@@ -35,11 +35,11 @@
 <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.components.crypto.Crypto;
 <a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.components.crypto.CryptoType;
-<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.Reference;
-<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.SecurityTokenReference;
-<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.Base64;
-<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.WSSecurityUtil;
-<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.apache.xml.security.algorithms.JCEMapper;
+<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.KerberosSecurity;
+<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.Reference;
+<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.message.token.SecurityTokenReference;
+<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.Base64;
+<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.apache.ws.security.util.WSSecurityUtil;
 <a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.apache.xml.security.encryption.EncryptedData;
 <a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.apache.xml.security.encryption.XMLCipher;
 <a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> org.apache.xml.security.encryption.XMLEncryptionException;
@@ -53,662 +53,591 @@
 <a name="43" href="#43">43</a>  <strong class="jxr_keyword">import</strong> javax.crypto.KeyGenerator;
 <a name="44" href="#44">44</a>  <strong class="jxr_keyword">import</strong> javax.crypto.SecretKey;
 <a name="45" href="#45">45</a>  
-<a name="46" href="#46">46</a>  <strong class="jxr_keyword">import</strong> java.security.NoSuchAlgorithmException;
-<a name="47" href="#47">47</a>  <strong class="jxr_keyword">import</strong> java.security.cert.X509Certificate;
-<a name="48" href="#48">48</a>  <strong class="jxr_keyword">import</strong> java.util.ArrayList;
-<a name="49" href="#49">49</a>  <strong class="jxr_keyword">import</strong> java.util.List;
-<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"> * Encrypts a parts of a message according to WS Specification, X509 profile,</em>
-<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * and adds the encryption data.</em>
-<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * </em>
-<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * @author Davanum Srinivas (dims@yahoo.com).</em>
-<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * @author Werner Dittmann (Werner.Dittmann@apache.org).</em>
-<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> */</em>
-<a name="58" href="#58">58</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/ws/security/message/WSSecEncrypt.html">WSSecEncrypt</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/ws/security/message/WSSecEncryptedKey.html">WSSecEncryptedKey</a> {
-<a name="59" href="#59">59</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> org.apache.commons.logging.Log log = 
-<a name="60" href="#60">60</a>          org.apache.commons.logging.LogFactory.getLog(WSSecEncrypt.<strong class="jxr_keyword">class</strong>);
-<a name="61" href="#61">61</a>      
-<a name="62" href="#62">62</a>      <strong class="jxr_keyword">protected</strong> String symEncAlgo = WSConstants.AES_128;
-<a name="63" href="#63">63</a>  
-<a name="64" href="#64">64</a>      <strong class="jxr_keyword">protected</strong> byte[] embeddedKey = <strong class="jxr_keyword">null</strong>;
-<a name="65" href="#65">65</a>  
-<a name="66" href="#66">66</a>      <strong class="jxr_keyword">protected</strong> String embeddedKeyName = <strong class="jxr_keyword">null</strong>;
-<a name="67" href="#67">67</a>  
-<a name="68" href="#68">68</a>      <em class="jxr_javadoccomment">/**</em>
-<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     * Symmetric key used in the EncrytpedKey.</em>
-<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     */</em>
-<a name="71" href="#71">71</a>      <strong class="jxr_keyword">protected</strong> SecretKey symmetricKey = <strong class="jxr_keyword">null</strong>;
-<a name="72" href="#72">72</a>  
-<a name="73" href="#73">73</a>      <em class="jxr_javadoccomment">/**</em>
-<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * SecurityTokenReference to be inserted into EncryptedData/keyInfo element.</em>
-<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     */</em>
-<a name="76" href="#76">76</a>      <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> securityTokenReference = <strong class="jxr_keyword">null</strong>;
-<a name="77" href="#77">77</a>  
-<a name="78" href="#78">78</a>      <em class="jxr_javadoccomment">/**</em>
-<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * Indicates whether to encrypt the symmetric key into an EncryptedKey </em>
-<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     * or not.</em>
-<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     */</em>
-<a name="82" href="#82">82</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> encryptSymmKey = <strong class="jxr_keyword">true</strong>;
-<a name="83" href="#83">83</a>      
-<a name="84" href="#84">84</a>      <em class="jxr_javadoccomment">/**</em>
-<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * Custom reference value</em>
-<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     */</em>
-<a name="87" href="#87">87</a>      <strong class="jxr_keyword">private</strong> String customReferenceValue;
-<a name="88" href="#88">88</a>  
-<a name="89" href="#89">89</a>      <em class="jxr_javadoccomment">/**</em>
-<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * True if the encKeyId is a direct reference to a key identifier instead of a URI to a key</em>
-<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     */</em>
-<a name="92" href="#92">92</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> encKeyIdDirectId;
-<a name="93" href="#93">93</a>      
-<a name="94" href="#94">94</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> embedEncryptedKey;
-<a name="95" href="#95">95</a>   
-<a name="96" href="#96">96</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecEncrypt.html">WSSecEncrypt</a>() {
-<a name="97" href="#97">97</a>          <strong class="jxr_keyword">super</strong>();
-<a name="98" href="#98">98</a>      }
-<a name="99" href="#99">99</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecEncrypt.html">WSSecEncrypt</a>(<a href="../../../../../org/apache/ws/security/WSSConfig.html">WSSConfig</a> config) {
-<a name="100" href="#100">100</a>         <strong class="jxr_keyword">super</strong>(config);
-<a name="101" href="#101">101</a>     }
-<a name="102" href="#102">102</a>     
-<a name="103" href="#103">103</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     * Sets the key to use during embedded encryption.</em>
-<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">     * </em>
-<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">     * @param key to use during encryption. The key must fit the selected</em>
-<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">     *            symmetrical encryption algorithm</em>
-<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     */</em>
-<a name="109" href="#109">109</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKey(byte[] key) {
-<a name="110" href="#110">110</a>         embeddedKey = key;
-<a name="111" href="#111">111</a>     }
-<a name="112" href="#112">112</a> 
-<a name="113" href="#113">113</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * Sets the algorithm to encode the symmetric key.</em>
-<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     * </em>
-<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     * Default is the &lt;code&gt;WSConstants.KEYTRANSPORT_RSA15&lt;/code&gt; algorithm.</em>
-<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * </em>
-<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * @param keyEnc specifies the key encoding algorithm.</em>
-<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * @see WSConstants#KEYTRANSPORT_RSA15</em>
-<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * @see WSConstants#KEYTRANSPORT_RSAOEP</em>
-<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     */</em>
-<a name="122" href="#122">122</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKeyEnc(String keyEnc) {
-<a name="123" href="#123">123</a>         keyEncAlgo = keyEnc;
-<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">     * Set the key name for EMBEDDED_KEYNAME</em>
-<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * </em>
-<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     * @param embeddedKeyName</em>
-<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     */</em>
-<a name="131" href="#131">131</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEmbeddedKeyName(String embeddedKeyName) {
-<a name="132" href="#132">132</a>         <strong class="jxr_keyword">this</strong>.embeddedKeyName = embeddedKeyName;
-<a name="133" href="#133">133</a>     }
-<a name="134" href="#134">134</a>     
-<a name="135" href="#135">135</a>     
-<a name="136" href="#136">136</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     * Set the name of the symmetric encryption algorithm to use.</em>
+<a name="46" href="#46">46</a>  <strong class="jxr_keyword">import</strong> java.security.cert.X509Certificate;
+<a name="47" href="#47">47</a>  <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a name="48" href="#48">48</a>  <strong class="jxr_keyword">import</strong> java.util.List;
+<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"> * Encrypts a parts of a message according to WS Specification, X509 profile,</em>
+<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * and adds the encryption data.</em>
+<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * </em>
+<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * @author Davanum Srinivas (dims@yahoo.com).</em>
+<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * @author Werner Dittmann (Werner.Dittmann@apache.org).</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> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/ws/security/message/WSSecEncrypt.html">WSSecEncrypt</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/ws/security/message/WSSecEncryptedKey.html">WSSecEncryptedKey</a> {
+<a name="58" href="#58">58</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> org.apache.commons.logging.Log log = 
+<a name="59" href="#59">59</a>          org.apache.commons.logging.LogFactory.getLog(WSSecEncrypt.<strong class="jxr_keyword">class</strong>);
+<a name="60" href="#60">60</a>      
+<a name="61" href="#61">61</a>      <strong class="jxr_keyword">protected</strong> byte[] embeddedKey = <strong class="jxr_keyword">null</strong>;
+<a name="62" href="#62">62</a>  
+<a name="63" href="#63">63</a>      <strong class="jxr_keyword">protected</strong> String embeddedKeyName = <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">     * SecurityTokenReference to be inserted into EncryptedData/keyInfo element.</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> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> securityTokenReference = <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">     * Indicates whether to encrypt the symmetric key into an EncryptedKey </em>
+<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * or not.</em>
+<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="74" href="#74">74</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> encryptSymmKey = <strong class="jxr_keyword">true</strong>;
+<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">     * Custom reference 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">private</strong> String customReferenceValue;
+<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">     * True if the encKeyId is a direct reference to a key identifier instead of a URI to a key</em>
+<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="84" href="#84">84</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> encKeyIdDirectId;
+<a name="85" href="#85">85</a>      
+<a name="86" href="#86">86</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> embedEncryptedKey;
+<a name="87" href="#87">87</a>   
+<a name="88" href="#88">88</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecEncrypt.html">WSSecEncrypt</a>() {
+<a name="89" href="#89">89</a>          <strong class="jxr_keyword">super</strong>();
+<a name="90" href="#90">90</a>      }
+<a name="91" href="#91">91</a>      
+<a name="92" href="#92">92</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/WSSecEncrypt.html">WSSecEncrypt</a>(<a href="../../../../../org/apache/ws/security/WSSConfig.html">WSSConfig</a> config) {
+<a name="93" href="#93">93</a>          <strong class="jxr_keyword">super</strong>(config);
+<a name="94" href="#94">94</a>      }
+<a name="95" href="#95">95</a>      
+<a name="96" href="#96">96</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     * Sets the key to use during embedded encryption.</em>
+<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">     * </em>
+<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * @param key to use during encryption. The key must fit the selected</em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     *            symmetrical encryption algorithm</em>
+<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     */</em>
+<a name="102" href="#102">102</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKey(byte[] key) {
+<a name="103" href="#103">103</a>         embeddedKey = key;
+<a name="104" href="#104">104</a>     }
+<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">     * Sets the algorithm to encode the symmetric key.</em>
+<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * </em>
+<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * Default is the &lt;code&gt;WSConstants.KEYTRANSPORT_RSA15&lt;/code&gt; algorithm.</em>
+<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * </em>
+<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * @param keyEnc specifies the key encoding algorithm.</em>
+<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * @see WSConstants#KEYTRANSPORT_RSA15</em>
+<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * @see WSConstants#KEYTRANSPORT_RSAOEP</em>
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     */</em>
+<a name="115" href="#115">115</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKeyEnc(String keyEnc) {
+<a name="116" href="#116">116</a>         keyEncAlgo = keyEnc;
+<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">     * Set the key name for EMBEDDED_KEYNAME</em>
+<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * </em>
+<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * @param embeddedKeyName</em>
+<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     */</em>
+<a name="124" href="#124">124</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEmbeddedKeyName(String embeddedKeyName) {
+<a name="125" href="#125">125</a>         <strong class="jxr_keyword">this</strong>.embeddedKeyName = embeddedKeyName;
+<a name="126" href="#126">126</a>     }
+<a name="127" href="#127">127</a>     
+<a name="128" href="#128">128</a>     
+<a name="129" href="#129">129</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     * Initialize a WSSec Encrypt.</em>
+<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * </em>
+<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     * The method prepares and initializes a WSSec Encrypt structure after the</em>
+<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     * relevant information was set. After preparation of the token references</em>
+<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * can be added and encrypted.</em>
+<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * </em>
+<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     * This method does not add any element to the security header. This must be</em>
+<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     * done explicitly.</em>
 <a name="138" href="#138">138</a> <em class="jxr_javadoccomment">     * </em>
-<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     * This encryption algorithm is used to encrypt the data. If the algorithm</em>
-<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * is not set then AES128 is used. Refer to WSConstants which algorithms are</em>
-<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * supported.</em>
-<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * </em>
-<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     * @param algo Is the name of the encryption algorithm</em>
-<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     * @see WSConstants#TRIPLE_DES</em>
-<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     * @see WSConstants#AES_128</em>
-<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     * @see WSConstants#AES_192</em>
-<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     * @see WSConstants#AES_256</em>
-<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">     */</em>
-<a name="149" href="#149">149</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSymmetricEncAlgorithm(String algo) {
-<a name="150" href="#150">150</a>         symEncAlgo = algo;
-<a name="151" href="#151">151</a>     }
-<a name="152" href="#152">152</a> 
-<a name="153" href="#153">153</a>     
-<a name="154" href="#154">154</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * Get the name of symmetric encryption algorithm to use.</em>
-<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     * </em>
-<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">     * The name of the encryption algorithm to encrypt the data, i.e. the SOAP</em>
-<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * Body. Refer to WSConstants which algorithms are supported.</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 the name of the currently selected symmetric encryption algorithm</em>
-<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * @see WSConstants#TRIPLE_DES</em>
-<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     * @see WSConstants#AES_128</em>
-<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * @see WSConstants#AES_192</em>
-<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * @see WSConstants#AES_256</em>
-<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     */</em>
-<a name="166" href="#166">166</a>     <strong class="jxr_keyword">public</strong> String getSymmetricEncAlgorithm() {
-<a name="167" href="#167">167</a>         <strong class="jxr_keyword">return</strong> symEncAlgo;
-<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">     * Initialize a WSSec Encrypt.</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 Encrypt structure after the</em>
-<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     * relevant information was set. After preparation of the token references</em>
-<a name="175" href="#175">175</a> <em class="jxr_javadoccomment">     * can be added and encrypted.</em>
-<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     * </em>
-<a name="177" href="#177">177</a> <em class="jxr_javadoccomment">     * This method does not add any element to the security header. This must be</em>
-<a name="178" href="#178">178</a> <em class="jxr_javadoccomment">     * done explicitly.</em>
-<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">     * </em>
-<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * @param doc The SOAP envelope as &lt;code&gt;Document&lt;/code&gt;</em>
-<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * @param crypto An instance of the Crypto API to handle keystore and certificates</em>
-<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     * @throws WSSecurityException</em>
-<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     */</em>
-<a name="184" href="#184">184</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare(Document doc, <a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> crypto) <strong class="jxr_keyword">throws</strong> WSSecurityException {
-<a name="185" href="#185">185</a>         document = doc;
-<a name="186" href="#186">186</a> 
-<a name="187" href="#187">187</a>         <em class="jxr_comment">//</em>
-<a name="188" href="#188">188</a>         <em class="jxr_comment">// If no external key (symmetricalKey) was set generate an encryption</em>
-<a name="189" href="#189">189</a>         <em class="jxr_comment">// key (session key) for this Encrypt element. This key will be</em>
-<a name="190" href="#190">190</a>         <em class="jxr_comment">// encrypted using the public key of the receiver</em>
-<a name="191" href="#191">191</a>         <em class="jxr_comment">//</em>
-<a name="192" href="#192">192</a>         <strong class="jxr_keyword">if</strong> (ephemeralKey == <strong class="jxr_keyword">null</strong>) {
-<a name="193" href="#193">193</a>             <strong class="jxr_keyword">if</strong> (symmetricKey == <strong class="jxr_keyword">null</strong>) {
-<a name="194" href="#194">194</a>                 KeyGenerator keyGen = getKeyGenerator();
-<a name="195" href="#195">195</a>                 symmetricKey = keyGen.generateKey();
-<a name="196" href="#196">196</a>             } 
-<a name="197" href="#197">197</a>             ephemeralKey = symmetricKey.getEncoded();
-<a name="198" href="#198">198</a>         }
-<a name="199" href="#199">199</a>         
-<a name="200" href="#200">200</a>         <strong class="jxr_keyword">if</strong> (symmetricKey == <strong class="jxr_keyword">null</strong>) {
-<a name="201" href="#201">201</a>             symmetricKey = WSSecurityUtil.prepareSecretKey(symEncAlgo, ephemeralKey);
-<a name="202" href="#202">202</a>         }
-<a name="203" href="#203">203</a>         
-<a name="204" href="#204">204</a>         <em class="jxr_comment">//</em>
-<a name="205" href="#205">205</a>         <em class="jxr_comment">// Get the certificate that contains the public key for the public key</em>
-<a name="206" href="#206">206</a>         <em class="jxr_comment">// algorithm that will encrypt the generated symmetric (session) key.</em>
-<a name="207" href="#207">207</a>         <em class="jxr_comment">//</em>
-<a name="208" href="#208">208</a>         <strong class="jxr_keyword">if</strong> (encryptSymmKey) {
-<a name="209" href="#209">209</a>             X509Certificate remoteCert = useThisCert;
-<a name="210" href="#210">210</a>             <strong class="jxr_keyword">if</strong> (remoteCert == <strong class="jxr_keyword">null</strong>) {
-<a name="211" href="#211">211</a>                 <a href="../../../../../org/apache/ws/security/components/crypto/CryptoType.html">CryptoType</a> cryptoType = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/components/crypto/CryptoType.html">CryptoType</a>(CryptoType.TYPE.ALIAS);
-<a name="212" href="#212">212</a>                 cryptoType.setAlias(user);
-<a name="213" href="#213">213</a>                 X509Certificate[] certs = crypto.getX509Certificates(cryptoType);
-<a name="214" href="#214">214</a>                 <strong class="jxr_keyword">if</strong> (certs == <strong class="jxr_keyword">null</strong> || certs.length &lt;= 0) {
-<a name="215" href="#215">215</a>                     <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(
-<a name="216" href="#216">216</a>                         WSSecurityException.FAILURE,
-<a name="217" href="#217">217</a>                         <span class="jxr_string">"noUserCertsFound"</span>, 
-<a name="218" href="#218">218</a>                         <strong class="jxr_keyword">new</strong> Object[] { user, <span class="jxr_string">"encryption"</span> }
-<a name="219" href="#219">219</a>                     );
-<a name="220" href="#220">220</a>                 }
-<a name="221" href="#221">221</a>                 remoteCert = certs[0];
-<a name="222" href="#222">222</a>             }
-<a name="223" href="#223">223</a>             prepareInternal(ephemeralKey, remoteCert, crypto);
-<a name="224" href="#224">224</a>         } <strong class="jxr_keyword">else</strong> {
-<a name="225" href="#225">225</a>             encryptedEphemeralKey = ephemeralKey;
-<a name="226" href="#226">226</a>         }
-<a name="227" href="#227">227</a>     }
-<a name="228" href="#228">228</a>     
-<a name="229" href="#229">229</a> 
-<a name="230" href="#230">230</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     * Builds the SOAP envelope with encrypted Body and adds encrypted key.</em>
-<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     * </em>
-<a name="233" href="#233">233</a> <em class="jxr_javadoccomment">     * This is a convenience method and for backward compatibility. The method</em>
-<a name="234" href="#234">234</a> <em class="jxr_javadoccomment">     * calls the single function methods in order to perform a &lt;i&gt;one shot</em>
-<a name="235" href="#235">235</a> <em class="jxr_javadoccomment">     * encryption&lt;/i&gt;. This method is compatible with the build method of the</em>
-<a name="236" href="#236">236</a> <em class="jxr_javadoccomment">     * previous version with the exception of the additional WSSecHeader</em>
-<a name="237" href="#237">237</a> <em class="jxr_javadoccomment">     * parameter.</em>
-<a name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * </em>
-<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">     * @param doc the SOAP envelope as &lt;code&gt;Document&lt;/code&gt; with plain text Body</em>
-<a name="240" href="#240">240</a> <em class="jxr_javadoccomment">     * @param crypto an instance of the Crypto API to handle keystore and Certificates</em>
-<a name="241" href="#241">241</a> <em class="jxr_javadoccomment">     * @param secHeader the security header element to hold the encrypted key element.</em>
-<a name="242" href="#242">242</a> <em class="jxr_javadoccomment">     * @return the SOAP envelope with encrypted Body as &lt;code&gt;Document&lt;/code&gt;</em>
-<a name="243" href="#243">243</a> <em class="jxr_javadoccomment">     * @throws WSSecurityException</em>
-<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     */</em>
-<a name="245" href="#245">245</a>     <strong class="jxr_keyword">public</strong> Document build(Document doc, <a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> crypto, <a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader)
-<a name="246" href="#246">246</a>         <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a> {
-<a name="247" href="#247">247</a>         doDebug = log.isDebugEnabled();
-<a name="248" href="#248">248</a> 
-<a name="249" href="#249">249</a>         <strong class="jxr_keyword">if</strong> (keyIdentifierType == WSConstants.EMBEDDED_KEYNAME
-<a name="250" href="#250">250</a>             || keyIdentifierType == WSConstants.EMBED_SECURITY_TOKEN_REF) {
-<a name="251" href="#251">251</a>             encryptSymmKey = false;
-<a name="252" href="#252">252</a>             document = doc;
-<a name="253" href="#253">253</a>             <em class="jxr_comment">//</em>
-<a name="254" href="#254">254</a>             <em class="jxr_comment">// Generate a symmetric key from the specified key (password) for this</em>
-<a name="255" href="#255">255</a>             <em class="jxr_comment">// algorithm, and set the cipher into encryption mode.</em>
-<a name="256" href="#256">256</a>             <em class="jxr_comment">//</em>
-<a name="257" href="#257">257</a>             <strong class="jxr_keyword">if</strong> (symmetricKey == <strong class="jxr_keyword">null</strong>) {
-<a name="258" href="#258">258</a>                 <strong class="jxr_keyword">if</strong> (embeddedKey == <strong class="jxr_keyword">null</strong>) {
-<a name="259" href="#259">259</a>                     <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(WSSecurityException.FAILURE, <span class="jxr_string">"noKeySupplied"</span>);
-<a name="260" href="#260">260</a>                 }
-<a name="261" href="#261">261</a>                 symmetricKey = WSSecurityUtil.prepareSecretKey(symEncAlgo, embeddedKey);
-<a name="262" href="#262">262</a>             }
-<a name="263" href="#263">263</a>         } <strong class="jxr_keyword">else</strong> {
-<a name="264" href="#264">264</a>             prepare(doc, crypto);
-<a name="265" href="#265">265</a>         }
-<a name="266" href="#266">266</a>         
-<a name="267" href="#267">267</a>         <strong class="jxr_keyword">if</strong> (envelope == <strong class="jxr_keyword">null</strong>) {
-<a name="268" href="#268">268</a>             envelope = document.getDocumentElement();
-<a name="269" href="#269">269</a>         }
-<a name="270" href="#270">270</a>         
-<a name="271" href="#271">271</a>         <strong class="jxr_keyword">if</strong> (parts == <strong class="jxr_keyword">null</strong>) {
-<a name="272" href="#272">272</a>             parts = <strong class="jxr_keyword">new</strong> ArrayList&lt;WSEncryptionPart&gt;(1);
-<a name="273" href="#273">273</a>             String soapNamespace = WSSecurityUtil.getSOAPNamespace(envelope);
-<a name="274" href="#274">274</a>             <a href="../../../../../org/apache/ws/security/WSEncryptionPart.html">WSEncryptionPart</a> encP = 
-<a name="275" href="#275">275</a>                 <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSEncryptionPart.html">WSEncryptionPart</a>(
-<a name="276" href="#276">276</a>                     WSConstants.ELEM_BODY, 
-<a name="277" href="#277">277</a>                     soapNamespace, 
-<a name="278" href="#278">278</a>                     <span class="jxr_string">"Content"</span>
-<a name="279" href="#279">279</a>                 );
-<a name="280" href="#280">280</a>             parts.add(encP);
-<a name="281" href="#281">281</a>         }
-<a name="282" href="#282">282</a> 
-<a name="283" href="#283">283</a>         <strong class="jxr_keyword">if</strong> (doDebug) {
-<a name="284" href="#284">284</a>             log.debug(<span class="jxr_string">"Beginning Encryption..."</span>);
-<a name="285" href="#285">285</a>         }
-<a name="286" href="#286">286</a>         
-<a name="287" href="#287">287</a>         Element refs = encryptForRef(<strong class="jxr_keyword">null</strong>, parts);
-<a name="288" href="#288">288</a>         <strong class="jxr_keyword">if</strong> (encryptedKeyElement != <strong class="jxr_keyword">null</strong>) {
-<a name="289" href="#289">289</a>             addInternalRefElement(refs);
-<a name="290" href="#290">290</a>             prependToHeader(secHeader); 
-<a name="291" href="#291">291</a>         } <strong class="jxr_keyword">else</strong> {
-<a name="292" href="#292">292</a>             addExternalRefElement(refs, secHeader);
-<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">if</strong> (bstToken != <strong class="jxr_keyword">null</strong>) {
-<a name="296" href="#296">296</a>             prependBSTElementToHeader(secHeader);
-<a name="297" href="#297">297</a>         }
-<a name="298" href="#298">298</a> 
-<a name="299" href="#299">299</a>         log.debug(<span class="jxr_string">"Encryption complete."</span>);
-<a name="300" href="#300">300</a>         <strong class="jxr_keyword">return</strong> doc;
-<a name="301" href="#301">301</a>     }
-<a name="302" href="#302">302</a>     
-<a name="303" href="#303">303</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="304" href="#304">304</a> <em class="jxr_javadoccomment">     * Encrypt one or more parts or elements of the message.</em>
-<a name="305" href="#305">305</a> <em class="jxr_javadoccomment">     * </em>
-<a name="306" href="#306">306</a> <em class="jxr_javadoccomment">     * This method takes a vector of &lt;code&gt;WSEncryptionPart&lt;/code&gt; object that</em>
-<a name="307" href="#307">307</a> <em class="jxr_javadoccomment">     * contain information about the elements to encrypt. The method call the</em>
-<a name="308" href="#308">308</a> <em class="jxr_javadoccomment">     * encryption method, takes the reference information generated during</em>
-<a name="309" href="#309">309</a> <em class="jxr_javadoccomment">     * encryption and add this to the &lt;code&gt;xenc:Reference&lt;/code&gt; element.</em>
-<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">     * This method can be called after &lt;code&gt;prepare()&lt;/code&gt; and can be</em>
-<a name="311" href="#311">311</a> <em class="jxr_javadoccomment">     * called multiple times to encrypt a number of parts or elements.</em>
-<a name="312" href="#312">312</a> <em class="jxr_javadoccomment">     * </em>
-<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">     * The method generates a &lt;code&gt;xenc:Reference&lt;/code&gt; element that &lt;i&gt;must&lt;/i&gt;</em>
-<a name="314" href="#314">314</a> <em class="jxr_javadoccomment">     * be added to this token. See &lt;code&gt;addInternalRefElement()&lt;/code&gt;.</em>
-<a name="315" href="#315">315</a> <em class="jxr_javadoccomment">     * </em>
-<a name="316" href="#316">316</a> <em class="jxr_javadoccomment">     * If the &lt;code&gt;dataRef&lt;/code&gt; parameter is &lt;code&gt;null&lt;/code&gt; the method</em>
-<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">     * creates and initializes a new Reference element.</em>
-<a name="318" href="#318">318</a> <em class="jxr_javadoccomment">     * </em>
-<a name="319" href="#319">319</a> <em class="jxr_javadoccomment">     * @param dataRef A &lt;code&gt;xenc:Reference&lt;/code&gt; element or &lt;code&gt;null&lt;/code&gt;</em>
-<a name="320" href="#320">320</a> <em class="jxr_javadoccomment">     * @param references A list containing WSEncryptionPart objects</em>
-<a name="321" href="#321">321</a> <em class="jxr_javadoccomment">     * @return Returns the updated &lt;code&gt;xenc:Reference&lt;/code&gt; element</em>
-<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">     * @throws WSSecurityException</em>
-<a name="323" href="#323">323</a> <em class="jxr_javadoccomment">     */</em>
-<a name="324" href="#324">324</a>     <strong class="jxr_keyword">public</strong> Element encryptForRef(
-<a name="325" href="#325">325</a>         Element dataRef, 
-<a name="326" href="#326">326</a>         List&lt;WSEncryptionPart&gt; references
-<a name="327" href="#327">327</a>     ) <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a> {
-<a name="328" href="#328">328</a> 
-<a name="329" href="#329">329</a>         KeyInfo keyInfo = createKeyInfo();
-<a name="330" href="#330">330</a>         List&lt;String&gt; encDataRefs = 
-<a name="331" href="#331">331</a>             doEncryption(
-<a name="332" href="#332">332</a>                 document, getWsConfig(), keyInfo, symmetricKey, symEncAlgo, references, callbackLookup
-<a name="333" href="#333">333</a>             );
-<a name="334" href="#334">334</a>         <strong class="jxr_keyword">if</strong> (dataRef == <strong class="jxr_keyword">null</strong>) {
-<a name="335" href="#335">335</a>             dataRef = 
-<a name="336" href="#336">336</a>                 document.createElementNS(
-<a name="337" href="#337">337</a>                     WSConstants.ENC_NS,
-<a name="338" href="#338">338</a>                     WSConstants.ENC_PREFIX + <span class="jxr_string">":ReferenceList"</span>
-<a name="339" href="#339">339</a>                 );
-<a name="340" href="#340">340</a>             <em class="jxr_comment">//</em>
-<a name="341" href="#341">341</a>             <em class="jxr_comment">// If we're not placing the ReferenceList in an EncryptedKey structure,</em>
-<a name="342" href="#342">342</a>             <em class="jxr_comment">// then add the ENC namespace</em>
-<a name="343" href="#343">343</a>             <em class="jxr_comment">//</em>
-<a name="344" href="#344">344</a>             <strong class="jxr_keyword">if</strong> (!encryptSymmKey) {
-<a name="345" href="#345">345</a>                 WSSecurityUtil.setNamespace(
-<a name="346" href="#346">346</a>                     dataRef, WSConstants.ENC_NS, WSConstants.ENC_PREFIX
-<a name="347" href="#347">347</a>                 );
-<a name="348" href="#348">348</a>             }
-<a name="349" href="#349">349</a>         }
-<a name="350" href="#350">350</a>         <strong class="jxr_keyword">return</strong> createDataRefList(document, dataRef, encDataRefs);
-<a name="351" href="#351">351</a>     }
-<a name="352" href="#352">352</a> 
-<a name="353" href="#353">353</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">     * @deprecated Use encryptForRef(dataRef, references) instead</em>
-<a name="355" href="#355">355</a> <em class="jxr_javadoccomment">     */</em>
-<a name="356" href="#356">356</a>     <strong class="jxr_keyword">public</strong> Element encryptForInternalRef(Element dataRef, List&lt;WSEncryptionPart&gt; references)
-<a name="357" href="#357">357</a>         <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a> {
-<a name="358" href="#358">358</a>         <strong class="jxr_keyword">return</strong> encryptForRef(dataRef, references);
-<a name="359" href="#359">359</a>     }
-<a name="360" href="#360">360</a> 
-<a name="361" href="#361">361</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="362" href="#362">362</a> <em class="jxr_javadoccomment">     * @deprecated Use encryptForRef(dataRef, references) instead</em>
-<a name="363" href="#363">363</a> <em class="jxr_javadoccomment">     */</em>
-<a name="364" href="#364">364</a>     <strong class="jxr_keyword">public</strong> Element encryptForExternalRef(Element dataRef, List&lt;WSEncryptionPart&gt; references)
-<a name="365" href="#365">365</a>         <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a> {
-<a name="366" href="#366">366</a>         <strong class="jxr_keyword">return</strong> encryptForRef(dataRef, references);
-<a name="367" href="#367">367</a>     }
-<a name="368" href="#368">368</a> 
-<a name="369" href="#369">369</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="370" href="#370">370</a> <em class="jxr_javadoccomment">     * Adds the internal Reference element to this Encrypt data.</em>
-<a name="371" href="#371">371</a> <em class="jxr_javadoccomment">     * </em>
-<a name="372" href="#372">372</a> <em class="jxr_javadoccomment">     * The reference element &lt;i&gt;must&lt;/i&gt; be created by the</em>
-<a name="373" href="#373">373</a> <em class="jxr_javadoccomment">     * &lt;code&gt;encryptForInternalRef()&lt;/code&gt; method. The reference element is</em>
-<a name="374" href="#374">374</a> <em class="jxr_javadoccomment">     * added to the &lt;code&gt;EncryptedKey&lt;/code&gt; element of this encrypt block.</em>
-<a name="375" href="#375">375</a> <em class="jxr_javadoccomment">     * </em>
-<a name="376" href="#376">376</a> <em class="jxr_javadoccomment">     * @param dataRef The internal &lt;code&gt;enc:Reference&lt;/code&gt; element</em>
-<a name="377" href="#377">377</a> <em class="jxr_javadoccomment">     */</em>
-<a name="378" href="#378">378</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addInternalRefElement(Element dataRef) {
-<a name="379" href="#379">379</a>         encryptedKeyElement.appendChild(dataRef);
-<a name="380" href="#380">380</a>     }
-<a name="381" href="#381">381</a> 
-<a name="382" href="#382">382</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="383" href="#383">383</a> <em class="jxr_javadoccomment">     * Adds (prepends) the external Reference element to the Security header.</em>
-<a name="384" href="#384">384</a> <em class="jxr_javadoccomment">     * </em>
-<a name="385" href="#385">385</a> <em class="jxr_javadoccomment">     * The reference element &lt;i&gt;must&lt;/i&gt; be created by the</em>
-<a name="386" href="#386">386</a> <em class="jxr_javadoccomment">     * &lt;code&gt;encryptForExternalRef() &lt;/code&gt; method. The method prepends the</em>
-<a name="387" href="#387">387</a> <em class="jxr_javadoccomment">     * reference element in the SecurityHeader.</em>
-<a name="388" href="#388">388</a> <em class="jxr_javadoccomment">     * </em>
-<a name="389" href="#389">389</a> <em class="jxr_javadoccomment">     * @param dataRef The external &lt;code&gt;enc:Reference&lt;/code&gt; element</em>
-<a name="390" href="#390">390</a> <em class="jxr_javadoccomment">     * @param secHeader The security header.</em>
-<a name="391" href="#391">391</a> <em class="jxr_javadoccomment">     */</em>
-<a name="392" href="#392">392</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addExternalRefElement(Element dataRef, <a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader) {
-<a name="393" href="#393">393</a>         WSSecurityUtil.prependChildElement(secHeader.getSecurityHeader(), dataRef);
-<a name="394" href="#394">394</a>     }
-<a name="395" href="#395">395</a> 
-<a name="396" href="#396">396</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="397" href="#397">397</a> <em class="jxr_javadoccomment">     * Perform encryption on the SOAP envelope.</em>
-<a name="398" href="#398">398</a> <em class="jxr_javadoccomment">     * @param doc The document containing the SOAP envelope as document element</em>
-<a name="399" href="#399">399</a> <em class="jxr_javadoccomment">     * @param config The WSSConfig from which to generate wsu:ID's</em>
-<a name="400" href="#400">400</a> <em class="jxr_javadoccomment">     * @param keyInfo The KeyInfo object to set in EncryptedData</em>
-<a name="401" href="#401">401</a> <em class="jxr_javadoccomment">     * @param secretKey The SecretKey object with which to encrypt data</em>
-<a name="402" href="#402">402</a> <em class="jxr_javadoccomment">     * @param encryptionAlgorithm The encryption algorithm URI to use</em>
-<a name="403" href="#403">403</a> <em class="jxr_javadoccomment">     * @param references The list of references to encrypt</em>
-<a name="404" href="#404">404</a> <em class="jxr_javadoccomment">     * @return a List of references to EncryptedData elements</em>
-<a name="405" href="#405">405</a> <em class="jxr_javadoccomment">     * @throws WSSecurityException</em>
-<a name="406" href="#406">406</a> <em class="jxr_javadoccomment">     */</em>
-<a name="407" href="#407">407</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> List&lt;String&gt; doEncryption(
-<a name="408" href="#408">408</a>         Document doc,
-<a name="409" href="#409">409</a>         <a href="../../../../../org/apache/ws/security/WSSConfig.html">WSSConfig</a> config,
-<a name="410" href="#410">410</a>         KeyInfo keyInfo,
-<a name="411" href="#411">411</a>         SecretKey secretKey,
-<a name="412" href="#412">412</a>         String encryptionAlgorithm,
-<a name="413" href="#413">413</a>         List&lt;WSEncryptionPart&gt; references,
-<a name="414" href="#414">414</a>         <a href="../../../../../org/apache/ws/security/message/CallbackLookup.html">CallbackLookup</a> callbackLookup
-<a name="415" href="#415">415</a>     ) <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a> {
-<a name="416" href="#416">416</a> 
-<a name="417" href="#417">417</a>         XMLCipher xmlCipher = <strong class="jxr_keyword">null</strong>;
-<a name="418" href="#418">418</a>         <strong class="jxr_keyword">try</strong> {
-<a name="419" href="#419">419</a>             xmlCipher = XMLCipher.getInstance(encryptionAlgorithm);
-<a name="420" href="#420">420</a>         } <strong class="jxr_keyword">catch</strong> (XMLEncryptionException ex) {
-<a name="421" href="#421">421</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(
-<a name="422" href="#422">422</a>                 WSSecurityException.UNSUPPORTED_ALGORITHM, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>, ex
-<a name="423" href="#423">423</a>             );
-<a name="424" href="#424">424</a>         }
-<a name="425" href="#425">425</a> 
-<a name="426" href="#426">426</a>         List&lt;String&gt; encDataRef = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;();
-<a name="427" href="#427">427</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> part = 0; part &lt; references.size(); part++) {
-<a name="428" href="#428">428</a>             <a href="../../../../../org/apache/ws/security/WSEncryptionPart.html">WSEncryptionPart</a> encPart = references.get(part);
-<a name="429" href="#429">429</a>             <em class="jxr_comment">//</em>
-<a name="430" href="#430">430</a>             <em class="jxr_comment">// Get the data to encrypt.</em>
-<a name="431" href="#431">431</a>             <em class="jxr_comment">//</em>
-<a name="432" href="#432">432</a>             <strong class="jxr_keyword">if</strong> (callbackLookup == <strong class="jxr_keyword">null</strong>) {
-<a name="433" href="#433">433</a>                 callbackLookup = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/DOMCallbackLookup.html">DOMCallbackLookup</a>(doc);
-<a name="434" href="#434">434</a>             }
-<a name="435" href="#435">435</a>             List&lt;Element&gt; elementsToEncrypt = 
-<a name="436" href="#436">436</a>                 WSSecurityUtil.findElements(encPart, callbackLookup, doc);
-<a name="437" href="#437">437</a>             <strong class="jxr_keyword">if</strong> (elementsToEncrypt == <strong class="jxr_keyword">null</strong> || elementsToEncrypt.size() == 0) {
-<a name="438" href="#438">438</a>                 <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(
-<a name="439" href="#439">439</a>                     WSSecurityException.FAILURE,
-<a name="440" href="#440">440</a>                     <span class="jxr_string">"noEncElement"</span>, 
-<a name="441" href="#441">441</a>                     <strong class="jxr_keyword">new</strong> Object[] {<span class="jxr_string">"{"</span> + encPart.getNamespace() + <span class="jxr_string">"}"</span> + encPart.getName()}
-<a name="442" href="#442">442</a>                 );
-<a name="443" href="#443">443</a>             }
-<a name="444" href="#444">444</a> 
-<a name="445" href="#445">445</a>             String modifier = encPart.getEncModifier();
-<a name="446" href="#446">446</a>             <strong class="jxr_keyword">for</strong> (Element elementToEncrypt : elementsToEncrypt) {
-<a name="447" href="#447">447</a>                 String id = 
-<a name="448" href="#448">448</a>                     encryptElement(doc, elementToEncrypt, modifier, config, xmlCipher, 
-<a name="449" href="#449">449</a>                                    secretKey, keyInfo);
-<a name="450" href="#450">450</a>                 encPart.setEncId(id);
-<a name="451" href="#451">451</a>                 encDataRef.add(<span class="jxr_string">"#"</span> + id);
-<a name="452" href="#452">452</a>             }
-<a name="453" href="#453">453</a>                 
-<a name="454" href="#454">454</a>             <strong class="jxr_keyword">if</strong> (part != (references.size() - 1)) {
-<a name="455" href="#455">455</a>                 <strong class="jxr_keyword">try</strong> {
-<a name="456" href="#456">456</a>                     keyInfo = <strong class="jxr_keyword">new</strong> KeyInfo((Element) keyInfo.getElement().cloneNode(<strong class="jxr_keyword">true</strong>), <strong class="jxr_keyword">null</strong>);
-<a name="457" href="#457">457</a>                 } <strong class="jxr_keyword">catch</strong> (Exception ex) {
-<a name="458" href="#458">458</a>                     <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(
-<a name="459" href="#459">459</a>                         WSSecurityException.FAILED_ENCRYPTION, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>, ex
-<a name="460" href="#460">460</a>                     );
-<a name="461" href="#461">461</a>                 }
-<a name="462" href="#462">462</a>             }
-<a name="463" href="#463">463</a>         }
-<a name="464" href="#464">464</a>         <strong class="jxr_keyword">return</strong> encDataRef;
-<a name="465" href="#465">465</a>     }
-<a name="466" href="#466">466</a>     
-<a name="467" href="#467">467</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="468" href="#468">468</a> <em class="jxr_javadoccomment">     * Encrypt an element.</em>
-<a name="469" href="#469">469</a> <em class="jxr_javadoccomment">     */</em>
-<a name="470" href="#470">470</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String encryptElement(
-<a name="471" href="#471">471</a>         Document doc,
-<a name="472" href="#472">472</a>         Element elementToEncrypt,
-<a name="473" href="#473">473</a>         String modifier,
-<a name="474" href="#474">474</a>         <a href="../../../../../org/apache/ws/security/WSSConfig.html">WSSConfig</a> config,
-<a name="475" href="#475">475</a>         XMLCipher xmlCipher,
-<a name="476" href="#476">476</a>         SecretKey secretKey,
-<a name="477" href="#477">477</a>         KeyInfo keyInfo
-<a name="478" href="#478">478</a>     ) <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a> {
-<a name="479" href="#479">479</a> 
-<a name="480" href="#480">480</a>         <strong class="jxr_keyword">boolean</strong> content = <span class="jxr_string">"Content"</span>.equals(modifier) ? <strong class="jxr_keyword">true</strong> : false;
-<a name="481" href="#481">481</a>         <em class="jxr_comment">//</em>
-<a name="482" href="#482">482</a>         <em class="jxr_comment">// Encrypt data, and set necessary attributes in xenc:EncryptedData</em>
-<a name="483" href="#483">483</a>         <em class="jxr_comment">//</em>
-<a name="484" href="#484">484</a>         String xencEncryptedDataId = 
-<a name="485" href="#485">485</a>             config.getIdAllocator().createId(<span class="jxr_string">"ED-"</span>, elementToEncrypt);
-<a name="486" href="#486">486</a>         <strong class="jxr_keyword">try</strong> {
-<a name="487" href="#487">487</a>             String headerId = <span class="jxr_string">""</span>;
-<a name="488" href="#488">488</a>             <strong class="jxr_keyword">if</strong> (modifier.equals(<span class="jxr_string">"Header"</span>)) {
-<a name="489" href="#489">489</a>                 Element elem = 
-<a name="490" href="#490">490</a>                     doc.createElementNS(
-<a name="491" href="#491">491</a>                         WSConstants.WSSE11_NS, <span class="jxr_string">"wsse11:"</span> + WSConstants.ENCRYPTED_HEADER
-<a name="492" href="#492">492</a>                     );
-<a name="493" href="#493">493</a>                 WSSecurityUtil.setNamespace(elem, WSConstants.WSSE11_NS, WSConstants.WSSE11_PREFIX);
-<a name="494" href="#494">494</a>                 String wsuPrefix = 
-<a name="495" href="#495">495</a>                     WSSecurityUtil.setNamespace(elem, WSConstants.WSU_NS, WSConstants.WSU_PREFIX);
-<a name="496" href="#496">496</a>                 headerId = config.getIdAllocator().createId(<span class="jxr_string">"EH-"</span>, elementToEncrypt);
-<a name="497" href="#497">497</a>                 elem.setAttributeNS(
-<a name="498" href="#498">498</a>                     WSConstants.WSU_NS, wsuPrefix + <span class="jxr_string">":Id"</span>, headerId
-<a name="499" href="#499">499</a>                 );
-<a name="500" href="#500">500</a>                 <em class="jxr_comment">//</em>
-<a name="501" href="#501">501</a>                 <em class="jxr_comment">// Add the EncryptedHeader node to the element to be encrypted's parent</em>
-<a name="502" href="#502">502</a>                 <em class="jxr_comment">// (i.e. the SOAP header). Add the element to be encrypted to the Encrypted</em>
-<a name="503" href="#503">503</a>                 <em class="jxr_comment">// Header node as well</em>
-<a name="504" href="#504">504</a>                 <em class="jxr_comment">//</em>
-<a name="505" href="#505">505</a>                 Node parent = elementToEncrypt.getParentNode();
-<a name="506" href="#506">506</a>                 elementToEncrypt = (Element)parent.replaceChild(elem, elementToEncrypt);
-<a name="507" href="#507">507</a>                 elem.appendChild(elementToEncrypt);
-<a name="508" href="#508">508</a>                 
-<a name="509" href="#509">509</a>                 NamedNodeMap map = elementToEncrypt.getAttributes();
-<a name="510" href="#510">510</a>                 <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; map.getLength(); i++) {
-<a name="511" href="#511">511</a>                     Attr attr = (Attr)map.item(i);
-<a name="512" href="#512">512</a>                     <strong class="jxr_keyword">if</strong> (attr.getNamespaceURI().equals(WSConstants.URI_SOAP11_ENV)
-<a name="513" href="#513">513</a>                         || attr.getNamespaceURI().equals(WSConstants.URI_SOAP12_ENV)) {                         
-<a name="514" href="#514">514</a>                         String soapEnvPrefix = 
-<a name="515" href="#515">515</a>                             WSSecurityUtil.setNamespace(
-<a name="516" href="#516">516</a>                                 elem, attr.getNamespaceURI(), WSConstants.DEFAULT_SOAP_PREFIX
-<a name="517" href="#517">517</a>                             );
-<a name="518" href="#518">518</a>                         elem.setAttributeNS(
-<a name="519" href="#519">519</a>                             attr.getNamespaceURI(), 
-<a name="520" href="#520">520</a>                             soapEnvPrefix + <span class="jxr_string">":"</span> + attr.getLocalName(), 
-<a name="521" href="#521">521</a>                             attr.getValue()
-<a name="522" href="#522">522</a>                         );
-<a name="523" href="#523">523</a>                     }
-<a name="524" href="#524">524</a>                 }
-<a name="525" href="#525">525</a>             }
-<a name="526" href="#526">526</a>             
-<a name="527" href="#527">527</a>             xmlCipher.init(XMLCipher.ENCRYPT_MODE, secretKey);
-<a name="528" href="#528">528</a>             EncryptedData encData = xmlCipher.getEncryptedData();
-<a name="529" href="#529">529</a>             encData.setId(xencEncryptedDataId);
-<a name="530" href="#530">530</a>             encData.setKeyInfo(keyInfo);
-<a name="531" href="#531">531</a>             xmlCipher.doFinal(doc, elementToEncrypt, content);
-<a name="532" href="#532">532</a>             <strong class="jxr_keyword">return</strong> xencEncryptedDataId;
-<a name="533" href="#533">533</a>         } <strong class="jxr_keyword">catch</strong> (Exception ex) {
-<a name="534" href="#534">534</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(
-<a name="535" href="#535">535</a>                 WSSecurityException.FAILED_ENCRYPTION, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>, ex
-<a name="536" href="#536">536</a>             );
-<a name="537" href="#537">537</a>         }
-<a name="538" href="#538">538</a>     }
-<a name="539" href="#539">539</a>     
-<a name="540" href="#540">540</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="541" href="#541">541</a> <em class="jxr_javadoccomment">     * Create a KeyInfo object</em>
-<a name="542" href="#542">542</a> <em class="jxr_javadoccomment">     */</em>
-<a name="543" href="#543">543</a>     <strong class="jxr_keyword">private</strong> KeyInfo createKeyInfo() <strong class="jxr_keyword">throws</strong> WSSecurityException {
-<a name="544" href="#544">544</a> 
-<a name="545" href="#545">545</a>         KeyInfo keyInfo = <strong class="jxr_keyword">new</strong> KeyInfo(document);
-<a name="546" href="#546">546</a>         <strong class="jxr_keyword">if</strong> (embedEncryptedKey) {
-<a name="547" href="#547">547</a>             keyInfo.addUnknownElement(getEncryptedKeyElement());
-<a name="548" href="#548">548</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (keyIdentifierType == WSConstants.ENCRYPTED_KEY_SHA1_IDENTIFIER) {
-<a name="549" href="#549">549</a>             <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a>(document);
-<a name="550" href="#550">550</a>             secToken.addWSSENamespace();
-<a name="551" href="#551">551</a>             <strong class="jxr_keyword">if</strong> (customReferenceValue != <strong class="jxr_keyword">null</strong>) {
-<a name="552" href="#552">552</a>                 secToken.setKeyIdentifierEncKeySHA1(customReferenceValue);
-<a name="553" href="#553">553</a>             } <strong class="jxr_keyword">else</strong> {
-<a name="554" href="#554">554</a>                 byte[] encodedBytes = WSSecurityUtil.generateDigest(encryptedEphemeralKey);
-<a name="555" href="#555">555</a>                 secToken.setKeyIdentifierEncKeySHA1(Base64.encode(encodedBytes));
-<a name="556" href="#556">556</a>             }
-<a name="557" href="#557">557</a>             secToken.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE);
-<a name="558" href="#558">558</a>             keyInfo.addUnknownElement(secToken.getElement());
-<a name="559" href="#559">559</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (keyIdentifierType == WSConstants.EMBEDDED_KEYNAME) {
-<a name="560" href="#560">560</a>             keyInfo.addKeyName(embeddedKeyName == <strong class="jxr_keyword">null</strong> ? user : embeddedKeyName);
-<a name="561" href="#561">561</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML_KI_VALUE_TYPE.equals(customReferenceValue)) {
-<a name="562" href="#562">562</a>             <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a>(document);
-<a name="563" href="#563">563</a>             secToken.addTokenType(WSConstants.WSS_SAML_TOKEN_TYPE);
-<a name="564" href="#564">564</a>             secToken.setKeyIdentifier(WSConstants.WSS_SAML_KI_VALUE_TYPE, encKeyId);
-<a name="565" href="#565">565</a>             keyInfo.addUnknownElement(secToken.getElement());
-<a name="566" href="#566">566</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML2_KI_VALUE_TYPE.equals(customReferenceValue)) {
-<a name="567" href="#567">567</a>             <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a>(document);
-<a name="568" href="#568">568</a>             secToken.addTokenType(WSConstants.WSS_SAML2_TOKEN_TYPE);
-<a name="569" href="#569">569</a>             secToken.setKeyIdentifier(WSConstants.WSS_SAML2_KI_VALUE_TYPE, encKeyId);
-<a name="570" href="#570">570</a>             keyInfo.addUnknownElement(secToken.getElement());
-<a name="571" href="#571">571</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (securityTokenReference != <strong class="jxr_keyword">null</strong>) {
-<a name="572" href="#572">572</a>             Element tmpE = securityTokenReference.getElement();
-<a name="573" href="#573">573</a>             tmpE.setAttributeNS(
-<a name="574" href="#574">574</a>                 WSConstants.XMLNS_NS, <span class="jxr_string">"xmlns:"</span> + tmpE.getPrefix(), tmpE.getNamespaceURI()
-<a name="575" href="#575">575</a>             );
-<a name="576" href="#576">576</a>             keyInfo.addUnknownElement(securityTokenReference.getElement());
-<a name="577" href="#577">577</a>         } <strong class="jxr_keyword">else</strong> {
-<a name="578" href="#578">578</a>             <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a>(document);
-<a name="579" href="#579">579</a>             secToken.addWSSENamespace();
-<a name="580" href="#580">580</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="581" href="#581">581</a>             <strong class="jxr_keyword">if</strong> (encKeyIdDirectId) {
-<a name="582" href="#582">582</a>                 ref.setURI(encKeyId);
-<a name="583" href="#583">583</a>             } <strong class="jxr_keyword">else</strong> {
-<a name="584" href="#584">584</a>                 ref.setURI(<span class="jxr_string">"#"</span> + encKeyId);                    
-<a name="585" href="#585">585</a>             }
-<a name="586" href="#586">586</a>             <strong class="jxr_keyword">if</strong> (customReferenceValue != <strong class="jxr_keyword">null</strong>) {
-<a name="587" href="#587">587</a>                 ref.setValueType(customReferenceValue);
-<a name="588" href="#588">588</a>             }
-<a name="589" href="#589">589</a>             secToken.setReference(ref);
-<a name="590" href="#590">590</a>             secToken.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE);
-<a name="591" href="#591">591</a>             keyInfo.addUnknownElement(secToken.getElement());
-<a name="592" href="#592">592</a>         }
-<a name="593" href="#593">593</a>         Element keyInfoElement = keyInfo.getElement();
-<a name="594" href="#594">594</a>         keyInfoElement.setAttributeNS(
-<a name="595" href="#595">595</a>             WSConstants.XMLNS_NS, <span class="jxr_string">"xmlns:"</span> + WSConstants.SIG_PREFIX, WSConstants.SIG_NS
-<a name="596" href="#596">596</a>         );
-<a name="597" href="#597">597</a>         
-<a name="598" href="#598">598</a>         <strong class="jxr_keyword">return</strong> keyInfo;
-<a name="599" href="#599">599</a>     }
-<a name="600" href="#600">600</a> 
-<a name="601" href="#601">601</a> 
-<a name="602" href="#602">602</a>     <strong class="jxr_keyword">private</strong> KeyGenerator getKeyGenerator() <strong class="jxr_keyword">throws</strong> WSSecurityException {
-<a name="603" href="#603">603</a>         <strong class="jxr_keyword">try</strong> {
-<a name="604" href="#604">604</a>             <em class="jxr_comment">//</em>
-<a name="605" href="#605">605</a>             <em class="jxr_comment">// Assume AES as default, so initialize it</em>
-<a name="606" href="#606">606</a>             <em class="jxr_comment">//</em>
-<a name="607" href="#607">607</a>             String keyAlgorithm = JCEMapper.getJCEKeyAlgorithmFromURI(symEncAlgo);
-<a name="608" href="#608">608</a>             KeyGenerator keyGen = KeyGenerator.getInstance(keyAlgorithm);
-<a name="609" href="#609">609</a>             <strong class="jxr_keyword">if</strong> (symEncAlgo.equalsIgnoreCase(WSConstants.AES_128)) {
-<a name="610" href="#610">610</a>                 keyGen.init(128);
-<a name="611" href="#611">611</a>             } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (symEncAlgo.equalsIgnoreCase(WSConstants.AES_192)) {
-<a name="612" href="#612">612</a>                 keyGen.init(192);
-<a name="613" href="#613">613</a>             } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (symEncAlgo.equalsIgnoreCase(WSConstants.AES_256)) {
-<a name="614" href="#614">614</a>                 keyGen.init(256);
-<a name="615" href="#615">615</a>             }
-<a name="616" href="#616">616</a>             <strong class="jxr_keyword">return</strong> keyGen;
-<a name="617" href="#617">617</a>         } <strong class="jxr_keyword">catch</strong> (NoSuchAlgorithmException e) {
-<a name="618" href="#618">618</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(
-<a name="619" href="#619">619</a>                 WSSecurityException.UNSUPPORTED_ALGORITHM, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>, e
-<a name="620" href="#620">620</a>             );
-<a name="621" href="#621">621</a>         }
-<a name="622" href="#622">622</a>     }
-<a name="623" href="#623">623</a> 
-<a name="624" href="#624">624</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="625" href="#625">625</a> <em class="jxr_javadoccomment">     * Create DOM subtree for &lt;code&gt;xenc:EncryptedKey&lt;/code&gt;</em>
-<a name="626" href="#626">626</a> <em class="jxr_javadoccomment">     * </em>
-<a name="627" href="#627">627</a> <em class="jxr_javadoccomment">     * @param doc the SOAP envelope parent document</em>
-<a name="628" href="#628">628</a> <em class="jxr_javadoccomment">     * @param referenceList</em>
-<a name="629" href="#629">629</a> <em class="jxr_javadoccomment">     * @param encDataRefs</em>
-<a name="630" href="#630">630</a> <em class="jxr_javadoccomment">     * @return an &lt;code&gt;xenc:EncryptedKey&lt;/code&gt; element</em>
-<a name="631" href="#631">631</a> <em class="jxr_javadoccomment">     */</em>
-<a name="632" href="#632">632</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Element createDataRefList(
-<a name="633" href="#633">633</a>         Document doc,
-<a name="634" href="#634">634</a>         Element referenceList, 
-<a name="635" href="#635">635</a>         List&lt;String&gt; encDataRefs
-<a name="636" href="#636">636</a>     ) {
-<a name="637" href="#637">637</a>         <strong class="jxr_keyword">for</strong> (String dataReferenceUri : encDataRefs) {
-<a name="638" href="#638">638</a>             Element dataReference = 
-<a name="639" href="#639">639</a>                 doc.createElementNS(
-<a name="640" href="#640">640</a>                     WSConstants.ENC_NS, WSConstants.ENC_PREFIX + <span class="jxr_string">":DataReference"</span>
-<a name="641" href="#641">641</a>                 );
-<a name="642" href="#642">642</a>             dataReference.setAttributeNS(<strong class="jxr_keyword">null</strong>, <span class="jxr_string">"URI"</span>, dataReferenceUri);
-<a name="643" href="#643">643</a>             referenceList.appendChild(dataReference);
-<a name="644" href="#644">644</a>         }
-<a name="645" href="#645">645</a>         <strong class="jxr_keyword">return</strong> referenceList;
-<a name="646" href="#646">646</a>     }
-<a name="647" href="#647">647</a> 
-<a name="648" href="#648">648</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="649" href="#649">649</a> <em class="jxr_javadoccomment">     * @return The symmetric key</em>
-<a name="650" href="#650">650</a> <em class="jxr_javadoccomment">     */</em>
-<a name="651" href="#651">651</a>     <strong class="jxr_keyword">public</strong> SecretKey getSymmetricKey() {
-<a name="652" href="#652">652</a>         <strong class="jxr_keyword">return</strong> symmetricKey;
-<a name="653" href="#653">653</a>     }
-<a name="654" href="#654">654</a> 
-<a name="655" href="#655">655</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="656" href="#656">656</a> <em class="jxr_javadoccomment">     * Set the symmetric key to be used for encryption</em>
-<a name="657" href="#657">657</a> <em class="jxr_javadoccomment">     * </em>
-<a name="658" href="#658">658</a> <em class="jxr_javadoccomment">     * @param key</em>
-<a name="659" href="#659">659</a> <em class="jxr_javadoccomment">     */</em>
-<a name="660" href="#660">660</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSymmetricKey(SecretKey key) {
-<a name="661" href="#661">661</a>         <strong class="jxr_keyword">this</strong>.symmetricKey = key;
-<a name="662" href="#662">662</a>     }
-<a name="663" href="#663">663</a> 
-<a name="664" href="#664">664</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="665" href="#665">665</a> <em class="jxr_javadoccomment">     * @return Return the SecurityTokenRefernce</em>
-<a name="666" href="#666">666</a> <em class="jxr_javadoccomment">     */</em>
-<a name="667" href="#667">667</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> getSecurityTokenReference() {
-<a name="668" href="#668">668</a>         <strong class="jxr_keyword">return</strong> securityTokenReference;
-<a name="669" href="#669">669</a>     }
-<a name="670" href="#670">670</a> 
-<a name="671" href="#671">671</a>     <em class="jxr_javadoccomment">/**</em>
-<a name="672" href="#672">672</a> <em class="jxr_javadoccomment">     * @param reference</em>
-<a name="673" href="#673">673</a> <em class="jxr_javadoccomment">     */</em>
-<a name="674" href="#674">674</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSecurityTokenReference(<a href="../../../../../org/apache/ws/security/message/token/SecurityTokenReference.html">SecurityTokenReference</a> reference) {
-<a name="675" href="#675">675</a>         securityTokenReference = reference;
-<a name="676" href="#676">676</a>     }
-<a name="677" href="#677">677</a> 
-<a name="678" href="#678">678</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEncryptSymmKey() {
-<a name="679" href="#679">679</a>         <strong class="jxr_keyword">return</strong> encryptSymmKey;
-<a name="680" href="#680">680</a>     }
-<a name="681" href="#681">681</a>     
-<a name="682" href="#682">682</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEncryptSymmKey(<strong class="jxr_keyword">boolean</strong> encryptSymmKey) {
-<a name="683" href="#683">683</a>         <strong class="jxr_keyword">this</strong>.encryptSymmKey = encryptSymmKey;
-<a name="684" href="#684">684</a>     }
-<a name="685" href="#685">685</a>     
-<a name="686" href="#686">686</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCustomReferenceValue(String customReferenceValue) {
-<a name="687" href="#687">687</a>         <strong class="jxr_keyword">this</strong>.customReferenceValue = customReferenceValue;
-<a name="688" href="#688">688</a>     }
-<a name="689" href="#689">689</a>     
-<a name="690" href="#690">690</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEncKeyIdDirectId(<strong class="jxr_keyword">boolean</strong> b) {
-<a name="691" href="#691">691</a>         encKeyIdDirectId = b;
-<a name="692" href="#692">692</a>     }
-<a name="693" href="#693">693</a>     
-<a name="694" href="#694">694</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEmbedEncryptedKey(<strong class="jxr_keyword">boolean</strong> embedEncryptedKey) {
-<a name="695" href="#695">695</a>         <strong class="jxr_keyword">this</strong>.embedEncryptedKey = embedEncryptedKey;
-<a name="696" href="#696">696</a>     }
-<a name="697" href="#697">697</a>     
-<a name="698" href="#698">698</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEmbedEncryptedKey() {
-<a name="699" href="#699">699</a>         <strong class="jxr_keyword">return</strong> embedEncryptedKey;
-<a name="700" href="#700">700</a>     }
-<a name="701" href="#701">701</a> }
+<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     * @param doc The SOAP envelope as &lt;code&gt;Document&lt;/code&gt;</em>
+<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * @param crypto An instance of the Crypto API to handle keystore and certificates</em>
+<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * @throws WSSecurityException</em>
+<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     */</em>
+<a name="143" href="#143">143</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare(Document doc, <a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> crypto) <strong class="jxr_keyword">throws</strong> WSSecurityException {
+<a name="144" href="#144">144</a>         document = doc;
+<a name="145" href="#145">145</a> 
+<a name="146" href="#146">146</a>         <em class="jxr_comment">//</em>
+<a name="147" href="#147">147</a>         <em class="jxr_comment">// If no external key (symmetricalKey) was set generate an encryption</em>
+<a name="148" href="#148">148</a>         <em class="jxr_comment">// key (session key) for this Encrypt element. This key will be</em>
+<a name="149" href="#149">149</a>         <em class="jxr_comment">// encrypted using the public key of the receiver</em>
+<a name="150" href="#150">150</a>         <em class="jxr_comment">//</em>
+<a name="151" href="#151">151</a>         <strong class="jxr_keyword">if</strong> (ephemeralKey == <strong class="jxr_keyword">null</strong>) {
+<a name="152" href="#152">152</a>             <strong class="jxr_keyword">if</strong> (symmetricKey == <strong class="jxr_keyword">null</strong>) {
+<a name="153" href="#153">153</a>                 KeyGenerator keyGen = getKeyGenerator();
+<a name="154" href="#154">154</a>                 symmetricKey = keyGen.generateKey();
+<a name="155" href="#155">155</a>             } 
+<a name="156" href="#156">156</a>             ephemeralKey = symmetricKey.getEncoded();
+<a name="157" href="#157">157</a>         }
+<a name="158" href="#158">158</a>         
+<a name="159" href="#159">159</a>         <strong class="jxr_keyword">if</strong> (symmetricKey == <strong class="jxr_keyword">null</strong>) {
+<a name="160" href="#160">160</a>             symmetricKey = WSSecurityUtil.prepareSecretKey(symEncAlgo, ephemeralKey);
+<a name="161" href="#161">161</a>         }
+<a name="162" href="#162">162</a>         
+<a name="163" href="#163">163</a>         <em class="jxr_comment">//</em>
+<a name="164" href="#164">164</a>         <em class="jxr_comment">// Get the certificate that contains the public key for the public key</em>
+<a name="165" href="#165">165</a>         <em class="jxr_comment">// algorithm that will encrypt the generated symmetric (session) key.</em>
+<a name="166" href="#166">166</a>         <em class="jxr_comment">//</em>
+<a name="167" href="#167">167</a>         <strong class="jxr_keyword">if</strong> (encryptSymmKey) {
+<a name="168" href="#168">168</a>             X509Certificate remoteCert = useThisCert;
+<a name="169" href="#169">169</a>             <strong class="jxr_keyword">if</strong> (remoteCert == <strong class="jxr_keyword">null</strong>) {
+<a name="170" href="#170">170</a>                 <a href="../../../../../org/apache/ws/security/components/crypto/CryptoType.html">CryptoType</a> cryptoType = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/components/crypto/CryptoType.html">CryptoType</a>(CryptoType.TYPE.ALIAS);
+<a name="171" href="#171">171</a>                 cryptoType.setAlias(user);
+<a name="172" href="#172">172</a>                 X509Certificate[] certs = crypto.getX509Certificates(cryptoType);
+<a name="173" href="#173">173</a>                 <strong class="jxr_keyword">if</strong> (certs == <strong class="jxr_keyword">null</strong> || certs.length &lt;= 0) {
+<a name="174" href="#174">174</a>                     <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(
+<a name="175" href="#175">175</a>                         WSSecurityException.FAILURE,
+<a name="176" href="#176">176</a>                         <span class="jxr_string">"noUserCertsFound"</span>, 
+<a name="177" href="#177">177</a>                         <strong class="jxr_keyword">new</strong> Object[] { user, <span class="jxr_string">"encryption"</span> }
+<a name="178" href="#178">178</a>                     );
+<a name="179" href="#179">179</a>                 }
+<a name="180" href="#180">180</a>                 remoteCert = certs[0];
+<a name="181" href="#181">181</a>             }
+<a name="182" href="#182">182</a>             prepareInternal(symmetricKey, remoteCert, crypto);
+<a name="183" href="#183">183</a>         } <strong class="jxr_keyword">else</strong> {
+<a name="184" href="#184">184</a>             encryptedEphemeralKey = ephemeralKey;
+<a name="185" href="#185">185</a>         }
+<a name="186" href="#186">186</a>     }
+<a name="187" href="#187">187</a>     
+<a name="188" href="#188">188</a> 
+<a name="189" href="#189">189</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">     * Builds the SOAP envelope with encrypted Body and adds encrypted key.</em>
+<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">     * </em>
+<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">     * This is a convenience method and for backward compatibility. The method</em>
+<a name="193" href="#193">193</a> <em class="jxr_javadoccomment">     * calls the single function methods in order to perform a &lt;i&gt;one shot</em>
+<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * encryption&lt;/i&gt;. This method is compatible with the build method of the</em>
+<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     * previous version with the exception of the additional WSSecHeader</em>
+<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * parameter.</em>
+<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     * </em>
+<a name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * @param doc the SOAP envelope as &lt;code&gt;Document&lt;/code&gt; with plain text Body</em>
+<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">     * @param crypto an instance of the Crypto API to handle keystore and Certificates</em>
+<a name="200" href="#200">200</a> <em class="jxr_javadoccomment">     * @param secHeader the security header element to hold the encrypted key element.</em>
+<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">     * @return the SOAP envelope with encrypted Body as &lt;code&gt;Document&lt;/code&gt;</em>
+<a name="202" href="#202">202</a> <em class="jxr_javadoccomment">     * @throws WSSecurityException</em>
+<a name="203" href="#203">203</a> <em class="jxr_javadoccomment">     */</em>
+<a name="204" href="#204">204</a>     <strong class="jxr_keyword">public</strong> Document build(Document doc, <a href="../../../../../org/apache/ws/security/components/crypto/Crypto.html">Crypto</a> crypto, <a href="../../../../../org/apache/ws/security/message/WSSecHeader.html">WSSecHeader</a> secHeader)
+<a name="205" href="#205">205</a>         <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a> {
+<a name="206" href="#206">206</a>         doDebug = log.isDebugEnabled();
+<a name="207" href="#207">207</a> 
+<a name="208" href="#208">208</a>         <strong class="jxr_keyword">if</strong> (keyIdentifierType == WSConstants.EMBEDDED_KEYNAME
+<a name="209" href="#209">209</a>             || keyIdentifierType == WSConstants.EMBED_SECURITY_TOKEN_REF) {
+<a name="210" href="#210">210</a>             encryptSymmKey = false;
+<a name="211" href="#211">211</a>             document = doc;
+<a name="212" href="#212">212</a>             <em class="jxr_comment">//</em>
+<a name="213" href="#213">213</a>             <em class="jxr_comment">// Generate a symmetric key from the specified key (password) for this</em>
+<a name="214" href="#214">214</a>             <em class="jxr_comment">// algorithm, and set the cipher into encryption mode.</em>
+<a name="215" href="#215">215</a>             <em class="jxr_comment">//</em>
+<a name="216" href="#216">216</a>             <strong class="jxr_keyword">if</strong> (symmetricKey == <strong class="jxr_keyword">null</strong>) {
+<a name="217" href="#217">217</a>                 <strong class="jxr_keyword">if</strong> (embeddedKey == <strong class="jxr_keyword">null</strong>) {
+<a name="218" href="#218">218</a>                     <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/ws/security/WSSecurityException.html">WSSecurityException</a>(WSSecurityException.FAILURE, <span class="jxr_string">"noKeySupplied"</span>);
+<a name="219" href="#219">219</a>                 }
+<a name="220" href="#220">220</a>                 symmetricKey = WSSecurityUtil.prepareSecretKey(symEncAlgo, embeddedKey);
+<a name="221" href="#221">221</a>             }
+<a name="222" href="#222">222</a>         } <strong class="jxr_keyword">else</strong> {
+<a name="223" href="#223">223</a>             prepare(doc, crypto);
+<a name="224" href="#224">224</a>         }
+<a name="225" href="#225">225</a>         
+<a name="226" href="#226">226</a>         <strong class="jxr_keyword">if</strong> (envelope == <strong class="jxr_keyword">null</strong>) {
+<a name="227" href="#227">227</a>             envelope = document.getDocumentElement();
+<a name="228" href="#228">228</a>         }
+<a name="229" href="#229">229</a>         

[... 405 lines stripped ...]