Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / xref / org / apache / shiro / crypto / PaddingScheme.html
blob: b490e3740addbf3ef0ef598bff59ee9b618fc47f [file] [log] [blame]
<!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>PaddingScheme xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/shiro/crypto/PaddingScheme.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_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="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.crypto;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em>
<a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * A {@code CipherPaddingScheme} represents well-known</em>
<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://en.wikipedia.org/wiki/Padding_(cryptography)" target="alexandria_uri">http://en.wikipedia.org/wiki/Padding_(cryptography)</a>"&gt;padding schemes&lt;/a&gt; supported by JPA providers in a</em>
<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * type-safe manner.</em>
<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * When encrypted data is transferred, it is usually desirable to ensure that all 'chunks' transferred are a fixed-length:</em>
<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * different length blocks might give cryptanalysts clues about what the data might be, among other reasons. Of course</em>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * not all data will convert to neat fixed-length blocks, so padding schemes are used to 'fill in' (pad) any remaining</em>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * space with unintelligible data.</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * Padding schemes can be used in both asymmetric key ciphers as well as symmetric key ciphers (e.g. block ciphers).</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Block-ciphers especially regularly use padding schemes as they are based on the notion of fixed-length block sizes.</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> *</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @see &lt;a href="<a href="http://en.wikipedia.org/wiki/Padding_(cryptography)" target="alexandria_uri">http://en.wikipedia.org/wiki/Padding_(cryptography)</a>"&gt;Wikipedia: Cryptographic Padding&lt;/a&gt;</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em>
<a name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../org/apache/shiro/crypto/PaddingScheme.html">PaddingScheme</a> {
<a name="38" href="#38">38</a>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * No padding. Useful when the block size is 8 bits for block cipher streaming operations. (Because</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * a byte is the most primitive block size, there is nothing to pad).</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
<a name="43" href="#43">43</a> NONE(<span class="jxr_string">"NoPadding"</span>),
<a name="44" href="#44">44</a>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Padding scheme as defined in the W3C's &amp;quot;XML Encryption Syntax and Processing&amp;quot; document,</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://www.w3.org/TR/xmlenc-core/" target="alexandria_uri">http://www.w3.org/TR/xmlenc-core/</a>#sec-Alg-Block"&gt;Section 5.2 - Block Encryption Algorithms&lt;/a&gt;.</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
<a name="49" href="#49">49</a> ISO10126(<span class="jxr_string">"ISO10126Padding"</span>),
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Optimal Asymmetric Encryption Padding defined in RSA's &lt;a href="<a href="http://en.wikipedia.org/wiki/PKCS1" target="alexandria_uri">http://en.wikipedia.org/wiki/PKCS1</a>"&gt;PKSC#1</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * standard&lt;/a&gt; (aka &lt;a href="<a href="http://tools.ietf.org/html/rfc3447" target="alexandria_uri">http://tools.ietf.org/html/rfc3447</a>"&gt;RFC 3447&lt;/a&gt;).</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * &lt;b&gt;NOTE:&lt;/b&gt; using this padding requires initializing {@link javax.crypto.Cipher Cipher} instances with a</em>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object which provides the 1) message digest and</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * 2) mask generation function to use for the scheme.</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * &lt;h3&gt;Convenient Alternatives&lt;/h3&gt;</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * While using this scheme enables you full customization of the message digest + mask generation function</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * combination, it does require the extra burden of providing your own {@code OAEPParameterSpec} object. This is</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * often unnecessary, because most combinations are fairly standard. These common combinations are pre-defined</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * in this enum in the {@code OAEP}* variants.</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * If you find that these common combinations still do not meet your needs, then you will need to</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * specify your own message digest and mask generation function, either as an {@code OAEPParameterSpec} object</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * during Cipher initialization or, maybe more easily, in the scheme name directly. If you want to use scheme name</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * approach, the name format is specified in the</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://java.sun.com/javase/6/docs/technotes/guides/security/StandardNames.html" target="alexandria_uri">http://java.sun.com/javase/6/docs/technotes/guides/security/StandardNames.html</a>"&gt;Standard Names&lt;/a&gt;</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * document in the &lt;code&gt;Cipher Algorithm Padding&lt;/code&gt; section.</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @see #OAEPWithMd5AndMgf1</em>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @see #OAEPWithSha1AndMgf1</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @see #OAEPWithSha256AndMgf1</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @see #OAEPWithSha384AndMgf1</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @see #OAEPWithSha512AndMgf1</em>
<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em>
<a name="77" href="#77">77</a> OAEP(<span class="jxr_string">"OAEPPadding"</span>),
<a name="78" href="#78">78</a>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Optimal Asymmetric Encryption Padding with {@code MD5} message digest and {@code MGF1} mask generation function.</em>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</em>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</em>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em>
<a name="87" href="#87">87</a> OAEPWithMd5AndMgf1(<span class="jxr_string">"OAEPWithMD5AndMGF1Padding"</span>),
<a name="88" href="#88">88</a>
<a name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em>
<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Optimal Asymmetric Encryption Padding with {@code SHA-1} message digest and {@code MGF1} mask generation function.</em>
<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</em>
<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</em>
<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</em>
<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</em>
<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> */</em>
<a name="97" href="#97">97</a> OAEPWithSha1AndMgf1(<span class="jxr_string">"OAEPWithSHA-1AndMGF1Padding"</span>),
<a name="98" href="#98">98</a>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment">/**</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * Optimal Asymmetric Encryption Padding with {@code SHA-256} message digest and {@code MGF1} mask generation function.</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em>
<a name="107" href="#107">107</a> OAEPWithSha256AndMgf1(<span class="jxr_string">"OAEPWithSHA-256AndMGF1Padding"</span>),
<a name="108" href="#108">108</a>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">/**</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * Optimal Asymmetric Encryption Padding with {@code SHA-384} message digest and {@code MGF1} mask generation function.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em>
<a name="117" href="#117">117</a> OAEPWithSha384AndMgf1(<span class="jxr_string">"OAEPWithSHA-384AndMGF1Padding"</span>),
<a name="118" href="#118">118</a>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">/**</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * Optimal Asymmetric Encryption Padding with {@code SHA-512} message digest and {@code MGF1} mask generation function.</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function.</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * When using this padding scheme, there is no need to init the {@code Cipher} instance with an</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * {@link javax.crypto.spec.OAEPParameterSpec OAEPParameterSpec} object, as it is already 'built in' to the scheme</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * name (unlike the {@link #OAEP OAEP} scheme, which requires a bit more work).</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> */</em>
<a name="127" href="#127">127</a> OAEPWithSha512AndMgf1(<span class="jxr_string">"OAEPWithSHA-512AndMGF1Padding"</span>),
<a name="128" href="#128">128</a>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">/**</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * Padding scheme used with the {@code RSA} algorithm defined in RSA's</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://en.wikipedia.org/wiki/PKCS1" target="alexandria_uri">http://en.wikipedia.org/wiki/PKCS1</a>"&gt;PKSC#1 standard&lt;/a&gt; (aka</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://tools.ietf.org/html/rfc3447" target="alexandria_uri">http://tools.ietf.org/html/rfc3447</a>"&gt;RFC 3447&lt;/a&gt;).</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> */</em>
<a name="134" href="#134">134</a> PKCS1(<span class="jxr_string">"PKCS1Padding"</span>),
<a name="135" href="#135">135</a>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * Padding scheme defined in RSA's &lt;a href="<a href="http://www.rsa.com/rsalabs/node.asp?id=2127" target="alexandria_uri">http://www.rsa.com/rsalabs/node.asp?id=2127</a>"&gt;Password-Based</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * Cryptography Standard&lt;/a&gt;.</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> */</em>
<a name="140" href="#140">140</a> PKCS5(<span class="jxr_string">"PKCS5Padding"</span>),
<a name="141" href="#141">141</a>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Padding scheme defined in the &lt;a href="<a href="http://www.mozilla.org/projects/security/pki/nss/ssl/draft302.txt" target="alexandria_uri">http://www.mozilla.org/projects/security/pki/nss/ssl/draft302.txt</a>"&gt;SSL</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * 3.0 specification&lt;/a&gt;, section &lt;code&gt;5.2.3.2 (CBC block cipher)&lt;/code&gt;.</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em>
<a name="146" href="#146">146</a> SSL3(<span class="jxr_string">"SSL3Padding"</span>);
<a name="147" href="#147">147</a>
<a name="148" href="#148">148</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String transformationName;
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/shiro/crypto/PaddingScheme.html">PaddingScheme</a>(String transformationName) {
<a name="151" href="#151">151</a> <strong class="jxr_keyword">this</strong>.transformationName = transformationName;
<a name="152" href="#152">152</a> }
<a name="153" href="#153">153</a>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">/**</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * Returns the actual string name to use when building the {@link javax.crypto.Cipher Cipher}</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * {@code transformation string}.</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> *</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * @return the actual string name to use when building the {@link javax.crypto.Cipher Cipher}</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * {@code transformation string}.</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @see javax.crypto.Cipher#getInstance(String)</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> */</em>
<a name="162" href="#162">162</a> <strong class="jxr_keyword">public</strong> String getTransformationName() {
<a name="163" href="#163">163</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.transformationName;
<a name="164" href="#164">164</a> }
<a name="165" href="#165">165</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>