cristy | f3bb478 | 2009-09-08 13:10:04 +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">
|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
| 4 | <head>
|
cristy | 1f9e1ed | 2009-11-18 04:09:38 +0000 | [diff] [blame] | 5 | <meta http-equiv="Content-Type" value="application/xhtml+xml" />
|
cristy | f3bb478 | 2009-09-08 13:10:04 +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" />
|
| 8 | <style type="text/css" media="screen,projection"><!--
|
| 9 | @import url("../../www/magick.css");
|
| 10 | --></style>
|
cristy | 3ed852e | 2009-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"/> |
cristy | 16af1cb | 2009-12-11 21:38:29 +0000 | [diff] [blame] | 25 | <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 26 | <meta name="Distribution" content="Global"/> |
cristy | f3bb478 | 2009-09-08 13:10:04 +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 |
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 47 | <div class="menu"> |
| 48 | <a href="../../index.html">About ImageMagick</a> |
| 49 | </div> |
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 50 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 51 | <div class="menu"> |
| 52 | <a href="../../www/command-line-tools.html">Command-line Tools</a> |
| 53 | </div> |
| 54 | <div class="sub"> |
| 55 | <a href="../../www/command-line-processing.html">Processing</a> |
| 56 | </div> |
| 57 | <div class="sub"> |
| 58 | <a href="../../www/command-line-options.html">Options</a> |
| 59 | </div> |
| 60 | <div class="sub"> |
| 61 | <a href="http://www.imagemagick.org/Usage/">Usage</a> |
| 62 | </div> |
| 63 | <div class="menu"> |
| 64 | <a href="../../www/api.html">Program Interfaces</a> |
| 65 | </div> |
| 66 | <div class="sub"> |
| 67 | <a href="../../www/magick-wand.html">MagickWand</a> |
| 68 | </div> |
| 69 | <div class="sub"> |
| 70 | <a href="../../www/magick-core.html">MagickCore</a> |
| 71 | </div> |
| 72 | <div class="sub"> |
| 73 | <a href="../../www/perl-magick.html">PerlMagick</a> |
| 74 | </div> |
| 75 | <div class="sub"> |
| 76 | <a href="../../Magick++/">Magick++</a> |
| 77 | </div> |
| 78 | <div class="menu"> |
| 79 | <a href="../../www/architecture.html">Architecture</a> |
| 80 | </div> |
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 81 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 82 | <div class="menu"> |
| 83 | <a href="../../www/install-source.html">Install from Source</a> |
| 84 | </div> |
| 85 | <div class="sub"> |
| 86 | <a href="../../www/install-source.html#unix">Unix</a> |
| 87 | </div> |
| 88 | <div class="sub"> |
| 89 | <a href="../../www/install-source.html#windows">Windows</a> |
| 90 | </div> |
| 91 | <div class="menu"> |
| 92 | <a href="../../www/binary-releases.html">Binary Releases</a> |
| 93 | </div> |
| 94 | <div class="sub"> |
| 95 | <a href="../../www/binary-releases.html#unix">Unix</a> |
| 96 | </div> |
| 97 | <div class="sub"> |
| 98 | <a href="../../www/binary-releases.html#macosx">Mac OS X</a> |
| 99 | </div> |
| 100 | <div class="sub"> |
| 101 | <a href="../../www/binary-releases.html#windows">Windows</a> |
| 102 | </div> |
| 103 | <div class="menu"> |
| 104 | <a href="../../www/resources.html">Resources</a> |
| 105 | </div> |
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 106 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 107 | <div class="menu"> |
| 108 | <a href="../../www/download.html">Download</a> |
| 109 | </div> |
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 110 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 111 | <div class="menu"> |
| 112 | <a href="../http://www.imagemagick.org/script/search.php">Search</a> |
| 113 | </div> |
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 114 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 115 | <div class="menu"> |
| 116 | <a href="../../www/sitemap.html">Site Map</a> |
| 117 | </div> |
| 118 | <div class="sub"> |
| 119 | <a href="../../www/links.html">Links</a> |
| 120 | </div> |
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 121 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 122 | <div class="menu"> |
| 123 | <a href="../../www/sponsors.html">Sponsors:</a> |
| 124 | |
| 125 | <div class="sponsbox"> |
| 126 | <div class="sponsor"> |
cristy | 045bd90 | 2010-01-30 18:56:24 +0000 | [diff] [blame^] | 127 | <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ --> |
cristy | 7396d88 | 2010-01-27 02:37:56 +0000 | [diff] [blame] | 128 | </div> |
| 129 | <div class="sponsor"> |
cristy | 1f9e1ed | 2009-11-18 04:09:38 +0000 | [diff] [blame] | 130 | <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de--> |
| 131 | </div> |
| 132 | <div class="sponsor"> |
cristy | 16ff93c | 2010-01-13 23:18:07 +0000 | [diff] [blame] | 133 | <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201006010120 Buchhorn --> |
cristy | b4c03bb | 2009-09-27 13:55:46 +0000 | [diff] [blame] | 134 | </div> |
| 135 | <div class="sponsor"> |
cristy | 0f61e61 | 2009-11-10 20:03:57 +0000 | [diff] [blame] | 136 | <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 --> |
cristy | 916e192 | 2009-10-01 12:52:47 +0000 | [diff] [blame] | 137 | </div> |
| 138 | <div class="sponsor"> |
cristy | b4c03bb | 2009-09-27 13:55:46 +0000 | [diff] [blame] | 139 | <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 --> |
cristy | c49f799 | 2009-09-22 22:48:40 +0000 | [diff] [blame] | 140 | </div> |
| 141 | <div class="sponsor"> |
cristy | 16ff93c | 2010-01-13 23:18:07 +0000 | [diff] [blame] | 142 | <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de --> |
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 143 | </div> |
| 144 | <div class="sponsor"> |
cristy | 16ff93c | 2010-01-13 23:18:07 +0000 | [diff] [blame] | 145 | <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de--> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 146 | </div> |
| 147 | <div class="sponsor"> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 148 | <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 --> |
| 149 | </div> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 150 | </div> |
| 151 | </div> |
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 152 |
|
| 153 |
|
| 154 | </div>
|
| 155 |
|
| 156 | <div class="main">
|
| 157 |
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 158 | <p class="navigation-index">[<a href="#AcquireAESInfo">AcquireAESInfo</a> • <a href="#DestroyAESInfo">DestroyAESInfo</a> • <a href="#EncipherAESBlock">EncipherAESBlock</a> • <a href="#PasskeyDecipherImage">PasskeyDecipherImage</a> • <a href="#PasskeyEncipherImage">PasskeyEncipherImage</a> • <a href="#SetAESKey">SetAESKey</a> • <a href="#PasskeyDecipherImage">PasskeyDecipherImage</a> • <a href="#PasskeyEncipherImage">PasskeyEncipherImage</a>]</p> |
| 159 | |
| 160 | <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher |
| 161 | _8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2> |
| 162 | <div class="doc-section"> |
| 163 | |
| 164 | <p>AcquireAESInfo() allocate the AESInfo structure.</p></ol> |
| 165 | |
| 166 | <p>The format of the AcquireAESInfo method is:</p> |
| 167 | |
| 168 | <pre class="code"> |
| 169 | AESInfo *AcquireAESInfo(void) |
| 170 | </pre> |
| 171 | |
| 172 | </div> |
| 173 | <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher |
| 174 | _8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2> |
| 175 | <div class="doc-section"> |
| 176 | |
| 177 | <p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol> |
| 178 | |
| 179 | <p>The format of the DestroyAESInfo method is:</p> |
| 180 | |
| 181 | <pre class="code"> |
| 182 | AESInfo *DestroyAESInfo(AESInfo *aes_info) |
| 183 | </pre> |
| 184 | |
| 185 | <p>A description of each parameter follows:</p></ol> |
| 186 | |
| 187 | <h5>aes_info</h5> |
| 188 | <ol><p>the cipher context.</p></ol> |
| 189 | |
| 190 | </div> |
| 191 | <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher |
| 192 | _8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2> |
| 193 | <div class="doc-section"> |
| 194 | |
| 195 | <p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol> |
| 196 | |
| 197 | <p>The format of the EncipherAESBlock method is:</p> |
| 198 | |
| 199 | <pre class="code"> |
| 200 | void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext, |
| 201 | unsigned char *ciphertext) |
| 202 | </pre> |
| 203 | |
| 204 | <p>A description of each parameter follows:</p></ol> |
| 205 | |
| 206 | <h5>aes_info</h5> |
| 207 | <ol><p>the cipher context.</p></ol> |
| 208 | |
| 209 | <h5>plaintext</h5> |
| 210 | <ol><p>the plain text.</p></ol> |
| 211 | |
| 212 | <h5>ciphertext</h5> |
| 213 | <ol><p>the cipher text.</p></ol> |
| 214 | |
| 215 | </div> |
| 216 | <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher |
| 217 | _8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2> |
| 218 | <div class="doc-section"> |
| 219 | |
| 220 | <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol> |
| 221 | |
| 222 | <p>The format of the PasskeyDecipherImage method is:</p> |
| 223 | |
| 224 | <pre class="code"> |
| 225 | MagickBooleanType PasskeyDecipherImage(Image *image, |
| 226 | const StringInfo *passkey,ExceptionInfo *exception) |
| 227 | MagickBooleanType DecipherImage(Image *image,const char *passphrase, |
| 228 | ExceptionInfo *exception) |
| 229 | </pre> |
| 230 | |
| 231 | <p>A description of each parameter follows:</p></ol> |
| 232 | |
| 233 | <h5>image</h5> |
| 234 | <ol><p>the image.</p></ol> |
| 235 | |
| 236 | <h5>passphrase</h5> |
| 237 | <ol><p>decipher cipher pixels with this passphrase.</p></ol> |
| 238 | |
| 239 | <h5>passkey</h5> |
| 240 | <ol><p>decrypt cipher pixels with this passkey.</p></ol> |
| 241 | |
| 242 | <h5>exception</h5> |
| 243 | <ol><p>return any errors or warnings in this structure.</p></ol> |
| 244 | |
| 245 | </div> |
| 246 | <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher |
| 247 | _8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2> |
| 248 | <div class="doc-section"> |
| 249 | |
| 250 | <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol> |
| 251 | |
| 252 | <p>The format of the PasskeyEncipherImage method is:</p> |
| 253 | |
| 254 | <pre class="code"> |
| 255 | MagickBooleanType PasskeyEncipherImage(Image *image, |
| 256 | const StringInfo *passkey,ExceptionInfo *exception) |
| 257 | MagickBooleanType EncipherImage(Image *image,const char *passphrase, |
| 258 | ExceptionInfo *exception) |
| 259 | </pre> |
| 260 | |
| 261 | <p>A description of each parameter follows:</p></ol> |
| 262 | |
| 263 | <h5>image</h5> |
| 264 | <ol><p>the image.</p></ol> |
| 265 | |
| 266 | <h5>passphrase</h5> |
| 267 | <ol><p>encipher pixels with this passphrase.</p></ol> |
| 268 | |
| 269 | <h5>passkey</h5> |
| 270 | <ol><p>decrypt cipher pixels with this passkey.</p></ol> |
| 271 | |
| 272 | <h5>exception</h5> |
| 273 | <ol><p>return any errors or warnings in this structure.</p></ol> |
| 274 | |
| 275 | </div> |
| 276 | <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher |
| 277 | _8c.html" target="source" name="SetAESKey">SetAESKey</a></h2> |
| 278 | <div class="doc-section"> |
| 279 | |
| 280 | <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> |
| 281 | |
| 282 | <p>The format of the SetAESKey method is:</p> |
| 283 | |
| 284 | <pre class="code"> |
| 285 | SetAESKey(AESInfo *aes_info,const StringInfo *key) |
| 286 | </pre> |
| 287 | |
| 288 | <p>A description of each parameter follows:</p></ol> |
| 289 | |
| 290 | <h5>aes_info</h5> |
| 291 | <ol><p>the cipher context.</p></ol> |
| 292 | |
| 293 | <h5>key</h5> |
| 294 | <ol><p>the key.</p></ol> |
| 295 | |
| 296 | </div> |
| 297 | <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher |
| 298 | _8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2> |
| 299 | <div class="doc-section"> |
| 300 | |
| 301 | <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol> |
| 302 | |
| 303 | <p>The format of the PasskeyDecipherImage method is:</p> |
| 304 | |
| 305 | <pre class="code"> |
| 306 | MagickBooleanType PasskeyDecipherImage(Image *image, |
| 307 | const StringInfo *passkey,ExceptionInfo *exception) |
| 308 | MagickBooleanType DecipherImage(Image *image,const char *passphrase, |
| 309 | ExceptionInfo *exception) |
| 310 | </pre> |
| 311 | |
| 312 | <p>A description of each parameter follows:</p></ol> |
| 313 | |
| 314 | <h5>image</h5> |
| 315 | <ol><p>the image.</p></ol> |
| 316 | |
| 317 | <h5>passphrase</h5> |
| 318 | <ol><p>decipher cipher pixels with this passphrase.</p></ol> |
| 319 | |
| 320 | <h5>passkey</h5> |
| 321 | <ol><p>decrypt cipher pixels with this passkey.</p></ol> |
| 322 | |
| 323 | <h5>exception</h5> |
| 324 | <ol><p>return any errors or warnings in this structure.</p></ol> |
| 325 | |
| 326 | </div> |
| 327 | <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher |
| 328 | _8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2> |
| 329 | <div class="doc-section"> |
| 330 | |
| 331 | <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol> |
| 332 | |
| 333 | <p>The format of the PasskeyEncipherImage method is:</p> |
| 334 | |
| 335 | <pre class="code"> |
| 336 | MagickBooleanType PasskeyEncipherImage(Image *image, |
| 337 | const StringInfo *passkey,ExceptionInfo *exception) |
| 338 | MagickBooleanType EncipherImage(Image *image,const char *passphrase, |
| 339 | ExceptionInfo *exception) |
| 340 | </pre> |
| 341 | |
| 342 | <p>A description of each parameter follows:</p></ol> |
| 343 | |
| 344 | <h5>passphrase</h5> |
| 345 | <ol><p>decipher cipher pixels with this passphrase.</p></ol> |
| 346 | |
| 347 | <h5>passkey</h5> |
| 348 | <ol><p>decrypt cipher pixels with this passkey.</p></ol> |
| 349 | |
| 350 | <h5>exception</h5> |
| 351 | <ol><p>return any errors or warnings in this structure.</p></ol> |
| 352 | |
| 353 | </div> |
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 354 |
|
| 355 | </div>
|
| 356 |
|
| 357 | <div id="linkbar">
|
| 358 | <!-- <span id="linkbar-west"> </span> -->
|
| 359 | <span id="linkbar-center">
|
| 360 | <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
|
cristy | d43a46b | 2010-01-21 02:13:41 +0000 | [diff] [blame] | 361 | <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
|
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 362 | </span>
|
| 363 | <span id="linkbar-east"> </span>
|
| 364 | </div>
|
| 365 | <div class="footer">
|
cristy | 16af1cb | 2009-12-11 21:38:29 +0000 | [diff] [blame] | 366 | <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
|
cristy | f3bb478 | 2009-09-08 13:10:04 +0000 | [diff] [blame] | 367 | <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
|
| 368 | </div>
|
| 369 | <div style="clear: both; margin: 0; width: 100%; "></div>
|
| 370 | </body>
|
| 371 | </html>
|