summaryrefslogtreecommitdiff
path: root/www/api/signature.html
diff options
context:
space:
mode:
Diffstat (limited to 'www/api/signature.html')
-rw-r--r--www/api/signature.html111
1 files changed, 52 insertions, 59 deletions
diff --git a/www/api/signature.html b/www/api/signature.html
index 92296cb..5152778 100644
--- a/www/api/signature.html
+++ b/www/api/signature.html
@@ -1,12 +1,14 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!DOCTYPE html>
+<html lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" />
-<title>signature</title>
-<link rel="stylesheet" href="../docutils-api.css" type="text/css" />
+ <meta charset="utf-8">
+ <meta content="en" name="language">
+ <title>signature</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">
+
</head>
+
<body>
<div class="banner">
@@ -19,6 +21,7 @@
</form>
</div>
+
<div class="navmenu">
<ul>
<li><a href="../index.html">Home</a></li>
@@ -32,39 +35,36 @@
<li><a href="../reference.html">Reference</a></li>
</ul>
</div>
+
<div class="document" id="signature">
<h1 class="title">signature</h1>
-<h2 class="subtitle" id="add-a-digital-signature-to-the-image">Add a digital signature to the image</h2>
-
+<p class="subtitle" id="add-a-digital-signature-to-the-image">Add a digital signature to the image</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
-<li><a class="reference internal" href="#finalizesignature" id="id9">FinalizeSignature</a></li>
-<li><a class="reference internal" href="#getsignatureinfo" id="id10">GetSignatureInfo</a></li>
-<li><a class="reference internal" href="#signatureimage" id="id11">SignatureImage</a></li>
-<li><a class="reference internal" href="#transformsignature" id="id12">TransformSignature</a></li>
-<li><a class="reference internal" href="#updatesignature" id="id13">UpdateSignature</a></li>
+<li><p><a class="reference internal" href="#finalizesignature" id="id9">FinalizeSignature</a></p></li>
+<li><p><a class="reference internal" href="#getsignatureinfo" id="id10">GetSignatureInfo</a></p></li>
+<li><p><a class="reference internal" href="#signatureimage" id="id11">SignatureImage</a></p></li>
+<li><p><a class="reference internal" href="#transformsignature" id="id12">TransformSignature</a></p></li>
+<li><p><a class="reference internal" href="#updatesignature" id="id13">UpdateSignature</a></p></li>
</ul>
</div>
<div class="section" id="finalizesignature">
<h1><a class="toc-backref" href="#id9">FinalizeSignature</a></h1>
<div class="section" id="synopsis">
<h2>Synopsis</h2>
-<pre class="literal-block">
-FinalizeSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );
-</pre>
+<pre class="literal-block">FinalizeSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );</pre>
</div>
<div class="section" id="description">
<h2>Description</h2>
<p>Method FinalizeSignature finalizes the SHA message digest computation.</p>
<p>The format of the FinalizeSignature method is:</p>
-<pre class="literal-block">
-FinalizeSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );
-</pre>
+<pre class="literal-block">FinalizeSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );</pre>
<p>A description of each parameter follows:</p>
-<dl class="docutils">
+<dl class="simple">
<dt>signature_info:</dt>
-<dd>The address of a structure of type SignatureInfo.</dd>
+<dd><p>The address of a structure of type SignatureInfo.</p>
+</dd>
</dl>
</div>
</div>
@@ -72,21 +72,18 @@ FinalizeSignature( <a class="reference external" href="../api/types.html#signatu
<h1><a class="toc-backref" href="#id10">GetSignatureInfo</a></h1>
<div class="section" id="id1">
<h2>Synopsis</h2>
-<pre class="literal-block">
-GetSignatureInfo( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );
-</pre>
+<pre class="literal-block">GetSignatureInfo( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );</pre>
</div>
<div class="section" id="id2">
<h2>Description</h2>
<p>Method GetSignatureInfo initializes the SHA message digest structure.</p>
<p>The format of the GetSignatureInfo method is:</p>
-<pre class="literal-block">
-GetSignatureInfo( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );
-</pre>
+<pre class="literal-block">GetSignatureInfo( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );</pre>
<p>A description of each parameter follows:</p>
-<dl class="docutils">
+<dl class="simple">
<dt>signature_info:</dt>
-<dd>The address of a structure of type SignatureInfo.</dd>
+<dd><p>The address of a structure of type SignatureInfo.</p>
+</dd>
</dl>
</div>
</div>
@@ -94,9 +91,7 @@ GetSignatureInfo( <a class="reference external" href="../api/types.html#signatur
<h1><a class="toc-backref" href="#id11">SignatureImage</a></h1>
<div class="section" id="id3">
<h2>Synopsis</h2>
-<pre class="literal-block">
-unsigned int SignatureImage( <a class="reference external" href="../api/types.html#image">Image</a> *image );
-</pre>
+<pre class="literal-block">unsigned int SignatureImage( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
</div>
<div class="section" id="id4">
<h2>Description</h2>
@@ -105,13 +100,12 @@ an implementation of the NIST SHA-256 Message Digest algorithm. This
signature uniquely identifies the image and is convenient for determining
if an image has been modified or whether two images are identical.</p>
<p>The format of the SignatureImage method is:</p>
-<pre class="literal-block">
-unsigned int SignatureImage( <a class="reference external" href="../api/types.html#image">Image</a> *image );
-</pre>
+<pre class="literal-block">unsigned int SignatureImage( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre>
<p>A description of each parameter follows:</p>
-<dl class="docutils">
+<dl class="simple">
<dt>image:</dt>
-<dd>The image.</dd>
+<dd><p>The image.</p>
+</dd>
</dl>
</div>
</div>
@@ -119,21 +113,18 @@ unsigned int SignatureImage( <a class="reference external" href="../api/types.ht
<h1><a class="toc-backref" href="#id12">TransformSignature</a></h1>
<div class="section" id="id5">
<h2>Synopsis</h2>
-<pre class="literal-block">
-TransformSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );
-</pre>
+<pre class="literal-block">TransformSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );</pre>
</div>
<div class="section" id="id6">
<h2>Description</h2>
<p>TransformSignature() transforms the SHA message digest.</p>
<p>The format of the TransformSignature method is:</p>
-<pre class="literal-block">
-TransformSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );
-</pre>
+<pre class="literal-block">TransformSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info );</pre>
<p>A description of each parameter follows:</p>
-<dl class="docutils">
+<dl class="simple">
<dt>signature_info:</dt>
-<dd>The address of a structure of type SignatureInfo.</dd>
+<dd><p>The address of a structure of type SignatureInfo.</p>
+</dd>
</dl>
</div>
</div>
@@ -141,34 +132,36 @@ TransformSignature( <a class="reference external" href="../api/types.html#signat
<h1><a class="toc-backref" href="#id13">UpdateSignature</a></h1>
<div class="section" id="id7">
<h2>Synopsis</h2>
-<pre class="literal-block">
-UpdateSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info, const unsigned char *message,
- const size_t length );
-</pre>
+<pre class="literal-block">UpdateSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info, const unsigned char *message,
+ const size_t length );</pre>
</div>
<div class="section" id="id8">
<h2>Description</h2>
<p>UpdateSignature() updates the SHA message digest.</p>
<p>The format of the UpdateSignature method is:</p>
-<pre class="literal-block">
-UpdateSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info, const unsigned char *message,
- const size_t length );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">UpdateSignature( <a class="reference external" href="../api/types.html#signatureinfo">SignatureInfo</a> *signature_info, const unsigned char *message,
+ const size_t length );</pre>
+<dl class="simple">
<dt>signature_info:</dt>
-<dd>The address of a structure of type SignatureInfo.</dd>
+<dd><p>The address of a structure of type SignatureInfo.</p>
+</dd>
<dt>message:</dt>
-<dd>the message</dd>
+<dd><p>the message</p>
+</dd>
<dt>length:</dt>
-<dd>The length of the message.</dd>
+<dd><p>The length of the message.</p>
+</dd>
</dl>
</div>
</div>
</div>
+
<hr class="docutils">
<div class="document">
- <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2022<!--SPONSOR_LOGO--></p>
+ <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p>
+</div>
+
</div>
</body>
</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 03:56:04 +0000