OpenSSF silver badge: input sanitization in C API #1254

mgovers · 2026-01-07T09:07:59Z

Input sanitization:
- Check user-provided pointers for nullptr
- Clearer distinction between "safe" and "unsafe" pointers
Refactor the error handling in the C API
- Explicit illegal operation and other C API exceptions
- All error handling goes via the same call_with_catch function
- Custom exception handlers can be provided
- Fix small bug where the PGM_calculate function was not able to handle nullptr handles
- NOSONAR the instances of catching generic exceptions and new/delete where they really were intentional

Signed-off-by: Martijn Govers <[email protected]>

power_grid_model_c/power_grid_model_c/src/input_sanitization.hpp

Signed-off-by: Martijn Govers <[email protected]>

power_grid_model_c/power_grid_model_c/src/handle.cpp

power_grid_model_c/power_grid_model_c/src/handle.hpp

power_grid_model_c/power_grid_model_c/src/meta_data.cpp

power_grid_model_c/power_grid_model_c/src/model.cpp

Signed-off-by: Martijn Govers <[email protected]>

figueroa1395

I'll finish the rest tomorrow morning, but here is some input already.

power_grid_model_c/power_grid_model_c/src/input_sanitization.hpp

power_grid_model_c/power_grid_model_c/src/handle.hpp

power_grid_model_c/power_grid_model_c/src/handle.cpp

power_grid_model_c/power_grid_model_c/src/input_sanitization.hpp

power_grid_model_c/power_grid_model_c/src/buffer.cpp

Signed-off-by: Martijn Govers <[email protected]>

power_grid_model_c/power_grid_model_c/src/meta_data.cpp

power_grid_model_c/power_grid_model_c/src/model.cpp

…ation Signed-off-by: Martijn Govers <[email protected]>

power_grid_model_c/power_grid_model_c/src/meta_data.cpp

power_grid_model_c/power_grid_model_c/src/serialization.cpp

Signed-off-by: Martijn Govers <[email protected]>

mgovers · 2026-01-08T14:57:52Z

there are still more cleanups that are possible, but i have a feeling that the PR is in a decent state as of now. it was fairly hard to merge with main do to conflicts with #1176 but i think the current state is the best of both worlds. can you please do another round of review @figueroa1395 ?

sonarqubecloud · 2026-01-08T15:10:55Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
87.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

input sanitization in C API

03023f5

Signed-off-by: Martijn Govers <[email protected]>

mgovers self-assigned this Jan 7, 2026

mgovers added the improvement Improvement on internal implementation label Jan 7, 2026

mgovers added 9 commits January 7, 2026 10:17

include exception header

fea9eee

Signed-off-by: Martijn Govers <[email protected]>

fix enum error type

a587fe8

Signed-off-by: Martijn Govers <[email protected]>

resolve sonar cloud + clang-tidy

b871e92

Signed-off-by: Martijn Govers <[email protected]>

include header

5ea7a51

Signed-off-by: Martijn Govers <[email protected]>

handle can never be fully safe

66475ff

Signed-off-by: Martijn Govers <[email protected]>

compile-time safe cast

269599c

Signed-off-by: Martijn Govers <[email protected]>

clang-tidy

88c681e

Signed-off-by: Martijn Govers <[email protected]>

do not accidentally deduce type

8685cca

Signed-off-by: Martijn Govers <[email protected]>

nosonar(S5025) replace use of new/delete

37bf561

Signed-off-by: Martijn Govers <[email protected]>

mgovers commented Jan 7, 2026

View reviewed changes

power_grid_model_c/power_grid_model_c/src/input_sanitization.hpp Show resolved Hide resolved

minor

80137ef

Signed-off-by: Martijn Govers <[email protected]>

mgovers commented Jan 7, 2026

View reviewed changes

mgovers added 2 commits January 7, 2026 16:13

make sonar happy

bb7a741

Signed-off-by: Martijn Govers <[email protected]>

missed a few serializer ptrs

dcd678a

Signed-off-by: Martijn Govers <[email protected]>

mgovers marked this pull request as ready for review January 7, 2026 15:20

figueroa1395 reviewed Jan 7, 2026

View reviewed changes