Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / d7c0545692809c244da49d98f861b9c43c20a728 / . / www / api / cipher.html
blob: a3a2200d68f19047accafb0b4c1791d2f32a1b6e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
<title>ImageMagick: MagickCore, C API for ImageMagick: Convert to and from Cipher Pixels</title/>
<meta http-equiv="Content-Language" content="en-US"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
<meta name="Application-name" content="ImageMagick"/>
<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."/>
<meta name="Application-url" content="http://www.imagemagick.org"/>
<meta name="Generator" content="PHP"/>
<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"/>
<meta name="Rating" content="GENERAL"/>
<meta name="Robots" content="INDEX, FOLLOW"/>
<meta name="Generator" content="ImageMagick Studio LLC"/>
<meta name="Author" content="ImageMagick Studio LLC"/>
<meta name="Revisit-after" content="2 DAYS"/>
<meta name="Resource-type" content="document"/>
<meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
<link rel="icon" href="../../images/wand.png" sizes="32x32"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
<style type="text/css" media="all">
@import url("../../www/magick.css");
</style>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<a href="../../index.html">
<img src="../../images/script.png" alt="[ImageMagick]"
style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
<a href="http://www.networkredux.com">
<img src="../../images/networkredux.png" alt="[sponsor]"
style="margin: 45px auto; border: 0px; float: left;" /></a>
<a href="http://www.imagemagick.org/discourse-server/">
<img src="../../images/logo.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
<a href="../../index.html">
<img src="../../images/sprite.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="westbar">
<div class="menu">
<a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a title="Resources" href="../../www/resources.html">Resources</a>
</div>
<div class="menu">
<a title="Architecture" href="../../www/architecture.html">Architecture</a>
</div>
<div class="menu">
<a title="Download" href="../../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Site Map"href="../../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a title="Site Map: Links"href="../../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
<div class="sponsbox">
<div class="sponsor">
<a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
</div>
<div class="sponsor">
<a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
</div>
<div class="sponsor">
<a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
</div>
<div class="sponsor">
<a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
</div>
<div class="sponsor">
<a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
</div>
<div class="sponsor">
<a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
</div>
<div class="sponsor">
<a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
</div>
</div>
</div>
</div>
<div class="eastbar">
<script type="text/javascript">
<!--
google_ad_client = "pub-3129977114552745";
google_ad_slot = "0574824969";
google_ad_width = 160;
google_ad_height = 600;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</div>
<div class="main">
<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>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
_8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2>
<div class="doc-section">
<p>AcquireAESInfo() allocate the AESInfo structure.</p></ol>
<p>The format of the AcquireAESInfo method is:</p>
<pre class="code">
AESInfo *AcquireAESInfo(void)
</pre>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
_8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2>
<div class="doc-section">
<p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol>
<p>The format of the DestroyAESInfo method is:</p>
<pre class="code">
AESInfo *DestroyAESInfo(AESInfo *aes_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>aes_info</h5>
<ol><p>the cipher context.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
_8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2>
<div class="doc-section">
<p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol>
<p>The format of the EncipherAESBlock method is:</p>
<pre class="code">
void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
unsigned char *ciphertext)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>aes_info</h5>
<ol><p>the cipher context.</p></ol>
<h5>plaintext</h5>
<ol><p>the plain text.</p></ol>
<h5>ciphertext</h5>
<ol><p>the cipher text.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
<div class="doc-section">
<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
<p>The format of the PasskeyDecipherImage method is:</p>
<pre class="code">
MagickBooleanType PasskeyDecipherImage(Image *image,
const StringInfo *passkey,ExceptionInfo *exception)
MagickBooleanType DecipherImage(Image *image,const char *passphrase,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>passphrase</h5>
<ol><p>decipher cipher pixels with this passphrase.</p></ol>
<h5>passkey</h5>
<ol><p>decrypt cipher pixels with this passkey.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
<div class="doc-section">
<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
<p>The format of the PasskeyEncipherImage method is:</p>
<pre class="code">
MagickBooleanType PasskeyEncipherImage(Image *image,
const StringInfo *passkey,ExceptionInfo *exception)
MagickBooleanType EncipherImage(Image *image,const char *passphrase,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>passphrase</h5>
<ol><p>encipher pixels with this passphrase.</p></ol>
<h5>passkey</h5>
<ol><p>decrypt cipher pixels with this passkey.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
_8c.html" target="source" name="SetAESKey">SetAESKey</a></h2>
<div class="doc-section">
<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>
<p>The format of the SetAESKey method is:</p>
<pre class="code">
SetAESKey(AESInfo *aes_info,const StringInfo *key)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>aes_info</h5>
<ol><p>the cipher context.</p></ol>
<h5>key</h5>
<ol><p>the key.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
<div class="doc-section">
<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
<p>The format of the PasskeyDecipherImage method is:</p>
<pre class="code">
MagickBooleanType PasskeyDecipherImage(Image *image,
const StringInfo *passkey,ExceptionInfo *exception)
MagickBooleanType DecipherImage(Image *image,const char *passphrase,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>passphrase</h5>
<ol><p>decipher cipher pixels with this passphrase.</p></ol>
<h5>passkey</h5>
<ol><p>decrypt cipher pixels with this passkey.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
<div class="doc-section">
<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
<p>The format of the PasskeyEncipherImage method is:</p>
<pre class="code">
MagickBooleanType PasskeyEncipherImage(Image *image,
const StringInfo *passkey,ExceptionInfo *exception)
MagickBooleanType EncipherImage(Image *image,const char *passphrase,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>passphrase</h5>
<ol><p>decipher cipher pixels with this passphrase.</p></ol>
<h5>passkey</h5>
<ol><p>decrypt cipher pixels with this passkey.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
</div>
<div id="linkbar">
<span id="linkbar-west">&nbsp;</span>
<span id="linkbar-center">
<a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east">&nbsp;</span>
</div>
<div class="footer">
<span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-17690367-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>