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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  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="Application-name" content="ImageMagick"/>
  16   <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."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <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"/>
  20   <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"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28   <link rel="icon" href="../../images/wand.png"/>
  29   <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"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <a href="../../index.html">\r
  53   <img src="../../images/script.png" alt="[ImageMagick]"\r
  54   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  55 <a href="http://www.networkredux.com">\r
  56   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  57   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
  58 <a href="http://www.imagemagick.org/discourse-server/">\r
  59   <img src="../../images/logo.jpg"\r
  60   alt="ImageMagick Logo"\r
  61   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  62 <a href="../../index.html">\r
  63   <img src="../../images/sprite.jpg"\r
  64   alt="ImageMagick Sprite"\r
  65   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  66 </div>\r
  67 \r
  68 <div class="westbar">\r
  69 \r
  70 <div class="menu">
  71   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  72 </div>
  73 <div class="sep"></div>\r
  74 <div class="menu">
  75   <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: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  88 </div>
  89 <div class="sep"></div>\r
  90 <div class="menu">
  91   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  95 </div>
  96 <div class="sub">
  97     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  98 </div>
  99 <div class="sub">
 100     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 101 </div>
 102 <div class="menu">
 103   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 104 </div>
 105 <div class="sub">
 106     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 107 </div>
 108 <div class="sub">
 109     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div  class="menu">
 119    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 123 </div>
 124 <div class="sub">
 125     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 126  </div>
 127 <div class="menu">
 128   <a title="Resources" href="../../www/resources.html">Resources</a>
 129 </div>
 130 <div class="menu">
 131   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 132 </div>
 133 <div class="menu">
 134   <a title="Download" href="../../www/download.html">Download</a>
 135 </div>
 136 <div class="sep"></div>\r
 137 <div class="menu">
 138   <a title="Search" href="../../www/search.html">Search</a>
 139 </div>
 140 <div class="sep"></div>\r
 141 <div class="menu">
 142   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 143 </div>
 144 <div  class="sub">
 145   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div  class="menu">
 149   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 150
 151 <div class="sponsbox">
 152 <div  class="sponsor">
 153   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 154 </div>
 155 <div  class="sponsor">
 156   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 157 </div>
 158 <div  class="sponsor">
 159   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
 160 </div>
 161 <div class="sponsor">
 162   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
 163 </div>
 164 <div  class="sponsor">
 165   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 166 </div>
 167 <div  class="sponsor">
 168   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 169 </div>
 170 <div  class="sponsor">
 171   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 172 </div>
 173 <div  class="sponsor">
 174    <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
 175 </div>
 176 </div>
 177 </div>
 178 </div>\r
 179 \r
 180 <div class="eastbar">\r
 181   <script type="text/javascript">\r
 182   <!--\r
 183     google_ad_client = "pub-3129977114552745";\r
 184     google_ad_slot = "0574824969";\r
 185     google_ad_width = 160;\r
 186     google_ad_height = 600;\r
 187   //-->\r
 188   </script>\r
 189   <script type="text/javascript"\r
 190     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 191   </script>\r
 192 </div>\r
 193 \r
 194 <div class="main">\r
 195 \r
 196 <h1>Module cipher Methods</h1>
 197 <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>
 198
 199 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="AcquireAESInfo">AcquireAESInfo</a></h2>
 200 <div class="doc-section">
 201
 202 <p>AcquireAESInfo() allocate the AESInfo structure.</p>
 203
 204 <p>The format of the AcquireAESInfo method is:</p>
 205
 206 <pre class="code">
 207   AESInfo *AcquireAESInfo(void)
 208 </pre>
 209
 210  </div>
 211 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_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_8c.html" id="EncipherAESBlock">EncipherAESBlock</a></h2>
 229 <div class="doc-section">
 230
 231 <p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p>
 232
 233 <p>The format of the EncipherAESBlock method is:</p>
 234
 235 <pre class="code">
 236   void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
 237     unsigned char *ciphertext)
 238 </pre>
 239
 240 <p>A description of each parameter follows:</p>
 241
 242 <h5>aes_info</h5>
 243 <p>the cipher context.</p>
 244
 245 <h5>plaintext</h5>
 246 <p>the plain text.</p>
 247
 248 <h5>ciphertext</h5>
 249 <p>the cipher text.</p>
 250
 251  </div>
 252 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
 253 <div class="doc-section">
 254
 255 <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p>
 256
 257 <p>The format of the PasskeyDecipherImage method is:</p>
 258
 259 <pre class="code">
 260   MagickBooleanType PasskeyDecipherImage(Image *image,
 261     const StringInfo *passkey,ExceptionInfo *exception)
 262   MagickBooleanType DecipherImage(Image *image,const char *passphrase,
 263     ExceptionInfo *exception)
 264 </pre>
 265
 266 <p>A description of each parameter follows:</p>
 267
 268 <h5>image</h5>
 269 <p>the image.</p>
 270
 271 <h5>passphrase</h5>
 272 <p>decipher cipher pixels with this passphrase.</p>
 273
 274 <h5>passkey</h5>
 275 <p>decrypt cipher pixels with this passkey.</p>
 276
 277 <h5>exception</h5>
 278 <p>return any errors or warnings in this structure.</p>
 279
 280  </div>
 281 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
 282 <div class="doc-section">
 283
 284 <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p>
 285
 286 <p>The format of the PasskeyEncipherImage method is:</p>
 287
 288 <pre class="code">
 289   MagickBooleanType PasskeyEncipherImage(Image *image,
 290     const StringInfo *passkey,ExceptionInfo *exception)
 291   MagickBooleanType EncipherImage(Image *image,const char *passphrase,
 292     ExceptionInfo *exception)
 293 </pre>
 294
 295 <p>A description of each parameter follows:</p>
 296
 297 <h5>image</h5>
 298 <p>the image.</p>
 299
 300 <h5>passphrase</h5>
 301 <p>encipher pixels with this passphrase.</p>
 302
 303 <h5>passkey</h5>
 304 <p>decrypt cipher pixels with this passkey.</p>
 305
 306 <h5>exception</h5>
 307 <p>return any errors or warnings in this structure.</p>
 308
 309  </div>
 310 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="SetAESKey">SetAESKey</a></h2>
 311 <div class="doc-section">
 312
 313 <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>
 314
 315 <p>The format of the SetAESKey method is:</p>
 316
 317 <pre class="code">
 318   SetAESKey(AESInfo *aes_info,const StringInfo *key)
 319 </pre>
 320
 321 <p>A description of each parameter follows:</p>
 322
 323 <h5>aes_info</h5>
 324 <p>the cipher context.</p>
 325
 326 <h5>key</h5>
 327 <p>the key.</p>
 328
 329  </div>
 330 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
 331 <div class="doc-section">
 332
 333 <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p>
 334
 335 <p>The format of the PasskeyDecipherImage method is:</p>
 336
 337 <pre class="code">
 338   MagickBooleanType PasskeyDecipherImage(Image *image,
 339     const StringInfo *passkey,ExceptionInfo *exception)
 340   MagickBooleanType DecipherImage(Image *image,const char *passphrase,
 341     ExceptionInfo *exception)
 342 </pre>
 343
 344 <p>A description of each parameter follows:</p>
 345
 346 <h5>image</h5>
 347 <p>the image.</p>
 348
 349 <h5>passphrase</h5>
 350 <p>decipher cipher pixels with this passphrase.</p>
 351
 352 <h5>passkey</h5>
 353 <p>decrypt cipher pixels with this passkey.</p>
 354
 355 <h5>exception</h5>
 356 <p>return any errors or warnings in this structure.</p>
 357
 358  </div>
 359 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
 360 <div class="doc-section">
 361
 362 <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p>
 363
 364 <p>The format of the PasskeyEncipherImage method is:</p>
 365
 366 <pre class="code">
 367   MagickBooleanType PasskeyEncipherImage(Image *image,
 368     const StringInfo *passkey,ExceptionInfo *exception)
 369   MagickBooleanType EncipherImage(Image *image,const char *passphrase,
 370     ExceptionInfo *exception)
 371 </pre>
 372
 373 <p>A description of each parameter follows:</p>
 374
 375 <h5>passphrase</h5>
 376 <p>decipher cipher pixels with this passphrase.</p>
 377
 378 <h5>passkey</h5>
 379 <p>decrypt cipher pixels with this passkey.</p>
 380
 381 <h5>exception</h5>
 382 <p>return any errors or warnings in this structure.</p>
 383
 384  </div>
 385 \r
 386 </div>\r
 387 \r
 388 <div id="linkbar">\r
 389     <span id="linkbar-west">&nbsp;</span>\r
 390     <span id="linkbar-center">\r
 391       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 392       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 393     </span>\r
 394     <span id="linkbar-east">&nbsp;</span>\r
 395   </div>\r
 396   <div class="footer">\r
 397     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 398     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 399   </div>\r
 400   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 401   <script type="text/javascript">\r
 402     var _gaq = _gaq || [];\r
 403     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 404     _gaq.push(['_trackPageview']);\r
 405 \r
 406     (function() {\r
 407       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 408       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 409       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 410     })();\r
 411   </script>\r
 412 </body>\r
 413 </html>\r