blob: e02f1d7a3603519f895819f86f52c7c319ef84c5 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!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 +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"/>
cristydcca3fa2010-12-29 21:50:07 +000012 <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 +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"/>
cristydcca3fa2010-12-29 21:50:07 +000024 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000025 <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>
cristydcca3fa2010-12-29 21:50:07 +000030 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000031 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
32 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
33 <script type="text/javascript">
34 $(document).ready(function() {
35 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
36 'transitionIn' : 'elastic',
37 'transitionOut' : 'elastic',
38 'overlayShow' : false,
39 'opacity' : true
40 });
41 });
42 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000043</head>
44
45<body id="www-imagemagick-org">
46<div class="titlebar">
47<a href="../../index.html">
48 <img src="../../images/script.png" alt="[ImageMagick]"
49 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
50<a href="http://www.networkredux.com">
51 <img src="../../images/networkredux.png" alt="[sponsor]"
52 style="margin: 45px auto; border: 0px; float: left;" /></a>
53<a href="http://www.imagemagick.org/discourse-server/">
54 <img src="../../images/logo.jpg" alt=""
55 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
56<a href="../../index.html">
57 <img src="../../images/sprite.jpg" alt=""
58 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
59</div>
60
cristyce69bb02010-07-27 19:49:46 +000061<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000062
cristy3ed852e2009-09-05 21:47:34 +000063<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000064 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000065</div>
cristy3eaa0ef2010-03-06 20:35:26 +000066<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000067<div class="menu">
cristybb503372010-05-27 20:51:26 +000068 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
69</div>
70<div class="sub">
71 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
78</div>
79<div class="sep"></div>
80<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000081 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000082</div>
83<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
104<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000105 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000107<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
111<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000116 </div>
117<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000118 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000119</div>
cristybb503372010-05-27 20:51:26 +0000120<div class="menu">
121 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
122</div>
cristy3ed852e2009-09-05 21:47:34 +0000123<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000124 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000125</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000126<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000128 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000129</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000130<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000131<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000132 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000133</div>
134<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000135 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000136</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000137<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000138<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000140
141<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000142<div class="sponsor">
143 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.html">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000144</div>
145<div class="sponsor">
146 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000147</div>
148<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000149 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
150</div>
151<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000152 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000154<div class="sponsor">
155 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011050100025 gabi.schulze-->
156</div>
cristy3ed852e2009-09-05 21:47:34 +0000157</div>
158</div>
cristyce69bb02010-07-27 19:49:46 +0000159</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000160
cristyce69bb02010-07-27 19:49:46 +0000161<div class="eastbar">
162 <script type="text/javascript">
163 <!--
164 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000165 google_ad_slot = "0574824969";
166 google_ad_width = 160;
167 google_ad_height = 600;
168 //-->
169 </script>
170 <script type="text/javascript"
171 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
172 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000173</div>
174
175<div class="main">
176
cristy307ba182010-12-25 01:00:34 +0000177<h1>Module cipher
178 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000179<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>
180
181<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
182_8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2>
183<div class="doc-section">
184
185<p>AcquireAESInfo() allocate the AESInfo structure.</p></ol>
186
187<p>The format of the AcquireAESInfo method is:</p>
188
189<pre class="code">
190 AESInfo *AcquireAESInfo(void)
191</pre>
192
193 </div>
194<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
195_8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2>
196<div class="doc-section">
197
198<p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol>
199
200<p>The format of the DestroyAESInfo method is:</p>
201
202<pre class="code">
203 AESInfo *DestroyAESInfo(AESInfo *aes_info)
204</pre>
205
206<p>A description of each parameter follows:</p></ol>
207
208<h5>aes_info</h5>
209<ol><p>the cipher context.</p></ol>
210
211 </div>
212<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
213_8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2>
214<div class="doc-section">
215
216<p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol>
217
218<p>The format of the EncipherAESBlock method is:</p>
219
220<pre class="code">
221 void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
222 unsigned char *ciphertext)
223</pre>
224
225<p>A description of each parameter follows:</p></ol>
226
227<h5>aes_info</h5>
228<ol><p>the cipher context.</p></ol>
229
230<h5>plaintext</h5>
231<ol><p>the plain text.</p></ol>
232
233<h5>ciphertext</h5>
234<ol><p>the cipher text.</p></ol>
235
236 </div>
237<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
238_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
239<div class="doc-section">
240
241<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
242
243<p>The format of the PasskeyDecipherImage method is:</p>
244
245<pre class="code">
246 MagickBooleanType PasskeyDecipherImage(Image *image,
247 const StringInfo *passkey,ExceptionInfo *exception)
248 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
249 ExceptionInfo *exception)
250</pre>
251
252<p>A description of each parameter follows:</p></ol>
253
254<h5>image</h5>
255<ol><p>the image.</p></ol>
256
257<h5>passphrase</h5>
258<ol><p>decipher cipher pixels with this passphrase.</p></ol>
259
260<h5>passkey</h5>
261<ol><p>decrypt cipher pixels with this passkey.</p></ol>
262
263<h5>exception</h5>
264<ol><p>return any errors or warnings in this structure.</p></ol>
265
266 </div>
267<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
268_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
269<div class="doc-section">
270
271<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
272
273<p>The format of the PasskeyEncipherImage method is:</p>
274
275<pre class="code">
276 MagickBooleanType PasskeyEncipherImage(Image *image,
277 const StringInfo *passkey,ExceptionInfo *exception)
278 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
279 ExceptionInfo *exception)
280</pre>
281
282<p>A description of each parameter follows:</p></ol>
283
284<h5>image</h5>
285<ol><p>the image.</p></ol>
286
287<h5>passphrase</h5>
288<ol><p>encipher pixels with this passphrase.</p></ol>
289
290<h5>passkey</h5>
291<ol><p>decrypt cipher pixels with this passkey.</p></ol>
292
293<h5>exception</h5>
294<ol><p>return any errors or warnings in this structure.</p></ol>
295
296 </div>
297<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
298_8c.html" target="source" name="SetAESKey">SetAESKey</a></h2>
299<div class="doc-section">
300
301<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>
302
303<p>The format of the SetAESKey method is:</p>
304
305<pre class="code">
306 SetAESKey(AESInfo *aes_info,const StringInfo *key)
307</pre>
308
309<p>A description of each parameter follows:</p></ol>
310
311<h5>aes_info</h5>
312<ol><p>the cipher context.</p></ol>
313
314<h5>key</h5>
315<ol><p>the key.</p></ol>
316
317 </div>
318<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
319_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
320<div class="doc-section">
321
322<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
323
324<p>The format of the PasskeyDecipherImage method is:</p>
325
326<pre class="code">
327 MagickBooleanType PasskeyDecipherImage(Image *image,
328 const StringInfo *passkey,ExceptionInfo *exception)
329 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
330 ExceptionInfo *exception)
331</pre>
332
333<p>A description of each parameter follows:</p></ol>
334
335<h5>image</h5>
336<ol><p>the image.</p></ol>
337
338<h5>passphrase</h5>
339<ol><p>decipher cipher pixels with this passphrase.</p></ol>
340
341<h5>passkey</h5>
342<ol><p>decrypt cipher pixels with this passkey.</p></ol>
343
344<h5>exception</h5>
345<ol><p>return any errors or warnings in this structure.</p></ol>
346
347 </div>
348<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
349_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
350<div class="doc-section">
351
352<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
353
354<p>The format of the PasskeyEncipherImage method is:</p>
355
356<pre class="code">
357 MagickBooleanType PasskeyEncipherImage(Image *image,
358 const StringInfo *passkey,ExceptionInfo *exception)
359 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
360 ExceptionInfo *exception)
361</pre>
362
363<p>A description of each parameter follows:</p></ol>
364
365<h5>passphrase</h5>
366<ol><p>decipher cipher pixels with this passphrase.</p></ol>
367
368<h5>passkey</h5>
369<ol><p>decrypt cipher pixels with this passkey.</p></ol>
370
371<h5>exception</h5>
372<ol><p>return any errors or warnings in this structure.</p></ol>
373
374 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000375
376</div>
377
378<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000379 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000380 <span id="linkbar-center">
381 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000382 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000383 </span>
384 <span id="linkbar-east">&nbsp;</span>
385 </div>
386 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000387 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000388 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
389 </div>
390 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000391 <script type="text/javascript">
392 var _gaq = _gaq || [];
393 _gaq.push(['_setAccount', 'UA-17690367-1']);
394 _gaq.push(['_trackPageview']);
395
396 (function() {
397 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
398 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
399 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
400 })();
401 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000402</body>
403</html>