Modified: webservices/website/wss4j/xref/org/apache/wss4j/dom/message/WSSecEncrypt.html URL: http://svn.apache.org/viewvc/webservices/website/wss4j/xref/org/apache/wss4j/dom/message/WSSecEncrypt.html?rev=1923808&r1=1923807&r2=1923808&view=diff ============================================================================== --- webservices/website/wss4j/xref/org/apache/wss4j/dom/message/WSSecEncrypt.html (original) +++ webservices/website/wss4j/xref/org/apache/wss4j/dom/message/WSSecEncrypt.html Fri Feb 14 11:39:24 2025 @@ -40,470 +40,472 @@ <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.common.ext.WSSecurityException; <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.common.token.Reference; <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.common.token.SecurityTokenReference; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.common.util.XMLUtils; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.dom.WSConstants; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.dom.message.token.KerberosSecurity; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.dom.util.WSSecurityUtil; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.xml.security.algorithms.JCEMapper; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.xml.security.encryption.Serializer; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.xml.security.keys.KeyInfo; -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document; -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; -<a class="jxr_linenumber" name="L44" href="#L44">44</a> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Encrypts a parts of a message according to WS Specification, X509 profile,</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * and adds the encryption data.</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="WSSecEncrypt" href="../../../../../org/apache/wss4j/dom/message/WSSecEncrypt.html#WSSecEncrypt">WSSecEncrypt</a> <strong class="jxr_keyword">extends</strong> <a name="WSSecEncryptedKey" href="../../../../../org/apache/wss4j/dom/message/WSSecEncryptedKey.html#WSSecEncryptedKey">WSSecEncryptedKey</a> { -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> org.slf4j.Logger LOG = -<a class="jxr_linenumber" name="L51" href="#L51">51</a> org.slf4j.LoggerFactory.getLogger(WSSecEncrypt.<strong class="jxr_keyword">class</strong>); -<a class="jxr_linenumber" name="L52" href="#L52">52</a> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * SecurityTokenReference to be inserted into EncryptedData/keyInfo element.</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> securityTokenReference; -<a class="jxr_linenumber" name="L57" href="#L57">57</a> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * Indicates whether to encrypt the symmetric key into an EncryptedKey</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * or not.</em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> encryptSymmKey = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L63" href="#L63">63</a> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * Custom reference value</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> String customReferenceValue; -<a class="jxr_linenumber" name="L68" href="#L68">68</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</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 class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> encKeyIdDirectId; -<a class="jxr_linenumber" name="L73" href="#L73">73</a> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> embedEncryptedKey; -<a class="jxr_linenumber" name="L75" href="#L75">75</a> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> List<Element> attachmentEncryptedDataElements; -<a class="jxr_linenumber" name="L77" href="#L77">77</a> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> Serializer encryptionSerializer; -<a class="jxr_linenumber" name="L79" href="#L79">79</a> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * Algorithm to be used with the ephemeral key</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> String symEncAlgo = WSConstants.AES_128; -<a class="jxr_linenumber" name="L84" href="#L84">84</a> -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">public</strong> <a name="WSSecEncrypt" href="../../../../../org/apache/wss4j/dom/message/WSSecEncrypt.html#WSSecEncrypt">WSSecEncrypt</a>(<a name="WSSecHeader" href="../../../../../org/apache/wss4j/dom/message/WSSecHeader.html#WSSecHeader">WSSecHeader</a> securityHeader) { -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">super</strong>(securityHeader); -<a class="jxr_linenumber" name="L87" href="#L87">87</a> } -<a class="jxr_linenumber" name="L88" href="#L88">88</a> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">public</strong> <a name="WSSecEncrypt" href="../../../../../org/apache/wss4j/dom/message/WSSecEncrypt.html#WSSecEncrypt">WSSecEncrypt</a>(Document doc) { -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">super</strong>(doc); -<a class="jxr_linenumber" name="L91" href="#L91">91</a> } -<a class="jxr_linenumber" name="L92" href="#L92">92</a> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">public</strong> <a name="WSSecEncrypt" href="../../../../../org/apache/wss4j/dom/message/WSSecEncrypt.html#WSSecEncrypt">WSSecEncrypt</a>(Document doc, Provider provider) { -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">super</strong>(doc, provider); -<a class="jxr_linenumber" name="L95" href="#L95">95</a> } -<a class="jxr_linenumber" name="L96" href="#L96">96</a> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * Initialize a WSSec Encrypt.</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * The method prepares and initializes a WSSec Encrypt structure after the</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * relevant information was set. After preparation of the token references</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * can be added and encrypted.</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * This method does not add any element to the security header. This must be</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * done explicitly.</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @param crypto An instance of the Crypto API to handle keystore and certificates</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @param symmetricKey The symmetric key to use for encryption</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare(<a name="Crypto" href="../../../../../org/apache/wss4j/common/crypto/Crypto.html#Crypto">Crypto</a> crypto, SecretKey symmetricKey) <strong class="jxr_keyword">throws</strong> <a name="WSSecurityException" href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html#WSSecurityException">WSSecurityException</a> { -<a class="jxr_linenumber" name="L112" href="#L112">112</a> attachmentEncryptedDataElements = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L113" href="#L113">113</a> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">if</strong> (encryptSymmKey) { -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">super</strong>.prepare(crypto, symmetricKey); -<a class="jxr_linenumber" name="L116" href="#L116">116</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L117" href="#L117">117</a> setEncryptedKeySHA1(symmetricKey.getEncoded()); -<a class="jxr_linenumber" name="L118" href="#L118">118</a> } -<a class="jxr_linenumber" name="L119" href="#L119">119</a> } -<a class="jxr_linenumber" name="L120" href="#L120">120</a> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Builds the SOAP envelope with encrypted Body and adds encrypted key.</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * This is a convenience method and for backward compatibility. The method</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * calls the single function methods in order to perform a <i>one shot</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * encryption</i>.</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @param crypto an instance of the Crypto API to handle keystore and Certificates</em> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @param symmetricKey The symmetric key to use for encryption</em> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @return the SOAP envelope with encrypted Body as <code>Document</code></em> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">public</strong> Document build(<a name="Crypto" href="../../../../../org/apache/wss4j/common/crypto/Crypto.html#Crypto">Crypto</a> crypto, SecretKey symmetricKey) -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">throws</strong> <a name="WSSecurityException" href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html#WSSecurityException">WSSecurityException</a> { -<a class="jxr_linenumber" name="L136" href="#L136">136</a> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> prepare(crypto, symmetricKey); +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.common.util.FIPSUtils; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.common.util.XMLUtils; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.dom.WSConstants; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.dom.message.token.KerberosSecurity; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.wss4j.dom.util.WSSecurityUtil; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.xml.security.algorithms.JCEMapper; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.xml.security.encryption.Serializer; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.xml.security.keys.KeyInfo; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Encrypts a parts of a message according to WS Specification, X509 profile,</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * and adds the encryption data.</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="WSSecEncrypt" href="../../../../../org/apache/wss4j/dom/message/WSSecEncrypt.html#WSSecEncrypt">WSSecEncrypt</a> <strong class="jxr_keyword">extends</strong> <a name="WSSecEncryptedKey" href="../../../../../org/apache/wss4j/dom/message/WSSecEncryptedKey.html#WSSecEncryptedKey">WSSecEncryptedKey</a> { +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> org.slf4j.Logger LOG = +<a class="jxr_linenumber" name="L52" href="#L52">52</a> org.slf4j.LoggerFactory.getLogger(WSSecEncrypt.<strong class="jxr_keyword">class</strong>); +<a class="jxr_linenumber" name="L53" href="#L53">53</a> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * SecurityTokenReference to be inserted into EncryptedData/keyInfo element.</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">private</strong> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> securityTokenReference; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * Indicates whether to encrypt the symmetric key into an EncryptedKey</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * or not.</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> encryptSymmKey = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * Custom reference value</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">private</strong> String customReferenceValue; +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</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 class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> encKeyIdDirectId; +<a class="jxr_linenumber" name="L74" href="#L74">74</a> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> embedEncryptedKey; +<a class="jxr_linenumber" name="L76" href="#L76">76</a> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> List<Element> attachmentEncryptedDataElements; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> Serializer encryptionSerializer; +<a class="jxr_linenumber" name="L80" href="#L80">80</a> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * Algorithm to be used with the ephemeral key</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> String symEncAlgo = FIPSUtils.isFIPSEnabled() +<a class="jxr_linenumber" name="L85" href="#L85">85</a> ? WSConstants.AES_128_GCM : WSConstants.AES_128; +<a class="jxr_linenumber" name="L86" href="#L86">86</a> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">public</strong> <a name="WSSecEncrypt" href="../../../../../org/apache/wss4j/dom/message/WSSecEncrypt.html#WSSecEncrypt">WSSecEncrypt</a>(<a name="WSSecHeader" href="../../../../../org/apache/wss4j/dom/message/WSSecHeader.html#WSSecHeader">WSSecHeader</a> securityHeader) { +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">super</strong>(securityHeader); +<a class="jxr_linenumber" name="L89" href="#L89">89</a> } +<a class="jxr_linenumber" name="L90" href="#L90">90</a> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">public</strong> <a name="WSSecEncrypt" href="../../../../../org/apache/wss4j/dom/message/WSSecEncrypt.html#WSSecEncrypt">WSSecEncrypt</a>(Document doc) { +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">super</strong>(doc); +<a class="jxr_linenumber" name="L93" href="#L93">93</a> } +<a class="jxr_linenumber" name="L94" href="#L94">94</a> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">public</strong> <a name="WSSecEncrypt" href="../../../../../org/apache/wss4j/dom/message/WSSecEncrypt.html#WSSecEncrypt">WSSecEncrypt</a>(Document doc, Provider provider) { +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">super</strong>(doc, provider); +<a class="jxr_linenumber" name="L97" href="#L97">97</a> } +<a class="jxr_linenumber" name="L98" href="#L98">98</a> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * Initialize a WSSec Encrypt.</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * The method prepares and initializes a WSSec Encrypt structure after the</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * relevant information was set. After preparation of the token references</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * can be added and encrypted.</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * This method does not add any element to the security header. This must be</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * done explicitly.</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @param crypto An instance of the Crypto API to handle keystore and certificates</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @param symmetricKey The symmetric key to use for encryption</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare(<a name="Crypto" href="../../../../../org/apache/wss4j/common/crypto/Crypto.html#Crypto">Crypto</a> crypto, SecretKey symmetricKey) <strong class="jxr_keyword">throws</strong> <a name="WSSecurityException" href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html#WSSecurityException">WSSecurityException</a> { +<a class="jxr_linenumber" name="L114" href="#L114">114</a> attachmentEncryptedDataElements = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">if</strong> (encryptSymmKey) { +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">super</strong>.prepare(crypto, symmetricKey); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L119" href="#L119">119</a> setEncryptedKeySHA1(symmetricKey.getEncoded()); +<a class="jxr_linenumber" name="L120" href="#L120">120</a> } +<a class="jxr_linenumber" name="L121" href="#L121">121</a> } +<a class="jxr_linenumber" name="L122" href="#L122">122</a> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * Builds the SOAP envelope with encrypted Body and adds encrypted key.</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * This is a convenience method and for backward compatibility. The method</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * calls the single function methods in order to perform a <i>one shot</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * encryption</i>.</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @param crypto an instance of the Crypto API to handle keystore and Certificates</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @param symmetricKey The symmetric key to use for encryption</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @return the SOAP envelope with encrypted Body as <code>Document</code></em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">public</strong> Document build(<a name="Crypto" href="../../../../../org/apache/wss4j/common/crypto/Crypto.html#Crypto">Crypto</a> crypto, SecretKey symmetricKey) +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">throws</strong> <a name="WSSecurityException" href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html#WSSecurityException">WSSecurityException</a> { <a class="jxr_linenumber" name="L138" href="#L138">138</a> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> LOG.debug(<span class="jxr_string">"Beginning Encryption..."</span>); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> prepare(crypto, symmetricKey); <a class="jxr_linenumber" name="L140" href="#L140">140</a> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> Element refs = encrypt(symmetricKey); +<a class="jxr_linenumber" name="L141" href="#L141">141</a> LOG.debug(<span class="jxr_string">"Beginning Encryption..."</span>); <a class="jxr_linenumber" name="L142" href="#L142">142</a> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> addAttachmentEncryptedDataElements(); -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">if</strong> (getEncryptedKeyElement() != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L145" href="#L145">145</a> addInternalRefElement(refs); -<a class="jxr_linenumber" name="L146" href="#L146">146</a> prependToHeader(); -<a class="jxr_linenumber" name="L147" href="#L147">147</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L148" href="#L148">148</a> addExternalRefElement(refs); -<a class="jxr_linenumber" name="L149" href="#L149">149</a> } -<a class="jxr_linenumber" name="L150" href="#L150">150</a> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> prependBSTElementToHeader(); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> Element refs = encrypt(symmetricKey); +<a class="jxr_linenumber" name="L144" href="#L144">144</a> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> addAttachmentEncryptedDataElements(); +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">if</strong> (getEncryptedKeyElement() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L147" href="#L147">147</a> addInternalRefElement(refs); +<a class="jxr_linenumber" name="L148" href="#L148">148</a> prependToHeader(); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L150" href="#L150">150</a> addExternalRefElement(refs); +<a class="jxr_linenumber" name="L151" href="#L151">151</a> } <a class="jxr_linenumber" name="L152" href="#L152">152</a> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> LOG.debug(<span class="jxr_string">"Encryption complete."</span>); -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">return</strong> getDocument(); -<a class="jxr_linenumber" name="L155" href="#L155">155</a> } -<a class="jxr_linenumber" name="L156" href="#L156">156</a> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * Perform encryption using the given symmetric key</em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @param symmetricKey The symmetric key to use for encryption</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @return the EncryptedData element</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">public</strong> Element encrypt(SecretKey symmetricKey) <strong class="jxr_keyword">throws</strong> <a name="WSSecurityException" href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html#WSSecurityException">WSSecurityException</a> { -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">if</strong> (getParts().isEmpty()) { -<a class="jxr_linenumber" name="L165" href="#L165">165</a> getParts().add(WSSecurityUtil.getDefaultEncryptionPart(getDocument())); -<a class="jxr_linenumber" name="L166" href="#L166">166</a> } -<a class="jxr_linenumber" name="L167" href="#L167">167</a> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">return</strong> encryptForRef(<strong class="jxr_keyword">null</strong>, getParts(), symmetricKey); -<a class="jxr_linenumber" name="L169" href="#L169">169</a> } -<a class="jxr_linenumber" name="L170" href="#L170">170</a> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * Encrypt one or more parts or elements of the message.</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * This method takes a list of <code>WSEncryptionPart</code> object that</em> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * contain information about the elements to encrypt. The method call the</em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * encryption method, takes the reference information generated during</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * encryption and add this to the <code>xenc:Reference</code> element.</em> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * This method can be called after <code>prepare()</code> and can be</em> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * called multiple times to encrypt a number of parts or elements.</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * The method generates a <code>xenc:Reference</code> element that <i>must</i></em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * be added to this token. See <code>addInternalRefElement()</code>.</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * If the <code>dataRef</code> parameter is <code>null</code> the method</em> -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * creates and initializes a new Reference element.</em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * @param dataRef A <code>xenc:Reference</code> element or <code>null</code></em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @param references A list containing WSEncryptionPart objects</em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @param symmetricKey The symmetric key to use for encryption</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * @return Returns the updated <code>xenc:Reference</code> element</em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">public</strong> Element encryptForRef( -<a class="jxr_linenumber" name="L194" href="#L194">194</a> Element dataRef, -<a class="jxr_linenumber" name="L195" href="#L195">195</a> List<WSEncryptionPart> references, -<a class="jxr_linenumber" name="L196" href="#L196">196</a> SecretKey symmetricKey -<a class="jxr_linenumber" name="L197" href="#L197">197</a> ) <strong class="jxr_keyword">throws</strong> <a name="WSSecurityException" href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html#WSSecurityException">WSSecurityException</a> { -<a class="jxr_linenumber" name="L198" href="#L198">198</a> KeyInfo keyInfo = createKeyInfo(); -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_comment">//the sun/oracle jce provider doesn't like a foreign SecretKey impl.</em> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_comment">//this occurs e.g. with a kerberos session-key. It doesn't matter for the bouncy-castle provider</em> -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_comment">//so create a new secretKeySpec to make everybody happy.</em> -<a class="jxr_linenumber" name="L202" href="#L202">202</a> String keyAlgorithm = JCEMapper.getJCEKeyAlgorithmFromURI(getSymmetricEncAlgorithm()); -<a class="jxr_linenumber" name="L203" href="#L203">203</a> SecretKeySpec secretKeySpec = <strong class="jxr_keyword">new</strong> SecretKeySpec(symmetricKey.getEncoded(), keyAlgorithm); -<a class="jxr_linenumber" name="L204" href="#L204">204</a> -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <a name="Encryptor" href="../../../../../org/apache/wss4j/dom/message/Encryptor.html#Encryptor">Encryptor</a> encryptor = <strong class="jxr_keyword">new</strong> <a name="Encryptor" href="../../../../../org/apache/wss4j/dom/message/Encryptor.html#Encryptor">Encryptor</a>(); -<a class="jxr_linenumber" name="L206" href="#L206">206</a> encryptor.setDoc(getDocument()); -<a class="jxr_linenumber" name="L207" href="#L207">207</a> encryptor.setSecurityHeader(getSecurityHeader()); -<a class="jxr_linenumber" name="L208" href="#L208">208</a> encryptor.setIdAllocator(getIdAllocator()); -<a class="jxr_linenumber" name="L209" href="#L209">209</a> encryptor.setCallbackLookup(callbackLookup); -<a class="jxr_linenumber" name="L210" href="#L210">210</a> encryptor.setAttachmentCallbackHandler(attachmentCallbackHandler); -<a class="jxr_linenumber" name="L211" href="#L211">211</a> encryptor.setStoreBytesInAttachment(storeBytesInAttachment); -<a class="jxr_linenumber" name="L212" href="#L212">212</a> encryptor.setEncryptionSerializer(getEncryptionSerializer()); -<a class="jxr_linenumber" name="L213" href="#L213">213</a> encryptor.setExpandXopInclude(isExpandXopInclude()); -<a class="jxr_linenumber" name="L214" href="#L214">214</a> encryptor.setWsDocInfo(getWsDocInfo()); -<a class="jxr_linenumber" name="L215" href="#L215">215</a> List<String> encDataRefs = -<a class="jxr_linenumber" name="L216" href="#L216">216</a> encryptor.doEncryption(keyInfo, secretKeySpec, getSymmetricEncAlgorithm(), references, attachmentEncryptedDataElements); -<a class="jxr_linenumber" name="L217" href="#L217">217</a> -<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_comment">// Clean the secret key from memory now that we're done with it</em> -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L220" href="#L220">220</a> secretKeySpec.destroy(); -<a class="jxr_linenumber" name="L221" href="#L221">221</a> } <strong class="jxr_keyword">catch</strong> (DestroyFailedException e) { -<a class="jxr_linenumber" name="L222" href="#L222">222</a> LOG.debug(<span class="jxr_string">"Error destroying key: {}"</span>, e.getMessage()); -<a class="jxr_linenumber" name="L223" href="#L223">223</a> } -<a class="jxr_linenumber" name="L224" href="#L224">224</a> -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">if</strong> (encDataRefs.isEmpty()) { -<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L227" href="#L227">227</a> } -<a class="jxr_linenumber" name="L228" href="#L228">228</a> -<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">if</strong> (dataRef == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L230" href="#L230">230</a> dataRef = -<a class="jxr_linenumber" name="L231" href="#L231">231</a> getDocument().createElementNS( -<a class="jxr_linenumber" name="L232" href="#L232">232</a> WSConstants.ENC_NS, -<a class="jxr_linenumber" name="L233" href="#L233">233</a> WSConstants.ENC_PREFIX + <span class="jxr_string">":ReferenceList"</span> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> ); -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_comment">//</em> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_comment">// If we're not placing the ReferenceList in an EncryptedKey structure,</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_comment">// then add the ENC namespace</em> -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_comment">//</em> -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">if</strong> (!encryptSymmKey) { -<a class="jxr_linenumber" name="L240" href="#L240">240</a> XMLUtils.setNamespace( -<a class="jxr_linenumber" name="L241" href="#L241">241</a> dataRef, WSConstants.ENC_NS, WSConstants.ENC_PREFIX -<a class="jxr_linenumber" name="L242" href="#L242">242</a> ); -<a class="jxr_linenumber" name="L243" href="#L243">243</a> } -<a class="jxr_linenumber" name="L244" href="#L244">244</a> } -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">return</strong> createDataRefList(getDocument(), dataRef, encDataRefs); -<a class="jxr_linenumber" name="L246" href="#L246">246</a> } -<a class="jxr_linenumber" name="L247" href="#L247">247</a> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * Adds the internal Reference element to this Encrypt data.</em> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * The reference element <i>must</i> be created by the</em> -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * <code>encryptForInternalRef()</code> method. The reference element is</em> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * added to the <code>EncryptedKey</code> element of this encrypt block.</em> -<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * @param dataRef The internal <code>enc:Reference</code> element</em> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addInternalRefElement(Element dataRef) { -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">if</strong> (dataRef != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L259" href="#L259">259</a> getEncryptedKeyElement().appendChild(dataRef); -<a class="jxr_linenumber" name="L260" href="#L260">260</a> } -<a class="jxr_linenumber" name="L261" href="#L261">261</a> } -<a class="jxr_linenumber" name="L262" href="#L262">262</a> -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * Adds (prepends) the external Reference element to the Security header.</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * The reference element <i>must</i> be created by the</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * <code>encryptForExternalRef() </code> method. The method prepends the</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * reference element in the SecurityHeader.</em> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @param dataRef The external <code>enc:Reference</code> element</em> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addExternalRefElement(Element dataRef) { -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">if</strong> (dataRef != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L274" href="#L274">274</a> Element secHeaderElement = getSecurityHeader().getSecurityHeaderElement(); -<a class="jxr_linenumber" name="L275" href="#L275">275</a> WSSecurityUtil.prependChildElement(secHeaderElement, dataRef); -<a class="jxr_linenumber" name="L276" href="#L276">276</a> } -<a class="jxr_linenumber" name="L277" href="#L277">277</a> } -<a class="jxr_linenumber" name="L278" href="#L278">278</a> -<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addAttachmentEncryptedDataElements() { -<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">if</strong> (attachmentEncryptedDataElements != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">for</strong> (Element encryptedData : attachmentEncryptedDataElements) { -<a class="jxr_linenumber" name="L282" href="#L282">282</a> Element secHeaderElement = getSecurityHeader().getSecurityHeaderElement(); -<a class="jxr_linenumber" name="L283" href="#L283">283</a> WSSecurityUtil.prependChildElement(secHeaderElement, encryptedData); -<a class="jxr_linenumber" name="L284" href="#L284">284</a> } -<a class="jxr_linenumber" name="L285" href="#L285">285</a> } -<a class="jxr_linenumber" name="L286" href="#L286">286</a> } -<a class="jxr_linenumber" name="L287" href="#L287">287</a> -<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * Create a KeyInfo object</em> -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">private</strong> KeyInfo createKeyInfo() <strong class="jxr_keyword">throws</strong> <a name="WSSecurityException" href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html#WSSecurityException">WSSecurityException</a> { -<a class="jxr_linenumber" name="L292" href="#L292">292</a> -<a class="jxr_linenumber" name="L293" href="#L293">293</a> KeyInfo keyInfo = <strong class="jxr_keyword">new</strong> KeyInfo(getDocument()); -<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">if</strong> (embedEncryptedKey) { -<a class="jxr_linenumber" name="L295" href="#L295">295</a> keyInfo.addUnknownElement(getEncryptedKeyElement()); -<a class="jxr_linenumber" name="L296" href="#L296">296</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (keyIdentifierType == WSConstants.ENCRYPTED_KEY_SHA1_IDENTIFIER) { -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a>(getDocument()); -<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">if</strong> (addWSUNamespace) { -<a class="jxr_linenumber" name="L299" href="#L299">299</a> secToken.addWSUNamespace(); -<a class="jxr_linenumber" name="L300" href="#L300">300</a> } -<a class="jxr_linenumber" name="L301" href="#L301">301</a> secToken.addWSSENamespace(); -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">if</strong> (customReferenceValue != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L303" href="#L303">303</a> secToken.setKeyIdentifierEncKeySHA1(customReferenceValue); -<a class="jxr_linenumber" name="L304" href="#L304">304</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L305" href="#L305">305</a> secToken.setKeyIdentifierEncKeySHA1(getEncryptedKeySHA1()); -<a class="jxr_linenumber" name="L306" href="#L306">306</a> } -<a class="jxr_linenumber" name="L307" href="#L307">307</a> secToken.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE); -<a class="jxr_linenumber" name="L308" href="#L308">308</a> keyInfo.addUnknownElement(secToken.getElement()); -<a class="jxr_linenumber" name="L309" href="#L309">309</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML_KI_VALUE_TYPE.equals(customReferenceValue)) { -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a>(getDocument()); -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">if</strong> (addWSUNamespace) { -<a class="jxr_linenumber" name="L312" href="#L312">312</a> secToken.addWSUNamespace(); -<a class="jxr_linenumber" name="L313" href="#L313">313</a> } -<a class="jxr_linenumber" name="L314" href="#L314">314</a> secToken.addWSSENamespace(); -<a class="jxr_linenumber" name="L315" href="#L315">315</a> secToken.addTokenType(WSConstants.WSS_SAML_TOKEN_TYPE); -<a class="jxr_linenumber" name="L316" href="#L316">316</a> secToken.setKeyIdentifier(WSConstants.WSS_SAML_KI_VALUE_TYPE, getId()); -<a class="jxr_linenumber" name="L317" href="#L317">317</a> keyInfo.addUnknownElement(secToken.getElement()); -<a class="jxr_linenumber" name="L318" href="#L318">318</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_SAML2_KI_VALUE_TYPE.equals(customReferenceValue)) { -<a class="jxr_linenumber" name="L319" href="#L319">319</a> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a>(getDocument()); -<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">if</strong> (addWSUNamespace) { -<a class="jxr_linenumber" name="L321" href="#L321">321</a> secToken.addWSUNamespace(); -<a class="jxr_linenumber" name="L322" href="#L322">322</a> } -<a class="jxr_linenumber" name="L323" href="#L323">323</a> secToken.addWSSENamespace(); -<a class="jxr_linenumber" name="L324" href="#L324">324</a> secToken.addTokenType(WSConstants.WSS_SAML2_TOKEN_TYPE); -<a class="jxr_linenumber" name="L325" href="#L325">325</a> secToken.setKeyIdentifier(WSConstants.WSS_SAML2_KI_VALUE_TYPE, getId()); -<a class="jxr_linenumber" name="L326" href="#L326">326</a> keyInfo.addUnknownElement(secToken.getElement()); -<a class="jxr_linenumber" name="L327" href="#L327">327</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (WSConstants.WSS_KRB_KI_VALUE_TYPE.equals(customReferenceValue)) { -<a class="jxr_linenumber" name="L328" href="#L328">328</a> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a>(getDocument()); -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">if</strong> (addWSUNamespace) { -<a class="jxr_linenumber" name="L330" href="#L330">330</a> secToken.addWSUNamespace(); -<a class="jxr_linenumber" name="L331" href="#L331">331</a> } -<a class="jxr_linenumber" name="L332" href="#L332">332</a> secToken.addWSSENamespace(); -<a class="jxr_linenumber" name="L333" href="#L333">333</a> secToken.addTokenType(WSConstants.WSS_GSS_KRB_V5_AP_REQ); -<a class="jxr_linenumber" name="L334" href="#L334">334</a> secToken.setKeyIdentifier(customReferenceValue, getId(), <strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L335" href="#L335">335</a> keyInfo.addUnknownElement(secToken.getElement()); -<a class="jxr_linenumber" name="L336" href="#L336">336</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (securityTokenReference != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L337" href="#L337">337</a> Element tmpE = securityTokenReference.getElement(); -<a class="jxr_linenumber" name="L338" href="#L338">338</a> tmpE.setAttributeNS( -<a class="jxr_linenumber" name="L339" href="#L339">339</a> WSConstants.XMLNS_NS, <span class="jxr_string">"xmlns:"</span> + tmpE.getPrefix(), tmpE.getNamespaceURI() -<a class="jxr_linenumber" name="L340" href="#L340">340</a> ); -<a class="jxr_linenumber" name="L341" href="#L341">341</a> keyInfo.addUnknownElement(securityTokenReference.getElement()); -<a class="jxr_linenumber" name="L342" href="#L342">342</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (getId() != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L343" href="#L343">343</a> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a>(getDocument()); -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">if</strong> (addWSUNamespace) { -<a class="jxr_linenumber" name="L345" href="#L345">345</a> secToken.addWSUNamespace(); -<a class="jxr_linenumber" name="L346" href="#L346">346</a> } -<a class="jxr_linenumber" name="L347" href="#L347">347</a> secToken.addWSSENamespace(); -<a class="jxr_linenumber" name="L348" href="#L348">348</a> <a name="Reference" href="../../../../../org/apache/wss4j/common/token/Reference.html#Reference">Reference</a> ref = <strong class="jxr_keyword">new</strong> <a name="Reference" href="../../../../../org/apache/wss4j/common/token/Reference.html#Reference">Reference</a>(getDocument()); -<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">if</strong> (encKeyIdDirectId) { -<a class="jxr_linenumber" name="L350" href="#L350">350</a> ref.setURI(getId()); -<a class="jxr_linenumber" name="L351" href="#L351">351</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L352" href="#L352">352</a> ref.setURI(<span class="jxr_string">"#"</span> + getId()); -<a class="jxr_linenumber" name="L353" href="#L353">353</a> } -<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">if</strong> (customReferenceValue != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L355" href="#L355">355</a> ref.setValueType(customReferenceValue); -<a class="jxr_linenumber" name="L356" href="#L356">356</a> } -<a class="jxr_linenumber" name="L357" href="#L357">357</a> secToken.setReference(ref); -<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">if</strong> (KerberosSecurity.isKerberosToken(customReferenceValue)) { -<a class="jxr_linenumber" name="L359" href="#L359">359</a> secToken.addTokenType(customReferenceValue); -<a class="jxr_linenumber" name="L360" href="#L360">360</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!WSConstants.WSS_USERNAME_TOKEN_VALUE_TYPE.equals(customReferenceValue)) { -<a class="jxr_linenumber" name="L361" href="#L361">361</a> secToken.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE); -<a class="jxr_linenumber" name="L362" href="#L362">362</a> } -<a class="jxr_linenumber" name="L363" href="#L363">363</a> keyInfo.addUnknownElement(secToken.getElement()); -<a class="jxr_linenumber" name="L364" href="#L364">364</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!encryptSymmKey && (keyIdentifierType == WSConstants.ISSUER_SERIAL -<a class="jxr_linenumber" name="L365" href="#L365">365</a> || keyIdentifierType == WSConstants.ISSUER_SERIAL_QUOTE_FORMAT)) { -<a class="jxr_linenumber" name="L366" href="#L366">366</a> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> secToken = <strong class="jxr_keyword">new</strong> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a>(getDocument()); -<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">if</strong> (addWSUNamespace) { -<a class="jxr_linenumber" name="L368" href="#L368">368</a> secToken.addWSUNamespace(); -<a class="jxr_linenumber" name="L369" href="#L369">369</a> } -<a class="jxr_linenumber" name="L370" href="#L370">370</a> secToken.addWSSENamespace(); -<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">if</strong> (customReferenceValue != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L372" href="#L372">372</a> secToken.setKeyIdentifierEncKeySHA1(customReferenceValue); -<a class="jxr_linenumber" name="L373" href="#L373">373</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L374" href="#L374">374</a> secToken.setKeyIdentifierEncKeySHA1(getEncryptedKeySHA1()); -<a class="jxr_linenumber" name="L375" href="#L375">375</a> } -<a class="jxr_linenumber" name="L376" href="#L376">376</a> secToken.addTokenType(WSConstants.WSS_ENC_KEY_VALUE_TYPE); -<a class="jxr_linenumber" name="L377" href="#L377">377</a> keyInfo.addUnknownElement(secToken.getElement()); -<a class="jxr_linenumber" name="L378" href="#L378">378</a> } -<a class="jxr_linenumber" name="L379" href="#L379">379</a> -<a class="jxr_linenumber" name="L380" href="#L380">380</a> Element keyInfoElement = keyInfo.getElement(); -<a class="jxr_linenumber" name="L381" href="#L381">381</a> keyInfoElement.setAttributeNS( -<a class="jxr_linenumber" name="L382" href="#L382">382</a> WSConstants.XMLNS_NS, <span class="jxr_string">"xmlns:"</span> + WSConstants.SIG_PREFIX, WSConstants.SIG_NS -<a class="jxr_linenumber" name="L383" href="#L383">383</a> ); -<a class="jxr_linenumber" name="L384" href="#L384">384</a> -<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">return</strong> keyInfo; -<a class="jxr_linenumber" name="L386" href="#L386">386</a> } -<a class="jxr_linenumber" name="L387" href="#L387">387</a> -<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * Create DOM subtree for <code>xenc:EncryptedKey</code></em> -<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * @param doc the SOAP envelope parent document</em> -<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * @param referenceList</em> -<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> * @param encDataRefs</em> -<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * @return an <code>xenc:EncryptedKey</code> element</em> -<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Element createDataRefList( -<a class="jxr_linenumber" name="L397" href="#L397">397</a> Document doc, -<a class="jxr_linenumber" name="L398" href="#L398">398</a> Element referenceList, -<a class="jxr_linenumber" name="L399" href="#L399">399</a> List<String> encDataRefs -<a class="jxr_linenumber" name="L400" href="#L400">400</a> ) { -<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">for</strong> (String dataReferenceUri : encDataRefs) { -<a class="jxr_linenumber" name="L402" href="#L402">402</a> Element dataReference = -<a class="jxr_linenumber" name="L403" href="#L403">403</a> doc.createElementNS( -<a class="jxr_linenumber" name="L404" href="#L404">404</a> WSConstants.ENC_NS, WSConstants.ENC_PREFIX + <span class="jxr_string">":DataReference"</span> -<a class="jxr_linenumber" name="L405" href="#L405">405</a> ); -<a class="jxr_linenumber" name="L406" href="#L406">406</a> dataReference.setAttributeNS(<strong class="jxr_keyword">null</strong>, <span class="jxr_string">"URI"</span>, dataReferenceUri); -<a class="jxr_linenumber" name="L407" href="#L407">407</a> referenceList.appendChild(dataReference); -<a class="jxr_linenumber" name="L408" href="#L408">408</a> } -<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">return</strong> referenceList; -<a class="jxr_linenumber" name="L410" href="#L410">410</a> } -<a class="jxr_linenumber" name="L411" href="#L411">411</a> -<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> * @return Return the SecurityTokenRefernce</em> -<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong class="jxr_keyword">public</strong> <a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> getSecurityTokenReference() { -<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">return</strong> securityTokenReference; -<a class="jxr_linenumber" name="L417" href="#L417">417</a> } -<a class="jxr_linenumber" name="L418" href="#L418">418</a> -<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * @param reference</em> -<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSecurityTokenReference(<a name="SecurityTokenReference" href="../../../../../org/apache/wss4j/common/token/SecurityTokenReference.html#SecurityTokenReference">SecurityTokenReference</a> reference) { -<a class="jxr_linenumber" name="L423" href="#L423">423</a> securityTokenReference = reference; -<a class="jxr_linenumber" name="L424" href="#L424">424</a> } -<a class="jxr_linenumber" name="L425" href="#L425">425</a> -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEncryptSymmKey() { -<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">return</strong> encryptSymmKey; -<a class="jxr_linenumber" name="L428" href="#L428">428</a> } -<a class="jxr_linenumber" name="L429" href="#L429">429</a> -<a class="jxr_linenumber" name="L430" href="#L430">430</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEncryptSymmKey(<strong class="jxr_keyword">boolean</strong> encryptSymmKey) { -<a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">this</strong>.encryptSymmKey = encryptSymmKey; -<a class="jxr_linenumber" name="L432" href="#L432">432</a> } -<a class="jxr_linenumber" name="L433" href="#L433">433</a> -<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCustomReferenceValue(String customReferenceValue) { -<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong class="jxr_keyword">this</strong>.customReferenceValue = customReferenceValue; -<a class="jxr_linenumber" name="L436" href="#L436">436</a> } -<a class="jxr_linenumber" name="L437" href="#L437">437</a> -<a class="jxr_linenumber" name="L438" href="#L438">438</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEncKeyIdDirectId(<strong class="jxr_keyword">boolean</strong> b) { -<a class="jxr_linenumber" name="L439" href="#L439">439</a> encKeyIdDirectId = b; -<a class="jxr_linenumber" name="L440" href="#L440">440</a> } -<a class="jxr_linenumber" name="L441" href="#L441">441</a> -<a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEmbedEncryptedKey(<strong class="jxr_keyword">boolean</strong> embedEncryptedKey) { -<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">this</strong>.embedEncryptedKey = embedEncryptedKey; -<a class="jxr_linenumber" name="L444" href="#L444">444</a> } -<a class="jxr_linenumber" name="L445" href="#L445">445</a> -<a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEmbedEncryptedKey() { -<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">return</strong> embedEncryptedKey; -<a class="jxr_linenumber" name="L448" href="#L448">448</a> } -<a class="jxr_linenumber" name="L449" href="#L449">449</a> -<a class="jxr_linenumber" name="L450" href="#L450">450</a> <strong class="jxr_keyword">public</strong> List<Element> getAttachmentEncryptedDataElements() { -<a class="jxr_linenumber" name="L451" href="#L451">451</a> <strong class="jxr_keyword">return</strong> attachmentEncryptedDataElements; -<a class="jxr_linenumber" name="L452" href="#L452">452</a> } -<a class="jxr_linenumber" name="L453" href="#L453">453</a> -<a class="jxr_linenumber" name="L454" href="#L454">454</a> <strong class="jxr_keyword">public</strong> Serializer getEncryptionSerializer() { -<a class="jxr_linenumber" name="L455" href="#L455">455</a> <strong class="jxr_keyword">return</strong> encryptionSerializer; -<a class="jxr_linenumber" name="L456" href="#L456">456</a> } -<a class="jxr_linenumber" name="L457" href="#L457">457</a> -<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEncryptionSerializer(Serializer encryptionSerializer) { -<a class="jxr_linenumber" name="L459" href="#L459">459</a> <strong class="jxr_keyword">this</strong>.encryptionSerializer = encryptionSerializer; -<a class="jxr_linenumber" name="L460" href="#L460">460</a> } -<a class="jxr_linenumber" name="L461" href="#L461">461</a> -<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> * Set the name of the symmetric encryption algorithm to use.</em> -<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L465" href="#L465">465</a> <em class="jxr_javadoccomment"> * This encryption algorithm is used to encrypt the data. If the algorithm</em> -<a class="jxr_linenumber" name="L466" href="#L466">466</a> <em class="jxr_javadoccomment"> * is not set then AES128 is used. Refer to WSConstants which algorithms are</em> -<a class="jxr_linenumber" name="L467" href="#L467">467</a> <em class="jxr_javadoccomment"> * supported.</em> -<a class="jxr_linenumber" name="L468" href="#L468">468</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L469" href="#L469">469</a> <em class="jxr_javadoccomment"> * @param algo Is the name of the encryption algorithm</em> -<a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_javadoccomment"> * @see WSConstants#TRIPLE_DES</em> -<a class="jxr_linenumber" name="L471" href="#L471">471</a> <em class="jxr_javadoccomment"> * @see WSConstants#AES_128</em> -<a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_javadoccomment"> * @see WSConstants#AES_192</em> -<a class="jxr_linenumber" name="L473" href="#L473">473</a> <em class="jxr_javadoccomment"> * @see WSConstants#AES_256</em> -<a class="jxr_linenumber" name="L474" href="#L474">474</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L475" href="#L475">475</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSymmetricEncAlgorithm(String algo) { -<a class="jxr_linenumber" name="L476" href="#L476">476</a> symEncAlgo = algo; -<a class="jxr_linenumber" name="L477" href="#L477">477</a> } -<a class="jxr_linenumber" name="L478" href="#L478">478</a> -<a class="jxr_linenumber" name="L479" href="#L479">479</a> -<a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L481" href="#L481">481</a> <em class="jxr_javadoccomment"> * Get the name of symmetric encryption algorithm to use.</em> -<a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_javadoccomment"> * The name of the encryption algorithm to encrypt the data, i.e. the SOAP</em> -<a class="jxr_linenumber" name="L484" href="#L484">484</a> <em class="jxr_javadoccomment"> * Body. Refer to WSConstants which algorithms are supported.</em> -<a class="jxr_linenumber" name="L485" href="#L485">485</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L486" href="#L486">486</a> <em class="jxr_javadoccomment"> * @return the name of the currently selected symmetric encryption algorithm</em> -<a class="jxr_linenumber" name="L487" href="#L487">487</a> <em class="jxr_javadoccomment"> * @see WSConstants#TRIPLE_DES</em> -<a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_javadoccomment"> * @see WSConstants#AES_128</em> -<a class="jxr_linenumber" name="L489" href="#L489">489</a> <em class="jxr_javadoccomment"> * @see WSConstants#AES_192</em> -<a class="jxr_linenumber" name="L490" href="#L490">490</a> <em class="jxr_javadoccomment"> * @see WSConstants#AES_256</em> -<a class="jxr_linenumber" name="L491" href="#L491">491</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L492" href="#L492">492</a> <strong class="jxr_keyword">public</strong> String getSymmetricEncAlgorithm() { -<a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong class="jxr_keyword">return</strong> symEncAlgo; -<a class="jxr_linenumber" name="L494" href="#L494">494</a> } -<a class="jxr_linenumber" name="L495" href="#L495">495</a> -<a class="jxr_linenumber" name="L496" href="#L496">496</a> } +<a class="jxr_linenumber" name="L153" href="#L153">153</a> prependBSTElementToHeader(); +<a class="jxr_linenumber" name="L154" href="#L154">154</a> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> LOG.debug(<span class="jxr_string">"Encryption complete."</span>); +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> getDocument(); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> } +<a class="jxr_linenumber" name="L158" href="#L158">158</a> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * Perform encryption using the given symmetric key</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @param symmetricKey The symmetric key to use for encryption</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @return the EncryptedData element</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">public</strong> Element encrypt(SecretKey symmetricKey) <strong class="jxr_keyword">throws</strong> <a name="WSSecurityException" href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html#WSSecurityException">WSSecurityException</a> { +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">if</strong> (getParts().isEmpty()) { +<a class="jxr_linenumber" name="L167" href="#L167">167</a> getParts().add(WSSecurityUtil.getDefaultEncryptionPart(getDocument())); +<a class="jxr_linenumber" name="L168" href="#L168">168</a> } +<a class="jxr_linenumber" name="L169" href="#L169">169</a> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> encryptForRef(<strong class="jxr_keyword">null</strong>, getParts(), symmetricKey); +<a class="jxr_linenumber" name="L171" href="#L171">171</a> } +<a class="jxr_linenumber" name="L172" href="#L172">172</a> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * Encrypt one or more parts or elements of the message.</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * This method takes a list of <code>WSEncryptionPart</code> object that</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * contain information about the elements to encrypt. The method call the</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * encryption method, takes the reference information generated during</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * encryption and add this to the <code>xenc:Reference</code> element.</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * This method can be called after <code>prepare()</code> and can be</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * called multiple times to encrypt a number of parts or elements.</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * The method generates a <code>xenc:Reference</code> element that <i>must</i></em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * be added to this token. See <code>addInternalRefElement()</code>.</em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * If the <code>dataRef</code> parameter is <code>null</code> the method</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * creates and initializes a new Reference element.</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @param dataRef A <code>xenc:Reference</code> element or <code>null</code></em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * @param references A list containing WSEncryptionPart objects</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * @param symmetricKey The symmetric key to use for encryption</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * @return Returns the updated <code>xenc:Reference</code> element</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * @throws WSSecurityException</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">public</strong> Element encryptForRef( +<a class="jxr_linenumber" name="L196" href="#L196">196</a> Element dataRef, +<a class="jxr_linenumber" name="L197" href="#L197">197</a> List<WSEncryptionPart> references, +<a class="jxr_linenumber" name="L198" href="#L198">198</a> SecretKey symmetricKey +<a class="jxr_linenumber" name="L199" href="#L199">199</a> ) <strong class="jxr_keyword">throws</strong> <a name="WSSecurityException" href="../../../../../org/apache/wss4j/common/ext/WSSecurityException.html#WSSecurityException">WSSecurityException</a> { +<a class="jxr_linenumber" name="L200" href="#L200">200</a> KeyInfo keyInfo = createKeyInfo(); +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_comment">//the sun/oracle jce provider doesn't like a foreign SecretKey impl.</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_comment">//this occurs e.g. with a kerberos session-key. It doesn't matter for the bouncy-castle provider</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_comment">//so create a new secretKeySpec to make everybody happy.</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> String keyAlgorithm = JCEMapper.getJCEKeyAlgorithmFromURI(getSymmetricEncAlgorithm()); +<a class="jxr_linenumber" name="L205" href="#L205">205</a> SecretKeySpec secretKeySpec = <strong class="jxr_keyword">new</strong> SecretKeySpec(symmetricKey.getEncoded(), keyAlgorithm); +<a class="jxr_linenumber" name="L206" href="#L206">206</a> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <a name="Encryptor" href="../../../../../org/apache/wss4j/dom/message/Encryptor.html#Encryptor">Encryptor</a> encryptor = <strong class="jxr_keyword">new</strong> <a name="Encryptor" href="../../../../../org/apache/wss4j/dom/message/Encryptor.html#Encryptor">Encryptor</a>(); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> encryptor.setDoc(getDocument()); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> encryptor.setSecurityHeader(getSecurityHeader()); +<a class="jxr_linenumber" name="L210" href="#L210">210</a> encryptor.setIdAllocator(getIdAllocator()); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> encryptor.setCallbackLookup(callbackLookup); +<a class="jxr_linenumber" name="L212" href="#L212">212</a> encryptor.setAttachmentCallbackHandler(attachmentCallbackHandler); +<a class="jxr_linenumber" name="L213" href="#L213">213</a> encryptor.setStoreBytesInAttachment(storeBytesInAttachment); +<a class="jxr_linenumber" name="L214" href="#L214">214</a> encryptor.setEncryptionSerializer(getEncryptionSerializer()); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> encryptor.setExpandXopInclude(isExpandXopInclude()); +<a class="jxr_linenumber" name="L216" href="#L216">216</a> encryptor.setWsDocInfo(getWsDocInfo()); +<a class="jxr_linenumber" name="L217" href="#L217">217</a> List<String> encDataRefs = +<a class="jxr_linenumber" name="L218" href="#L218">218</a> encryptor.doEncryption(keyInfo, secretKeySpec, getSymmetricEncAlgorithm(), references, attachmentEncryptedDataElements); +<a class="jxr_linenumber" name="L219" href="#L219">219</a> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_comment">// Clean the secret key from memory now that we're done with it</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L222" href="#L222">222</a> secretKeySpec.destroy(); +<a class="jxr_linenumber" name="L223" href="#L223">223</a> } <strong class="jxr_keyword">catch</strong> (DestroyFailedException e) { +<a class="jxr_linenumber" name="L224" href="#L224">224</a> LOG.debug(<span class="jxr_string">"Error destroying key: {}"</span>, e.getMessage()); +<a class="jxr_linenumber" name="L225" href="#L225">225</a> } +<a class="jxr_linenumber" name="L226" href="#L226">226</a> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> (encDataRefs.isEmpty()) { +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L229" href="#L229">229</a> } +<a class="jxr_linenumber" name="L230" href="#L230">230</a> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">if</strong> (dataRef == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L232" href="#L232">232</a> dataRef = +<a class="jxr_linenumber" name="L233" href="#L233">233</a> getDocument().createElementNS( +<a class="jxr_linenumber" name="L234" href="#L234">234</a> WSConstants.ENC_NS, +<a class="jxr_linenumber" name="L235" href="#L235">235</a> WSConstants.ENC_PREFIX + <span class="jxr_string">":ReferenceList"</span> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> ); +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_comment">// If we're not placing the ReferenceList in an EncryptedKey structure,</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_comment">// then add the ENC namespace</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">if</strong> (!encryptSymmKey) { +<a class="jxr_linenumber" name="L242" href="#L242">242</a> XMLUtils.setNamespace( +<a class="jxr_linenumber" name="L243" href="#L243">243</a> dataRef, WSConstants.ENC_NS, WSConstants.ENC_PREFIX +<a class="jxr_linenumber" name="L244" href="#L244">244</a> ); +<a class="jxr_linenumber" name="L245" href="#L245">245</a> } +<a class="jxr_linenumber" name="L246" href="#L246">246</a> } +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">return</strong> createDataRefList(getDocument(), dataRef, encDataRefs); +<a class="jxr_linenumber" name="L248" href="#L248">248</a> } +<a class="jxr_linenumber" name="L249" href="#L249">249</a> +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * Adds the internal Reference element to this Encrypt data.</em> +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> *</em>
[... 253 lines stripped ...]
