Skip to content

Commit

Permalink
fix html in docs and add second tag for releases (#746)
Browse files Browse the repository at this point in the history
  • Loading branch information
@lsh123
lsh123 authored Dec 22, 2023
1 parent 46c01ed commit 95ba31b
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 36 deletions.
2 changes: 1 addition & 1 deletion docs/download.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,7 @@ <h2>Requirements</h2>
<h2>Build and install</h2>
<p>All steps are the usual Unix/Linux build steps (see readme file in <code>xmlsec-&lt;version&gt;/win32</code>
folder for Windows instructions):
</p>
<blockquote><code>
gunzip -c xmlsec-&lt;version&gt;.tar.gz | tar xvf - <br>
cd xmlsec-&lt;version&gt; <br>
Expand All @@ -275,7 +276,6 @@ <h2>Build and install</h2>
make check <br>
make install <br>
</code></blockquote>
</p>
</div>
<div align="left">
<h2>Other languages</h2>
Expand Down
37 changes: 14 additions & 23 deletions docs/faq.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ <h4><a name="section_1_1"></a>1.1. Licensing Terms for XMLSec library.</h4>
<h4><a name="section_1_2"></a>1.2. Can I use xmlsec with proprietary application or library? Can I use xmlsec with
a GNU GPL application or library?</h4>
<p>Probably, you will need to ask a lawyer. But IANAL answer can be found in the following table:</p>
<p>
<table style="text-align: left; width: 85%; margin-left: auto; margin-right: auto;" border="1" cellpadding="2" cellspacing="2">
<tbody>
<tr>
Expand Down Expand Up @@ -128,7 +127,6 @@ <h4><a name="section_1_2"></a>1.2. Can I use xmlsec with proprietary application
</tr>
</tbody>
</table>
</p>
<p>
If you have questions about XML Security Library licensing then feel free to send these questions
to the <a href="mailing-list.html">mailing list</a>.
Expand All @@ -141,7 +139,7 @@ <h4><a name="section_2_1"></a>2.1. Where can I get xmlsec?</h4>
<p>See XML Security Library <a href="http://www.aleksey.com/xmlsec/">download page</a>.</p>

<h4><a name="section_2_2"></a>2.2. How to compile xmlsec?</h4>
<p>On Unix just follow the "standard":
<p>On Unix just follow the "standard":</p>
<blockquote><code>
gunzip -c xmlsec-&lt;version&gt;.tar.gz | tar xvf - <br>
cd xmlsec-&lt;version&gt; <br>
Expand All @@ -153,7 +151,6 @@ <h4><a name="section_2_2"></a>2.2. How to compile xmlsec?</h4>
make check <br>
make install
</code></blockquote>
</p>
<p>
On Windows the process is more complicated. Please check readme file in
the <code>xmlsec-&lt;version&gt;/win32</code> folder.
Expand All @@ -172,23 +169,22 @@ <h4><a name="section_2_4"></a>2.4. Why does make check fail for some tests?</h4>
<h4><a name="section_2_5"></a>2.5. I got the xmlsec source code from GitHub and there is
no <code>configure</code> script. Where can I get it?</h4>
<p>The <code>configure</code> (and several other files) are generated. Use the
<code>autogen.sh</code> script to regenerate these files:
<blockquote><code>
mkdir build <br>
cd build <br>
../autogen.sh [configure options] <br>
make <br>
...
</code></blockquote>
</p>
<code>autogen.sh</code> script to regenerate these files:</p>
<blockquote><code>
mkdir build <br>
cd build <br>
../autogen.sh [configure options] <br>
make <br>
...
</code></blockquote>

<h4><a name="section_2_6"></a>2.6. I do not need all these features supported by xmlsec. Can I disable
some of them?</h4>
<p>Yes, you can. Please run <code>configure --help</code> for the list of possible configuration options. </p>

<h4><a name="section_2_7"></a>2.7. I am compiling XMLSec library on Windows and it does not compile or crashes
right after the launch. Can you help me?</h4>
<p>There are several possible reasons why you might have problems on Windows:
<p>There are several possible reasons why you might have problems on Windows:</p>
<ul>
<li>
<b>Incorrect MS C runtime libraries.</b>
Expand All @@ -210,7 +206,6 @@ <h4><a name="section_2_7"></a>2.7. I am compiling XMLSec library on Windows and
no effect on Unix.
</li>
</ul>
</p>
</div>

<div>
Expand All @@ -226,7 +221,7 @@ <h4><a name="section_3_2"></a>3.2. I am trying to sign use a part of XML documen
it does not work. Do you support "Id" attributes at all?</h4>
<p>Yes, the <code>Id</code> attributes are supported by both XMLSec and LibXML2 libraries. However, you have to
tell LibXML2/XMLSec what is the name of the ID attribute. XML specification does not require ID attribute to
have name "ID", "Id" or "id". It can be anything you want! There are several ways to declare an ID attribute:
have name "ID", "Id" or "id". It can be anything you want! There are several ways to declare an ID attribute:</p>
<ul>
<li><b>Use DTD.</b> For example, the following DTD declares <code>Id</code> attribute in <code>Data</code> node to be
an XML ID attribute:
Expand All @@ -248,7 +243,6 @@ <h4><a name="section_3_2"></a>3.2. I am trying to sign use a part of XML documen
the <code>xmlAddID</code> LibXML2 function.
</li>
</ul>
</p>

<h4><a name="section_3_3"></a>3.3.<span style="font-weight: bold;"> </span>I am trying to sign an XML document and
I have a warning about "empty nodes set". Should I worry about this?</h4>
Expand All @@ -266,7 +260,7 @@ <h4><a name="section_3_4"></a>3.4. I am trying to sign/validate a document but x
Visa 3D "id" attribute may start from number or contain "+" or "/" and this breakes the
<a href="http://www.w3.org/TR/REC-xml#sec-attribute-types">XML specification</a> again. The right solution
for this problem is to change Visa 3D protocol. As a practical soluton, try (on your own risk) the "Visa 3D hack"
in xmlsec:
in xmlsec:</p>
<ul>
<li>
First, register ID attributes manually (using either <code>xmlAddID</code> function or
Expand All @@ -277,8 +271,7 @@ <h4><a name="section_3_4"></a>3.4. I am trying to sign/validate a document but x
or <code>--enable-visa3d-hack</code> option for <a href="xmlsec-man.html">xmlsec command line utility</a>).
</li>
</ul>
<b>This is a hack. You are warned!</b>
</p>
<p><b>This is a hack. You are warned!</b></p>
<p><b>UPDATE:</b> It appears that newer version (Novemeber, 2005) of the Visa3D DTD has this problem fixed and
now "id" attribute is declared as ID correctly.
</p>
Expand Down Expand Up @@ -314,7 +307,7 @@ <h4><a name="section_3_5"></a>3.5. The XMLSec library or XMLSec command line too

<h4><a name="section_3_6"></a>3.6. The XMLSec library or XMLSec command line tool fails because the certificate cannot be
verified. What's wrong?</h4>
<p>There might be several reasons why XMLSec library cannot verify a certificate:
<p>There might be several reasons why XMLSec library cannot verify a certificate:</p>
<ul>
<li>
First, check that both trusted (root) and untrusted certificates from the certificate chain are provided to
Expand Down Expand Up @@ -346,9 +339,7 @@ <h4><a name="section_3_6"></a>3.6. The XMLSec library or XMLSec command line too
there is no mechanism to verify the key origin (and for example, this enables to create "fake" signatures).
<b>THIS IS NOT SECURE AND NOT RECOMMENDED.</b>
</li>

</ul>
</p>

<h4><a name="section_3_7"></a>3.7. I really like the XMLSec library but it is based on OpenSSL and I have to use another crypto library in my application. Can you write code to support my crypto library?</h4>
<p>The XMLSec library has a very modular structure and there should be no problem with using another crypto library.
Expand Down
10 changes: 5 additions & 5 deletions docs/xmldsig.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1165,19 +1165,19 @@ <h3>XMLSec Cryptographic Libraries features</h3>
<div id="notes">
<ul>
<li>
<a name="xslt" id="xslt"></a><sup>(1)</sup> Requires <a href="http://xmlsoft.org/XSLT/downloads.html">LibXSLT</a> library.
<a id="xslt"></a><sup>(1)</sup> Requires <a href="http://xmlsoft.org/XSLT/downloads.html">LibXSLT</a> library.
</li>
<li>
<a name="gost-openssl" id="gost-openssl"></a><sup>(2)</sup> GOST support for the xmlsec-openssl library requires installation of the <a href="https://github.com/gost-engine/engine">GOST OpenSSL Engine</a>.
<a id="gost-openssl"></a><sup>(2)</sup> GOST support for the xmlsec-openssl library requires installation of the <a href="https://github.com/gost-engine/engine">GOST OpenSSL Engine</a>.
</li>
<li>
<a name="gost-mscrypto" id="gost-mscrypto"></a><sup>(3)</sup> GOST support for the xmlsec-mscrypto library requires installation of a GOST CSP.
<a id="gost-mscrypto"></a><sup>(3)</sup> GOST support for the xmlsec-mscrypto library requires installation of a GOST CSP.
</li>
<li>
<a name="dsa-ke-value" id="dsa-ke-value"></a><sup>(4)</sup> Seed and PgenCounter are not supported in DSAKeyValue element.
<a id="dsa-ke-value"></a><sup>(4)</sup> Seed and PgenCounter are not supported in DSAKeyValue element.
</li>
<li>
<a name="mscng-x509-digest" id="mscng-x509-digest"></a><sup>(5)</sup> The xmlsec-mscng library only supports SHA1 digest algorithm for X509Digest element.
<a id="mscng-x509-digest"></a><sup>(5)</sup> The xmlsec-mscng library only supports SHA1 digest algorithm for X509Digest element.
</li>
</ul>
</div>
Expand Down
14 changes: 7 additions & 7 deletions docs/xmlenc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -571,29 +571,29 @@ <h3>XMLSec Cryptographic Libraries features</h3>
<div id="notes">
<ul>
<li>
<a name="derived-key" id="derived-key"><sup>(1)</sup></a> Some optional features in DerivedKey element are not supported
<a id="derived-key"><sup>(1)</sup></a> Some optional features in DerivedKey element are not supported
(<a href="https://github.com/lsh123/xmlsec/issues/515">more details</a>).
</li>
<li>
<a name="openssl3-required" id="openssl3-required"><sup>(2)</sup></a> Requires OpenSSL 3.0.0 or greater.
<a id="openssl3-required"><sup>(2)</sup></a> Requires OpenSSL 3.0.0 or greater.
</li>
<li>
<a name="concatkdf" id="concatkdf"><sup>(3)</sup></a> Only byte-aligned bit strings in ConcatKDFParams element are supported
<a id="concatkdf"><sup>(3)</sup></a> Only byte-aligned bit strings in ConcatKDFParams element are supported
(<a href="https://github.com/lsh123/xmlsec/issues/514">more details</a>).
</li>
<li>
<a name="mscng-old-win" id="mscng-old-win"><sup>(4)</sup></a> The xmlsec-mscng library does not support some cryptographic algortihms
<a id="mscng-old-win"><sup>(4)</sup></a> The xmlsec-mscng library does not support some cryptographic algortihms
on Windows 8, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP.
</li>
<li>
<a name="pbkdf2" id="pbkdf2"><sup>(5)</sup></a> Only "specified" salt is supported for PBKDF2.
<a id="pbkdf2"><sup>(5)</sup></a> Only "specified" salt is supported for PBKDF2.
</li>
<li>
<a name="rsa-oaep-same-algo" id="rsa-oaep-same-algo"><sup>(6)</sup></a> RSA-OAEP digest algorithm and MGF1 algorithm
<a id="rsa-oaep-same-algo"><sup>(6)</sup></a> RSA-OAEP digest algorithm and MGF1 algorithm
must be the same.
</li>
<li>
<a name="openssl-dhx" id="openssl-dhx"><sup>(7)</sup></a> The xmlsec-openssl library only supports DHX (X9.42 format) keys for DH algorithm.
<a id="openssl-dhx"><sup>(7)</sup></a> The xmlsec-openssl library only supports DHX (X9.42 format) keys for DH algorithm.
</li>
</ul>
</div>
Expand Down
1 change: 1 addition & 0 deletions scripts/build_release.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ if [ x"$rc" = x ]; then
echo "RUN MANUALLY: git push --follow-tags"
else
echo "============== Tagging the release $version-$rc in the github"
echo "RUN MANUALLY: git tag -a "xmlsec_${version}-$rc" -m 'XMLSec release $version-$rc'"
echo "RUN MANUALLY: git tag -a "xmlsec_${git_version_tag}_$rc" -m 'XMLSec release $version-$rc'"
echo "RUN MANUALLY: git push --follow-tags"
fi
Expand Down

0 comments on commit 95ba31b

Please sign in to comment.