Home | History | Annotate | Download | only in api
      1 
      2 
      3 
      4 
      5 <!DOCTYPE html>
      6 <html lang="en">
      7 <head>
      8     <title>ImageMagick: MagickCore, C API for ImageMagick: Convert to and from Cipher Pixels</title>
      9   <meta charset="utf-8" />
     10   <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     11   <meta name="viewport" content="width=device-width, initial-scale=1" />
     12   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
     13   <meta name="application-name" content="ImageMagick"/>
     14   <meta name="description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bzier curves."/>
     15   <meta name="application-url" content="http://www.imagemagick.org"/>
     16   <meta name="generator" content="PHP"/>
     17   <meta name="keywords" content="magickcore, c, api, for, imagemagick:, convert, to, from, cipher, pixels, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
     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-2016 ImageMagick Studio LLC"/>
     25   <meta name="distribution" content="Global"/>
     26   <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
     27   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
     28   <link rel="icon" href="../images/wand.png"/>
     29   <link rel="shortcut icon" href="../images/wand.ico"/>
     30   <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Roboto:900,400,400italic,700,700italic,300,300italic|Open+Sans:300italic,400italic,700italic,300,400,600,700">
     31   <link rel="stylesheet" href="../css/magick.html"/>
     32 </head>
     33 <body>
     34 <div class="main">
     35 <div class="magick-masthead">
     36   <div class="container">
     37     <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
     38          style="display:block"
     39          data-ad-client="ca-pub-3129977114552745"
     40          data-ad-slot="6345125851"
     41          data-ad-format="auto"></ins>
     42     <script>
     43       (adsbygoogle = window.adsbygoogle || []).push({});
     44     </script>
     45     <nav class="magick-nav">
     46       <a class="magick-nav-item " href="../index.html">Home</a>
     47       <a class="magick-nav-item " href="../binary-releases.html">Download</a>
     48       <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
     49       <a class="magick-nav-item " href="../command-line-processing.html">Command-line</a>
     50       <a class="magick-nav-item " href="../resources.html">Resources</a>
     51       <a class="magick-nav-item " href="api.html">Develop</a>
     52       <a class="magick-nav-item " href="http://www.imagemagick.org/script/search.php">Search</a>
     53       <a class="magick-nav-item pull-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
     54     </nav>
     55   </div>
     56 </div>
     57 <div class="container">
     58 <div class="magick-header">
     59 <p class="text-center"><a href="cipher.html#AcquireAESInfo">AcquireAESInfo</a> &#8226; <a href="cipher.html#DestroyAESInfo">DestroyAESInfo</a> &#8226; <a href="cipher.html#EncipherAESBlock">EncipherAESBlock</a> &#8226; <a href="cipher.html#PasskeyDecipherImage">PasskeyDecipherImage</a> &#8226; <a href="cipher.html#PasskeyEncipherImage">PasskeyEncipherImage</a> &#8226; <a href="cipher.html#SetAESKey">SetAESKey</a> &#8226; <a href="cipher.html#PasskeyDecipherImage">PasskeyDecipherImage</a> &#8226; <a href="cipher.html#PasskeyEncipherImage">PasskeyEncipherImage</a></p>
     60 
     61 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="AcquireAESInfo">AcquireAESInfo</a></h2>
     62 
     63 <p>AcquireAESInfo() allocate the AESInfo structure.</p>
     64 
     65 <p>The format of the AcquireAESInfo method is:</p>
     66 
     67 <pre class="text">
     68 AESInfo *AcquireAESInfo(void)
     69 </pre>
     70 
     71 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="DestroyAESInfo">DestroyAESInfo</a></h2>
     72 
     73 <p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p>
     74 
     75 <p>The format of the DestroyAESInfo method is:</p>
     76 
     77 <pre class="text">
     78 AESInfo *DestroyAESInfo(AESInfo *aes_info)
     79 </pre>
     80 
     81 <p>A description of each parameter follows:</p>
     82 
     83 <dd>
     84 </dd>
     85 
     86 <dd> </dd>
     87 <dl class="dl-horizontal">
     88 <dt>aes_info</dt>
     89 <dd>the cipher context. </dd>
     90 
     91 <dd>  </dd>
     92 </dl>
     93 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="EncipherAESBlock">EncipherAESBlock</a></h2>
     94 
     95 <p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p>
     96 
     97 <p>The format of the EncipherAESBlock method is:</p>
     98 
     99 <pre class="text">
    100 void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
    101   unsigned char *ciphertext)
    102 </pre>
    103 
    104 <p>A description of each parameter follows:</p>
    105 
    106 <dd>
    107 </dd>
    108 
    109 <dd> </dd>
    110 <dl class="dl-horizontal">
    111 <dt>aes_info</dt>
    112 <dd>the cipher context. </dd>
    113 
    114 <dd> </dd>
    115 <dt>plaintext</dt>
    116 <dd>the plain text. </dd>
    117 
    118 <dd> </dd>
    119 <dt>ciphertext</dt>
    120 <dd>the cipher text. </dd>
    121 
    122 <dd>  </dd>
    123 </dl>
    124 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
    125 
    126 <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p>
    127 
    128 <p>The format of the PasskeyDecipherImage method is:</p>
    129 
    130 <pre class="text">
    131 MagickBooleanType PasskeyDecipherImage(Image *image,
    132   const StringInfo *passkey,ExceptionInfo *exception)
    133 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
    134   ExceptionInfo *exception)
    135 </pre>
    136 
    137 <p>A description of each parameter follows:</p>
    138 
    139 <dd>
    140 </dd>
    141 
    142 <dd> </dd>
    143 <dl class="dl-horizontal">
    144 <dt>image</dt>
    145 <dd>the image. </dd>
    146 
    147 <dd> </dd>
    148 <dt>passphrase</dt>
    149 <dd>decipher cipher pixels with this passphrase. </dd>
    150 
    151 <dd> </dd>
    152 <dt>passkey</dt>
    153 <dd>decrypt cipher pixels with this passkey. </dd>
    154 
    155 <dd> </dd>
    156 <dt>exception</dt>
    157 <dd>return any errors or warnings in this structure. </dd>
    158 
    159 <dd>  </dd>
    160 </dl>
    161 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
    162 
    163 <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p>
    164 
    165 <p>The format of the PasskeyEncipherImage method is:</p>
    166 
    167 <pre class="text">
    168 MagickBooleanType PasskeyEncipherImage(Image *image,
    169   const StringInfo *passkey,ExceptionInfo *exception)
    170 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
    171   ExceptionInfo *exception)
    172 </pre>
    173 
    174 <p>A description of each parameter follows:</p>
    175 
    176 <dd>
    177 </dd>
    178 
    179 <dd> </dd>
    180 <dl class="dl-horizontal">
    181 <dt>image</dt>
    182 <dd>the image. </dd>
    183 
    184 <dd> </dd>
    185 <dt>passphrase</dt>
    186 <dd>encipher pixels with this passphrase. </dd>
    187 
    188 <dd> </dd>
    189 <dt>passkey</dt>
    190 <dd>decrypt cipher pixels with this passkey. </dd>
    191 
    192 <dd> </dd>
    193 <dt>exception</dt>
    194 <dd>return any errors or warnings in this structure. </dd>
    195 
    196 <dd>  </dd>
    197 </dl>
    198 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="SetAESKey">SetAESKey</a></h2>
    199 
    200 <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>
    201 
    202 <p>The format of the SetAESKey method is:</p>
    203 
    204 <pre class="text">
    205 SetAESKey(AESInfo *aes_info,const StringInfo *key)
    206 </pre>
    207 
    208 <p>A description of each parameter follows:</p>
    209 
    210 <dd>
    211 </dd>
    212 
    213 <dd> </dd>
    214 <dl class="dl-horizontal">
    215 <dt>aes_info</dt>
    216 <dd>the cipher context. </dd>
    217 
    218 <dd> </dd>
    219 <dt>key</dt>
    220 <dd>the key. </dd>
    221 
    222 <dd>  </dd>
    223 </dl>
    224 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
    225 
    226 <p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p>
    227 
    228 <p>The format of the PasskeyDecipherImage method is:</p>
    229 
    230 <pre class="text">
    231 MagickBooleanType PasskeyDecipherImage(Image *image,
    232   const StringInfo *passkey,ExceptionInfo *exception)
    233 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
    234   ExceptionInfo *exception)
    235 </pre>
    236 
    237 <p>A description of each parameter follows:</p>
    238 
    239 <dd>
    240 </dd>
    241 
    242 <dd> </dd>
    243 <dl class="dl-horizontal">
    244 <dt>image</dt>
    245 <dd>the image. </dd>
    246 
    247 <dd> </dd>
    248 <dt>passphrase</dt>
    249 <dd>decipher cipher pixels with this passphrase. </dd>
    250 
    251 <dd> </dd>
    252 <dt>passkey</dt>
    253 <dd>decrypt cipher pixels with this passkey. </dd>
    254 
    255 <dd> </dd>
    256 <dt>exception</dt>
    257 <dd>return any errors or warnings in this structure. </dd>
    258 
    259 <dd>  </dd>
    260 </dl>
    261 <h2><a href="http://www.imagemagick.org/api/MagickCore/cipher_8c.html" id="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
    262 
    263 <p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p>
    264 
    265 <p>The format of the PasskeyEncipherImage method is:</p>
    266 
    267 <pre class="text">
    268 MagickBooleanType PasskeyEncipherImage(Image *image,
    269   const StringInfo *passkey,ExceptionInfo *exception)
    270 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
    271   ExceptionInfo *exception)
    272 </pre>
    273 
    274 <p>A description of each parameter follows:</p>
    275 
    276 <dd>
    277 </dd>
    278 
    279 <dd> </dd>
    280 <dl class="dl-horizontal">
    281 <dt>passphrase</dt>
    282 <dd>decipher cipher pixels with this passphrase. </dd>
    283 
    284 <dd> </dd>
    285 <dt>passkey</dt>
    286 <dd>decrypt cipher pixels with this passkey. </dd>
    287 
    288 <dd> </dd>
    289 <dt>exception</dt>
    290 <dd>return any errors or warnings in this structure. </dd>
    291 
    292 <dd>  </dd>
    293 </dl>
    294 </div>
    295   <footer class="magick-footer">
    296     <p><a href="../support.html">Donate</a> 
    297      <a href="../sitemap.html">Sitemap</a> 
    298     <a href="../links.html">Related</a> 
    299     <a href="../architecture.html">Architecture</a>
    300 </p>
    301     <p><a href="cipher.html#">Back to top</a> 
    302     <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> 
    303     <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
    304         <p><small>  1999-2016 ImageMagick Studio LLC</small></p>
    305   </footer>
    306 </div><!-- /.container -->
    307 
    308   <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
    309   <script src="../js/magick.html"></script>
    310 </div>
    311 </body>
    312 </html>
    313