You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ws.apache.org by di...@apache.org on 2005/03/09 17:09:28 UTC
cvs commit: ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/dkAlgo AlgoFactory.html DerivationAlgorithm.html P_SHA1.html package-frame.html package-summary.html
dims 2005/03/09 08:09:28
Added: targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/dkAlgo
AlgoFactory.html DerivationAlgorithm.html
P_SHA1.html package-frame.html package-summary.html
Log:
Update WSS4J web site.
Revision Changes Path
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/dkAlgo/AlgoFactory.html
Index: AlgoFactory.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>AlgoFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/ws/security/conversation/dkAlgo/AlgoFactory.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * Copyright 2003-2004 The Apache Software Foundation.</em>
<a name="3" href="#3">3</a> <em class="comment"> *</em>
<a name="4" href="#4">4</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a> <em class="comment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a> <em class="comment"> *</em>
<a name="8" href="#8">8</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a> <em class="comment"> *</em>
<a name="10" href="#10">10</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a> <em class="comment"> * limitations under the License.</em>
<a name="15" href="#15">15</a> <em class="comment"> *</em>
<a name="16" href="#16">16</a> <em class="comment"> */</em>
<a name="17" href="#17">17</a>
<a name="18" href="#18">18</a> <strong>package</strong> <a href="../../../../../../org/apache/ws/security/conversation/dkAlgo/package-summary.html">org.apache.ws.security.conversation.dkAlgo</a>;
<a name="19" href="#19">19</a>
<a name="20" href="#20">20</a> <strong>import</strong> org.apache.ws.security.conversation.ConversationException;
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <em>/**<em>*</em></em>
<a name="23" href="#23">23</a> <em> * @author Ruchith Fernando</em>
<a name="24" href="#24">24</a> <em> * @version 1.0</em>
<a name="25" href="#25">25</a> <em> */</em>
<a name="26" href="#26">26</a>
<a name="27" href="#27">27</a> <strong>public</strong> <strong>class</strong> <a href="../../../../../../org/apache/ws/security/conversation/dkAlgo/AlgoFactory.html">AlgoFactory</a> {
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <em>/**<em>*</em></em>
<a name="30" href="#30">30</a> <em> * This gives a DerivationAlgorithm instance from the default set of algorithms provided</em>
<a name="31" href="#31">31</a> <em> *</em>
<a name="32" href="#32">32</a> <em> * @param algorithm The algo identifier @see DeivationAlgorithm</em>
<a name="33" href="#33">33</a> <em> * @return A derivatio algorithm</em>
<a name="34" href="#34">34</a> <em> * @throws ConversationException If the specified algorithmis not available in</em>
<a name="35" href="#35">35</a> <em> * default implementations</em>
<a name="36" href="#36">36</a> <em> */</em>
<a name="37" href="#37">37</a> <strong>public</strong> <strong>static</strong> <a href="../../../../../../org/apache/ws/security/conversation/dkAlgo/DerivationAlgorithm.html">DerivationAlgorithm</a> getInstance(String algorithm) throws
<a name="38" href="#38">38</a> <a href="../../../../../../org/apache/ws/security/conversation/ConversationException.html">ConversationException</a> {
<a name="39" href="#39">39</a> <strong>if</strong> (algorithm.equals(DerivationAlgorithm.P_SHA_1)) {
<a name="40" href="#40">40</a> <strong>return</strong> <strong>new</strong> P_SHA1();
<a name="41" href="#41">41</a> } <strong>else</strong> {
<a name="42" href="#42">42</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../../../org/apache/ws/security/conversation/ConversationException.html">ConversationException</a>(<span class="string">"No such algorithm"</span>);
<a name="43" href="#43">43</a> }
<a name="44" href="#44">44</a> }
<a name="45" href="#45">45</a>
<a name="46" href="#46">46</a> <em>/**<em>* @todo instanciate an algo from a algo class externally specified */</em></em>
<a name="47" href="#47">47</a> <em class="comment">// public static DerivationAlgorithm getInstance(String algoClass, Properties properties) {</em>
<a name="48" href="#48">48</a> <em class="comment">//</em>
<a name="49" href="#49">49</a> <em class="comment">// }</em>
<a name="50" href="#50">50</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/dkAlgo/DerivationAlgorithm.html
Index: DerivationAlgorithm.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>DerivationAlgorithm xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/ws/security/conversation/dkAlgo/DerivationAlgorithm.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * Copyright 2003-2004 The Apache Software Foundation.</em>
<a name="3" href="#3">3</a> <em class="comment"> *</em>
<a name="4" href="#4">4</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a> <em class="comment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a> <em class="comment"> *</em>
<a name="8" href="#8">8</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a> <em class="comment"> *</em>
<a name="10" href="#10">10</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a> <em class="comment"> * limitations under the License.</em>
<a name="15" href="#15">15</a> <em class="comment"> *</em>
<a name="16" href="#16">16</a> <em class="comment"> */</em>
<a name="17" href="#17">17</a>
<a name="18" href="#18">18</a> <strong>package</strong> <a href="../../../../../../org/apache/ws/security/conversation/dkAlgo/package-summary.html">org.apache.ws.security.conversation.dkAlgo</a>;
<a name="19" href="#19">19</a>
<a name="20" href="#20">20</a> <strong>import</strong> org.apache.ws.security.conversation.ConversationException;
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../../../org/apache/ws/security/conversation/dkAlgo/DerivationAlgorithm.html">DerivationAlgorithm</a> {
<a name="23" href="#23">23</a>
<a name="24" href="#24">24</a> <em>/**<em>*</em></em>
<a name="25" href="#25">25</a> <em> * This is the default key generation algotithm</em>
<a name="26" href="#26">26</a> <em> */</em>
<a name="27" href="#27">27</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String P_SHA_1 = <span class="string">"http://schemas.xmlsoap.org/ws/2004/04/security/sc/dk/p_sha1"</span>;
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <em>/**<em>*</em></em>
<a name="30" href="#30">30</a> <em> * @param secret</em>
<a name="31" href="#31">31</a> <em> * @param labelAndNonce</em>
<a name="32" href="#32">32</a> <em> * @param length</em>
<a name="33" href="#33">33</a> <em> * @return</em>
<a name="34" href="#34">34</a> <em> */</em>
<a name="35" href="#35">35</a> <strong>public</strong> byte[] createKey(byte[] secret, String labelAndNonce, <strong>int</strong> offset, <strong>long</strong> length) throws ConversationException;
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/dkAlgo/P_SHA1.html
Index: P_SHA1.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>P_SHA1 xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/ws/security/conversation/dkAlgo/P_SHA1.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * Copyright 2003-2004 The Apache Software Foundation.</em>
<a name="3" href="#3">3</a> <em class="comment"> *</em>
<a name="4" href="#4">4</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a> <em class="comment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a> <em class="comment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a> <em class="comment"> *</em>
<a name="8" href="#8">8</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a> <em class="comment"> *</em>
<a name="10" href="#10">10</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a> <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a> <em class="comment"> * limitations under the License.</em>
<a name="15" href="#15">15</a> <em class="comment"> *</em>
<a name="16" href="#16">16</a> <em class="comment"> */</em>
<a name="17" href="#17">17</a>
<a name="18" href="#18">18</a> <strong>package</strong> <a href="../../../../../../org/apache/ws/security/conversation/dkAlgo/package-summary.html">org.apache.ws.security.conversation.dkAlgo</a>;
<a name="19" href="#19">19</a>
<a name="20" href="#20">20</a> <em>/**<em>*</em></em>
<a name="21" href="#21">21</a> <em> *</em>
<a name="22" href="#22">22</a> <em> <pre></em>
<a name="23" href="#23">23</a> <em> P_SHA-1 DEFINITION</em>
<a name="24" href="#24">24</a> <em> ==================</em>
<a name="25" href="#25">25</a> <em> <b>P_SHA-1(secret, seed)</b> =</em>
<a name="26" href="#26">26</a> <em> HMAC_SHA-1(secret, A(1) + seed) +</em>
<a name="27" href="#27">27</a> <em> HMAC_SHA-1(secret, A(2) + seed) +</em>
<a name="28" href="#28">28</a> <em> HMAC_SHA-1(secret, A(3) + seed) + ...</em>
<a name="29" href="#29">29</a> <em> <i>Where + indicates concatenation.</i></em>
<a name="30" href="#30">30</a> <em> <br></em>
<a name="31" href="#31">31</a> <em> A() is defined as:</em>
<a name="32" href="#32">32</a> <em> A(0) = seed</em>
<a name="33" href="#33">33</a> <em> A(i) = HMAC_SHA-1(secret, A(i-1))</em>
<a name="34" href="#34">34</a> <em> <br></em>
<a name="35" href="#35">35</a> <em> <i>Source : RFC 2246 - The TLS Protocol Version 1.0</em>
<a name="36" href="#36">36</a> <em> Section 5. HMAC and the pseudorandom function</i></em>
<a name="37" href="#37">37</a> <em> </pre></em>
<a name="38" href="#38">38</a> <em> *</em>
<a name="39" href="#39">39</a> <em> * @author Ruchith Fernando</em>
<a name="40" href="#40">40</a> <em> * @version 1.0</em>
<a name="41" href="#41">41</a> <em> */</em>
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <strong>import</strong> org.apache.ws.security.conversation.ConversationException;
<a name="44" href="#44">44</a>
<a name="45" href="#45">45</a> <strong>import</strong> javax.crypto.Mac;
<a name="46" href="#46">46</a> <strong>import</strong> javax.crypto.spec.SecretKeySpec;
<a name="47" href="#47">47</a>
<a name="48" href="#48">48</a> <strong>public</strong> <strong>class</strong> P_SHA1
<a name="49" href="#49">49</a> implements <a href="../../../../../../org/apache/ws/security/conversation/dkAlgo/DerivationAlgorithm.html">DerivationAlgorithm</a> {
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <strong>private</strong> byte[] secret;
<a name="52" href="#52">52</a> <strong>private</strong> String seed;
<a name="53" href="#53">53</a>
<a name="54" href="#54">54</a> <strong>public</strong> byte[] createKey(byte[] secret, String labelAndNonce, <strong>int</strong> offset,
<a name="55" href="#55">55</a> <strong>long</strong> length) throws ConversationException {
<a name="56" href="#56">56</a> <strong>try</strong> {
<a name="57" href="#57">57</a> Mac mac = Mac.getInstance(<span class="string">"HmacSHA1"</span>);
<a name="58" href="#58">58</a> byte[] key = <strong>new</strong> String(P_hash(secret, labelAndNonce.getBytes(), mac,
<a name="59" href="#59">59</a> (offset + (<strong>int</strong>) length))).substring(offset,
<a name="60" href="#60">60</a> (<strong>int</strong>) length).getBytes();
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <strong>return</strong> key;
<a name="63" href="#63">63</a> } <strong>catch</strong> (Exception ex) {
<a name="64" href="#64">64</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../../../org/apache/ws/security/conversation/ConversationException.html">ConversationException</a>(<span class="string">"Key Derivation : P_SHA-1: "</span> +
<a name="65" href="#65">65</a> ex.getMessage());
<a name="66" href="#66">66</a> }
<a name="67" href="#67">67</a> }
<a name="68" href="#68">68</a>
<a name="69" href="#69">69</a> <em>/**<em>*</em></em>
<a name="70" href="#70">70</a> <em> * Stolen from WSUsernameToken :-)</em>
<a name="71" href="#71">71</a> <em> *</em>
<a name="72" href="#72">72</a> <em> * @param secret</em>
<a name="73" href="#73">73</a> <em> * @param seed</em>
<a name="74" href="#74">74</a> <em> * @param mac</em>
<a name="75" href="#75">75</a> <em> * @param required</em>
<a name="76" href="#76">76</a> <em> * @return</em>
<a name="77" href="#77">77</a> <em> * @throws java.lang.Exception</em>
<a name="78" href="#78">78</a> <em> */</em>
<a name="79" href="#79">79</a> <strong>private</strong> <strong>static</strong> byte[] P_hash(byte[] secret, byte[] seed, Mac mac,
<a name="80" href="#80">80</a> <strong>int</strong> required) throws Exception {
<a name="81" href="#81">81</a> byte[] out = <strong>new</strong> byte[required];
<a name="82" href="#82">82</a> <strong>int</strong> offset = 0, tocpy;
<a name="83" href="#83">83</a> byte[] A, tmp;
<a name="84" href="#84">84</a> A = seed;
<a name="85" href="#85">85</a> <strong>while</strong> (required > 0) {
<a name="86" href="#86">86</a> SecretKeySpec key = <strong>new</strong> SecretKeySpec(secret, <span class="string">"HMACSHA1"</span>);
<a name="87" href="#87">87</a> mac.init(key);
<a name="88" href="#88">88</a> mac.update(A);
<a name="89" href="#89">89</a> A = mac.doFinal();
<a name="90" href="#90">90</a> mac.reset();
<a name="91" href="#91">91</a> mac.init(key);
<a name="92" href="#92">92</a> mac.update(A);
<a name="93" href="#93">93</a> mac.update(seed);
<a name="94" href="#94">94</a> tmp = mac.doFinal();
<a name="95" href="#95">95</a> tocpy = min(required, tmp.length);
<a name="96" href="#96">96</a> System.arraycopy(tmp, 0, out, offset, tocpy);
<a name="97" href="#97">97</a> offset += tocpy;
<a name="98" href="#98">98</a> required -= tocpy;
<a name="99" href="#99">99</a> }
<a name="100" href="#100">100</a> <strong>return</strong> out;
<a name="101" href="#101">101</a> }
<a name="102" href="#102">102</a>
<a name="103" href="#103">103</a> <strong>private</strong> <strong>static</strong> <strong>int</strong> min(<strong>int</strong> a, <strong>int</strong> b) {
<a name="104" href="#104">104</a> <strong>return</strong> (a > b) ? b : a;
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/dkAlgo/package-frame.html
Index: package-frame.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"></meta>
<title>Apache WSS4J 1.0 Reference Package org.apache.ws.security.conversation.dkAlgo</title>
<link rel="stylesheet" href="../../../../../../stylesheet.css" type="text/css" title="style"></link>
</head>
<body>
<h3>
<a href="package-summary.html" target="classFrame">org.apache.ws.security.conversation.dkAlgo</a>
</h3>
<h3>Classes</h3>
<ul>
<li>
<a href="AlgoFactory.html" target="classFrame">AlgoFactory</a>
</li>
<li>
<a href="DerivationAlgorithm.html" target="classFrame">DerivationAlgorithm</a>
</li>
<li>
<a href="P_SHA1.html" target="classFrame">P_SHA1</a>
</li>
</ul>
</body>
</html>
1.1 ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/dkAlgo/package-summary.html
Index: package-summary.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"></meta>
<title>Apache WSS4J 1.0 Reference Package </title>
<link rel="stylesheet" href="../../../../../../stylesheet.css" type="text/css" title="style"></link>
</head>
<body>
<div class="overview">
<ul>
<li>
<a href="../../../../../../overview-summary.html">Overview</a>
</li>
<li class="selected">Package</li>
</ul>
</div>
<div class="framenoframe">
<ul>
<li>
<a href="../../../../../../index.html" target="_top">FRAMES</a>
</li>
<li>
<a href="package-summary.html" target="_top">NO FRAMES</a>
</li>
</ul>
</div>
<h2>Package org.apache.ws.security.conversation.dkAlgo</h2>
<table class="summary">
<thead>
<tr>
<th>Class Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="AlgoFactory.html" target="classFrame">AlgoFactory</a>
</td>
</tr>
<tr>
<td>
<a href="DerivationAlgorithm.html" target="classFrame">DerivationAlgorithm</a>
</td>
</tr>
<tr>
<td>
<a href="P_SHA1.html" target="classFrame">P_SHA1</a>
</td>
</tr>
</tbody>
</table>
<div class="overview">
<ul>
<li>
<a href="../../../../../../overview-summary.html">Overview</a>
</li>
<li class="selected">Package</li>
</ul>
</div>
<div class="framenoframe">
<ul>
<li>
<a href="../../../../../../index.html" target="_top">FRAMES</a>
</li>
<li>
<a href="package-summary.html" target="_top">NO FRAMES</a>
</li>
</ul>
</div>
<hr></hr>
Copyright © Apache Web Services. All Rights Reserved.
</body>
</html>