Release/2.8.1

.github/workflows/build_wheels.yml

@@ -28,20 +28,20 @@ jobs:
           # which are only executed on push to tag. 
           # Test wheels are also generated for the other platforms (and uploaded to testpypi)
           # on pushes to release branches and to main
-          - [ubuntu-latest, x86_64, manylinux2014_x86_64]
-          - [ubuntu-latest, x86_64, manylinux_2_28_x86_64]
-          - [ubuntu-latest, aarch64, manylinux_2_28_aarch64]
-          - [macos-13, x86_64, macosx_x86_64]
-          - [macos-14, arm64, macosx_arm64]
-          - [windows-latest, AMD64, win_amd64]
+          - [ubuntu-latest, x86_64, manylinux2014_x86_64, 0.0]
+          - [ubuntu-latest, x86_64, manylinux_2_28_x86_64, 0.0]
+          - [ubuntu-latest, aarch64, manylinux_2_28_aarch64, 0.0]
+          - [macos-13, x86_64, macosx_x86_64, 13.0]
+          - [macos-14, arm64, macosx_arm64, 14.0]
+          - [windows-latest, AMD64, win_amd64, 0.0]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         # need git tags available for setuptools_scm to grab tags
         with:
           fetch-depth: 0
 
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v7
         with:
           script: |
             core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
@@ -107,15 +107,15 @@ jobs:
 
       - name: build windows wheels
         if: runner.OS == 'Windows'
-        uses: pypa/cibuildwheel@v2.17.0
+        uses: pypa/cibuildwheel@v2.22.0
         with:
           package-dir: ${{github.workspace}}/install/python_installer
           config-file: ${{github.workspace}}/install/python_installer/pyproject.toml
         env:
           CIBW_ARCHS: ${{matrix.build-platform[1]}}
           CIBW_PLATFORM: windows
           CIBW_BUILD: cp3*-${{matrix.build-platform[2]}}
-          CIBW_SKIP: cp36* cp37*   
+          CIBW_SKIP: cp36* cp37* cp313*  
           CIBW_REPAIR_WHEEL_COMMAND_WINDOWS: "delvewheel repair -w {dest_dir} {wheel} --add-path ${{github.workspace}}/install/lib"
           CIBW_BEFORE_BUILD_WINDOWS: "pip install delvewheel"
 
@@ -125,7 +125,7 @@ jobs:
           startswith(matrix.build-platform[2], 'manylinux2014') && 
           github.event_name == 'push' && 
           startsWith(github.ref, 'refs/tags/')
-        uses: pypa/cibuildwheel@v2.17.0
+        uses: pypa/cibuildwheel@v2.22.0
         with:
           package-dir: ./source/wrappers/python
           config-file: ./source/wrappers/python/pyproject.toml
@@ -176,7 +176,7 @@ jobs:
           startswith(matrix.build-platform[2], 'manylinux_2_28') && 
           ! ( startswith(matrix.build-platform[1], 'aarch64') && 
           !startsWith(github.ref, 'refs/tags/') )
-        uses: pypa/cibuildwheel@v2.17.0
+        uses: pypa/cibuildwheel@v2.22.0
         with:
           package-dir: ./source/wrappers/python
           config-file: ./source/wrappers/python/pyproject.toml
@@ -189,7 +189,7 @@ jobs:
           CIBW_BEFORE_ALL: >
             dnf update -y &&
             dnf install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm &&
-            dnf install -y boost-devel openssl-devel libxml2-devel libtirpc-devel 
+            dnf install -y boost1.78-devel openssl-devel libxml2-devel libtirpc-devel 
             fmt fmt-devel spdlog spdlog-devel capnproto capnproto-devel &&
             cd /project &&
             cmake -B build 
@@ -203,6 +203,10 @@ jobs:
 
       - name: build uda on macos
         if: runner.os == 'macOS'
+        # note: it's recommended in cibuildwheel to build all deps from source in macos 
+        # instead of using homebrew as this way the wheel will be back-compatible with 
+        # other macos versions. MACOSX_DEPLOYMENT_TARGET will no longer be required if
+        # this change is made.
         run: >
           brew update-reset && brew install
           git
@@ -222,18 +226,20 @@ jobs:
           -DCMAKE_INSTALL_PREFIX=$PWD/install
           -DCLIENT_ONLY=ON &&
           cmake --build build -j --config Release --target install &&
-          cp -r $PWD/install/python_installer/* ${{github.workspace}}/source/wrappers/python/ 
+          cp -r $PWD/install/python_installer/* ${{github.workspace}}/source/wrappers/python/
 
       - name: Build macos wheels
         if: runner.os == 'macOS'
-        uses: pypa/cibuildwheel@v2.17.0
+        uses: pypa/cibuildwheel@v2.22.0
         with:
           package-dir: ./source/wrappers/python
           config-file: ./source/wrappers/python/pyproject.toml
         env:
           CIBW_ARCHS: ${{matrix.build-platform[1]}}
           CIBW_PLATFORM: macos
+          CIBW_SKIP: cp313*
           CIBW_BUILD: cp*-${{matrix.build-platform[2]}}
+          MACOSX_DEPLOYMENT_TARGET: ${{matrix.build-platform[3]}}
 
       - uses: actions/upload-artifact@v4
         with:

.github/workflows/cmake.yml

@@ -18,15 +18,15 @@ jobs:
   build:
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-22.04, windows-latest, macos-latest]
         release: [Release]
         ssl: [ON, OFF]
         client-only: [ON, OFF]
         capnp: [ON, OFF]
         exclude:
           - os: windows-latest
             client-only: OFF
-          - os: ubuntu-latest
+          - os: ubuntu-22.04
             client-only: ON
           - os: macos-latest
             client-only: ON
@@ -47,7 +47,7 @@ jobs:
             core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
 
       - name: Install linux dependencies
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-22.04'
         run: >
           sudo apt update && sudo apt install -y
           git
@@ -67,7 +67,7 @@ jobs:
           python3-venv
 
       - name: Install Intel compiler
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-22.04'
         run: >
           sudo apt install -y wget &&
           wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB &&
@@ -115,7 +115,7 @@ jobs:
           spdlog
 
       - name: Configure CMake (linux)
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-22.04'
         run: >
           cmake -G Ninja -B build
           -DBUILD_SHARED_LIBS=ON
@@ -125,7 +125,7 @@ jobs:
           -DENABLE_CAPNP=${{ matrix.capnp }}
 
       - name: Configure CMake (linux Intel)
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-22.04'
         run: >
           source /opt/intel/oneapi/setvars.sh &&
           CXX=icpx CC=icx cmake -G Ninja -B build-intel
@@ -176,7 +176,7 @@ jobs:
         run: cmake --build build --config ${{ matrix.release }}
 
       - name: Build Intel
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-22.04'
         run: cmake --build build-intel --config ${{ matrix.release }}
 
       - name: Install
@@ -188,7 +188,7 @@ jobs:
         run: cmake --install build --config ${{ matrix.release }}
 
       - name: Install pyuda
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-22.04'
         run: >
           cp -r /usr/local/python_installer ${{github.workspace}}/python_installer &&
           python3 -m venv ${{github.workspace}}/venv &&
@@ -198,13 +198,13 @@ jobs:
           pip3 install ${{github.workspace}}/python_installer
 
       - name: Test pyuda import
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-22.04'
         run: >
           source ${{github.workspace}}/venv/bin/activate &&
           python3 -c 'import pyuda; client=pyuda.Client()'
 
       - name: Run non-SSL system tests
-        if: matrix.os == 'ubuntu-latest' && matrix.ssl == 'OFF'
+        if: matrix.os == 'ubuntu-22.04' && matrix.ssl == 'OFF'
         run: >
           sudo cp /usr/local/etc/uda.socket /usr/local/etc/[email protected] /etc/systemd/system &&
           sudo systemctl start uda.socket &&
@@ -216,7 +216,7 @@ jobs:
           ./build/test/plugins/plugin_test_testplugin
 
       - name: Run SSL system tests
-        if: matrix.os == 'ubuntu-latest' && matrix.ssl == 'ON'
+        if: matrix.os == 'ubuntu-22.04' && matrix.ssl == 'ON'
         run: >
           sudo cp /usr/local/etc/uda.socket /usr/local/etc/[email protected] /etc/systemd/system &&
           sudo chown -R $USER:$USER /usr/local/etc &&

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required( VERSION 3.0 )
+cmake_minimum_required( VERSION 3.12 )
 
 ########################################################################################################################
 # Macro used to convert Windows path to Unix

README.md

@@ -55,6 +55,7 @@ UDA requires the following to packages in order to build:
 | libfmt | | |
 | spdlog | | |
 | capnproto | | |
+| tirpc | | |
 | boost | | C++, Python & HTTP wrappers |
 | LibMemcached | | to enable caching |
 | python | \> 3.0 | Python wrapper |
@@ -64,6 +65,7 @@ Start by installing all system-level dependencies.
 ```sh
 sudo apt update && sudo apt install -y
 git
+libtirpc-dev
 libboost-dev
 libboost-program-options-dev
 libssl-dev
@@ -94,4 +96,8 @@ build and install
 ```sh
 cmake --build build -j --config Release --target install
 ```
+## Events and training
 
+Slide packs including some hands-on exercises are available from an UDA workshop delivered at ITER in 2023. These resources provide some additional details and working examples for working with UDA, especially in the context of the ITER Modelling and Analysis Suite (IMAS).
+
+See event details and resources [here](https://indico.iter.org/event/81/).

docs/api_changes.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: API changes
-nav_order: 6
+nav_order: 7
 ---
 
 # API changes

docs/authentication.md

@@ -0,0 +1,44 @@
+---
+layout: default
+title: Authentication
+nav_order: 6
+---
+
+TODO: Notes on configuring authenticated connections
+
+# Authenticated connections in UDA
+{:.no_toc}
+
+An UDA server can be configured to only accept requests from authenticated clients. This can be used to ensure only recognised users are able to access the data available through that server. 
+
+Currently only X509 certificate-based authentication is implemented. This involves both the server and client having access to their own certificate bundles, including the SSL Certificate Authority (CA) certificate used to sign the server and client certificates. 
+
+Certificate revocations can be managed using a certificate revocation list (CRL) on the server. 
+
+## Contents
+{:.no_toc}
+1. TOC 
+{:toc}
+
+## Configuring an SSL-authenticated server
+
+```sh
+export UDA_SERVER_SSL_AUTHENTICATE=1
+export UDA_SERVER_SSL_CERT="${UDA_ROOT}/etc/.uda/certs/<server_address>.pem"
+export UDA_SERVER_SSL_KEY="${UDA_ROOT}/etc/.uda/keys/<server_address>.key.pem"
+export UDA_SERVER_CA_SSL_CERT="${UDA_ROOT}/etc/.uda/certs/uda-ca.cert.pem"
+export UDA_SERVER_CA_SSL_CRL="${UDA_ROOT}/etc/.uda/crl/uda-ca.crl.pem"
+```
+
+## Configuring an authenticated client connection
+
+```sh
+SSL_HOME="<certificate_install_dir>/.uda"
+
+export UDA_CLIENT_SSL_KEY="${SSL_HOME}/keys/<username>.key.pem"
+export UDA_CLIENT_CA_SSL_CERT="${SSL_HOME}/certs/uda-ca.cert.pem"
+export UDA_CLIENT_SSL_CERT="${SSL_HOME}/certs/<username>.cert.pem"
+export UDA_CLIENT_SSL_AUTHENTICATE=1
+
+```
+

docs/client_installation.md

@@ -15,7 +15,7 @@ There are a number of client wrappers which provide an UDA interface in differen
 often with a more user-friendly, object-oriented layer over the basic C-API.
 
 In general, the underlying UDA client library must be fully built and then any number of additional language wrappers can 
-be built on-top. With the exception on the python wrapper, building any additional wrappers is completely handled by the 
+be built on-top. With the exception of the python wrapper, building any additional wrappers is completely handled by the 
 project CMake configuration. It's worth noting, however, that pre-built Docker images or python wheels may already be 
 available for your platform. 
 
@@ -76,6 +76,7 @@ Install dependencies from system package manager.
 ```sh
 sudo apt update && sudo apt install -y \
 git \
+libtirpc-dev \
 libboost-dev \
 libboost-program-options-dev \
 libssl-dev \
@@ -342,10 +343,23 @@ cd <uda-install-dir>/python_installer
 python3 -m venv venv
 source venv/bin/activate
 python3 -m pip install --upgrade pip wheel
-python3 -m pip install "numpy<2" cython six
 python3 -m pip install .
 
 # test
 python3 -c 'import pyuda; print(pyuda.__version__)'
 ```
+# Configuring an authenticated client connection
 
+Once you have a certificate bundle, set the following environment variables to the individual SSL file locations. See the [Authentication section](/UDA/authentication) for more details about authenticated connections in uda.
+
+These variables will need to be set before every new client session when you are connecting to an SSL-authenticated uda server.
+
+```sh
+SSL_HOME="<certificate_install_dir>/.uda"
+
+export UDA_CLIENT_SSL_KEY="${SSL_HOME}/keys/<username>.key.pem"
+export UDA_CLIENT_CA_SSL_CERT="${SSL_HOME}/certs/uda-ca.cert.pem"
+export UDA_CLIENT_SSL_CERT="${SSL_HOME}/certs/<username>.cert.pem"
+export UDA_CLIENT_SSL_AUTHENTICATE=1
+
+```