blob: 00acc90c5dac7649628108cee83e8ebfb5774715 [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">
cristy2bd2a982011-02-15 00:52:58 +00003<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +00008<head>
cristy3c98a4f2010-08-13 20:09:41 +00009 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +000011 <title>ImageMagick: MagickCore, C API for ImageMagick: Convert to and from Cipher Pixels</title>
cristy3ed852e2009-09-05 21:47:34 +000012 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000015 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +000016 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000017 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000018 <meta name="Generator" content="PHP"/>
19 <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 +000020 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +000026 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000028 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000029 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000031 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000032 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +000035 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000036 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000048</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
52<a href="../../index.html">
53 <img src="../../images/script.png" alt="[ImageMagick]"
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
55<a href="http://www.networkredux.com">
56 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000057 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000058<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000059 <img src="../../images/logo.jpg"
60 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000061 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000062<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +000063 <img src="../../images/sprite.jpg"
64 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000065 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
66</div>
67
cristyce69bb02010-07-27 19:49:46 +000068<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000069
cristy3ed852e2009-09-05 21:47:34 +000070<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
cristy3eaa0ef2010-03-06 20:35:26 +000073<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000074<div class="menu">
cristybb503372010-05-27 20:51:26 +000075 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
82</div>
83<div class="sub">
84 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
85</div>
86<div class="sep"></div>
87<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000089</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000091 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
108<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
111<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000112 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</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="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000122 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000123 </div>
124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000125 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000126</div>
cristybb503372010-05-27 20:51:26 +0000127<div class="menu">
128 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
129</div>
cristy3ed852e2009-09-05 21:47:34 +0000130<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000131 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000134<div class="menu">
cristy52923442011-01-15 22:54:31 +0000135 <a title="Search" href="../../www/search.html">Search</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">
cristyffb69ed2010-12-25 00:06:48 +0000139 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000140</div>
141<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000142 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000145<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000147
148<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000149<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000150 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
151</div>
152<div class="sponsor">
153 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
154</div>
155<div class="sponsor">
cristy2bd2a982011-02-15 00:52:58 +0000156 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
cristy178edaf2011-01-23 03:42:39 +0000157</div>
cristyec6b4752011-01-08 03:16:23 +0000158<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000159 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000160</div>
161<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000162 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
163</div>
164<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000165 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
166</div>
cristyec6b4752011-01-08 03:16:23 +0000167<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000168 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
169</div>
170<div class="sponsor">
cristy6f77f692011-02-15 15:31:39 +0000171 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000172</div>
cristy3ed852e2009-09-05 21:47:34 +0000173</div>
174</div>
cristyce69bb02010-07-27 19:49:46 +0000175</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000176
cristyce69bb02010-07-27 19:49:46 +0000177<div class="eastbar">
178 <script type="text/javascript">
179 <!--
180 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000181 google_ad_slot = "0574824969";
182 google_ad_width = 160;
183 google_ad_height = 600;
184 //-->
185 </script>
186 <script type="text/javascript"
187 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
188 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000189</div>
190
191<div class="main">
192
cristy6f77f692011-02-15 15:31:39 +0000193<h1>Module cipher
194 Methods</h1>
195<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>
cristy3ed852e2009-09-05 21:47:34 +0000196
cristy6f77f692011-02-15 15:31:39 +0000197<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
198_8c.html" id="AcquireAESInfo">AcquireAESInfo</a></h2>
199<div class="doc-section">
200
201<p>AcquireAESInfo() allocate the AESInfo structure.</p>
202
203<p>The format of the AcquireAESInfo method is:</p>
204
205<pre class="code">
206 AESInfo *AcquireAESInfo(void)
207</pre>
208
209 </div>
210<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
211_8c.html" id="DestroyAESInfo">DestroyAESInfo</a></h2>
212<div class="doc-section">
213
214<p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p>
215
216<p>The format of the DestroyAESInfo method is:</p>
217
218<pre class="code">
219 AESInfo *DestroyAESInfo(AESInfo *aes_info)
220</pre>
221
222<p>A description of each parameter follows:</p>
223
224<h5>aes_info</h5>
225<p>the cipher context.</p>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
229_8c.html" id="EncipherAESBlock">EncipherAESBlock</a></h2>
230<div class="doc-section">
231
232<p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p>
233
234<p>The format of the EncipherAESBlock method is:</p>
235
236<pre class="code">
237 void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
238 unsigned char *ciphertext)
239</pre>
240
241<p>A description of each parameter follows:</p>
242
243<h5>aes_info</h5>
244<p>the cipher context.</p>
245
246<h5>plaintext</h5>
247<p>the plain text.</p>
248
249<h5>ciphertext</h5>
250<p>the cipher text.</p>
251
252 </div>
253<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
254_8c.html" id="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
255<div class="doc-section">
256
257<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p>
258
259<p>The format of the PasskeyDecipherImage method is:</p>
260
261<pre class="code">
262 MagickBooleanType PasskeyDecipherImage(Image *image,
263 const StringInfo *passkey,ExceptionInfo *exception)
264 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
265 ExceptionInfo *exception)
266</pre>
267
268<p>A description of each parameter follows:</p>
269
270<h5>image</h5>
271<p>the image.</p>
272
273<h5>passphrase</h5>
274<p>decipher cipher pixels with this passphrase.</p>
275
276<h5>passkey</h5>
277<p>decrypt cipher pixels with this passkey.</p>
278
279<h5>exception</h5>
280<p>return any errors or warnings in this structure.</p>
281
282 </div>
283<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
284_8c.html" id="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
285<div class="doc-section">
286
287<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p>
288
289<p>The format of the PasskeyEncipherImage method is:</p>
290
291<pre class="code">
292 MagickBooleanType PasskeyEncipherImage(Image *image,
293 const StringInfo *passkey,ExceptionInfo *exception)
294 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
295 ExceptionInfo *exception)
296</pre>
297
298<p>A description of each parameter follows:</p>
299
300<h5>image</h5>
301<p>the image.</p>
302
303<h5>passphrase</h5>
304<p>encipher pixels with this passphrase.</p>
305
306<h5>passkey</h5>
307<p>decrypt cipher pixels with this passkey.</p>
308
309<h5>exception</h5>
310<p>return any errors or warnings in this structure.</p>
311
312 </div>
313<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
314_8c.html" id="SetAESKey">SetAESKey</a></h2>
315<div class="doc-section">
316
317<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>
318
319<p>The format of the SetAESKey method is:</p>
320
321<pre class="code">
322 SetAESKey(AESInfo *aes_info,const StringInfo *key)
323</pre>
324
325<p>A description of each parameter follows:</p>
326
327<h5>aes_info</h5>
328<p>the cipher context.</p>
329
330<h5>key</h5>
331<p>the key.</p>
332
333 </div>
334<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
335_8c.html" id="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
336<div class="doc-section">
337
338<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p>
339
340<p>The format of the PasskeyDecipherImage method is:</p>
341
342<pre class="code">
343 MagickBooleanType PasskeyDecipherImage(Image *image,
344 const StringInfo *passkey,ExceptionInfo *exception)
345 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
346 ExceptionInfo *exception)
347</pre>
348
349<p>A description of each parameter follows:</p>
350
351<h5>image</h5>
352<p>the image.</p>
353
354<h5>passphrase</h5>
355<p>decipher cipher pixels with this passphrase.</p>
356
357<h5>passkey</h5>
358<p>decrypt cipher pixels with this passkey.</p>
359
360<h5>exception</h5>
361<p>return any errors or warnings in this structure.</p>
362
363 </div>
364<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
365_8c.html" id="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
366<div class="doc-section">
367
368<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p>
369
370<p>The format of the PasskeyEncipherImage method is:</p>
371
372<pre class="code">
373 MagickBooleanType PasskeyEncipherImage(Image *image,
374 const StringInfo *passkey,ExceptionInfo *exception)
375 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
376 ExceptionInfo *exception)
377</pre>
378
379<p>A description of each parameter follows:</p>
380
381<h5>passphrase</h5>
382<p>decipher cipher pixels with this passphrase.</p>
383
384<h5>passkey</h5>
385<p>decrypt cipher pixels with this passkey.</p>
386
387<h5>exception</h5>
388<p>return any errors or warnings in this structure.</p>
389
390 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000391
392</div>
393
394<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000395 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000396 <span id="linkbar-center">
397 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000398 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000399 </span>
400 <span id="linkbar-east">&nbsp;</span>
401 </div>
402 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000403 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000404 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
405 </div>
406 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000407 <script type="text/javascript">
408 var _gaq = _gaq || [];
409 _gaq.push(['_setAccount', 'UA-17690367-1']);
410 _gaq.push(['_trackPageview']);
411
412 (function() {
413 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
414 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
415 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
416 })();
417 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000418</body>
419</html>