Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

apc_modbus: Use snprintf instead of strncpy #2123

Merged
merged 2 commits into from
Oct 21, 2023

Conversation

EchterAgo
Copy link
Contributor

@EchterAgo EchterAgo commented Oct 21, 2023

strncpy does not necessarily zero terminate the buffer so we replace it with snprintf and add error checking.

This also fixes an off-by-one in the snprintf error checking of the _apc_modbus_double_to_nut and _apc_modbus_power_to_nut functions and adds error checking to every snprintf call.

fixes #2122

General points

  • Described the changes in the PR submission or a separate issue, e.g.
    known published or discovered protocols, applicable hardware (expected
    compatible and actually tested/developed against), limitations, etc.

  • There may be multiple commits in the PR, aligned and commented with
    a functional change. Notably, coding style changes better belong in a
    separate PR, but certainly in a dedicated commit to simplify reviews
    of "real" changes in the other commits. Similarly for typo fixes in
    comments or text documents.

Frequent "underwater rocks" for driver addition/update PRs

  • Revised existing driver families and added a sub-driver if applicable
    (nutdrv_qx, usbhid-ups...) or added a brand new driver in the other
    case.

  • Did not extend obsoleted drivers with new hardware support features
    (notably blazer and other single-device family drivers for Qx protocols,
    except the new nutdrv_qx which should cover them all).

  • For updated existing device drivers, bumped the DRIVER_VERSION macro
    or its equivalent.

  • For USB devices (HID or not), revised that the driver uses unique
    VID/PID combinations, or raised discussions when this is not the case
    (several vendors do use same interface chips for unrelated protocols).

  • For new USB devices, built and committed the changes for the
    scripts/upower/95-upower-hid.hwdb file

  • Proposed NUT data mapping is aligned with existing docs/nut-names.txt
    file. If the device exposes useful data points not listed in the file, the
    experimental.* namespace can be used as documented there, and discussion
    should be raised on the NUT Developers mailing list to standardize the new
    concept.

  • Updated data/driver.list.in if applicable (new tested device info)

Frequent "underwater rocks" for general C code PRs

  • Did not "blindly assume" default integer type sizes and value ranges,
    structure layout and alignment in memory, endianness (layout of bytes and
    bits in memory for multi-byte numeric types), or use of generic int where
    language or libraries dictate the use of size_t (or ssize_t sometimes).
  • Progress and errors are handled with upsdebugx(), upslogx(),
    fatalx() and related methods, not with direct printf() or exit().
    Similarly, NUT helpers are used for error-checked memory allocation and
    string operations (except where customized error handling is needed,
    such as unlocking device ports, etc.)

  • Coding style (including whitespace for indentations) follows precedent
    in the code of the file, and examples/guide in docs/developers.txt file.

  • For newly added files, the Makefile.am recipes were updated and the
    make distcheck target passes.

General documentation updates

  • Updated docs/acknowledgements.txt (for vendor-backed device support)

  • Added or updated manual page information in docs/man/*.txt files
    and corresponding recipe lists in docs/man/Makefile.am for new pages

  • Passed make spellcheck, updated spell-checking dictionary in the
    docs/nut.dict file if needed (did not remove any words -- the make
    rule printout in case of changes suggests how to maintain it).

Additional work may be needed after posting this PR

  • Propose a PR for NUT DDL with detailed device data dumps from tests
    against real hardware (the more models, the better).

  • Address NUT CI farm build failures for the PR: testing on numerous
    platforms and toolkits can expose issues not seen on just one system.

  • Revise suggestions from LGTM.COM analysis about "new issues" with
    the changed codebase.

@desertwitch
Copy link
Contributor

Thanks a lot - can confirm this compiles without problems on my system now, let's see what the CIs do. :-)

@jimklimov jimklimov added enhancement refactor/fightwarn PR or issue proposal to improve code maintainability without functional changes, or to fix warnings labels Oct 21, 2023
@jimklimov jimklimov added this to the 2.8.1 milestone Oct 21, 2023
drivers/apc_modbus.c Outdated Show resolved Hide resolved
`strncpy` does not necessarily zero terminate the buffer so we replace
it with `snprintf` and add error checking.

This also fixes an off-by-one in the `snprintf` error checking of the
`_apc_modbus_double_to_nut` and `_apc_modbus_power_to_nut` functions and
adds error checking to every `snprintf` call.

Signed-off-by: Axel Gembe <axel@gembe.net>
A minuscule optimization.

Signed-off-by: Axel Gembe <axel@gembe.net>
@EchterAgo EchterAgo force-pushed the apc_modbus_fix_string_ops branch from c852b54 to 0f675b4 Compare October 21, 2023 12:49
@jimklimov jimklimov added the ready / gonna merge The PR is in final cycles leading to merge unless someone logs an objection before we hit the button label Oct 21, 2023
@jimklimov jimklimov merged commit 46f64c3 into networkupstools:master Oct 21, 2023
6 checks passed
@EchterAgo EchterAgo deleted the apc_modbus_fix_string_ops branch October 22, 2023 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ready / gonna merge The PR is in final cycles leading to merge unless someone logs an objection before we hit the button refactor/fightwarn PR or issue proposal to improve code maintainability without functional changes, or to fix warnings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

apc_modbus: truncation compiler warning
3 participants