/lib/bouncycastle/docs/org/bouncycastle/crypto/Wrapper.html

https://bitbucket.org/arkban/somersault · HTML · 280 lines · 226 code · 34 blank · 20 comment · 0 complexity · 635ed7c2bb6be437e38b03f1b0639b8a MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.6.0) on Mon Jan 11 13:46:35 EST 2010 -->
    6. 

  6. <TITLE>
    7. 

  7. Wrapper (Bouncy Castle Library 1.45 API Specification)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="date" CONTENT="2010-01-11">
    11. 

  11. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
    13. 

  13. 

  14. <SCRIPT type="text/javascript">
    15. 

  15. function windowTitle()
    16. 

  16. {
    17. 

  17.     if (location.href.indexOf('is-external=true') == -1) {
    18. 

  18.         parent.document.title="Wrapper (Bouncy Castle Library 1.45 API Specification)";
    19. 

  19.     }
    20. 

  20. }
    21. 

  21. </SCRIPT>
    22. 

  22. <NOSCRIPT>
    23. 

  23. </NOSCRIPT>
    24. 

  24. 

  25. </HEAD>
    26. 

  26. 

  27. <BODY BGCOLOR="white" onload="windowTitle();">
    28. 

  28. <HR>
    29. 

  29. 

  30. 

  31. <!-- ========= START OF TOP NAVBAR ======= -->
    32. 

  32. <A NAME="navbar_top"><!-- --></A>
    33. 

  33. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    34. 

  34. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    35. 

  35. <TR>
    36. 

  36. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    37. 

  37. <A NAME="navbar_top_firstrow"><!-- --></A>
    38. 

  38. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    39. 

  39.   <TR ALIGN="center" VALIGN="top">
    40. 

  40.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    41. 

  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    42. 

  42.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    43. 

  43.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    44. 

  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    45. 

  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    46. 

  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    47. 

  47.   </TR>
    48. 

  48. </TABLE>
    49. 

  49. </TD>
    50. 

  50. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    51. 

  51. <b>Bouncy Castle Cryptography Library 1.45</b></EM>
    52. 

  52. </TD>
    53. 

  53. </TR>
    54. 

  54. 

  55. <TR>
    56. 

  56. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    57. 

  57. &nbsp;<A HREF="../../../org/bouncycastle/crypto/StreamCipher.html" title="interface in org.bouncycastle.crypto"><B>PREV CLASS</B></A>&nbsp;
    58. 

  58. &nbsp;NEXT CLASS</FONT></TD>
    59. 

  59. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    60. 

  60.   <A HREF="../../../index.html?org/bouncycastle/crypto/Wrapper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    61. 

  61. &nbsp;<A HREF="Wrapper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    62. 

  62. &nbsp;<SCRIPT type="text/javascript">
    63. 

  63.   <!--
    64. 

  64.   if(window==top) {
    65. 

  65.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
    66. 

  66.   }
    67. 

  67.   //-->
    68. 

  68. </SCRIPT>
    69. 

  69. <NOSCRIPT>
    70. 

  70.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
    71. 

  71. </NOSCRIPT>
    72. 

  72. 

  73. 

  74. </FONT></TD>
    75. 

  75. </TR>
    76. 

  76. <TR>
    77. 

  77. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    78. 

  78.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    79. 

  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    80. 

  80. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    81. 

  81. </TR>
    82. 

  82. </TABLE>
    83. 

  83. <A NAME="skip-navbar_top"></A>
    84. 

  84. <!-- ========= END OF TOP NAVBAR ========= -->
    85. 

  85. 

  86. <HR>
    87. 

  87. <!-- ======== START OF CLASS DATA ======== -->
    88. 

  88. <H2>
    89. 

  89. <FONT SIZE="-1">
    90. 

  90. org.bouncycastle.crypto</FONT>
    91. 

  91. <BR>
    92. 

  92. Interface Wrapper</H2>
    93. 

  93. <DL>
    94. 

  94. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/bouncycastle/crypto/engines/AESWrapEngine.html" title="class in org.bouncycastle.crypto.engines">AESWrapEngine</A>, <A HREF="../../../org/bouncycastle/crypto/engines/CamelliaWrapEngine.html" title="class in org.bouncycastle.crypto.engines">CamelliaWrapEngine</A>, <A HREF="../../../org/bouncycastle/crypto/engines/DESedeWrapEngine.html" title="class in org.bouncycastle.crypto.engines">DESedeWrapEngine</A>, <A HREF="../../../org/bouncycastle/crypto/engines/RC2WrapEngine.html" title="class in org.bouncycastle.crypto.engines">RC2WrapEngine</A>, <A HREF="../../../org/bouncycastle/crypto/engines/RFC3211WrapEngine.html" title="class in org.bouncycastle.crypto.engines">RFC3211WrapEngine</A>, <A HREF="../../../org/bouncycastle/crypto/engines/RFC3394WrapEngine.html" title="class in org.bouncycastle.crypto.engines">RFC3394WrapEngine</A>, <A HREF="../../../org/bouncycastle/crypto/engines/SEEDWrapEngine.html" title="class in org.bouncycastle.crypto.engines">SEEDWrapEngine</A></DD>
    95. 

  95. </DL>
    96. 

  96. <HR>
    97. 

  97. <DL>
    98. 

  98. <DT><PRE>public interface <B>Wrapper</B></DL>
    99. 

  99. </PRE>
    100. 

  100. 

  101. <P>
    102. 

  102. <HR>
    103. 

  103. 

  104. <P>
    105. 

  105. 

  106. <!-- ========== METHOD SUMMARY =========== -->
    107. 

  107. 

  108. <A NAME="method_summary"><!-- --></A>
    109. 

  109. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    110. 

  110. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    111. 

  111. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    112. 

  112. <B>Method Summary</B></FONT></TH>
    113. 

  113. </TR>
    114. 

  114. <TR BGCOLOR="white" CLASS="TableRowColor">
    115. 

  115. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    116. 

  116. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
    117. 

  117. <TD><CODE><B><A HREF="../../../org/bouncycastle/crypto/Wrapper.html#getAlgorithmName()">getAlgorithmName</A></B>()</CODE>
    118. 

  118. 

  119. <BR>
    120. 

  120. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the name of the algorithm the wrapper implements.</TD>
    121. 

  121. </TR>
    122. 

  122. <TR BGCOLOR="white" CLASS="TableRowColor">
    123. 

  123. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    124. 

  124. <CODE>&nbsp;void</CODE></FONT></TD>
    125. 

  125. <TD><CODE><B><A HREF="../../../org/bouncycastle/crypto/Wrapper.html#init(boolean, org.bouncycastle.crypto.CipherParameters)">init</A></B>(boolean&nbsp;forWrapping,
    126. 

  126.      <A HREF="../../../org/bouncycastle/crypto/CipherParameters.html" title="interface in org.bouncycastle.crypto">CipherParameters</A>&nbsp;param)</CODE>
    127. 

  127. 

  128. <BR>
    129. 

  129. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    130. 

  130. </TR>
    131. 

  131. <TR BGCOLOR="white" CLASS="TableRowColor">
    132. 

  132. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    133. 

  133. <CODE>&nbsp;byte[]</CODE></FONT></TD>
    134. 

  134. <TD><CODE><B><A HREF="../../../org/bouncycastle/crypto/Wrapper.html#unwrap(byte[], int, int)">unwrap</A></B>(byte[]&nbsp;in,
    135. 

  135.        int&nbsp;inOff,
    136. 

  136.        int&nbsp;inLen)</CODE>
    137. 

  137. 

  138. <BR>
    139. 

  139. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    140. 

  140. </TR>
    141. 

  141. <TR BGCOLOR="white" CLASS="TableRowColor">
    142. 

  142. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    143. 

  143. <CODE>&nbsp;byte[]</CODE></FONT></TD>
    144. 

  144. <TD><CODE><B><A HREF="../../../org/bouncycastle/crypto/Wrapper.html#wrap(byte[], int, int)">wrap</A></B>(byte[]&nbsp;in,
    145. 

  145.      int&nbsp;inOff,
    146. 

  146.      int&nbsp;inLen)</CODE>
    147. 

  147. 

  148. <BR>
    149. 

  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    150. 

  150. </TR>
    151. 

  151. </TABLE>
    152. 

  152. &nbsp;
    153. 

  153. <P>
    154. 

  154. 

  155. <!-- ============ METHOD DETAIL ========== -->
    156. 

  156. 

  157. <A NAME="method_detail"><!-- --></A>
    158. 

  158. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    159. 

  159. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    160. 

  160. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    161. 

  161. <B>Method Detail</B></FONT></TH>
    162. 

  162. </TR>
    163. 

  163. </TABLE>
    164. 

  164. 

  165. <A NAME="init(boolean, org.bouncycastle.crypto.CipherParameters)"><!-- --></A><H3>
    166. 

  166. init</H3>
    167. 

  167. <PRE>
    168. 

  168. void <B>init</B>(boolean&nbsp;forWrapping,
    169. 

  169.           <A HREF="../../../org/bouncycastle/crypto/CipherParameters.html" title="interface in org.bouncycastle.crypto">CipherParameters</A>&nbsp;param)</PRE>
    170. 

  170. <DL>
    171. 

  171. <DD><DL>
    172. 

  172. </DL>
    173. 

  173. </DD>
    174. 

  174. </DL>
    175. 

  175. <HR>
    176. 

  176. 

  177. <A NAME="getAlgorithmName()"><!-- --></A><H3>
    178. 

  178. getAlgorithmName</H3>
    179. 

  179. <PRE>
    180. 

  180. java.lang.String <B>getAlgorithmName</B>()</PRE>
    181. 

  181. <DL>
    182. 

  182. <DD>Return the name of the algorithm the wrapper implements.
    183. 

  183. <P>
    184. 

  184. <DD><DL>
    185. 

  185. 

  186. <DT><B>Returns:</B><DD>the name of the algorithm the wrapper implements.</DL>
    187. 

  187. </DD>
    188. 

  188. </DL>
    189. 

  189. <HR>
    190. 

  190. 

  191. <A NAME="wrap(byte[], int, int)"><!-- --></A><H3>
    192. 

  192. wrap</H3>
    193. 

  193. <PRE>
    194. 

  194. byte[] <B>wrap</B>(byte[]&nbsp;in,
    195. 

  195.             int&nbsp;inOff,
    196. 

  196.             int&nbsp;inLen)</PRE>
    197. 

  197. <DL>
    198. 

  198. <DD><DL>
    199. 

  199. </DL>
    200. 

  200. </DD>
    201. 

  201. </DL>
    202. 

  202. <HR>
    203. 

  203. 

  204. <A NAME="unwrap(byte[], int, int)"><!-- --></A><H3>
    205. 

  205. unwrap</H3>
    206. 

  206. <PRE>
    207. 

  207. byte[] <B>unwrap</B>(byte[]&nbsp;in,
    208. 

  208.               int&nbsp;inOff,
    209. 

  209.               int&nbsp;inLen)
    210. 

  210.               throws <A HREF="../../../org/bouncycastle/crypto/InvalidCipherTextException.html" title="class in org.bouncycastle.crypto">InvalidCipherTextException</A></PRE>
    211. 

  211. <DL>
    212. 

  212. <DD><DL>
    213. 

  213. 

  214. <DT><B>Throws:</B>
    215. 

  215. <DD><CODE><A HREF="../../../org/bouncycastle/crypto/InvalidCipherTextException.html" title="class in org.bouncycastle.crypto">InvalidCipherTextException</A></CODE></DL>
    216. 

  216. </DD>
    217. 

  217. </DL>
    218. 

  218. <!-- ========= END OF CLASS DATA ========= -->
    219. 

  219. <HR>
    220. 

  220. 

  221. 

  222. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    223. 

  223. <A NAME="navbar_bottom"><!-- --></A>
    224. 

  224. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    225. 

  225. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    226. 

  226. <TR>
    227. 

  227. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    228. 

  228. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    229. 

  229. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    230. 

  230.   <TR ALIGN="center" VALIGN="top">
    231. 

  231.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    232. 

  232.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    233. 

  233.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    234. 

  234.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    235. 

  235.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    236. 

  236.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    237. 

  237.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    238. 

  238.   </TR>
    239. 

  239. </TABLE>
    240. 

  240. </TD>
    241. 

  241. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    242. 

  242. <b>Bouncy Castle Cryptography Library 1.45</b></EM>
    243. 

  243. </TD>
    244. 

  244. </TR>
    245. 

  245. 

  246. <TR>
    247. 

  247. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    248. 

  248. &nbsp;<A HREF="../../../org/bouncycastle/crypto/StreamCipher.html" title="interface in org.bouncycastle.crypto"><B>PREV CLASS</B></A>&nbsp;
    249. 

  249. &nbsp;NEXT CLASS</FONT></TD>
    250. 

  250. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    251. 

  251.   <A HREF="../../../index.html?org/bouncycastle/crypto/Wrapper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    252. 

  252. &nbsp;<A HREF="Wrapper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    253. 

  253. &nbsp;<SCRIPT type="text/javascript">
    254. 

  254.   <!--
    255. 

  255.   if(window==top) {
    256. 

  256.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
    257. 

  257.   }
    258. 

  258.   //-->
    259. 

  259. </SCRIPT>
    260. 

  260. <NOSCRIPT>
    261. 

  261.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
    262. 

  262. </NOSCRIPT>
    263. 

  263. 

  264. 

  265. </FONT></TD>
    266. 

  266. </TR>
    267. 

  267. <TR>
    268. 

  268. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    269. 

  269.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    270. 

  270. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    271. 

  271. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    272. 

  272. </TR>
    273. 

  273. </TABLE>
    274. 

  274. <A NAME="skip-navbar_bottom"></A>
    275. 

  275. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    276. 

  276. 

  277. <HR>
    278. 

  278. 

  279. </BODY>
    280. 

  280. </HTML>
    281.