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