From 876a13d858b70e6f2c34eaefad90d0577f5f1583 Mon Sep 17 00:00:00 2001
From: Adam Dickmeiss <adam@indexdata.dk>
Date: Mon, 10 May 2004 10:46:26 +0000
Subject: [PATCH] Describe new SSL comstack functions

---
 doc/Makefile.am       |    5 +++--
 doc/asn.xml           |    6 +++---
 doc/comstack.xml      |   43 ++++++++++++++++++++++++++++++++++++++++++-
 doc/yaz-ztest-man.xml |    3 ++-
 doc/ztest-options.xml |    7 ++++++-
 5 files changed, 56 insertions(+), 8 deletions(-)

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 2d20be5..787d92e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-## $Id: Makefile.am,v 1.54 2004-04-28 22:44:59 adam Exp $
+## $Id: Makefile.am,v 1.55 2004-05-10 10:46:26 adam Exp $
 
 docdir=$(datadir)/doc/@PACKAGE@
 
@@ -12,7 +12,8 @@ HTMLFILES = \
  client.commands.html client.html client.invoking.html client.searching.html \
  comstack.addresses.html comstack.client.html comstack.common.html \
  comstack.diagnostics.html comstack.html comstack.introduction.html \
- comstack.server.html comstack.summary.html credits.html future.html \
+ comstack.server.html comstack.ssl.html comstack.summary.html \
+ credits.html future.html \
  indexdata.html installation.html installation.unix.html \
  installation.win32.html introduction.api.html introduction.html \
  license.html license.other.html odr.debugging.html odr.html \
diff --git a/doc/asn.xml b/doc/asn.xml
index adf59de..fd3d649 100644
--- a/doc/asn.xml
+++ b/doc/asn.xml
@@ -1,4 +1,4 @@
-<!-- $Id: asn.xml,v 1.14 2004-03-19 21:12:13 adam Exp $ -->
+<!-- $Id: asn.xml,v 1.15 2004-05-10 10:46:26 adam Exp $ -->
  <chapter id="asn"><title>The Z39.50 ASN.1 Module</title>
   <sect1 id="asn.introduction"><title>Introduction</title>
    <para>
@@ -635,7 +635,7 @@ typedef struct Z_ext_typeent
 	nextResultSetPosition</entry><entry>int</entry><entry>0
        </entry></row>
       <row><entry>
-	presentStatus</entry><entry>int</entry><entry>Z_PRES_SUCCESS
+	presentStatus</entry><entry>int</entry><entry>Z_PresentStatus_success
        </entry></row>
       <row><entry>
 	records</entry><entry>Z_Records</entry><entry>NULL
@@ -665,7 +665,7 @@ typedef struct Z_ext_typeent
        </entry><entry>Z_ReferenceId</entry><entry>NULL
        </entry></row>
       <row><entry>
-	deleteFunction</entry><entry>int</entry><entry>Z_DeleteRequest_list
+	deleteFunction</entry><entry>int</entry><entry>Z_DeleteResultSetRequest_list
        </entry></row>
       <row><entry>
 	num_ids</entry><entry>int</entry><entry>0
diff --git a/doc/comstack.xml b/doc/comstack.xml
index 335eb0d..890b5cd 100644
--- a/doc/comstack.xml
+++ b/doc/comstack.xml
@@ -1,4 +1,4 @@
-<!-- $Id: comstack.xml,v 1.10 2003-02-21 12:06:05 adam Exp $ -->
+<!-- $Id: comstack.xml,v 1.11 2004-05-10 10:46:26 adam Exp $ -->
  <chapter id="comstack"><title>The COMSTACK Module</title>
   
   <sect1 id="comstack.synopsis"><title>Synopsis (blocking mode)</title>
@@ -490,6 +490,47 @@ if (buf)
 
   </sect1>
 
+  <sect1 id="comstack.ssl"><title>SSL</title>
+   <para>
+    <synopsis>
+     void *cs_get_ssl(COMSTACK cs);
+    </synopsis>
+    Returns the SSL handle, <literal>SSL *</literal> for comstack. If comstack
+    is not of type SSL, NULL is returned.
+   </para>
+
+   <para>
+    <synopsis>
+     int cs_set_ssl_ctx(COMSTACK cs, void *ctx);
+    </synopsis>
+    Sets SSL context for comstack. The parameter is expected to be of type
+    <literal>SSL_CTX *</literal>. This function should be called just
+    after comstack has been created (before connect, bind, etc).
+    This function returns 1 for success; 0 for failure.
+   </para>
+
+   <para>
+    <synopsis>
+     int cs_set_ssl_certificate_file(COMSTACK cs, const char *fname);
+    </synopsis>
+    Sets SSL certificate for comstack as a PEM file. This function
+    returns 1 for success; 0 for failure.
+   </para>
+
+
+   <para>
+    <synopsis>
+     int cs_get_ssl_peer_certificate_x509(COMSTACK cs, char **buf, int *len);
+    </synopsis>
+    This function returns the peer certificate. If successful,
+    <literal>*buf</literal> and <literal>*len</literal> holds
+    X509 buffer and length respectively. Buffer should be freed
+    with <literal>xfree</literal>. This function returns 1 for success;
+    0 for failure.
+   </para>
+
+  </sect1>
+  
   <sect1 id="comstack.diagnostics"><title>Diagnostics</title>
 
    <para>
diff --git a/doc/yaz-ztest-man.xml b/doc/yaz-ztest-man.xml
index 3bc42cf..f0776cc 100644
--- a/doc/yaz-ztest-man.xml
+++ b/doc/yaz-ztest-man.xml
@@ -1,7 +1,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY ztest-options SYSTEM "ztest-options.xml">
 ]>
-<!-- $Id: yaz-ztest-man.xml,v 1.4 2004-04-28 22:44:59 adam Exp $ -->
+<!-- $Id: yaz-ztest-man.xml,v 1.5 2004-05-10 10:46:26 adam Exp $ -->
 <refentry id="yaz-ztest">
  
  <refmeta>
@@ -25,6 +25,7 @@
    <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
    <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
    <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
+   <arg choice="opt"><option>-C <replaceable>fname</replaceable></option></arg>
    <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
    <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
    <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
diff --git a/doc/ztest-options.xml b/doc/ztest-options.xml
index 0606201..f7c4f93 100644
--- a/doc/ztest-options.xml
+++ b/doc/ztest-options.xml
@@ -1,5 +1,5 @@
 <!-- 
-   $Id: ztest-options.xml,v 1.4 2004-01-17 01:20:12 adam Exp $
+   $Id: ztest-options.xml,v 1.5 2004-05-10 10:46:26 adam Exp $
    Options for generic frontend server and yaz-ztest.
    Included in both manual and man page for yaz-ztest
 -->
@@ -65,6 +65,11 @@
     <literal>statserv_options_block</literal>.
    </para></listitem></varlistentry>
 
+ <varlistentry><term><literal>-C </literal>
+   <replaceable>fname</replaceable></term>
+  <listitem><para>Sets SSL certificate file name for server (PEM).
+   </para></listitem></varlistentry>
+
  <varlistentry><term><literal>-v </literal>
    <replaceable>level</replaceable></term>
   <listitem><para>
-- 
1.7.10.4