README

xmlsec module for Qore
version 1.0.1 by David Nichols

This module provides the ability for Qore programs to sign, verify, encrypt,
and decrypt XML strings according to the xmldsig and xmlenc standards.

Requires qore 1.0+, libxml2, and xmlsec1 headers and libraries to build.

Documentation is generated by Doxygen and included in the module package.
See the API documentation for comprehensive usage examples.

Test script: test/xmlsec.qtest

BUILD AND INSTALL
-----------------

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr ..
make
sudo make install

The cmake configuration will find your qore module directory and set this
for the install directory.

DEPENDENCIES
------------

Build-time:
- CMake 2.8.12+
- Qore 1.0+ with development headers
- libxml2 with development headers
- xmlsec1 with development headers
- xmlsec1-openssl with development headers
- C++11 compatible compiler

Run-time:
- Qore 1.0+
- xmlsec1
- xmlsec1-openssl

Use -DQORE_XMLSEC_STRICT_DOCS=ON to make documentation warnings fail the
build. The public reference includes the main guide and generated declarations
for XmlSec, XmlSecKey and XmlSecKeyManager. CMake regeneration preserves this
strict policy; CMake 4 is supported.