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

   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>
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
   7   <style type="text/css" media="screen,projection"><!--
   8     @import url("../../www/magick.css");
   9   --></style>
  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>
  27
  28 <body id="www-imagemagick-org">
  29 <div class="titlebar">
  30 <a href="../../index.html">
  31   <img src="../../images/script.png" alt="[ImageMagick]"
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
  33 <a href="http://www.networkredux.com">
  34   <img src="../../images/networkredux.png" alt="[sponsor]"
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>
  36 <a href="http://www.imagemagick.org/discourse-server/">
  37   <img src="../../images/logo.jpg" alt=""
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  39 <a href="../../index.html">
  40   <img src="../../images/sprite.jpg" alt=""
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  42 </div>
  43
  44 <div class="eastbar">
  45
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>
  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>
  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>
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>
 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>
 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.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
 139 </div>
 140 </div>
 141 </div>
 142
 143
 144 </div>
 145
 146 <div class="main">
 147
 148 <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>
 149
 150 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 151 _8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2>
 152 <div class="doc-section">
 153
 154 <p>AcquireAESInfo() allocate the AESInfo structure.</p></ol>
 155
 156 <p>The format of the AcquireAESInfo method is:</p>
 157
 158 <pre class="code">
 159   AESInfo *AcquireAESInfo(void)
 160 </pre>
 161
 162  </div>
 163 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 164 _8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2>
 165 <div class="doc-section">
 166
 167 <p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol>
 168
 169 <p>The format of the DestroyAESInfo method is:</p>
 170
 171 <pre class="code">
 172   AESInfo *DestroyAESInfo(AESInfo *aes_info)
 173 </pre>
 174
 175 <p>A description of each parameter follows:</p></ol>
 176
 177 <h5>aes_info</h5>
 178 <ol><p>the cipher context.</p></ol>
 179
 180  </div>
 181 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 182 _8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2>
 183 <div class="doc-section">
 184
 185 <p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol>
 186
 187 <p>The format of the EncipherAESBlock method is:</p>
 188
 189 <pre class="code">
 190   void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
 191     unsigned char *ciphertext)
 192 </pre>
 193
 194 <p>A description of each parameter follows:</p></ol>
 195
 196 <h5>aes_info</h5>
 197 <ol><p>the cipher context.</p></ol>
 198
 199 <h5>plaintext</h5>
 200 <ol><p>the plain text.</p></ol>
 201
 202 <h5>ciphertext</h5>
 203 <ol><p>the cipher text.</p></ol>
 204
 205  </div>
 206 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 207 _8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
 208 <div class="doc-section">
 209
 210 <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
 211
 212 <p>The format of the PasskeyDecipherImage method is:</p>
 213
 214 <pre class="code">
 215   MagickBooleanType PasskeyDecipherImage(Image *image,
 216     const StringInfo *passkey,ExceptionInfo *exception)
 217   MagickBooleanType DecipherImage(Image *image,const char *passphrase,
 218     ExceptionInfo *exception)
 219 </pre>
 220
 221 <p>A description of each parameter follows:</p></ol>
 222
 223 <h5>image</h5>
 224 <ol><p>the image.</p></ol>
 225
 226 <h5>passphrase</h5>
 227 <ol><p>decipher cipher pixels with this passphrase.</p></ol>
 228
 229 <h5>passkey</h5>
 230 <ol><p>decrypt cipher pixels with this passkey.</p></ol>
 231
 232 <h5>exception</h5>
 233 <ol><p>return any errors or warnings in this structure.</p></ol>
 234
 235  </div>
 236 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 237 _8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
 238 <div class="doc-section">
 239
 240 <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
 241
 242 <p>The format of the PasskeyEncipherImage method is:</p>
 243
 244 <pre class="code">
 245   MagickBooleanType PasskeyEncipherImage(Image *image,
 246     const StringInfo *passkey,ExceptionInfo *exception)
 247   MagickBooleanType EncipherImage(Image *image,const char *passphrase,
 248     ExceptionInfo *exception)
 249 </pre>
 250
 251 <p>A description of each parameter follows:</p></ol>
 252
 253 <h5>image</h5>
 254 <ol><p>the image.</p></ol>
 255
 256 <h5>passphrase</h5>
 257 <ol><p>encipher pixels with this passphrase.</p></ol>
 258
 259 <h5>passkey</h5>
 260 <ol><p>decrypt cipher pixels with this passkey.</p></ol>
 261
 262 <h5>exception</h5>
 263 <ol><p>return any errors or warnings in this structure.</p></ol>
 264
 265  </div>
 266 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 267 _8c.html" target="source" name="SetAESKey">SetAESKey</a></h2>
 268 <div class="doc-section">
 269
 270 <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>
 271
 272 <p>The format of the SetAESKey method is:</p>
 273
 274 <pre class="code">
 275   SetAESKey(AESInfo *aes_info,const StringInfo *key)
 276 </pre>
 277
 278 <p>A description of each parameter follows:</p></ol>
 279
 280 <h5>aes_info</h5>
 281 <ol><p>the cipher context.</p></ol>
 282
 283 <h5>key</h5>
 284 <ol><p>the key.</p></ol>
 285
 286  </div>
 287 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 288 _8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
 289 <div class="doc-section">
 290
 291 <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
 292
 293 <p>The format of the PasskeyDecipherImage method is:</p>
 294
 295 <pre class="code">
 296   MagickBooleanType PasskeyDecipherImage(Image *image,
 297     const StringInfo *passkey,ExceptionInfo *exception)
 298   MagickBooleanType DecipherImage(Image *image,const char *passphrase,
 299     ExceptionInfo *exception)
 300 </pre>
 301
 302 <p>A description of each parameter follows:</p></ol>
 303
 304 <h5>image</h5>
 305 <ol><p>the image.</p></ol>
 306
 307 <h5>passphrase</h5>
 308 <ol><p>decipher cipher pixels with this passphrase.</p></ol>
 309
 310 <h5>passkey</h5>
 311 <ol><p>decrypt cipher pixels with this passkey.</p></ol>
 312
 313 <h5>exception</h5>
 314 <ol><p>return any errors or warnings in this structure.</p></ol>
 315
 316  </div>
 317 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
 318 _8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
 319 <div class="doc-section">
 320
 321 <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
 322
 323 <p>The format of the PasskeyEncipherImage method is:</p>
 324
 325 <pre class="code">
 326   MagickBooleanType PasskeyEncipherImage(Image *image,
 327     const StringInfo *passkey,ExceptionInfo *exception)
 328   MagickBooleanType EncipherImage(Image *image,const char *passphrase,
 329     ExceptionInfo *exception)
 330 </pre>
 331
 332 <p>A description of each parameter follows:</p></ol>
 333
 334 <h5>passphrase</h5>
 335 <ol><p>decipher cipher pixels with this passphrase.</p></ol>
 336
 337 <h5>passkey</h5>
 338 <ol><p>decrypt cipher pixels with this passkey.</p></ol>
 339
 340 <h5>exception</h5>
 341 <ol><p>return any errors or warnings in this structure.</p></ol>
 342
 343  </div>
 344
 345 </div>
 346
 347 <div id="linkbar">
 348  <!--    <span id="linkbar-west">&nbsp;</span>  -->
 349     <span id="linkbar-center">
 350       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
 351       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
 352     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 353     </span>
 354     <span id="linkbar-east">&nbsp;</span>
 355   </div>
 356   <div class="footer">
 357     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
 358     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
 359   </div>
 360   <div style="clear: both; margin: 0; width: 100%; "></div>
 361 </body>
 362 </html>