...
In this noncompliant code example, control reaches the end of the checkpass() function when the two strings passed to strcmp() are not equal. This leads to undefined behavior, and various compilers generate code equivalent to the checkpass function returning various values when no return statement is executed in checkpass() is reached.
| Code Block | ||
|---|---|---|
| ||
int checkpass(char *password) {
if (strcmp(password, "pass") == 0) {
return 1;
}
}
/* ... */
if (checkpass(userinput)) {
printf("Success\n");
}
|
...
This compliant solution ensures that control never reaches the end of the checkpass() function always returns a value.
| Code Block | ||
|---|---|---|
| ||
int checkpass(char *password) {
if (strcmp(password, "pass") == 0) {
return 1;
}
return 0;
}
/* ... */
if (checkpass(userinput)) {
printf("Success!\n");
}
|
...
| Code Block | ||
|---|---|---|
| ||
size_t getlen(int *input, size_t maxlen, int delim) {
size_t i;
for (i = 0; i < maxlen; ++i) {
if (input[i] == delim) {
return i;
}
}
}
/* ... */
size_t i;
int data[] = {1, 1, 1};
i = getlen(data, sizeof(data), 0);
data[i] = userdata;
|
...
When the program was compiled and run with GCC 4.4.3 and runon Linux, the getlen() function returned 5, causing to an out-of-bounds write to the data array:
| Code Block | ||
|---|---|---|
| ||
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
size_t getlen(int *input, size_t maxlen, int delim) {
size_t i;
for (i = 0; i < maxlen; ++i) {
if (input[i] == delim) {
return i;
}
}
}
/* ... */
int main(int argc, char **argv) {
size_t i;
int data[] = {1, 1, 1};
i = getlen(data, sizeof(data), 0);
printf("Returned: %d\n", i);
data[i] = 0;
return EXIT_SUCCESS;
|
...
This compliant solution changes the interface of getlen() to store the result in a user-provided pointer and return an error code to indicate any error conditions. The best method for handling this type of error is specific to the application and the type of error (see ERR00-C. Adopt and implement a consistent and comprehensive error-handling policy for more on error handling).
| Code Block | ||
|---|---|---|
| ||
int getlen(int *input, size_t maxlen, int delim, size_t *result) {
size_t i;
for (i = 0; i < maxlen; ++i) {
if (input[i] == delim) {
if (result != NULL) {
*result = i;
}
return 0;
}
}
return -1;
}
/* ... */
size_t i;
int data[] = {1, 1, 1};
if (getlen(data, sizeof(data), 0, &i) != 0) {
/* Handle error. */
} else {
data[i] = userdata;
}
|
...