Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 178edafa2ddbc40465115383b13685f7bc913b1f / . / www / api / cipher.html
blob: aa5fbb30964fc7a72ec8f1437c1144dd39b71f21 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Convert to and from Cipher Pixels</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, convert, to, from, cipher, pixels, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame^]56 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]57<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]62<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]63
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]69 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]82 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]85 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]86</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141
142<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame^]143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]147 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame^]156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristye855cb32011-01-16 02:13:10 +0000[diff] [blame]159 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]160</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]164
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]181<h1>Module cipher
182 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]183<p class="navigation-index">[<a href="#AcquireAESInfo">AcquireAESInfo</a> &bull; <a href="#DestroyAESInfo">DestroyAESInfo</a> &bull; <a href="#EncipherAESBlock">EncipherAESBlock</a> &bull; <a href="#PasskeyDecipherImage">PasskeyDecipherImage</a> &bull; <a href="#PasskeyEncipherImage">PasskeyEncipherImage</a> &bull; <a href="#SetAESKey">SetAESKey</a> &bull; <a href="#PasskeyDecipherImage">PasskeyDecipherImage</a> &bull; <a href="#PasskeyEncipherImage">PasskeyEncipherImage</a>]</p>
184
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]185<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cipher
186_8c.html" id="AcquireAESInfo">AcquireAESInfo</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187<div class="doc-section">
188
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]189<p>AcquireAESInfo() allocate the AESInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]190
191<p>The format of the AcquireAESInfo method is:</p>
192
193<pre class="code">
194 AESInfo *AcquireAESInfo(void)
195</pre>
196
197 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]198<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cipher
199_8c.html" id="DestroyAESInfo">DestroyAESInfo</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]200<div class="doc-section">
201
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]202<p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]203
204<p>The format of the DestroyAESInfo method is:</p>
205
206<pre class="code">
207 AESInfo *DestroyAESInfo(AESInfo *aes_info)
208</pre>
209
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]210<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]211
212<h5>aes_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]213<p>the cipher context.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]214
215 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]216<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cipher
217_8c.html" id="EncipherAESBlock">EncipherAESBlock</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]218<div class="doc-section">
219
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]220<p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]221
222<p>The format of the EncipherAESBlock method is:</p>
223
224<pre class="code">
225 void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
226 unsigned char *ciphertext)
227</pre>
228
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]229<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]230
231<h5>aes_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]232<p>the cipher context.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]233
234<h5>plaintext</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]235<p>the plain text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]236
237<h5>ciphertext</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]238<p>the cipher text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]239
240 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]241<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cipher
242_8c.html" id="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]243<div class="doc-section">
244
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]245<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]246
247<p>The format of the PasskeyDecipherImage method is:</p>
248
249<pre class="code">
250 MagickBooleanType PasskeyDecipherImage(Image *image,
251 const StringInfo *passkey,ExceptionInfo *exception)
252 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
253 ExceptionInfo *exception)
254</pre>
255
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]256<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]257
258<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]259<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]260
261<h5>passphrase</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]262<p>decipher cipher pixels with this passphrase.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]263
264<h5>passkey</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]265<p>decrypt cipher pixels with this passkey.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]266
267<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]268<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]269
270 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]271<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cipher
272_8c.html" id="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]273<div class="doc-section">
274
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]275<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]276
277<p>The format of the PasskeyEncipherImage method is:</p>
278
279<pre class="code">
280 MagickBooleanType PasskeyEncipherImage(Image *image,
281 const StringInfo *passkey,ExceptionInfo *exception)
282 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
283 ExceptionInfo *exception)
284</pre>
285
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]286<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]287
288<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]289<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]290
291<h5>passphrase</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]292<p>encipher pixels with this passphrase.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]293
294<h5>passkey</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]295<p>decrypt cipher pixels with this passkey.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]296
297<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]298<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]299
300 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]301<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cipher
302_8c.html" id="SetAESKey">SetAESKey</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]303<div class="doc-section">
304
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]305<p>SetAESKey() sets the key for the AES cipher. The key length is specified in bits. Valid values are 128, 192, or 256 requiring a key buffer length in bytes of 16, 24, and 32 respectively.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]306
307<p>The format of the SetAESKey method is:</p>
308
309<pre class="code">
310 SetAESKey(AESInfo *aes_info,const StringInfo *key)
311</pre>
312
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]313<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]314
315<h5>aes_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]316<p>the cipher context.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]317
318<h5>key</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]319<p>the key.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]320
321 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]322<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cipher
323_8c.html" id="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]324<div class="doc-section">
325
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]326<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]327
328<p>The format of the PasskeyDecipherImage method is:</p>
329
330<pre class="code">
331 MagickBooleanType PasskeyDecipherImage(Image *image,
332 const StringInfo *passkey,ExceptionInfo *exception)
333 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
334 ExceptionInfo *exception)
335</pre>
336
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]337<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]338
339<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]340<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]341
342<h5>passphrase</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]343<p>decipher cipher pixels with this passphrase.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]344
345<h5>passkey</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]346<p>decrypt cipher pixels with this passkey.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]347
348<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]349<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]350
351 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]352<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cipher
353_8c.html" id="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]354<div class="doc-section">
355
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]356<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]357
358<p>The format of the PasskeyEncipherImage method is:</p>
359
360<pre class="code">
361 MagickBooleanType PasskeyEncipherImage(Image *image,
362 const StringInfo *passkey,ExceptionInfo *exception)
363 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
364 ExceptionInfo *exception)
365</pre>
366
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]367<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]368
369<h5>passphrase</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]370<p>decipher cipher pixels with this passphrase.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]371
372<h5>passkey</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]373<p>decrypt cipher pixels with this passkey.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]374
375<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]376<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]377
378 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]379
380</div>
381
382<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]383 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]384 <span id="linkbar-center">
385 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]386 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]387 </span>
388 <span id="linkbar-east">&nbsp;</span>
389 </div>
390 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]391 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]392 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
393 </div>
394 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]395 <script type="text/javascript">
396 var _gaq = _gaq || [];
397 _gaq.push(['_setAccount', 'UA-17690367-1']);
398 _gaq.push(['_trackPageview']);
399
400 (function() {
401 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
402 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
403 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
404 })();
405 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]406</body>
407</html>