<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Verifies a signed text</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gnupg-sign.html">gnupg_sign</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.haru.html">haru</a></div>
<div class="up"><a href="ref.gnupg.html">GnuPG Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.gnupg-verify" class="refentry">
<div class="refnamediv">
<h1 class="refname">gnupg_verify</h1>
<p class="verinfo">(PECL gnupg >= 0.1)</p><p class="refpurpose"><span class="refname">gnupg_verify</span> — <span class="dc-title">Verifies a signed text</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gnupg-verify-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>gnupg_verify</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$identifier</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$signed_text</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$signature</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$plaintext</code></span>
] )</div>
<p class="para rdfs-comment">
Verifies the given <em><code class="parameter">signed_text</code></em> and returns information about the
signature.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gnupg-verify-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">identifier</code></em></span>
<dd>
<p class="para">The gnupg identifier, from a call to
<span class="function"><a href="function.gnupg-init.html" class="function">gnupg_init()</a></span> or <strong class="classname">gnupg</strong>.</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">signed_text</code></em></span>
<dd>
<p class="para">
The signed text.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">signature</code></em></span>
<dd>
<p class="para">
The signature.
To verify a clearsigned text, set signature to <strong><code>FALSE</code></strong>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">plaintext</code></em></span>
<dd>
<p class="para">
The plain text.
If this optional parameter is passed, it is
filled with the plain text.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gnupg-verify-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
On success, this function returns information about the signature.
On failure, this function returns <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.gnupg-verify-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3533">
<p><strong>Example #1 Procedural <span class="function"><strong>gnupg_verify()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$plaintext </span><span style="color: #007700">= </span><span style="color: #DD0000">""</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">gnupg_init</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">// clearsigned<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #0000BB">gnupg_verify</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">,</span><span style="color: #0000BB">$signed_text</span><span style="color: #007700">,</span><span style="color: #0000BB">false</span><span style="color: #007700">,</span><span style="color: #0000BB">$plaintext</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$info</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// detached signature<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #0000BB">gnupg_verify</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">,</span><span style="color: #0000BB">$signed_text</span><span style="color: #007700">,</span><span style="color: #0000BB">$signature</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$info</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-3534">
<p><strong>Example #2 OO <span class="function"><strong>gnupg_verify()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$plaintext </span><span style="color: #007700">= </span><span style="color: #DD0000">""</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$gpg </span><span style="color: #007700">= new </span><span style="color: #0000BB">gnupg</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">// clearsigned<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #0000BB">$gpg </span><span style="color: #007700">-> </span><span style="color: #0000BB">verify</span><span style="color: #007700">(</span><span style="color: #0000BB">$signed_text</span><span style="color: #007700">,</span><span style="color: #0000BB">false</span><span style="color: #007700">,</span><span style="color: #0000BB">$plaintext</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$info</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// detached signature<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #0000BB">$gpg </span><span style="color: #007700">-> </span><span style="color: #0000BB">verify</span><span style="color: #007700">(</span><span style="color: #0000BB">$signed_text</span><span style="color: #007700">,</span><span style="color: #0000BB">$signature</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$info</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gnupg-sign.html">gnupg_sign</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.haru.html">haru</a></div>
<div class="up"><a href="ref.gnupg.html">GnuPG Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
