| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>PaddingScheme (Apache Shiro 1.12.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PaddingScheme (Apache Shiro 1.12.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":9,"i2":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PaddingScheme.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.shiro.crypto</a></div> |
| <h2 title="Enum PaddingScheme" class="title">Enum PaddingScheme</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Enum</a><<a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.crypto.PaddingScheme</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a>></code></dd> |
| </dl> |
| <hr> |
| <pre>public enum <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.37">PaddingScheme</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a><<a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a>></pre> |
| <div class="block">A <code>CipherPaddingScheme</code> represents well-known |
| <a href="http://en.wikipedia.org/wiki/Padding_(cryptography)">padding schemes</a> supported by JPA providers in a |
| type-safe manner. |
| <p/> |
| When encrypted data is transferred, it is usually desirable to ensure that all 'chunks' transferred are a fixed-length: |
| different length blocks might give cryptanalysts clues about what the data might be, among other reasons. Of course |
| not all data will convert to neat fixed-length blocks, so padding schemes are used to 'fill in' (pad) any remaining |
| space with unintelligible data. |
| <p/> |
| Padding schemes can be used in both asymmetric key ciphers as well as symmetric key ciphers (e.g. block ciphers). |
| Block-ciphers especially regularly use padding schemes as they are based on the notion of fixed-length block sizes.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://en.wikipedia.org/wiki/Padding_(cryptography)">Wikipedia: Cryptographic Padding</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum Constant</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ISO10126">ISO10126</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Padding scheme as defined in the W3C's "XML Encryption Syntax and Processing" document, |
| <a href="http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block">Section 5.2 - Block Encryption Algorithms</a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#NONE">NONE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">No padding.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#OAEP">OAEP</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Optimal Asymmetric Encryption Padding defined in RSA's <a href="http://en.wikipedia.org/wiki/PKCS1">PKSC#1 |
| standard</a> (aka <a href="http://tools.ietf.org/html/rfc3447">RFC 3447</a>).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#OAEPWithMd5AndMgf1">OAEPWithMd5AndMgf1</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>MD5</code> message digest and <code>MGF1</code> mask generation function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#OAEPWithSha1AndMgf1">OAEPWithSha1AndMgf1</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>SHA-1</code> message digest and <code>MGF1</code> mask generation function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#OAEPWithSha256AndMgf1">OAEPWithSha256AndMgf1</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>SHA-256</code> message digest and <code>MGF1</code> mask generation function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#OAEPWithSha384AndMgf1">OAEPWithSha384AndMgf1</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>SHA-384</code> message digest and <code>MGF1</code> mask generation function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#OAEPWithSha512AndMgf1">OAEPWithSha512AndMgf1</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>SHA-512</code> message digest and <code>MGF1</code> mask generation function.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PKCS1">PKCS1</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Padding scheme used with the <code>RSA</code> algorithm defined in RSA's |
| <a href="http://en.wikipedia.org/wiki/PKCS1">PKSC#1 standard</a> (aka |
| <a href="http://tools.ietf.org/html/rfc3447">RFC 3447</a>).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PKCS5">PKCS5</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Padding scheme defined in RSA's <a href="http://www.rsa.com/rsalabs/node.asp?id=2127">Password-Based |
| Cryptography Standard</a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SSL3">SSL3</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Padding scheme defined in the <a href="http://www.mozilla.org/projects/security/pki/nss/ssl/draft302.txt">SSL |
| 3.0 specification</a>, section <code>5.2.3.2 (CBC block cipher)</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransformationName()">getTransformationName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the actual string name to use when building the <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/Cipher.html?is-external=true" title="class or interface in javax.crypto" class="externalLink"><code>Cipher</code></a> |
| <code>transformation string</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang" class="externalLink">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang" class="externalLink">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang" class="externalLink">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang" class="externalLink">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="externalLink">valueOf</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a id="NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NONE</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.43">NONE</a></pre> |
| <div class="block">No padding. Useful when the block size is 8 bits for block cipher streaming operations. (Because |
| a byte is the most primitive block size, there is nothing to pad).</div> |
| </li> |
| </ul> |
| <a id="ISO10126"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ISO10126</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.49">ISO10126</a></pre> |
| <div class="block">Padding scheme as defined in the W3C's "XML Encryption Syntax and Processing" document, |
| <a href="http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block">Section 5.2 - Block Encryption Algorithms</a>.</div> |
| </li> |
| </ul> |
| <a id="OAEP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OAEP</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.77">OAEP</a></pre> |
| <div class="block">Optimal Asymmetric Encryption Padding defined in RSA's <a href="http://en.wikipedia.org/wiki/PKCS1">PKSC#1 |
| standard</a> (aka <a href="http://tools.ietf.org/html/rfc3447">RFC 3447</a>). |
| <p/> |
| <b>NOTE:</b> using this padding requires initializing <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/Cipher.html?is-external=true" title="class or interface in javax.crypto" class="externalLink"><code>Cipher</code></a> instances with a |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec" class="externalLink"><code>OAEPParameterSpec</code></a> object which provides the 1) message digest and |
| 2) mask generation function to use for the scheme. |
| <h3>Convenient Alternatives</h3> |
| While using this scheme enables you full customization of the message digest + mask generation function |
| combination, it does require the extra burden of providing your own <code>OAEPParameterSpec</code> object. This is |
| often unnecessary, because most combinations are fairly standard. These common combinations are pre-defined |
| in this enum in the <code>OAEP</code>* variants. |
| <p/> |
| If you find that these common combinations still do not meet your needs, then you will need to |
| specify your own message digest and mask generation function, either as an <code>OAEPParameterSpec</code> object |
| during Cipher initialization or, maybe more easily, in the scheme name directly. If you want to use scheme name |
| approach, the name format is specified in the |
| <a href="http://java.sun.com/javase/6/docs/technotes/guides/security/StandardNames.html">Standard Names</a> |
| document in the <code>Cipher Algorithm Padding</code> section.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#OAEPWithMd5AndMgf1"><code>OAEPWithMd5AndMgf1</code></a>, |
| <a href="#OAEPWithSha1AndMgf1"><code>OAEPWithSha1AndMgf1</code></a>, |
| <a href="#OAEPWithSha256AndMgf1"><code>OAEPWithSha256AndMgf1</code></a>, |
| <a href="#OAEPWithSha384AndMgf1"><code>OAEPWithSha384AndMgf1</code></a>, |
| <a href="#OAEPWithSha512AndMgf1"><code>OAEPWithSha512AndMgf1</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="OAEPWithMd5AndMgf1"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OAEPWithMd5AndMgf1</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.87">OAEPWithMd5AndMgf1</a></pre> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>MD5</code> message digest and <code>MGF1</code> mask generation function. |
| <p/> |
| This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function. |
| When using this padding scheme, there is no need to init the <code>Cipher</code> instance with an |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec" class="externalLink"><code>OAEPParameterSpec</code></a> object, as it is already 'built in' to the scheme |
| name (unlike the <a href="#OAEP"><code>OAEP</code></a> scheme, which requires a bit more work).</div> |
| </li> |
| </ul> |
| <a id="OAEPWithSha1AndMgf1"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OAEPWithSha1AndMgf1</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.97">OAEPWithSha1AndMgf1</a></pre> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>SHA-1</code> message digest and <code>MGF1</code> mask generation function. |
| <p/> |
| This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function. |
| When using this padding scheme, there is no need to init the <code>Cipher</code> instance with an |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec" class="externalLink"><code>OAEPParameterSpec</code></a> object, as it is already 'built in' to the scheme |
| name (unlike the <a href="#OAEP"><code>OAEP</code></a> scheme, which requires a bit more work).</div> |
| </li> |
| </ul> |
| <a id="OAEPWithSha256AndMgf1"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OAEPWithSha256AndMgf1</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.107">OAEPWithSha256AndMgf1</a></pre> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>SHA-256</code> message digest and <code>MGF1</code> mask generation function. |
| <p/> |
| This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function. |
| When using this padding scheme, there is no need to init the <code>Cipher</code> instance with an |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec" class="externalLink"><code>OAEPParameterSpec</code></a> object, as it is already 'built in' to the scheme |
| name (unlike the <a href="#OAEP"><code>OAEP</code></a> scheme, which requires a bit more work).</div> |
| </li> |
| </ul> |
| <a id="OAEPWithSha384AndMgf1"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OAEPWithSha384AndMgf1</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.117">OAEPWithSha384AndMgf1</a></pre> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>SHA-384</code> message digest and <code>MGF1</code> mask generation function. |
| <p/> |
| This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function. |
| When using this padding scheme, there is no need to init the <code>Cipher</code> instance with an |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec" class="externalLink"><code>OAEPParameterSpec</code></a> object, as it is already 'built in' to the scheme |
| name (unlike the <a href="#OAEP"><code>OAEP</code></a> scheme, which requires a bit more work).</div> |
| </li> |
| </ul> |
| <a id="OAEPWithSha512AndMgf1"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OAEPWithSha512AndMgf1</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.127">OAEPWithSha512AndMgf1</a></pre> |
| <div class="block">Optimal Asymmetric Encryption Padding with <code>SHA-512</code> message digest and <code>MGF1</code> mask generation function. |
| <p/> |
| This is a convenient pre-defined OAEP padding scheme that embeds the message digest and mask generation function. |
| When using this padding scheme, there is no need to init the <code>Cipher</code> instance with an |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec" class="externalLink"><code>OAEPParameterSpec</code></a> object, as it is already 'built in' to the scheme |
| name (unlike the <a href="#OAEP"><code>OAEP</code></a> scheme, which requires a bit more work).</div> |
| </li> |
| </ul> |
| <a id="PKCS1"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PKCS1</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.134">PKCS1</a></pre> |
| <div class="block">Padding scheme used with the <code>RSA</code> algorithm defined in RSA's |
| <a href="http://en.wikipedia.org/wiki/PKCS1">PKSC#1 standard</a> (aka |
| <a href="http://tools.ietf.org/html/rfc3447">RFC 3447</a>).</div> |
| </li> |
| </ul> |
| <a id="PKCS5"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PKCS5</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.140">PKCS5</a></pre> |
| <div class="block">Padding scheme defined in RSA's <a href="http://www.rsa.com/rsalabs/node.asp?id=2127">Password-Based |
| Cryptography Standard</a>.</div> |
| </li> |
| </ul> |
| <a id="SSL3"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SSL3</h4> |
| <pre>public static final <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.146">SSL3</a></pre> |
| <div class="block">Padding scheme defined in the <a href="http://www.mozilla.org/projects/security/pki/nss/ssl/draft302.txt">SSL |
| 3.0 specification</a>, section <code>5.2.3.2 (CBC block cipher)</code>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="values()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre class="methodSignature">public static <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a>[] <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.37">values</a>()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (PaddingScheme c : PaddingScheme.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="valueOf(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre class="methodSignature">public static <a href="PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.37">valueOf</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTransformationName()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTransformationName</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.162">getTransformationName</a>()</pre> |
| <div class="block">Returns the actual string name to use when building the <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/Cipher.html?is-external=true" title="class or interface in javax.crypto" class="externalLink"><code>Cipher</code></a> |
| <code>transformation string</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the actual string name to use when building the <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/Cipher.html?is-external=true" title="class or interface in javax.crypto" class="externalLink"><code>Cipher</code></a> |
| <code>transformation string</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/Cipher.html?is-external=true#getInstance(java.lang.String)" title="class or interface in javax.crypto" class="externalLink"><code>Cipher.getInstance(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PaddingScheme.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |