blob: c9a0ed5a779297c819d06864b49cdccf5e57ce6e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_65) on Tue Feb 25 18:15:47 EST 2014 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
PaddingScheme (Apache Shiro 1.2.3 API)
</TITLE>
<META NAME="date" CONTENT="2014-02-25">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PaddingScheme (Apache Shiro 1.2.3 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PaddingScheme.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/shiro/crypto/OperationMode.html" title="enum in org.apache.shiro.crypto"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/shiro/crypto/RandomNumberGenerator.html" title="interface in org.apache.shiro.crypto"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/shiro/crypto/PaddingScheme.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="PaddingScheme.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.shiro.crypto</FONT>
<BR>
Enum PaddingScheme</H2>
<PRE>
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</A>&lt;<A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A>&gt;
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.shiro.crypto.PaddingScheme</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;<A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A>&gt;</DD>
</DL>
<HR>
<DL>
<DT><PRE>public enum <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.37"><B>PaddingScheme</B></A><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A>&lt;<A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A>&gt;</DL>
</PRE>
<P>
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.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.0</DD>
<DT><B>See Also:</B><DD><a href="http://en.wikipedia.org/wiki/Padding_(cryptography)">Wikipedia: Cryptographic Padding</a></DL>
<HR>
<P>
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<A NAME="enum_constant_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Enum Constant Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#ISO10126">ISO10126</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Padding scheme as defined in the W3C's &quot;XML Encryption Syntax and Processing&quot; document,
<a href="http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block">Section 5.2 - Block Encryption Algorithms</a>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#NONE">NONE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;No padding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEP">OAEP</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithMd5AndMgf1">OAEPWithMd5AndMgf1</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Optimal Asymmetric Encryption Padding with <code>MD5</code> message digest and <code>MGF1</code> mask generation function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithSha1AndMgf1">OAEPWithSha1AndMgf1</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Optimal Asymmetric Encryption Padding with <code>SHA-1</code> message digest and <code>MGF1</code> mask generation function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithSha256AndMgf1">OAEPWithSha256AndMgf1</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Optimal Asymmetric Encryption Padding with <code>SHA-256</code> message digest and <code>MGF1</code> mask generation function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithSha384AndMgf1">OAEPWithSha384AndMgf1</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Optimal Asymmetric Encryption Padding with <code>SHA-384</code> message digest and <code>MGF1</code> mask generation function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithSha512AndMgf1">OAEPWithSha512AndMgf1</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Optimal Asymmetric Encryption Padding with <code>SHA-512</code> message digest and <code>MGF1</code> mask generation function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#PKCS1">PKCS1</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#PKCS5">PKCS5</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Padding scheme defined in RSA's <a href="http://www.rsa.com/rsalabs/node.asp?id=2127">Password-Based
Cryptography Standard</a>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#SSL3">SSL3</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#getTransformationName()">getTransformationName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the actual string name to use when building the <A HREF="http://java.sun.com/javase/6/docs/api/javax/crypto/Cipher.html?is-external=true" title="class or interface in javax.crypto"><CODE>Cipher</CODE></A>
<code>transformation string</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#valueOf(java.lang.String)">valueOf</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the enum constant of this type with the specified name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#values()">values</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the constants of this enum type, in
the order they are declared.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class, java.lang.String)" title="class or interface in java.lang">valueOf</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<A NAME="enum_constant_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Enum Constant Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="NONE"><!-- --></A><H3>
NONE</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.43"><B>NONE</B></A></PRE>
<DL>
<DD>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).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="ISO10126"><!-- --></A><H3>
ISO10126</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.49"><B>ISO10126</B></A></PRE>
<DL>
<DD>Padding scheme as defined in the W3C's &quot;XML Encryption Syntax and Processing&quot; document,
<a href="http://www.w3.org/TR/xmlenc-core/#sec-Alg-Block">Section 5.2 - Block Encryption Algorithms</a>.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="OAEP"><!-- --></A><H3>
OAEP</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.77"><B>OAEP</B></A></PRE>
<DL>
<DD>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="http://java.sun.com/javase/6/docs/api/javax/crypto/Cipher.html?is-external=true" title="class or interface in javax.crypto"><CODE>Cipher</CODE></A> instances with a
<A HREF="http://java.sun.com/javase/6/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec"><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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithMd5AndMgf1"><CODE>OAEPWithMd5AndMgf1</CODE></A>,
<A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithSha1AndMgf1"><CODE>OAEPWithSha1AndMgf1</CODE></A>,
<A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithSha256AndMgf1"><CODE>OAEPWithSha256AndMgf1</CODE></A>,
<A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithSha384AndMgf1"><CODE>OAEPWithSha384AndMgf1</CODE></A>,
<A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEPWithSha512AndMgf1"><CODE>OAEPWithSha512AndMgf1</CODE></A></DL>
</DL>
<HR>
<A NAME="OAEPWithMd5AndMgf1"><!-- --></A><H3>
OAEPWithMd5AndMgf1</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.87"><B>OAEPWithMd5AndMgf1</B></A></PRE>
<DL>
<DD>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="http://java.sun.com/javase/6/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec"><CODE>OAEPParameterSpec</CODE></A> object, as it is already 'built in' to the scheme
name (unlike the <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEP"><CODE>OAEP</CODE></A> scheme, which requires a bit more work).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="OAEPWithSha1AndMgf1"><!-- --></A><H3>
OAEPWithSha1AndMgf1</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.97"><B>OAEPWithSha1AndMgf1</B></A></PRE>
<DL>
<DD>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="http://java.sun.com/javase/6/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec"><CODE>OAEPParameterSpec</CODE></A> object, as it is already 'built in' to the scheme
name (unlike the <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEP"><CODE>OAEP</CODE></A> scheme, which requires a bit more work).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="OAEPWithSha256AndMgf1"><!-- --></A><H3>
OAEPWithSha256AndMgf1</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.107"><B>OAEPWithSha256AndMgf1</B></A></PRE>
<DL>
<DD>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="http://java.sun.com/javase/6/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec"><CODE>OAEPParameterSpec</CODE></A> object, as it is already 'built in' to the scheme
name (unlike the <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEP"><CODE>OAEP</CODE></A> scheme, which requires a bit more work).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="OAEPWithSha384AndMgf1"><!-- --></A><H3>
OAEPWithSha384AndMgf1</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.117"><B>OAEPWithSha384AndMgf1</B></A></PRE>
<DL>
<DD>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="http://java.sun.com/javase/6/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec"><CODE>OAEPParameterSpec</CODE></A> object, as it is already 'built in' to the scheme
name (unlike the <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEP"><CODE>OAEP</CODE></A> scheme, which requires a bit more work).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="OAEPWithSha512AndMgf1"><!-- --></A><H3>
OAEPWithSha512AndMgf1</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.127"><B>OAEPWithSha512AndMgf1</B></A></PRE>
<DL>
<DD>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="http://java.sun.com/javase/6/docs/api/javax/crypto/spec/OAEPParameterSpec.html?is-external=true" title="class or interface in javax.crypto.spec"><CODE>OAEPParameterSpec</CODE></A> object, as it is already 'built in' to the scheme
name (unlike the <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html#OAEP"><CODE>OAEP</CODE></A> scheme, which requires a bit more work).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="PKCS1"><!-- --></A><H3>
PKCS1</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.134"><B>PKCS1</B></A></PRE>
<DL>
<DD>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>).
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="PKCS5"><!-- --></A><H3>
PKCS5</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.140"><B>PKCS5</B></A></PRE>
<DL>
<DD>Padding scheme defined in RSA's <a href="http://www.rsa.com/rsalabs/node.asp?id=2127">Password-Based
Cryptography Standard</a>.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="SSL3"><!-- --></A><H3>
SSL3</H3>
<PRE>
public static final <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.146"><B>SSL3</B></A></PRE>
<DL>
<DD>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>.
<P>
<DL>
</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="values()"><!-- --></A><H3>
values</H3>
<PRE>
public static <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A>[] <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.37"><B>values</B></A>()</PRE>
<DL>
<DD>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())
&nbsp; System.out.println(c);
</pre>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in
the order they are declared</DL>
</DD>
</DL>
<HR>
<A NAME="valueOf(java.lang.String)"><!-- --></A><H3>
valueOf</H3>
<PRE>
public static <A HREF="../../../../org/apache/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto">PaddingScheme</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.37"><B>valueOf</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>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.)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned.
<DT><B>Returns:</B><DD>the enum constant with the specified name
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if this enum type has no constant
with the specified name
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if the argument is null</DL>
</DD>
</DL>
<HR>
<A NAME="getTransformationName()"><!-- --></A><H3>
getTransformationName</H3>
<PRE>
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/shiro/crypto/PaddingScheme.html#line.162"><B>getTransformationName</B></A>()</PRE>
<DL>
<DD>Returns the actual string name to use when building the <A HREF="http://java.sun.com/javase/6/docs/api/javax/crypto/Cipher.html?is-external=true" title="class or interface in javax.crypto"><CODE>Cipher</CODE></A>
<code>transformation string</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the actual string name to use when building the <A HREF="http://java.sun.com/javase/6/docs/api/javax/crypto/Cipher.html?is-external=true" title="class or interface in javax.crypto"><CODE>Cipher</CODE></A>
<code>transformation string</code>.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/javax/crypto/Cipher.html?is-external=true#getInstance(java.lang.String)" title="class or interface in javax.crypto"><CODE>Cipher.getInstance(String)</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PaddingScheme.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/shiro/crypto/OperationMode.html" title="enum in org.apache.shiro.crypto"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/shiro/crypto/RandomNumberGenerator.html" title="interface in org.apache.shiro.crypto"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/shiro/crypto/PaddingScheme.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="PaddingScheme.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2004-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>