granicus.if.org Git - imagemagick/blob - www/api/cipher.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Convert to and from Cipher Pixels</title>
  12   <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"/>
  15   <meta name="Generator" content="PHP"/>
  16   <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"/>
  17   <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."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <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>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 157 _8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2>
 158 <div class="doc-section">
 159
 160 <p>AcquireAESInfo() allocate the AESInfo structure.</p></ol>
 161
 162 <p>The format of the AcquireAESInfo method is:</p>
 163
 164 <pre class="code">
 165   AESInfo *AcquireAESInfo(void)
 166 </pre>
 167
 168  </div>
 169 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 170 _8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2>
 171 <div class="doc-section">
 172
 173 <p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol>
 174
 175 <p>The format of the DestroyAESInfo method is:</p>
 176
 177 <pre class="code">
 178   AESInfo *DestroyAESInfo(AESInfo *aes_info)
 179 </pre>
 180
 181 <p>A description of each parameter follows:</p></ol>
 182
 183 <h5>aes_info</h5>
 184 <ol><p>the cipher context.</p></ol>
 185
 186  </div>
 187 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 188 _8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2>
 189 <div class="doc-section">
 190
 191 <p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol>
 192
 193 <p>The format of the EncipherAESBlock method is:</p>
 194
 195 <pre class="code">
 196   void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
 197     unsigned char *ciphertext)
 198 </pre>
 199
 200 <p>A description of each parameter follows:</p></ol>
 201
 202 <h5>aes_info</h5>
 203 <ol><p>the cipher context.</p></ol>
 204
 205 <h5>plaintext</h5>
 206 <ol><p>the plain text.</p></ol>
 207
 208 <h5>ciphertext</h5>
 209 <ol><p>the cipher text.</p></ol>
 210
 211  </div>
 212 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 213 _8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
 214 <div class="doc-section">
 215
 216 <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
 217
 218 <p>The format of the PasskeyDecipherImage method is:</p>
 219
 220 <pre class="code">
 221   MagickBooleanType PasskeyDecipherImage(Image *image,
 222     const StringInfo *passkey,ExceptionInfo *exception)
 223   MagickBooleanType DecipherImage(Image *image,const char *passphrase,
 224     ExceptionInfo *exception)
 225 </pre>
 226
 227 <p>A description of each parameter follows:</p></ol>
 228
 229 <h5>image</h5>
 230 <ol><p>the image.</p></ol>
 231
 232 <h5>passphrase</h5>
 233 <ol><p>decipher cipher pixels with this passphrase.</p></ol>
 234
 235 <h5>passkey</h5>
 236 <ol><p>decrypt cipher pixels with this passkey.</p></ol>
 237
 238 <h5>exception</h5>
 239 <ol><p>return any errors or warnings in this structure.</p></ol>
 240
 241  </div>
 242 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 243 _8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
 244 <div class="doc-section">
 245
 246 <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
 247
 248 <p>The format of the PasskeyEncipherImage method is:</p>
 249
 250 <pre class="code">
 251   MagickBooleanType PasskeyEncipherImage(Image *image,
 252     const StringInfo *passkey,ExceptionInfo *exception)
 253   MagickBooleanType EncipherImage(Image *image,const char *passphrase,
 254     ExceptionInfo *exception)
 255 </pre>
 256
 257 <p>A description of each parameter follows:</p></ol>
 258
 259 <h5>image</h5>
 260 <ol><p>the image.</p></ol>
 261
 262 <h5>passphrase</h5>
 263 <ol><p>encipher pixels with this passphrase.</p></ol>
 264
 265 <h5>passkey</h5>
 266 <ol><p>decrypt cipher pixels with this passkey.</p></ol>
 267
 268 <h5>exception</h5>
 269 <ol><p>return any errors or warnings in this structure.</p></ol>
 270
 271  </div>
 272 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 273 _8c.html" target="source" name="SetAESKey">SetAESKey</a></h2>
 274 <div class="doc-section">
 275
 276 <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>
 277
 278 <p>The format of the SetAESKey method is:</p>
 279
 280 <pre class="code">
 281   SetAESKey(AESInfo *aes_info,const StringInfo *key)
 282 </pre>
 283
 284 <p>A description of each parameter follows:</p></ol>
 285
 286 <h5>aes_info</h5>
 287 <ol><p>the cipher context.</p></ol>
 288
 289 <h5>key</h5>
 290 <ol><p>the key.</p></ol>
 291
 292  </div>
 293 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 294 _8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
 295 <div class="doc-section">
 296
 297 <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
 298
 299 <p>The format of the PasskeyDecipherImage method is:</p>
 300
 301 <pre class="code">
 302   MagickBooleanType PasskeyDecipherImage(Image *image,
 303     const StringInfo *passkey,ExceptionInfo *exception)
 304   MagickBooleanType DecipherImage(Image *image,const char *passphrase,
 305     ExceptionInfo *exception)
 306 </pre>
 307
 308 <p>A description of each parameter follows:</p></ol>
 309
 310 <h5>image</h5>
 311 <ol><p>the image.</p></ol>
 312
 313 <h5>passphrase</h5>
 314 <ol><p>decipher cipher pixels with this passphrase.</p></ol>
 315
 316 <h5>passkey</h5>
 317 <ol><p>decrypt cipher pixels with this passkey.</p></ol>
 318
 319 <h5>exception</h5>
 320 <ol><p>return any errors or warnings in this structure.</p></ol>
 321
 322  </div>
 323 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 324 _8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
 325 <div class="doc-section">
 326
 327 <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
 328
 329 <p>The format of the PasskeyEncipherImage method is:</p>
 330
 331 <pre class="code">
 332   MagickBooleanType PasskeyEncipherImage(Image *image,
 333     const StringInfo *passkey,ExceptionInfo *exception)
 334   MagickBooleanType EncipherImage(Image *image,const char *passphrase,
 335     ExceptionInfo *exception)
 336 </pre>
 337
 338 <p>A description of each parameter follows:</p></ol>
 339
 340 <h5>passphrase</h5>
 341 <ol><p>decipher cipher pixels with this passphrase.</p></ol>
 342
 343 <h5>passkey</h5>
 344 <ol><p>decrypt cipher pixels with this passkey.</p></ol>
 345
 346 <h5>exception</h5>
 347 <ol><p>return any errors or warnings in this structure.</p></ol>
 348
 349  </div>
 350 \r
 351 </div>\r
 352 \r
 353 <div id="linkbar">\r
 354  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 355     <span id="linkbar-center">\r
 356       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 357       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 358     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 359     </span>\r
 360     <span id="linkbar-east">&nbsp;</span>\r
 361   </div>\r
 362   <div class="footer">\r
 363     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 364     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 365   </div>\r
 366   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 367 </body>\r
 368 </html>\r