Source of: /manual/en/function.openssl-decrypt.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.openssl.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.openssl-decrypt.php',
1 => 'openssl_decrypt',
),
'up' =>
array (
0 => 'ref.openssl.php',
1 => 'OpenSSL Functions',
),
'prev' =>
array (
0 => 'function.openssl-csr-sign.php',
1 => 'openssl_csr_sign',
),
'next' =>
array (
0 => 'function.openssl-dh-compute-key.php',
1 => 'openssl_dh_compute_key',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.openssl-decrypt" class="refentry">
<div class="refnamediv">
<h1 class="refname">openssl_decrypt</h1>
<p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">openssl_decrypt</span> — <span class="dc-title">Decrypts data</span></p>
</div>
<a name="function.openssl-decrypt.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>openssl_decrypt</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$data</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$method</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$password</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$raw_input</tt><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Takes a raw or base64 encoded string and decrypts it using a given method and key.
</p>
<div class="warning"><b class="warning">Warning</b><p class="simpara">This function is
currently not documented; only its argument list is available.
</p></div>
</div>
<a name="function.openssl-decrypt.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">data</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The data.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">method</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The cipher method.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">password</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The password.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">raw_input</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Setting to <b><tt class="constant">TRUE</tt></b> will take a raw encoded string,
otherwise a base64 string is assumed for the
<i><tt class="parameter">data</tt></i>
parameter.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.openssl-decrypt.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The decrypted string on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.openssl-decrypt.errors"></a><div class="refsect1 errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Emits an <b><tt class="constant">E_WARNING</tt></b> level error if an unknown cipher algorithm
is passed via the <i><tt class="parameter">method</tt></i>
parameter.
</p>
</div>
<a name="function.openssl-decrypt.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.openssl-encrypt.php" class="function" rel="rdfs-seeAlso">openssl_encrypt()</a> - Encrypts data</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
