blob: 2ac531456741017bf9c5f2efadc8ef3b9711f111 [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>
cristy3de29cc2010-04-15 02:34:44 +00005 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +00006 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +00008 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +00009 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +000010 </style>
cristy3ed852e2009-09-05 21:47:34 +000011 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Convert to and from Cipher Pixels</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <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"/>
18 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +000025 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000026 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000027</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
cristyce69bb02010-07-27 19:49:46 +000045<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000046
cristy3ed852e2009-09-05 21:47:34 +000047<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000048 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000049</div>
cristy3eaa0ef2010-03-06 20:35:26 +000050<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
cristybb503372010-05-27 20:51:26 +000052 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000065 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</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: Options" href="../../www/command-line-options.html">Options</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: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
cristy3eaa0ef2010-03-06 20:35:26 +000091<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000092<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</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: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
cristybb503372010-05-27 20:51:26 +0000104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000124
125<div class="sponsbox">
126<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000127 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy2c839602010-04-03 02:32:08 +0000131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000143</div>
144<div class="sponsor">
cristy9c60d3f2010-08-09 02:29:30 +0000145 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
cristy3ed852e2009-09-05 21:47:34 +0000146</div>
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
148</div>
cristyce69bb02010-07-27 19:49:46 +0000149</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000150
cristyce69bb02010-07-27 19:49:46 +0000151<div class="eastbar">
152 <script type="text/javascript">
153 <!--
154 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000155 google_ad_slot = "0574824969";
156 google_ad_width = 160;
157 google_ad_height = 600;
158 //-->
159 </script>
160 <script type="text/javascript"
161 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
162 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000163</div>
164
165<div class="main">
166
cristy3ed852e2009-09-05 21:47:34 +0000167<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>
168
169<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
170_8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2>
171<div class="doc-section">
172
173<p>AcquireAESInfo() allocate the AESInfo structure.</p></ol>
174
175<p>The format of the AcquireAESInfo method is:</p>
176
177<pre class="code">
178 AESInfo *AcquireAESInfo(void)
179</pre>
180
181 </div>
182<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
183_8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2>
184<div class="doc-section">
185
186<p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol>
187
188<p>The format of the DestroyAESInfo method is:</p>
189
190<pre class="code">
191 AESInfo *DestroyAESInfo(AESInfo *aes_info)
192</pre>
193
194<p>A description of each parameter follows:</p></ol>
195
196<h5>aes_info</h5>
197<ol><p>the cipher context.</p></ol>
198
199 </div>
200<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
201_8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2>
202<div class="doc-section">
203
204<p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol>
205
206<p>The format of the EncipherAESBlock method is:</p>
207
208<pre class="code">
209 void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
210 unsigned char *ciphertext)
211</pre>
212
213<p>A description of each parameter follows:</p></ol>
214
215<h5>aes_info</h5>
216<ol><p>the cipher context.</p></ol>
217
218<h5>plaintext</h5>
219<ol><p>the plain text.</p></ol>
220
221<h5>ciphertext</h5>
222<ol><p>the cipher text.</p></ol>
223
224 </div>
225<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
226_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
227<div class="doc-section">
228
229<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
230
231<p>The format of the PasskeyDecipherImage method is:</p>
232
233<pre class="code">
234 MagickBooleanType PasskeyDecipherImage(Image *image,
235 const StringInfo *passkey,ExceptionInfo *exception)
236 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
237 ExceptionInfo *exception)
238</pre>
239
240<p>A description of each parameter follows:</p></ol>
241
242<h5>image</h5>
243<ol><p>the image.</p></ol>
244
245<h5>passphrase</h5>
246<ol><p>decipher cipher pixels with this passphrase.</p></ol>
247
248<h5>passkey</h5>
249<ol><p>decrypt cipher pixels with this passkey.</p></ol>
250
251<h5>exception</h5>
252<ol><p>return any errors or warnings in this structure.</p></ol>
253
254 </div>
255<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
256_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
257<div class="doc-section">
258
259<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
260
261<p>The format of the PasskeyEncipherImage method is:</p>
262
263<pre class="code">
264 MagickBooleanType PasskeyEncipherImage(Image *image,
265 const StringInfo *passkey,ExceptionInfo *exception)
266 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
267 ExceptionInfo *exception)
268</pre>
269
270<p>A description of each parameter follows:</p></ol>
271
272<h5>image</h5>
273<ol><p>the image.</p></ol>
274
275<h5>passphrase</h5>
276<ol><p>encipher pixels with this passphrase.</p></ol>
277
278<h5>passkey</h5>
279<ol><p>decrypt cipher pixels with this passkey.</p></ol>
280
281<h5>exception</h5>
282<ol><p>return any errors or warnings in this structure.</p></ol>
283
284 </div>
285<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
286_8c.html" target="source" name="SetAESKey">SetAESKey</a></h2>
287<div class="doc-section">
288
289<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>
290
291<p>The format of the SetAESKey method is:</p>
292
293<pre class="code">
294 SetAESKey(AESInfo *aes_info,const StringInfo *key)
295</pre>
296
297<p>A description of each parameter follows:</p></ol>
298
299<h5>aes_info</h5>
300<ol><p>the cipher context.</p></ol>
301
302<h5>key</h5>
303<ol><p>the key.</p></ol>
304
305 </div>
306<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
307_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
308<div class="doc-section">
309
310<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
311
312<p>The format of the PasskeyDecipherImage method is:</p>
313
314<pre class="code">
315 MagickBooleanType PasskeyDecipherImage(Image *image,
316 const StringInfo *passkey,ExceptionInfo *exception)
317 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
318 ExceptionInfo *exception)
319</pre>
320
321<p>A description of each parameter follows:</p></ol>
322
323<h5>image</h5>
324<ol><p>the image.</p></ol>
325
326<h5>passphrase</h5>
327<ol><p>decipher cipher pixels with this passphrase.</p></ol>
328
329<h5>passkey</h5>
330<ol><p>decrypt cipher pixels with this passkey.</p></ol>
331
332<h5>exception</h5>
333<ol><p>return any errors or warnings in this structure.</p></ol>
334
335 </div>
336<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
337_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
338<div class="doc-section">
339
340<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
341
342<p>The format of the PasskeyEncipherImage method is:</p>
343
344<pre class="code">
345 MagickBooleanType PasskeyEncipherImage(Image *image,
346 const StringInfo *passkey,ExceptionInfo *exception)
347 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
348 ExceptionInfo *exception)
349</pre>
350
351<p>A description of each parameter follows:</p></ol>
352
353<h5>passphrase</h5>
354<ol><p>decipher cipher pixels with this passphrase.</p></ol>
355
356<h5>passkey</h5>
357<ol><p>decrypt cipher pixels with this passkey.</p></ol>
358
359<h5>exception</h5>
360<ol><p>return any errors or warnings in this structure.</p></ol>
361
362 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000363
364</div>
365
366<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000367 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000368 <span id="linkbar-center">
369 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000370 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000371 </span>
372 <span id="linkbar-east">&nbsp;</span>
373 </div>
374 <div class="footer">
375 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
376 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
377 </div>
378 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000379 <script type="text/javascript">
380 var _gaq = _gaq || [];
381 _gaq.push(['_setAccount', 'UA-17690367-1']);
382 _gaq.push(['_trackPageview']);
383
384 (function() {
385 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
386 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
387 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
388 })();
389 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000390</body>
391</html>