VER: Release 0.22.1

threecgreen · web-flow · commit 832b63f91ca5 · 2024-10-08T19:37:37.000+02:00
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     name: build - Python ${{ matrix.python-version }} (x86_64 ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
 
@@ -63,7 +63,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     name: build - Python ${{ matrix.python-version }} (aarch64 linux)
     runs-on: ubuntu-latest
 
@@ -110,7 +110,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     name: build - Python ${{ matrix.python-version }} (macOS)
     runs-on: macos-latest
 
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -47,7 +47,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     runs-on: macos-latest
     steps:
       - name: Checkout repository
@@ -94,7 +94,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     runs-on: windows-latest
     steps:
       - name: Checkout repository
@@ -137,7 +137,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
         target: [x86_64, aarch64]
     runs-on: ubuntu-latest
     steps:
@@ -181,7 +181,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
         target: [x86_64-unknown-linux-musl, aarch64-unknown-linux-musl]
     runs-on: ubuntu-latest
     steps:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.22.1 - 2024-10-08
+
+### Enhancements
+- Removed support for Python 3.8 in `databento-dbn` due to end of life
+
+### Bug fixes
+- Fixed buffer overrun in `c_chars_to_str` on non-null terminated input
+
 ## 0.22.0 - 2024-10-01
 
 ### Enhancements
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,7 +11,7 @@ resolver = "2"
 [workspace.package]
 authors = ["Databento <support@databento.com>"]
 edition = "2021"
-version = "0.22.0"
+version = "0.22.1"
 documentation = "https://docs.databento.com"
 repository = "https://github.com/databento/dbn"
 license = "Apache-2.0"
diff --git a/python/README.md b/python/README.md
@@ -1,7 +1,7 @@
 # databento-dbn
 
 [![build](https://github.com/databento/dbn/actions/workflows/build.yaml/badge.svg)](https://github.com/databento/dbn/actions/workflows/build.yaml)
-![python](https://img.shields.io/badge/python-3.8+-blue.svg)
+![python](https://img.shields.io/badge/python-3.9+-blue.svg)
 ![license](https://img.shields.io/github/license/databento/dbn?color=blue)
 [![pypi-version](https://img.shields.io/pypi/v/databento_dbn)](https://pypi.org/project/databento-dbn)
 
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -1,12 +1,12 @@
 [tool.poetry]
 name = "databento-dbn"
-version = "0.22.0"
+version = "0.22.1"
 description = "Python bindings for encoding and decoding Databento Binary Encoding (DBN)"
 authors = ["Databento <support@databento.com>"]
 license = "Apache-2.0"
 
 [tool.poetry.dependencies]
-python = ">=3.8"
+python = ">=3.9"
 
 [tool.poetry.dev-dependencies]
 maturin = ">=1.0"
@@ -17,14 +17,14 @@ build-backend = "maturin"
 
 [project]
 name = "databento-dbn"
-version = "0.22.0"
+version = "0.22.1"
 authors = [
     { name = "Databento", email = "support@databento.com" }
 ]
 description = "Python bindings for encoding and decoding Databento Binary Encoding (DBN)"
 readme = "README.md"
 license = { file = "../LICENSE" }
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 classifiers = [
     "Programming Language :: Rust",
     "Programming Language :: Python :: Implementation :: CPython",
diff --git a/python/python/databento_dbn/__init__.py b/python/python/databento_dbn/__init__.py
@@ -1,6 +1,6 @@
 import datetime as dt
+from collections.abc import Sequence
 from typing import Protocol
-from typing import Sequence
 from typing import TypedDict
 
 # Import native module
diff --git a/rust/dbn-cli/Cargo.toml b/rust/dbn-cli/Cargo.toml
@@ -16,7 +16,7 @@ name = "dbn"
 path = "src/main.rs"
 
 [dependencies]
-dbn = { path = "../dbn", version = "=0.22.0", default-features = false }
+dbn = { path = "../dbn", version = "=0.22.1", default-features = false }
 
 anyhow = { workspace = true }
 clap = { version = "4.5", features = ["derive", "wrap_help"] }
diff --git a/rust/dbn/Cargo.toml b/rust/dbn/Cargo.toml
@@ -25,7 +25,7 @@ serde = ["dep:serde", "time/parsing", "time/serde"]
 trivial_copy = []
 
 [dependencies]
-dbn-macros = { version = "=0.22.0", path = "../dbn-macros" }
+dbn-macros = { version = "=0.22.1", path = "../dbn-macros" }
 
 async-compression = { version = "0.4.11", features = ["tokio", "zstd"], optional = true }
 csv = { workspace = true }
diff --git a/rust/dbn/src/record/conv.rs b/rust/dbn/src/record/conv.rs
@@ -124,9 +124,15 @@ pub fn str_to_c_chars<const N: usize>(s: &str) -> Result<[c_char; N]> {
 /// None.
 ///
 /// # Errors
-/// This function returns an error if `chars` contains invalid UTF-8.
+/// This function returns an error if `chars` contains invalid UTF-8 or is not null-terminated.
 pub fn c_chars_to_str<const N: usize>(chars: &[c_char; N]) -> Result<&str> {
-    let cstr = unsafe { CStr::from_ptr(chars.as_ptr()) };
+    // Safety: Casting from i8 to u8 slice should be safe
+    let bytes = unsafe { as_u8_slice(chars) };
+    let cstr = CStr::from_bytes_until_nul(bytes).map_err(|_| Error::Conversion {
+        input: format!("{chars:?}"),
+        desired_type: "CStr (null-terminated)",
+    })?;
+
     cstr.to_str()
         .map_err(|e| Error::utf8(e, format!("converting c_char array: {chars:?}")))
 }
@@ -168,3 +174,37 @@ pub(crate) mod cstr_serde {
         str_to_c_chars(&str).map_err(de::Error::custom)
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::os::raw::c_char;
+
+    #[test]
+    fn test_c_chars_to_str_success() {
+        let null_terminated: [c_char; 5] = [
+            'A' as c_char,
+            'A' as c_char,
+            'A' as c_char,
+            'A' as c_char,
+            0,
+        ];
+        let result = c_chars_to_str(&null_terminated);
+        assert_eq!(result.unwrap(), "AAAA");
+    }
+
+    #[test]
+    fn test_c_chars_to_str_failure_on_missing_null_terminator() {
+        let non_null_terminated: [c_char; 5] = ['A' as c_char; 5];
+        let err = c_chars_to_str(&non_null_terminated)
+            .expect_err("Expected failure on non-null terminated string");
+
+        assert!(matches!(
+            err,
+            Error::Conversion {
+                input: _,
+                desired_type: "CStr (null-terminated)",
+            }
+        ));
+    }
+}
