C/C++的strncpy函数引发的[-Werror=stringop-truncation]问题

函数对于C/C++开发人员来说是永远也绕不开的话题，因为具体的相关落地操作都是通过函数调用来完成闭环，比如文件读写、网络数据收发等等。

一、背景

C/C++开发过程中的代码编译告警对于很多人来说应该不陌生，不要说初学者，就算是具备多年熟练开发经验的熟手来说，对于代码编译告警也经常存在视若无睹的情况。带来的后果不言而喻，存在安全风险。虽然不是所有的告警都是必然存在问题，但是大部分情况下肯定存在开发人员疏忽的地方，而且其隐含的问题在特定条件满足时，往往会导致不可预知的后果，部分后果可能还很严重。所以，对待代码编译的告警必须要引起足够重视，不能有任何松懈。

这几天，编译代码时就遇到一个strncpy函数引发的[-Werror=stringop-truncation]问题，下面就针对这个问题进行分析和解决过程的说明。

二、strncpy问题起因

gsoap是C/C++早期开发webservice功能比较经常使用的开源库，能够自动生成webservice处理框架，并便于扩展自定义接口。虽然webservice服务后面逐步被RESTful服务所替代，但是已经运行中的webservice功能还在发挥着作用，也需要继续提供着对应的技术支持。

前期因为解决2038年mysql问题（详见2025年7月13日的《MySQL彻底解决2038年问题》文章内容），升级了编译工具gcc的版本，后面又进行了一些测试，电脑上有着多个版本的gcc，而这次使用的是v10.3.1版本的gcc，结果在编译存量代码时就出现了[-Werror=stringop-truncation]告警信息，相关信息如下所示：

stdsoap2.cpp: In function 'void soap_get_version(soap *)':

stdsoap2.h:1470:113: error 'char *strncpy(char *, const char *, size_t)' output truncated before terminating nul copying 41 bytes from a string of the same length [-Werror=stringop-truncation]

#define soap_strncpy(buf, len, src, num) (void)((buf) == NULL || ((size_t)(len) > (size_t)(num) ? strncpy((buf), (src), (num)) : ((buf)[0] = '\0')) || 1)

stdsoap2.cpp:6360:7:note:in expasion of macro 'soap_strncpy'

soap_strncpy(p[1].out, sizeof(soap_enc1), soap_enc1, sizeof(soap_enc1) - 1);

三、strncpy问题分析

从报错信息来看，strncpy函数在复制一个长度恰好为 41字节的源字符串时，虽然精确地复制了对应长度字节到目标缓冲区，但是没有在目标缓冲区的末尾添加字符串结束符\0。因此，目标缓冲区中的内容可能不是一个有效的、以\0结尾的C风格字符串。

从soap_strncpy的宏定义代码来看，是要实现安全的复制字符串，确保复制后的字符串都以正确的\0结尾。如果目标缓冲区（buf）大小（len）大于源缓冲区（src）所要复制字符串长度（num），就仅复制num长度字符串，否则返回空串。

通过查看系统关于strncpy函数的原型和相关说明如下：

char *strncpy(char *dest, const char *src, size_t n);

The strncpy() function is similar, except that at most n bytes of src are copied. Warning: If there is no null byte among the first n bytes of src, the string placed in dest will not be null-terminated.

If the length of src is less than n, strncpy() writes additional null bytes to dest to ensure that a total of n bytes are written.

翻译成中文意思如下：

strncpy() 函数与此类似，但最多只复制 src的前 n个字节。

警告：如果 src的前 n个字节中没有空字节 (\0)，那么放置在 dest中的字符串将不会以空字符结尾。

如果 src的长度小于 n，strncpy()会向 dest写入额外的空字节 (\0)，以确保总共写入 n个字节

基于上述的相关信息，再反过来查看前述报错的soap_strncpy宏定义代码。如果要复制的num字节长度字符串中未包含\0结束符，则strncpy就不会再目的缓冲区buf的结尾添加\0结束符，buf就不是一个有效的字符串，使用时存在不可预知的安全风险。

四、strncpy问题解决

解决上述问题的思路也在strncpy函数的说明中，确保strncpy会自动添加\0结束符即可，即确保num长度大于src实际存储的字符长度，所以将num加1即可，最终代码如下：

#define soap_strncpy(buf, len, src, num) (void)((buf) == NULL || ((size_t)(len) > (size_t)(num) ? strncpy((buf), (src), (num) + 1) : ((buf)[0] = '\0')) || 1)

上述代码中，如果len大于num，则目标缓冲区buf的空间至少比源缓冲区src的空间多1个字节，用于存储字符串结束符\0已经足够，所以就直接把strncpy的第三个参数增加数值1，让strncpy自己添加字符串结束符。

修改后再次进行代码编译，没有再出现编译告警，问题解决。

五、结语

这个问题的关键是理解strncpy函数的相关参数含义，以及对应的函数具体实现细节，实际重点就是前述翻译的strncpy函数说明中文描述。万丈高楼平地起，打好基础，一切都会越来越好。

六、联系

如果有任何疑问欢迎随时交流。学无止境，实事求是，每天进步一点点！

#头号创作者激励计划#