xmlsec 1.3.16__tar.gz → 1.3.18__tar.gz

xmlsec-1.3.18/.pre-commit-config.yaml

@@ -0,0 +1,42 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.17.1
+  hooks:
+    - id: ruff
+      args: ["--fix"]
+      types: [python]
+    - id: ruff-format
+      types: [python]
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+    - id: no-commit-to-branch
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files
+    - id: check-ast
+    - id: check-merge-conflict
+    - id: check-json
+    - id: detect-private-key
+      exclude: ^.*/rsakey.pem$
+    - id: mixed-line-ending
+    - id: pretty-format-json
+      args: [--autofix]
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v2.4.0
+  hooks:
+    - id: mypy
+      exclude: (setup.py|tests|build_support/.*.py|doc/.*)
+      types: []
+      files: ^.*.pyi?$
+      additional_dependencies: [lxml-stubs, types-docutils]
+
+- repo: https://github.com/pre-commit/pygrep-hooks
+  rev: v1.10.0
+  hooks:
+    - id: rst-backticks

{xmlsec-1.3.16 → xmlsec-1.3.18}/.readthedocs.yaml

@@ -1,9 +1,9 @@
 version: 2
 
 build:
-  os: ubuntu-20.04
+  os: ubuntu-24.04
   tools:
-    python: '3.9'
+    python: '3.14'
 
 sphinx:
   configuration: doc/source/conf.py

xmlsec-1.3.18/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.4
+Name: xmlsec
+Version: 1.3.18
+Summary: Python bindings for the XML Security Library
+Author-email: Bulat Gaifullin <support@mehcode.com>
+Maintainer-email: Oleg Hoefling <oleg.hoefling@gmail.com>, Amin Solhizadeh <amin.solhizadeh@gmail.com>
+License-Expression: MIT
+Project-URL: Documentation, https://xmlsec.readthedocs.io
+Project-URL: Source, https://github.com/xmlsec/python-xmlsec
+Project-URL: Changelog, https://github.com/xmlsec/python-xmlsec/releases
+Keywords: xmlsec
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Text Processing :: Markup :: XML
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lxml>=3.8
+Dynamic: license-file
+
+# python-xmlsec
+
+[![image](https://img.shields.io/pypi/v/xmlsec.svg?logo=python&logoColor=white)](https://pypi.python.org/pypi/xmlsec)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/xmlsec/python-xmlsec/master.svg)](https://results.pre-commit.ci/latest/github/xmlsec/python-xmlsec/master)
+[![image](https://github.com/xmlsec/python-xmlsec/actions/workflows/manylinux.yml/badge.svg)](https://github.com/xmlsec/python-xmlsec/actions/workflows/manylinux.yml)
+[![image](https://github.com/xmlsec/python-xmlsec/actions/workflows/macosx.yml/badge.svg)](https://github.com/xmlsec/python-xmlsec/actions/workflows/macosx.yml)
+[![image](https://github.com/xmlsec/python-xmlsec/actions/workflows/linuxbrew.yml/badge.svg)](https://github.com/xmlsec/python-xmlsec/actions/workflows/linuxbrew.yml)
+[![image](https://codecov.io/gh/xmlsec/python-xmlsec/branch/master/graph/badge.svg)](https://codecov.io/gh/xmlsec/python-xmlsec)
+[![Documentation Status](https://img.shields.io/readthedocs/xmlsec/latest?logo=read-the-docs)](https://xmlsec.readthedocs.io/en/latest/?badge=latest)
+
+Python bindings for the [XML Security
+Library](https://www.aleksey.com/xmlsec/).
+
+## Documentation
+
+Documentation for `xmlsec` can be found at
+[xmlsec.readthedocs.io](https://xmlsec.readthedocs.io/).
+
+## Usage
+
+Check the
+[examples](https://xmlsec.readthedocs.io/en/latest/examples.html)
+section in the documentation to see various examples of signing and
+verifying using the library.
+
+## Requirements
+
+- `libxml2 >= 2.9.1`
+- `libxmlsec1 >= 1.2.33`
+
+## Install
+
+`xmlsec` is available on PyPI:
+
+``` bash
+pip install xmlsec
+```
+
+Depending on your OS, you may need to install the required native
+libraries first:
+
+### Linux (Debian)
+
+``` bash
+apt-get install pkg-config libxml2-dev libxmlsec1-dev libxmlsec1-openssl
+```
+
+Note: There is no required version of LibXML2 for Ubuntu Precise, so you
+need to download and install it manually.
+
+``` bash
+wget http://xmlsoft.org/sources/libxml2-2.9.1.tar.gz
+tar -xvf libxml2-2.9.1.tar.gz
+cd libxml2-2.9.1
+./configure && make && make install
+```
+
+### Linux (CentOS)
+
+``` bash
+yum install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
+```
+
+### Linux (Fedora)
+
+``` bash
+dnf install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
+```
+
+### Mac
+
+``` bash
+brew install libxml2 libxmlsec1 pkg-config
+```
+
+or
+
+``` bash
+port install libxml2 xmlsec pkgconfig
+```
+
+### Alpine
+
+``` bash
+apk add build-base openssl libffi-dev openssl-dev libxslt-dev libxml2-dev xmlsec-dev xmlsec
+```
+
+## Troubleshooting
+
+### `lxml & xmlsec libxml2 library version mismatch`
+
+`xmlsec` passes `lxml` XML nodes to the underlying `xmlsec1` library. Both
+libraries use `libxml2`, so they must use compatible `libxml2` versions at
+runtime. If `lxml` is installed from a wheel that bundles one `libxml2`
+version while `xmlsec` is built against another system `libxml2`, importing
+or using `xmlsec` can fail with:
+
+``` text
+xmlsec.InternalError: (-1, 'lxml & xmlsec libxml2 library version mismatch')
+```
+
+The most reliable fixes are:
+
+- Use prebuilt wheels for both `lxml` and `xmlsec` when wheels are available
+  for your platform:
+
+  ``` bash
+  pip install --only-binary=lxml,xmlsec lxml xmlsec
+  ```
+
+- If you need to build from source, build both packages against the same
+  locally installed `libxml2`:
+
+  ``` bash
+  pip install --no-binary=lxml,xmlsec lxml xmlsec
+  ```
+
+Do not mix a wheel-built `lxml` with a locally built `xmlsec`, or the other
+way around, unless you know they use the same `libxml2` version.
+
+An `lxml` release upgrade does not by itself mean `xmlsec` is incompatible;
+this error is about the `libxml2` libraries loaded in that environment.
+
+If the error appears only under uWSGI, uWSGI may have loaded the system
+`libxml2` before Python imports `lxml` or `xmlsec`. In that case, make sure
+uWSGI and the Python packages resolve to the same `libxml2`, or rebuild the
+Python packages from source in that environment. If you use `uv`, clear any
+cached mixed builds before reinstalling. For example, to reinstall from
+wheels:
+
+``` bash
+uv pip uninstall lxml xmlsec
+uv cache clean
+uv pip install --only-binary lxml --only-binary xmlsec lxml xmlsec
+```
+
+For background, see
+[issue #356](https://github.com/xmlsec/python-xmlsec/issues/356) and the
+uWSGI edge case in
+[issue #415](https://github.com/xmlsec/python-xmlsec/issues/415).
+
+### Mac
+
+If you get any fatal errors about missing `.h` files, update your
+`C_INCLUDE_PATH` environment variable to include the appropriate files
+from the `libxml2` and `libxmlsec1` libraries.
+
+### Windows
+
+Starting with 1.3.7, prebuilt wheels are available for Windows, so
+running `pip install xmlsec` should suffice. If you want to build from
+source:
+
+1. Configure build environment, see
+   [wiki.python.org](https://wiki.python.org/moin/WindowsCompilers) for
+   more details.
+
+2. Install from source dist:
+
+    ``` bash
+    pip install xmlsec --no-binary=xmlsec
+    ```
+
+## Building from source
+
+1. Clone the `xmlsec` source code repository to your local computer.
+
+    ``` bash
+    git clone https://github.com/xmlsec/python-xmlsec.git
+    ```
+
+2. Change into the `python-xmlsec` root directory.
+
+    ``` bash
+    cd /path/to/xmlsec
+    ```
+
+3. Install the project and all its dependencies using `pip`.
+
+   ``` bash
+   pip install .
+   ```
+
+## Contributing
+
+### Setting up your environment
+
+1. Follow steps 1 and 2 of the [manual installation
+   instructions](#building-from-source).
+
+2. Initialize a virtual environment to develop in. This is done so as
+   to ensure every contributor is working with close-to-identical
+   versions of packages.
+
+   ``` bash
+   mkvirtualenv xmlsec
+   ```
+
+   The `mkvirtualenv` command is available from `virtualenvwrapper`
+   package which can be installed by following
+   [link](http://virtualenvwrapper.readthedocs.org/en/latest/install.html#basic-installation).
+
+3. Activate the created virtual environment:
+
+   ``` bash
+   workon xmlsec
+   ```
+
+4. Install `xmlsec` in development mode with testing enabled. This will
+   download all dependencies required for running the unit tests.
+
+   ``` bash
+   pip install -r requirements-test.txt
+   pip install -e "."
+   ```
+
+### Running the test suite
+
+1. [Set up your environment](#setting-up-your-environment).
+
+2. Run the unit tests.
+
+   ``` bash
+   pytest tests
+   ```
+
+3. Tests configuration
+
+   Env variable `PYXMLSEC_TEST_ITERATIONS` specifies number of test
+   iterations to detect memory leaks.
+
+### Reporting an issue
+
+Please attach the output of following information:
+
+- version of `xmlsec`
+- version of `libxmlsec1`
+- version of `libxml2`
+- output from the command
+
+  ``` bash
+  pkg-config --cflags xmlsec1
+  ```
+
+## License
+
+Unless otherwise noted, all files contained within this project are
+licensed under the MIT open source license. See the included `LICENSE`
+file or visit [opensource.org](http://opensource.org/licenses/MIT) for
+more information.

xmlsec-1.3.18/README.md

@@ -0,0 +1,250 @@
+# python-xmlsec
+
+[![image](https://img.shields.io/pypi/v/xmlsec.svg?logo=python&logoColor=white)](https://pypi.python.org/pypi/xmlsec)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/xmlsec/python-xmlsec/master.svg)](https://results.pre-commit.ci/latest/github/xmlsec/python-xmlsec/master)
+[![image](https://github.com/xmlsec/python-xmlsec/actions/workflows/manylinux.yml/badge.svg)](https://github.com/xmlsec/python-xmlsec/actions/workflows/manylinux.yml)
+[![image](https://github.com/xmlsec/python-xmlsec/actions/workflows/macosx.yml/badge.svg)](https://github.com/xmlsec/python-xmlsec/actions/workflows/macosx.yml)
+[![image](https://github.com/xmlsec/python-xmlsec/actions/workflows/linuxbrew.yml/badge.svg)](https://github.com/xmlsec/python-xmlsec/actions/workflows/linuxbrew.yml)
+[![image](https://codecov.io/gh/xmlsec/python-xmlsec/branch/master/graph/badge.svg)](https://codecov.io/gh/xmlsec/python-xmlsec)
+[![Documentation Status](https://img.shields.io/readthedocs/xmlsec/latest?logo=read-the-docs)](https://xmlsec.readthedocs.io/en/latest/?badge=latest)
+
+Python bindings for the [XML Security
+Library](https://www.aleksey.com/xmlsec/).
+
+## Documentation
+
+Documentation for `xmlsec` can be found at
+[xmlsec.readthedocs.io](https://xmlsec.readthedocs.io/).
+
+## Usage
+
+Check the
+[examples](https://xmlsec.readthedocs.io/en/latest/examples.html)
+section in the documentation to see various examples of signing and
+verifying using the library.
+
+## Requirements
+
+- `libxml2 >= 2.9.1`
+- `libxmlsec1 >= 1.2.33`
+
+## Install
+
+`xmlsec` is available on PyPI:
+
+``` bash
+pip install xmlsec
+```
+
+Depending on your OS, you may need to install the required native
+libraries first:
+
+### Linux (Debian)
+
+``` bash
+apt-get install pkg-config libxml2-dev libxmlsec1-dev libxmlsec1-openssl
+```
+
+Note: There is no required version of LibXML2 for Ubuntu Precise, so you
+need to download and install it manually.
+
+``` bash
+wget http://xmlsoft.org/sources/libxml2-2.9.1.tar.gz
+tar -xvf libxml2-2.9.1.tar.gz
+cd libxml2-2.9.1
+./configure && make && make install
+```
+
+### Linux (CentOS)
+
+``` bash
+yum install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
+```
+
+### Linux (Fedora)
+
+``` bash
+dnf install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel
+```
+
+### Mac
+
+``` bash
+brew install libxml2 libxmlsec1 pkg-config
+```
+
+or
+
+``` bash
+port install libxml2 xmlsec pkgconfig
+```
+
+### Alpine
+
+``` bash
+apk add build-base openssl libffi-dev openssl-dev libxslt-dev libxml2-dev xmlsec-dev xmlsec
+```
+
+## Troubleshooting
+
+### `lxml & xmlsec libxml2 library version mismatch`
+
+`xmlsec` passes `lxml` XML nodes to the underlying `xmlsec1` library. Both
+libraries use `libxml2`, so they must use compatible `libxml2` versions at
+runtime. If `lxml` is installed from a wheel that bundles one `libxml2`
+version while `xmlsec` is built against another system `libxml2`, importing
+or using `xmlsec` can fail with:
+
+``` text
+xmlsec.InternalError: (-1, 'lxml & xmlsec libxml2 library version mismatch')
+```
+
+The most reliable fixes are:
+
+- Use prebuilt wheels for both `lxml` and `xmlsec` when wheels are available
+  for your platform:
+
+  ``` bash
+  pip install --only-binary=lxml,xmlsec lxml xmlsec
+  ```
+
+- If you need to build from source, build both packages against the same
+  locally installed `libxml2`:
+
+  ``` bash
+  pip install --no-binary=lxml,xmlsec lxml xmlsec
+  ```
+
+Do not mix a wheel-built `lxml` with a locally built `xmlsec`, or the other
+way around, unless you know they use the same `libxml2` version.
+
+An `lxml` release upgrade does not by itself mean `xmlsec` is incompatible;
+this error is about the `libxml2` libraries loaded in that environment.
+
+If the error appears only under uWSGI, uWSGI may have loaded the system
+`libxml2` before Python imports `lxml` or `xmlsec`. In that case, make sure
+uWSGI and the Python packages resolve to the same `libxml2`, or rebuild the
+Python packages from source in that environment. If you use `uv`, clear any
+cached mixed builds before reinstalling. For example, to reinstall from
+wheels:
+
+``` bash
+uv pip uninstall lxml xmlsec
+uv cache clean
+uv pip install --only-binary lxml --only-binary xmlsec lxml xmlsec
+```
+
+For background, see
+[issue #356](https://github.com/xmlsec/python-xmlsec/issues/356) and the
+uWSGI edge case in
+[issue #415](https://github.com/xmlsec/python-xmlsec/issues/415).
+
+### Mac
+
+If you get any fatal errors about missing `.h` files, update your
+`C_INCLUDE_PATH` environment variable to include the appropriate files
+from the `libxml2` and `libxmlsec1` libraries.
+
+### Windows
+
+Starting with 1.3.7, prebuilt wheels are available for Windows, so
+running `pip install xmlsec` should suffice. If you want to build from
+source:
+
+1. Configure build environment, see
+   [wiki.python.org](https://wiki.python.org/moin/WindowsCompilers) for
+   more details.
+
+2. Install from source dist:
+
+    ``` bash
+    pip install xmlsec --no-binary=xmlsec
+    ```
+
+## Building from source
+
+1. Clone the `xmlsec` source code repository to your local computer.
+
+    ``` bash
+    git clone https://github.com/xmlsec/python-xmlsec.git
+    ```
+
+2. Change into the `python-xmlsec` root directory.
+
+    ``` bash
+    cd /path/to/xmlsec
+    ```
+
+3. Install the project and all its dependencies using `pip`.
+
+   ``` bash
+   pip install .
+   ```
+
+## Contributing
+
+### Setting up your environment
+
+1. Follow steps 1 and 2 of the [manual installation
+   instructions](#building-from-source).
+
+2. Initialize a virtual environment to develop in. This is done so as
+   to ensure every contributor is working with close-to-identical
+   versions of packages.
+
+   ``` bash
+   mkvirtualenv xmlsec
+   ```
+
+   The `mkvirtualenv` command is available from `virtualenvwrapper`
+   package which can be installed by following
+   [link](http://virtualenvwrapper.readthedocs.org/en/latest/install.html#basic-installation).
+
+3. Activate the created virtual environment:
+
+   ``` bash
+   workon xmlsec
+   ```
+
+4. Install `xmlsec` in development mode with testing enabled. This will
+   download all dependencies required for running the unit tests.
+
+   ``` bash
+   pip install -r requirements-test.txt
+   pip install -e "."
+   ```
+
+### Running the test suite
+
+1. [Set up your environment](#setting-up-your-environment).
+
+2. Run the unit tests.
+
+   ``` bash
+   pytest tests
+   ```
+
+3. Tests configuration
+
+   Env variable `PYXMLSEC_TEST_ITERATIONS` specifies number of test
+   iterations to detect memory leaks.
+
+### Reporting an issue
+
+Please attach the output of following information:
+
+- version of `xmlsec`
+- version of `libxmlsec1`
+- version of `libxml2`
+- output from the command
+
+  ``` bash
+  pkg-config --cflags xmlsec1
+  ```
+
+## License
+
+Unless otherwise noted, all files contained within this project are
+licensed under the MIT open source license. See the included `LICENSE`
+file or visit [opensource.org](http://opensource.org/licenses/MIT) for
+more information.

xmlsec-1.3.18/build_libs_xmlsec.py

@@ -0,0 +1,55 @@
+import argparse
+import os
+import sys
+from pathlib import Path
+
+from build_support.lib_xmlsec_dependency_builder import LibXmlsecDependencyBuilder
+
+
+def _console_info(message):
+    print(message)
+
+
+def main(argv=None):
+    parser = argparse.ArgumentParser(description='Download and build static dependency libraries for python-xmlsec.')
+    parser.add_argument(
+        '--platform',
+        default=sys.platform,
+        help='Target platform (default: current interpreter platform).',
+    )
+    parser.add_argument(
+        '--plat-name',
+        default=os.environ.get('PYXMLSEC_PLAT_NAME'),
+        help='Target platform tag for cross-compiling (for example macosx-11.0-arm64).',
+    )
+    parser.add_argument(
+        '--libs-dir',
+        default=os.environ.get('PYXMLSEC_LIBS_DIR', 'libs'),
+        help='Directory where source/binary archives are stored.',
+    )
+    parser.add_argument(
+        '--buildroot',
+        default=Path('build', 'tmp'),
+        type=Path,
+        help='Build root for extracted/build artifacts.',
+    )
+    parser.add_argument(
+        '--download-only',
+        action='store_true',
+        help='Only download dependency archives; do not extract/build.',
+    )
+
+    args = parser.parse_args(argv)
+    builder = LibXmlsecDependencyBuilder(
+        platform_name=args.platform,
+        info=_console_info,
+        libs_dir=Path(args.libs_dir),
+        buildroot=args.buildroot,
+        plat_name=args.plat_name,
+    )
+    builder.prepare(download_only=args.download_only)
+    return 0
+
+
+if __name__ == '__main__':
+    raise SystemExit(main())