blob: 74242440774bcba1294a94ac39a049167be570e4 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: Convert to and from Cipher Pixels</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <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 +000011 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <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 +000016 <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 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000024 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
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"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000030</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +000048<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000049
cristy3ed852e2009-09-05 21:47:34 +000050<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000051 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000052</div>
cristy3eaa0ef2010-03-06 20:35:26 +000053<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristybb503372010-05-27 20:51:26 +000055 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
cristy3eaa0ef2010-03-06 20:35:26 +000094<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000095<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristybb503372010-05-27 20:51:26 +0000107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000127
128<div class="sponsbox">
129<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000130 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011040100025 gabi.schulze-->
cristy7d52cd62010-10-01 17:26:59 +0000131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy2c839602010-04-03 02:32:08 +0000143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000149</div>
cristy3ed852e2009-09-05 21:47:34 +0000150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000153
cristyce69bb02010-07-27 19:49:46 +0000154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000166</div>
167
168<div class="main">
169
cristy307ba182010-12-25 01:00:34 +0000170<h1>Module cipher
171 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000172<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>
173
174<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
175_8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2>
176<div class="doc-section">
177
178<p>AcquireAESInfo() allocate the AESInfo structure.</p></ol>
179
180<p>The format of the AcquireAESInfo method is:</p>
181
182<pre class="code">
183 AESInfo *AcquireAESInfo(void)
184</pre>
185
186 </div>
187<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
188_8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2>
189<div class="doc-section">
190
191<p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol>
192
193<p>The format of the DestroyAESInfo method is:</p>
194
195<pre class="code">
196 AESInfo *DestroyAESInfo(AESInfo *aes_info)
197</pre>
198
199<p>A description of each parameter follows:</p></ol>
200
201<h5>aes_info</h5>
202<ol><p>the cipher context.</p></ol>
203
204 </div>
205<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
206_8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2>
207<div class="doc-section">
208
209<p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol>
210
211<p>The format of the EncipherAESBlock method is:</p>
212
213<pre class="code">
214 void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
215 unsigned char *ciphertext)
216</pre>
217
218<p>A description of each parameter follows:</p></ol>
219
220<h5>aes_info</h5>
221<ol><p>the cipher context.</p></ol>
222
223<h5>plaintext</h5>
224<ol><p>the plain text.</p></ol>
225
226<h5>ciphertext</h5>
227<ol><p>the cipher text.</p></ol>
228
229 </div>
230<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
231_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
232<div class="doc-section">
233
234<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
235
236<p>The format of the PasskeyDecipherImage method is:</p>
237
238<pre class="code">
239 MagickBooleanType PasskeyDecipherImage(Image *image,
240 const StringInfo *passkey,ExceptionInfo *exception)
241 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
242 ExceptionInfo *exception)
243</pre>
244
245<p>A description of each parameter follows:</p></ol>
246
247<h5>image</h5>
248<ol><p>the image.</p></ol>
249
250<h5>passphrase</h5>
251<ol><p>decipher cipher pixels with this passphrase.</p></ol>
252
253<h5>passkey</h5>
254<ol><p>decrypt cipher pixels with this passkey.</p></ol>
255
256<h5>exception</h5>
257<ol><p>return any errors or warnings in this structure.</p></ol>
258
259 </div>
260<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
261_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
262<div class="doc-section">
263
264<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
265
266<p>The format of the PasskeyEncipherImage method is:</p>
267
268<pre class="code">
269 MagickBooleanType PasskeyEncipherImage(Image *image,
270 const StringInfo *passkey,ExceptionInfo *exception)
271 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
272 ExceptionInfo *exception)
273</pre>
274
275<p>A description of each parameter follows:</p></ol>
276
277<h5>image</h5>
278<ol><p>the image.</p></ol>
279
280<h5>passphrase</h5>
281<ol><p>encipher pixels with this passphrase.</p></ol>
282
283<h5>passkey</h5>
284<ol><p>decrypt cipher pixels with this passkey.</p></ol>
285
286<h5>exception</h5>
287<ol><p>return any errors or warnings in this structure.</p></ol>
288
289 </div>
290<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
291_8c.html" target="source" name="SetAESKey">SetAESKey</a></h2>
292<div class="doc-section">
293
294<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></ol>
295
296<p>The format of the SetAESKey method is:</p>
297
298<pre class="code">
299 SetAESKey(AESInfo *aes_info,const StringInfo *key)
300</pre>
301
302<p>A description of each parameter follows:</p></ol>
303
304<h5>aes_info</h5>
305<ol><p>the cipher context.</p></ol>
306
307<h5>key</h5>
308<ol><p>the key.</p></ol>
309
310 </div>
311<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
312_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
313<div class="doc-section">
314
315<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
316
317<p>The format of the PasskeyDecipherImage method is:</p>
318
319<pre class="code">
320 MagickBooleanType PasskeyDecipherImage(Image *image,
321 const StringInfo *passkey,ExceptionInfo *exception)
322 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
323 ExceptionInfo *exception)
324</pre>
325
326<p>A description of each parameter follows:</p></ol>
327
328<h5>image</h5>
329<ol><p>the image.</p></ol>
330
331<h5>passphrase</h5>
332<ol><p>decipher cipher pixels with this passphrase.</p></ol>
333
334<h5>passkey</h5>
335<ol><p>decrypt cipher pixels with this passkey.</p></ol>
336
337<h5>exception</h5>
338<ol><p>return any errors or warnings in this structure.</p></ol>
339
340 </div>
341<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
342_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
343<div class="doc-section">
344
345<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
346
347<p>The format of the PasskeyEncipherImage method is:</p>
348
349<pre class="code">
350 MagickBooleanType PasskeyEncipherImage(Image *image,
351 const StringInfo *passkey,ExceptionInfo *exception)
352 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
353 ExceptionInfo *exception)
354</pre>
355
356<p>A description of each parameter follows:</p></ol>
357
358<h5>passphrase</h5>
359<ol><p>decipher cipher pixels with this passphrase.</p></ol>
360
361<h5>passkey</h5>
362<ol><p>decrypt cipher pixels with this passkey.</p></ol>
363
364<h5>exception</h5>
365<ol><p>return any errors or warnings in this structure.</p></ol>
366
367 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000368
369</div>
370
371<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000372 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000373 <span id="linkbar-center">
374 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000375 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000376 </span>
377 <span id="linkbar-east">&nbsp;</span>
378 </div>
379 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000380 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000381 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
382 </div>
383 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000384 <script type="text/javascript">
385 var _gaq = _gaq || [];
386 _gaq.push(['_setAccount', 'UA-17690367-1']);
387 _gaq.push(['_trackPageview']);
388
389 (function() {
390 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
391 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
392 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
393 })();
394 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000395</body>
396</html>