Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 83a272ecd5c0a2f5dc501872d84d8f934c0dcc38 / . / www / api / cipher.html
blob: 097248ade452c898d9c2a03fb5ff3e04a9493321 [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
45<div class="eastbar">
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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]52 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]53</div>
54<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]55 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]56</div>
57<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]58 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]59</div>
60<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]61 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]62</div>
63<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]64 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]65</div>
66<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]67 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68</div>
69<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]70 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]71</div>
72<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]73 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]74</div>
75<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]76 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]77</div>
78<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]79 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]80</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]83 <a title="Install from Source" href="../../www/install-source.html">Install from Source</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="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</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="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90 </div>
91<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]92 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
94<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]95 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]96</div>
97<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]98 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]101 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102</div>
103<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]104 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]106<div class="sep"></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: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]142 <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]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame^]145 <a title="Sponsor: Lampe Berger" href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<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>
156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
158_8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2>
159<div class="doc-section">
160
161<p>AcquireAESInfo() allocate the AESInfo structure.</p></ol>
162
163<p>The format of the AcquireAESInfo method is:</p>
164
165<pre class="code">
166 AESInfo *AcquireAESInfo(void)
167</pre>
168
169 </div>
170<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
171_8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2>
172<div class="doc-section">
173
174<p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol>
175
176<p>The format of the DestroyAESInfo method is:</p>
177
178<pre class="code">
179 AESInfo *DestroyAESInfo(AESInfo *aes_info)
180</pre>
181
182<p>A description of each parameter follows:</p></ol>
183
184<h5>aes_info</h5>
185<ol><p>the cipher context.</p></ol>
186
187 </div>
188<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
189_8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2>
190<div class="doc-section">
191
192<p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol>
193
194<p>The format of the EncipherAESBlock method is:</p>
195
196<pre class="code">
197 void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
198 unsigned char *ciphertext)
199</pre>
200
201<p>A description of each parameter follows:</p></ol>
202
203<h5>aes_info</h5>
204<ol><p>the cipher context.</p></ol>
205
206<h5>plaintext</h5>
207<ol><p>the plain text.</p></ol>
208
209<h5>ciphertext</h5>
210<ol><p>the cipher text.</p></ol>
211
212 </div>
213<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
214_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
215<div class="doc-section">
216
217<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
218
219<p>The format of the PasskeyDecipherImage method is:</p>
220
221<pre class="code">
222 MagickBooleanType PasskeyDecipherImage(Image *image,
223 const StringInfo *passkey,ExceptionInfo *exception)
224 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
225 ExceptionInfo *exception)
226</pre>
227
228<p>A description of each parameter follows:</p></ol>
229
230<h5>image</h5>
231<ol><p>the image.</p></ol>
232
233<h5>passphrase</h5>
234<ol><p>decipher cipher pixels with this passphrase.</p></ol>
235
236<h5>passkey</h5>
237<ol><p>decrypt cipher pixels with this passkey.</p></ol>
238
239<h5>exception</h5>
240<ol><p>return any errors or warnings in this structure.</p></ol>
241
242 </div>
243<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
244_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
245<div class="doc-section">
246
247<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
248
249<p>The format of the PasskeyEncipherImage method is:</p>
250
251<pre class="code">
252 MagickBooleanType PasskeyEncipherImage(Image *image,
253 const StringInfo *passkey,ExceptionInfo *exception)
254 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
255 ExceptionInfo *exception)
256</pre>
257
258<p>A description of each parameter follows:</p></ol>
259
260<h5>image</h5>
261<ol><p>the image.</p></ol>
262
263<h5>passphrase</h5>
264<ol><p>encipher pixels with this passphrase.</p></ol>
265
266<h5>passkey</h5>
267<ol><p>decrypt cipher pixels with this passkey.</p></ol>
268
269<h5>exception</h5>
270<ol><p>return any errors or warnings in this structure.</p></ol>
271
272 </div>
273<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
274_8c.html" target="source" name="SetAESKey">SetAESKey</a></h2>
275<div class="doc-section">
276
277<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>
278
279<p>The format of the SetAESKey method is:</p>
280
281<pre class="code">
282 SetAESKey(AESInfo *aes_info,const StringInfo *key)
283</pre>
284
285<p>A description of each parameter follows:</p></ol>
286
287<h5>aes_info</h5>
288<ol><p>the cipher context.</p></ol>
289
290<h5>key</h5>
291<ol><p>the key.</p></ol>
292
293 </div>
294<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
295_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
296<div class="doc-section">
297
298<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
299
300<p>The format of the PasskeyDecipherImage method is:</p>
301
302<pre class="code">
303 MagickBooleanType PasskeyDecipherImage(Image *image,
304 const StringInfo *passkey,ExceptionInfo *exception)
305 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
306 ExceptionInfo *exception)
307</pre>
308
309<p>A description of each parameter follows:</p></ol>
310
311<h5>image</h5>
312<ol><p>the image.</p></ol>
313
314<h5>passphrase</h5>
315<ol><p>decipher cipher pixels with this passphrase.</p></ol>
316
317<h5>passkey</h5>
318<ol><p>decrypt cipher pixels with this passkey.</p></ol>
319
320<h5>exception</h5>
321<ol><p>return any errors or warnings in this structure.</p></ol>
322
323 </div>
324<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
325_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
326<div class="doc-section">
327
328<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
329
330<p>The format of the PasskeyEncipherImage method is:</p>
331
332<pre class="code">
333 MagickBooleanType PasskeyEncipherImage(Image *image,
334 const StringInfo *passkey,ExceptionInfo *exception)
335 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
336 ExceptionInfo *exception)
337</pre>
338
339<p>A description of each parameter follows:</p></ol>
340
341<h5>passphrase</h5>
342<ol><p>decipher cipher pixels with this passphrase.</p></ol>
343
344<h5>passkey</h5>
345<ol><p>decrypt cipher pixels with this passkey.</p></ol>
346
347<h5>exception</h5>
348<ol><p>return any errors or warnings in this structure.</p></ol>
349
350 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]351
352</div>
353
354<div id="linkbar">
355 <!-- <span id="linkbar-west">&nbsp;</span> -->
356 <span id="linkbar-center">
357 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristybebec402010-04-23 19:19:08 +0000[diff] [blame]358 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]359 </span>
360 <span id="linkbar-east">&nbsp;</span>
361 </div>
362 <div class="footer">
363 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
364 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
365 </div>
366 <div style="clear: both; margin: 0; width: 100%; "></div>
367</body>
368</html>