Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ce69bb0630da050618321fbefe3c5010e5414c3d / . / www / api / cipher.html
blob: f0ed8f99a191a476b8c5af22bdb276b18fd7eea3 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!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 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <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 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]10 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <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 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</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 +0000[diff] [blame^]45<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]52 <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 +0000[diff] [blame]65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]91<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]142 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
145</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]148<div class="eastbar">
149 <script type="text/javascript">
150 <!--
151 google_ad_client = "pub-3129977114552745";
152 /* 160x600, created 7/27/10 */
153 google_ad_slot = "0574824969";
154 google_ad_width = 160;
155 google_ad_height = 600;
156 //-->
157 </script>
158 <script type="text/javascript"
159 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
160 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]161</div>
162
163<div class="main">
164
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]165<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>
166
167<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
168_8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2>
169<div class="doc-section">
170
171<p>AcquireAESInfo() allocate the AESInfo structure.</p></ol>
172
173<p>The format of the AcquireAESInfo method is:</p>
174
175<pre class="code">
176 AESInfo *AcquireAESInfo(void)
177</pre>
178
179 </div>
180<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
181_8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2>
182<div class="doc-section">
183
184<p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol>
185
186<p>The format of the DestroyAESInfo method is:</p>
187
188<pre class="code">
189 AESInfo *DestroyAESInfo(AESInfo *aes_info)
190</pre>
191
192<p>A description of each parameter follows:</p></ol>
193
194<h5>aes_info</h5>
195<ol><p>the cipher context.</p></ol>
196
197 </div>
198<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
199_8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2>
200<div class="doc-section">
201
202<p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol>
203
204<p>The format of the EncipherAESBlock method is:</p>
205
206<pre class="code">
207 void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
208 unsigned char *ciphertext)
209</pre>
210
211<p>A description of each parameter follows:</p></ol>
212
213<h5>aes_info</h5>
214<ol><p>the cipher context.</p></ol>
215
216<h5>plaintext</h5>
217<ol><p>the plain text.</p></ol>
218
219<h5>ciphertext</h5>
220<ol><p>the cipher text.</p></ol>
221
222 </div>
223<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
224_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
225<div class="doc-section">
226
227<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
228
229<p>The format of the PasskeyDecipherImage method is:</p>
230
231<pre class="code">
232 MagickBooleanType PasskeyDecipherImage(Image *image,
233 const StringInfo *passkey,ExceptionInfo *exception)
234 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
235 ExceptionInfo *exception)
236</pre>
237
238<p>A description of each parameter follows:</p></ol>
239
240<h5>image</h5>
241<ol><p>the image.</p></ol>
242
243<h5>passphrase</h5>
244<ol><p>decipher cipher pixels with this passphrase.</p></ol>
245
246<h5>passkey</h5>
247<ol><p>decrypt cipher pixels with this passkey.</p></ol>
248
249<h5>exception</h5>
250<ol><p>return any errors or warnings in this structure.</p></ol>
251
252 </div>
253<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
254_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
255<div class="doc-section">
256
257<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
258
259<p>The format of the PasskeyEncipherImage method is:</p>
260
261<pre class="code">
262 MagickBooleanType PasskeyEncipherImage(Image *image,
263 const StringInfo *passkey,ExceptionInfo *exception)
264 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
265 ExceptionInfo *exception)
266</pre>
267
268<p>A description of each parameter follows:</p></ol>
269
270<h5>image</h5>
271<ol><p>the image.</p></ol>
272
273<h5>passphrase</h5>
274<ol><p>encipher pixels with this passphrase.</p></ol>
275
276<h5>passkey</h5>
277<ol><p>decrypt cipher pixels with this passkey.</p></ol>
278
279<h5>exception</h5>
280<ol><p>return any errors or warnings in this structure.</p></ol>
281
282 </div>
283<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
284_8c.html" target="source" name="SetAESKey">SetAESKey</a></h2>
285<div class="doc-section">
286
287<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>
288
289<p>The format of the SetAESKey method is:</p>
290
291<pre class="code">
292 SetAESKey(AESInfo *aes_info,const StringInfo *key)
293</pre>
294
295<p>A description of each parameter follows:</p></ol>
296
297<h5>aes_info</h5>
298<ol><p>the cipher context.</p></ol>
299
300<h5>key</h5>
301<ol><p>the key.</p></ol>
302
303 </div>
304<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
305_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
306<div class="doc-section">
307
308<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
309
310<p>The format of the PasskeyDecipherImage method is:</p>
311
312<pre class="code">
313 MagickBooleanType PasskeyDecipherImage(Image *image,
314 const StringInfo *passkey,ExceptionInfo *exception)
315 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
316 ExceptionInfo *exception)
317</pre>
318
319<p>A description of each parameter follows:</p></ol>
320
321<h5>image</h5>
322<ol><p>the image.</p></ol>
323
324<h5>passphrase</h5>
325<ol><p>decipher cipher pixels with this passphrase.</p></ol>
326
327<h5>passkey</h5>
328<ol><p>decrypt cipher pixels with this passkey.</p></ol>
329
330<h5>exception</h5>
331<ol><p>return any errors or warnings in this structure.</p></ol>
332
333 </div>
334<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
335_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
336<div class="doc-section">
337
338<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
339
340<p>The format of the PasskeyEncipherImage method is:</p>
341
342<pre class="code">
343 MagickBooleanType PasskeyEncipherImage(Image *image,
344 const StringInfo *passkey,ExceptionInfo *exception)
345 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
346 ExceptionInfo *exception)
347</pre>
348
349<p>A description of each parameter follows:</p></ol>
350
351<h5>passphrase</h5>
352<ol><p>decipher cipher pixels with this passphrase.</p></ol>
353
354<h5>passkey</h5>
355<ol><p>decrypt cipher pixels with this passkey.</p></ol>
356
357<h5>exception</h5>
358<ol><p>return any errors or warnings in this structure.</p></ol>
359
360 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]361
362</div>
363
364<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]365 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]366 <span id="linkbar-center">
367 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]368 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]369 </span>
370 <span id="linkbar-east">&nbsp;</span>
371 </div>
372 <div class="footer">
373 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
374 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
375 </div>
376 <div style="clear: both; margin: 0; width: 100%; "></div>
377</body>
378</html>