Skip to content

Commit

Permalink
Preparation for xmlsec 1.3.5 (#821)
Browse files Browse the repository at this point in the history
  • Loading branch information
lsh123 committed Jul 18, 2024
1 parent 9f76374 commit d76b77b
Show file tree
Hide file tree
Showing 113 changed files with 7,279 additions and 11,434 deletions.
4 changes: 2 additions & 2 deletions docs/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ man-docs:
endif

if HAS_XSLTPROC
docs-format:
docs-format: docs-copy man-docs
@(echo "Formatting html documents"; \
for i in `find $(builddir) -name "*.html" -print`; \
do \
Expand Down Expand Up @@ -90,7 +90,7 @@ docs-format-ga:
done)
else
# do nothing
docs-format:
docs-format: docs-copy man-docs

endif

Expand Down
53 changes: 7 additions & 46 deletions docs/api/index.html
Original file line number Diff line number Diff line change
@@ -1,54 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XML Security Library Reference Manual: XML Security Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<meta name="description" content="This manual documents the interfaces of the xmlsec library and has some short notes to help get you up to speed with using the library.">
<link rel="home" href="index.html" title="XML Security Library Reference Manual">
<link rel="next" href="xmlsec-notes.html" title="Part I. XML Security Library Tutorial">
<link rel="next" href="xmlsec-notes.html" title="Part I. XML Security Library Tutorial">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body><table width="100%" valign="top"><tr valign="top">
<td valign="top" align="left" width="210">
<img src="../images/logo.gif" alt="XML Security Library" border="0"><p></p>
<ul>
<li><a href="../index.html">Home</a></li>
<li><a href="../download.html">Download</a></li>
<ul><li><a href="../https://github.com/lsh123/xmlsec">GitHub</a></li></ul>
<li><a href="../news.html">News</a></li>
<li><a href="../documentation.html">Documentation</a></li>
<ul>
<li><a href="../faq.html">FAQ</a></li>
<li><a href="../api/xmlsec-notes.html">Tutorial</a></li>
<li><a href="../api/xmlsec-reference.html">API reference</a></li>
<li><a href="../api/xmlsec-examples.html">Examples</a></li>
</ul>
<li><a href="../xmldsig.html">XML Digital Signature</a></li>
<li><a href="../xmlenc.html">XML Encryption</a></li>
<li><a href="../c14n.html">XML Canonicalization</a></li>
<li><a href="../bugs.html">Reporting Bugs</a></li>
<li><a href="mailing-list.html">Mailing list</a></li>
<li><a href="../related.html">Related</a></li>
<li><a href="../authors.html">Authors</a></li>
</ul>
<table width="100%">
<tr>
<td width="15"></td>
<td><a href="http://xmlsoft.org/"><img src="../images/libxml2-logo.png" alt="LibXML2" border="0"></a></td>
</tr>
<tr>
<td width="15"></td>
<td><a href="http://xmlsoft.org/XSLT"><img src="../images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td>
</tr>
<tr>
<td width="15"></td>
<td><a href="http://www.openssl.org/"><img src="../images/openssl-logo.png" alt="OpenSSL" border="0"></a></td>
</tr>
<!--Links - start--><!--Links - end-->
</table>
</td>
<td valign="top"><table width="80%" valign="top" style="margin-left:10px;"><tr><td valign="top" align="left" id="xmlsecContent">
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="book">
<div class="titlepage">
<div>
Expand All @@ -58,10 +20,10 @@ <h3 class="author">
<span class="firstname">Aleksey</span> <span class="surname">Sanin</span>
</h3>
<div class="affiliation"><div class="address"><p><br>
<code class="email">&lt;<a class="email" href="mailto:[email protected]">[email protected]</a>&gt;</code><br>
</p></div></div>
    <code class="email">&lt;<a class="email" href="mailto:[email protected]">[email protected]</a>&gt;</code><br>
  </p></div></div>
</div></div></div>
<div><p class="copyright">Copyright 2002-2024 Aleksey Sanin</p></div>
<div><p class="copyright">Copyright © 2002-2024 Aleksey Sanin</p></div>
<div><div class="legalnotice">
<a name="id-1.1.4"></a><p>Permission is granted to make and distribute verbatim
copies of this manual provided the copyright notice and this
Expand Down Expand Up @@ -370,6 +332,5 @@ <h3 class="author">
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</td></tr></table></td>
</tr></table></body>
</body>
</html>
50 changes: 25 additions & 25 deletions docs/api/src/xmlsec.sgml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" standalone="no"?>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "
http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY chapter-compiling-and-linking SYSTEM "chapters/compiling-and-linking.sgml">
Expand Down Expand Up @@ -119,9 +119,9 @@ http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
</author>
</authorgroup>
<copyright>
<year>2002-2022</year>
<year>2002-2024</year>
<holder>Aleksey Sanin</holder>
</copyright>
</copyright>
<legalnotice>
<para>Permission is granted to make and distribute verbatim
copies of this manual provided the copyright notice and this
Expand All @@ -131,7 +131,7 @@ http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
copying, provided also that the entire resulting derived work is
distributed under the terms of a permission notice identical to
this one.</para>

<para>Permission is granted to copy and distribute translations
of this manual into another language, under the above conditions
for modified versions.</para>
Expand All @@ -148,35 +148,35 @@ http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<title>XML Security Library Tutorial</title>
<chapter id="xmlsec-notes-overview">
<title>Overview.</title>
<para>XML Security Library provides support for XML Digital Signature
<para>XML Security Library provides support for XML Digital Signature
and XML Encryption. It is based on LibXML/LibXSLT and can use
practicaly any crypto library (currently there is "out of the box"
practicaly any crypto library (currently there is "out of the box"
support for OpenSSL, Microsoft Crypto API, Microsoft Cryptography API:
Next Generation (CNG), GnuTLS, GCrypt and NSS).
</para>
</chapter>
<chapter id="xmlsec-notes-structure">
<title>XML Security Library Structure.</title>
<para>In order to provide the an ability to use different crypto engines,
<para>In order to provide the an ability to use different crypto engines,
the XML Security Library is splitted in two parts: core library (xmlsec)
and crypto library (xmlsec-openssl, xmlsec-mscrypt, xmlsec-mscng, xmlsec-gnutls,
and crypto library (xmlsec-openssl, xmlsec-mscrypt, xmlsec-mscng, xmlsec-gnutls,
xmlsec-gcrypt, xmlsec-nss, ...).
<figure>
<title>The library structure and dependencies.</title>
<graphic fileref="images/structure.png" align="center"></graphic>
</figure>
</figure>
</para>
<para>The core library has no dependency on any crypto library and provides
implementation of all the engines as well as support for all the non
crypto transforms (xml parser, c14n transforms, xpath and xslt
transforms,...). The XML Security Crypto library provides
implementations for crypto transforms, crypto keys data and key
data stores. Application is linked with particular XML Security
Crypto library (or even libraries), but the actual application
code might be general enough so switching crypto engine would be
<para>The core library has no dependency on any crypto library and provides
implementation of all the engines as well as support for all the non
crypto transforms (xml parser, c14n transforms, xpath and xslt
transforms,...). The XML Security Crypto library provides
implementations for crypto transforms, crypto keys data and key
data stores. Application is linked with particular XML Security
Crypto library (or even libraries), but the actual application
code might be general enough so switching crypto engine would be
a matter of changing several #include directives.</para>
</chapter>

&chapter-compiling-and-linking;
&chapter-init-and-shutdown;
&chapter-sign-and-encrypt;
Expand All @@ -189,27 +189,27 @@ http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
&chapter-using-contexts;
&chapter-new-crypto;
&chapter-examples;

<chapter id="xmlsec-signature-klasses">
<title>APPENDIX A. XML Security Library Signature Klasses.</title>
<figure>
<title>XML Security Library Signature Klasses.</title>
<graphic fileref="images/signature-structure.png" align="center"></graphic>
</figure>
</figure>
</chapter>

<chapter id="xmlsec-encryption-klasses">
<title>APPENDIX B. XML Security Library Encryption Klasses.</title>
<figure>
<title>XML Security Library Encryption Klasses.</title>
<graphic fileref="images/encryption-structure.png" align="center"></graphic>
</figure>
</figure>
</chapter>
</part>

<part id="xmlsec-reference">
<title>XML Security Library API Reference.</title>

<chapter id="xmlsec-ref">
<title>XML Security Core Library API Reference.</title>
<para>This section contains the API reference for xmlsec. All
Expand Down Expand Up @@ -299,12 +299,12 @@ http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<xi:include href="&xmlsec-mscrypto-keysstore;"/>
<xi:include href="&xmlsec-mscrypto-x509;"/>
</chapter>


<chapter id="xmlsec-msccng-ref">
<title>XML Security Library for Microsoft Cryptography API: Next Generation (CNG) Reference.</title>
<para>This section contains the API reference for xmlsec-mscng (based on
<a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa376210(v=vs.85).aspx">Microsoft
<a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa376210(v=vs.85).aspx">Microsoft
Cryptography API: Next Generation (CNG)</a>). All the public interfaces are
documented here. This reference guide is build by extracting comments from
the code sources. </para>
Expand All @@ -322,7 +322,7 @@ http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<itemizedlist>
&xmlsec-index;
</itemizedlist>
</para>
</para>
</chapter>
</part>
</book>
Loading

0 comments on commit d76b77b

Please sign in to comment.