CWE-193 Off-by-one错误

Off-by-one Error

结构: Simple

Abstraction: Base

状态: Draft

被利用可能性: unkown

基本描述

A product calculates or uses an incorrect maximum or minimum value that is 1 more, or 1 less, than the correct value.

相关缺陷

  • cwe_Nature: ChildOf cwe_CWE_ID: 682 cwe_View_ID: 1000 cwe_Ordinal: Primary

  • cwe_Nature: ChildOf cwe_CWE_ID: 682 cwe_View_ID: 1003 cwe_Ordinal: Primary

  • cwe_Nature: ChildOf cwe_CWE_ID: 682 cwe_View_ID: 699 cwe_Ordinal: Primary

  • cwe_Nature: CanPrecede cwe_CWE_ID: 617 cwe_View_ID: 1000

  • cwe_Nature: CanPrecede cwe_CWE_ID: 170 cwe_View_ID: 1000

  • cwe_Nature: CanPrecede cwe_CWE_ID: 119 cwe_View_ID: 1000

适用平台

Language: {'cwe_Class': 'Language-Independent', 'cwe_Prevalence': 'Undetermined'}

常见的影响

范围 影响 注释
Availability ['DoS: Crash, Exit, or Restart', 'DoS: Resource Consumption (CPU)', 'DoS: Resource Consumption (Memory)', 'DoS: Instability'] This weakness will generally lead to undefined behavior and therefore crashes. In the case of overflows involving loop index variables, the likelihood of infinite loops is also high.
Integrity Modify Memory If the value in question is important to data (as opposed to flow), simple data corruption has occurred. Also, if the wrap around results in other conditions such as buffer overflows, further memory corruption may occur.
['Confidentiality', 'Availability', 'Access Control'] ['Execute Unauthorized Code or Commands', 'Bypass Protection Mechanism'] This weakness can sometimes trigger buffer overflows which can be used to execute arbitrary code. This is usually outside the scope of a program's implicit security policy.

可能的缓解方案

Implementation

策略:

When copying character arrays or using character manipulation methods, the correct size parameter must be used to account for the null terminator that needs to be added at the end of the array. Some examples of functions susceptible to this weakness in C include strcpy(), strncpy(), strcat(), strncat(), printf(), sprintf(), scanf() and sscanf().

示例代码

例

The following code allocates memory for a maximum number of widgets. It then gets a user-specified number of widgets, making sure that the user does not request too many. It then initializes the elements of the array using InitializeWidget(). Because the number of widgets can vary for each request, the code inserts a NULL pointer to signify the location of the last widget.

bad C

int i;
unsigned int numWidgets;
Widget WidgetList;

numWidgets = GetUntrustedSizeValue();
if ((numWidgets == 0) || (numWidgets > MAX_NUM_WIDGETS)) {
ExitError("Incorrect number of widgets requested!");
}
WidgetList = (Widget )malloc(numWidgets * sizeof(Widget *));
printf("WidgetList ptr=%p\n", WidgetList);
for(i=0; i<numWidgets; i++) {
WidgetList[i] = InitializeWidget();
}
WidgetList[numWidgets] = NULL;
showWidgets(WidgetList);

However, this code contains an off-by-one calculation error. It allocates exactly enough space to contain the specified number of widgets, but it does not include the space for the NULL pointer. As a result, the allocated buffer is smaller than it is supposed to be (CWE-131). So if the user ever requests MAX_NUM_WIDGETS, there is an off-by-one buffer overflow when the NULL is assigned. Depending on the environment and compilation settings, this could cause memory corruption.

例

In this example, the code does not account for the terminating null character, and it writes one byte beyond the end of the buffer.

The first call to strncat() appends up to 20 characters plus a terminating null character to fullname[]. There is plenty of allocated space for this, and there is no weakness associated with this first call. However, the second call to strncat() potentially appends another 20 characters. The code does not account for the terminating null character that is automatically added by strncat(). This terminating null character would be written one byte beyond the end of the fullname[] buffer. Therefore an off-by-one error exists with the second strncat() call, as the third argument should be 19.

bad C

char firstname[20];
char lastname[20];
char fullname[40];

fullname[0] = '\0';

strncat(fullname, firstname, 20);
strncat(fullname, lastname, 20);

When using a function like strncat() one must leave a free byte at the end of the buffer for a terminating null character, thus avoiding the off-by-one weakness. Additionally, the last argument to strncat() is the number of characters to append, which must be less than the remaining space in the buffer. Be careful not to just use the total size of the buffer.

good C

char firstname[20];
char lastname[20];
char fullname[40];

fullname[0] = '\0';

strncat(fullname, firstname, sizeof(fullname)-strlen(fullname)-1);
strncat(fullname, lastname, sizeof(fullname)-strlen(fullname)-1);

例

The Off-by-one error can also be manifested when reading characters from a character array within a for loop that has an incorrect continuation condition.

bad C

#define PATH_SIZE 60

char filename[PATH_SIZE];

for(i=0; i<=PATH_SIZE; i++) {
char c = getc();
if (c == 'EOF') {
filename[i] = '\0';
}

filename[i] = getc();
}

In this case, the correct continuation condition is shown below.

good C

for(i=0; i<PATH_SIZE; i++) {
...

例

As another example the Off-by-one error can occur when using the sprintf library function to copy a string variable to a formatted string variable and the original string variable comes from an untrusted source. As in the following example where a local function, setFilename is used to store the value of a filename to a database but first uses sprintf to format the filename. The setFilename function includes an input parameter with the name of the file that is used as the copy source in the sprintf function. The sprintf function will copy the file name to a char array of size 20 and specifies the format of the new variable as 16 characters followed by the file extension .dat.

bad C

int setFilename(char *filename) {
char name[20];
sprintf(name, "%16s.dat", filename);
int success = saveFormattedFilenameToDB(name);
return success;
}

However this will cause an Off-by-one error if the original filename is exactly 16 characters or larger because the format of 16 characters with the file extension is exactly 20 characters and does not take into account the required null terminator that will be placed at the end of the string.

分析过的案例

标识 说明 链接
CVE-2003-0252 Off-by-one error allows remote attackers to cause a denial of service and possibly execute arbitrary code via requests that do not contain newlines. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2003-0252
CVE-2001-1391 Off-by-one vulnerability in driver allows users to modify kernel memory. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2001-1391
CVE-2002-0083 Off-by-one error allows local users or remote malicious servers to gain privileges. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2002-0083
CVE-2002-0653 Off-by-one buffer overflow in function usd by server allows local users to execute arbitrary code as the server user via .htaccess files with long entries. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2002-0653
CVE-2002-0844 Off-by-one buffer overflow in version control system allows local users to execute arbitrary code. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2002-0844
CVE-1999-1568 Off-by-one error in FTP server allows a remote attacker to cause a denial of service (crash) via a long PORT command. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-1999-1568
CVE-2004-0346 Off-by-one buffer overflow in FTP server allows local users to gain privileges via a 1024 byte RETR command. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2004-0346
CVE-2004-0005 Multiple buffer overflows in chat client allow remote attackers to cause a denial of service and possibly execute arbitrary code. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2004-0005
CVE-2003-0356 Multiple off-by-one vulnerabilities in product allow remote attackers to cause a denial of service and possibly execute arbitrary code. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2003-0356
CVE-2001-1496 Off-by-one buffer overflow in server allows remote attackers to cause a denial of service and possibly execute arbitrary code. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2001-1496
CVE-2004-0342 This is an interesting example that might not be an off-by-one. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2004-0342
CVE-2001-0609 An off-by-one enables a terminating null to be overwritten, which causes 2 strings to be merged and enable a format string. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2001-0609
CVE-2002-1745 Off-by-one error allows source code disclosure of files with 4 letter extensions that match an accepted 3-letter extension. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2002-1745
CVE-2002-1816 Off-by-one buffer overflow. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2002-1816
CVE-2002-1721 Off-by-one error causes an snprintf call to overwrite a critical internal variable with a null value. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2002-1721
CVE-2003-0466 Off-by-one error in function used in many products leads to a buffer overflow during pathname management, as demonstrated using multiple commands in an FTP server. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2003-0466
CVE-2003-0625 Off-by-one error allows read of sensitive memory via a malformed request. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2003-0625
CVE-2006-4574 Chain: security monitoring product has an off-by-one error that leads to unexpected length values, triggering an assertion. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2006-4574

Notes

Relationship This is not always a buffer overflow. For example, an off-by-one error could be a factor in a partial comparison, a read from the wrong memory location, an incorrect conditional, etc. Research Gap Under-studied. It requires careful code analysis or black box testing, where inputs of excessive length might not cause an error. Off-by-ones are likely triggered by extensive fuzzing, with the attendant diagnostic problems.

分类映射

映射的分类名 ImNode ID Fit Mapped Node Name
PLOVER Off-by-one Error
CERT C Secure Coding STR31-C Guarantee that storage for strings has sufficient space for character data and the null terminator

引用