From 307b7543ea1e73ab04e062bdbe4b5bb409eaba3a Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Sat, 17 Sep 2022 17:32:21 +0200 Subject: [PATCH] misc: null-terminate Make use of this term consistently. Closes #9527 --- docs/BUFREF.md | 4 ++-- docs/CODE_REVIEW.md | 4 ++-- docs/libcurl/curl_easy_header.3 | 4 ++-- docs/libcurl/curl_easy_option_next.3 | 2 +- docs/libcurl/opts/CURLOPT_POSTFIELDS.3 | 2 +- docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 | 8 ++++---- include/curl/options.h | 2 +- lib/base64.c | 2 +- lib/curl_addrinfo.c | 2 +- lib/doh.c | 2 +- lib/dynbuf.h | 2 +- lib/headers.c | 2 +- lib/mprintf.c | 2 +- lib/rand.c | 4 ++-- lib/rand.h | 2 +- lib/vauth/digest.c | 2 +- lib/vauth/ntlm.c | 2 +- tests/libtest/lib1911.c | 2 +- tests/unit/unit1305.c | 2 +- 19 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/BUFREF.md b/docs/BUFREF.md index 35c534263b..c11c601512 100644 --- a/docs/BUFREF.md +++ b/docs/BUFREF.md @@ -59,8 +59,8 @@ Releases the previously referenced buffer, then duplicates the `length`-byte `data` into a buffer allocated via `malloc()` and references the latter associated with destructor `curl_free()`. -An additional trailing byte is allocated and set to zero as a possible -string zero-terminator; it is not counted in the stored length. +An additional trailing byte is allocated and set to zero as a possible string +null-terminator; it is not counted in the stored length. Returns `CURLE_OK` if successful, else `CURLE_OUT_OF_MEMORY`. diff --git a/docs/CODE_REVIEW.md b/docs/CODE_REVIEW.md index 20d1be849d..3380281171 100644 --- a/docs/CODE_REVIEW.md +++ b/docs/CODE_REVIEW.md @@ -151,12 +151,12 @@ Maybe use of `realloc()` should rather use the dynbuf functions? Do not allow new code that grows buffers without using dynbuf. Use of C functions that rely on a terminating zero must only be used on data -that really do have a zero terminating zero. +that really do have a null-terminating zero. ## Dangerous "data styles" Make extra precautions and verify that memory buffers that need a terminating -zero always have exactly that. Buffers *without* a zero terminator must not be +zero always have exactly that. Buffers *without* a null-terminator must not be used as input to string functions. # Commit messages diff --git a/docs/libcurl/curl_easy_header.3 b/docs/libcurl/curl_easy_header.3 index 85a1e7d451..e0676883c6 100644 --- a/docs/libcurl/curl_easy_header.3 +++ b/docs/libcurl/curl_easy_header.3 @@ -37,7 +37,7 @@ CURLHcode curl_easy_header(CURL *easy, .SH DESCRIPTION \fIcurl_easy_header(3)\fP returns a pointer to a "curl_header" struct in \fBhout\fP with data for the HTTP response header \fIname\fP. The case -insensitive nul-terminated header name should be specified without colon. +insensitive null-terminated header name should be specified without colon. \fIindex\fP 0 means asking for the first instance of the header. If the returned header struct has \fBamount\fP set larger than 1, it means there are @@ -94,7 +94,7 @@ but it might have a different case. The data \fBvalue\fP field points to, comes exactly as delivered over the network but with leading and trailing whitespace and newlines stripped -off. The `value` data is nul-terminated. For legacy HTTP/1 "folded headers", +off. The `value` data is null-terminated. For legacy HTTP/1 "folded headers", this API provides the full single value in an unfolded manner with a single whitespace between the lines. diff --git a/docs/libcurl/curl_easy_option_next.3 b/docs/libcurl/curl_easy_option_next.3 index fa73ccceab..934edd838f 100644 --- a/docs/libcurl/curl_easy_option_next.3 +++ b/docs/libcurl/curl_easy_option_next.3 @@ -33,7 +33,7 @@ typedef enum { CURLOT_VALUES, /* (a defined set or bitmask) */ CURLOT_OFF_T, /* curl_off_t (a range of values) */ CURLOT_OBJECT, /* pointer (void *) */ - CURLOT_STRING, /* (char * to zero terminated buffer) */ + CURLOT_STRING, /* (char * to null-terminated buffer) */ CURLOT_SLIST, /* (struct curl_slist *) */ CURLOT_CBPTR, /* (void * passed as-is to a callback) */ CURLOT_BLOB, /* blob (struct curl_blob *) */ diff --git a/docs/libcurl/opts/CURLOPT_POSTFIELDS.3 b/docs/libcurl/opts/CURLOPT_POSTFIELDS.3 index 24988d54f2..459b40d7c5 100644 --- a/docs/libcurl/opts/CURLOPT_POSTFIELDS.3 +++ b/docs/libcurl/opts/CURLOPT_POSTFIELDS.3 @@ -56,7 +56,7 @@ the POST data from the read callback. If you want to send a zero-byte POST set \fICURLOPT_POSTFIELDS(3)\fP to an empty string, or set \fICURLOPT_POST(3)\fP to 1 and \fICURLOPT_POSTFIELDSIZE(3)\fP to 0. -libcurl will use assume this option points to a nul-terminated string unless +libcurl will use assume this option points to a null-terminated string unless you also set \fICURLOPT_POSTFIELDSIZE(3)\fP to specify the length of the provided data, which then is strictly required if you want to send off nul bytes included in the data. diff --git a/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 b/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 index 4f983b8df6..ba345c7d3d 100644 --- a/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 +++ b/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 @@ -59,12 +59,12 @@ The callback function must return \fICURL_PREREQFUNC_OK\fP on success, or This function is passed the following arguments: .IP conn_primary_ip -A nul-terminated pointer to a C string containing the primary IP of the remote -server established with this connection. For FTP, this is the IP for the -control connection. IPv6 addresses are represented without surrounding +A null-terminated pointer to a C string containing the primary IP of the +remote server established with this connection. For FTP, this is the IP for +the control connection. IPv6 addresses are represented without surrounding brackets. .IP conn_local_ip -A nul-terminated pointer to a C string containing the originating IP for this +A null-terminated pointer to a C string containing the originating IP for this connection. IPv6 addresses are represented without surrounding brackets. .IP conn_primary_port The primary port number on the remote server established with this connection. diff --git a/include/curl/options.h b/include/curl/options.h index c8ac827c07..a792687cf4 100644 --- a/include/curl/options.h +++ b/include/curl/options.h @@ -33,7 +33,7 @@ typedef enum { CURLOT_VALUES, /* (a defined set or bitmask) */ CURLOT_OFF_T, /* curl_off_t (a range of values) */ CURLOT_OBJECT, /* pointer (void *) */ - CURLOT_STRING, /* (char * to zero terminated buffer) */ + CURLOT_STRING, /* (char * to null-terminated buffer) */ CURLOT_SLIST, /* (struct curl_slist *) */ CURLOT_CBPTR, /* (void * passed as-is to a callback) */ CURLOT_BLOB, /* blob (struct curl_blob *) */ diff --git a/lib/base64.c b/lib/base64.c index 53ebc3db30..a9142541c9 100644 --- a/lib/base64.c +++ b/lib/base64.c @@ -138,7 +138,7 @@ CURLcode Curl_base64_decode(const char *src, /* Calculate the size of the decoded string */ rawlen = (numQuantums * 3) - padding; - /* Allocate our buffer including room for a zero terminator */ + /* Allocate our buffer including room for a null-terminator */ newstr = malloc(rawlen + 1); if(!newstr) return CURLE_OUT_OF_MEMORY; diff --git a/lib/curl_addrinfo.c b/lib/curl_addrinfo.c index d5d11113f4..72e778b34e 100644 --- a/lib/curl_addrinfo.c +++ b/lib/curl_addrinfo.c @@ -279,7 +279,7 @@ Curl_he2ai(const struct hostent *he, int port) for(i = 0; (curr = he->h_addr_list[i]) != NULL; i++) { size_t ss_size; - size_t namelen = strlen(he->h_name) + 1; /* include zero termination */ + size_t namelen = strlen(he->h_name) + 1; /* include null-terminatior */ #ifdef ENABLE_IPV6 if(he->h_addrtype == AF_INET6) ss_size = sizeof(struct sockaddr_in6); diff --git a/lib/doh.c b/lib/doh.c index a86e157fc0..087258d930 100644 --- a/lib/doh.c +++ b/lib/doh.c @@ -792,7 +792,7 @@ doh2ai(const struct dohentry *de, const char *hostname, int port) #endif CURLcode result = CURLE_OK; int i; - size_t hostlen = strlen(hostname) + 1; /* include zero terminator */ + size_t hostlen = strlen(hostname) + 1; /* include null-terminator */ if(!de) /* no input == no output! */ diff --git a/lib/dynbuf.h b/lib/dynbuf.h index 26c8cd5427..04a728c779 100644 --- a/lib/dynbuf.h +++ b/lib/dynbuf.h @@ -46,7 +46,7 @@ struct dynbuf { char *bufr; /* point to a null-terminated allocated buffer */ - size_t leng; /* number of bytes *EXCLUDING* the zero terminator */ + size_t leng; /* number of bytes *EXCLUDING* the null-terminator */ size_t allc; /* size of the current allocation */ size_t toobig; /* size limit for the buffer */ #ifdef DEBUGBUILD diff --git a/lib/headers.c b/lib/headers.c index 69a9205980..978c918f4f 100644 --- a/lib/headers.c +++ b/lib/headers.c @@ -259,7 +259,7 @@ static CURLcode unfold_value(struct Curl_easy *data, const char *value, /* put the data at the end of the previous data, not the newline */ memcpy(&newhs->value[olen], value, vlen); - newhs->value[olen + vlen] = 0; /* zero terminate at newline */ + newhs->value[olen + vlen] = 0; /* null-terminate at newline */ /* insert this node into the list of headers */ Curl_llist_insert_next(&data->state.httphdrs, data->state.httphdrs.tail, diff --git a/lib/mprintf.c b/lib/mprintf.c index 30347de250..6bf55f661e 100644 --- a/lib/mprintf.c +++ b/lib/mprintf.c @@ -956,7 +956,7 @@ static int dprintf_formatf( else *fptr++ = 'f'; - *fptr = 0; /* and a final zero termination */ + *fptr = 0; /* and a final null-termination */ #ifdef __clang__ #pragma clang diagnostic push diff --git a/lib/rand.c b/lib/rand.c index c6fd47e7f6..2e7e7e8238 100644 --- a/lib/rand.c +++ b/lib/rand.c @@ -212,7 +212,7 @@ CURLcode Curl_rand(struct Curl_easy *data, unsigned char *rnd, size_t num) /* * Curl_rand_hex() fills the 'rnd' buffer with a given 'num' size with random - * hexadecimal digits PLUS a zero terminating byte. It must be an odd number + * hexadecimal digits PLUS a null-terminating byte. It must be an odd number * size. */ @@ -235,7 +235,7 @@ CURLcode Curl_rand_hex(struct Curl_easy *data, unsigned char *rnd, /* make sure it fits in the local buffer and that it is an odd number! */ return CURLE_BAD_FUNCTION_ARGUMENT; - num--; /* save one for zero termination */ + num--; /* save one for null-termination */ result = Curl_rand(data, buffer, num/2); if(result) diff --git a/lib/rand.h b/lib/rand.h index 99f25b94e1..30fc29615a 100644 --- a/lib/rand.h +++ b/lib/rand.h @@ -42,7 +42,7 @@ CURLcode Curl_rand(struct Curl_easy *data, unsigned char *rnd, size_t num); /* * Curl_rand_hex() fills the 'rnd' buffer with a given 'num' size with random - * hexadecimal digits PLUS a zero terminating byte. It must be an odd number + * hexadecimal digits PLUS a null-terminating byte. It must be an odd number * size. */ CURLcode Curl_rand_hex(struct Curl_easy *data, unsigned char *rnd, diff --git a/lib/vauth/digest.c b/lib/vauth/digest.c index 9b4acd5a7a..f945e8b6c9 100644 --- a/lib/vauth/digest.c +++ b/lib/vauth/digest.c @@ -382,7 +382,7 @@ CURLcode Curl_auth_create_digest_md5_message(struct Curl_easy *data, if(!(qop_values & DIGEST_QOP_VALUE_AUTH)) return CURLE_BAD_CONTENT_ENCODING; - /* Generate 32 random hex chars, 32 bytes + 1 zero termination */ + /* Generate 32 random hex chars, 32 bytes + 1 null-termination */ result = Curl_rand_hex(data, (unsigned char *)cnonce, sizeof(cnonce)); if(result) return result; diff --git a/lib/vauth/ntlm.c b/lib/vauth/ntlm.c index edaacbb9ed..948a504701 100644 --- a/lib/vauth/ntlm.c +++ b/lib/vauth/ntlm.c @@ -658,7 +658,7 @@ CURLcode Curl_auth_create_ntlm_type3_message(struct Curl_easy *data, /* LanManager response */ /* NT response */ - 0, /* zero termination */ + 0, /* null-termination */ 0, 0, 0, /* type-3 long, the 24 upper bits */ SHORTPAIR(0x18), /* LanManager response length, twice */ diff --git a/tests/libtest/lib1911.c b/tests/libtest/lib1911.c index 97b45040fc..a346bb0f71 100644 --- a/tests/libtest/lib1911.c +++ b/tests/libtest/lib1911.c @@ -47,7 +47,7 @@ int test(char *URL) return 1; } - /* make it a zero terminated C string with just As */ + /* make it a null-terminated C string with just As */ memset(buffer, 'A', MAX_INPUT_LENGTH + 1); buffer[MAX_INPUT_LENGTH + 1] = 0; diff --git a/tests/unit/unit1305.c b/tests/unit/unit1305.c index 815d303884..a4f70d1d52 100644 --- a/tests/unit/unit1305.c +++ b/tests/unit/unit1305.c @@ -75,7 +75,7 @@ static struct Curl_addrinfo *fake_ai(void) { static struct Curl_addrinfo *ai; static const char dummy[]="dummy"; - size_t namelen = sizeof(dummy); /* including the zero terminator */ + size_t namelen = sizeof(dummy); /* including the null-terminator */ ai = calloc(1, sizeof(struct Curl_addrinfo) + sizeof(struct sockaddr_in) + namelen); -- 2.47.3