Variant · Low-Medium

CWE-129: Improper Validation of Array Index

The product uses untrusted input when calculating or using an array index, but the product does not validate or incorrectly validates the index to ensure the index references a valid position within t...

CWE-129 · Variant Level ·6 CVEs ·9 Mitigations

Description

The product uses untrusted input when calculating or using an array index, but the product does not validate or incorrectly validates the index to ensure the index references a valid position within the array.

Potential Impact

Integrity, Availability

DoS: Crash, Exit, or Restart

Integrity

Modify Memory

Confidentiality, Integrity

Modify Memory, Read Memory

Integrity, Confidentiality, Availability

Execute Unauthorized Code or Commands

Integrity, Availability, Confidentiality

DoS: Crash, Exit, or Restart, Execute Unauthorized Code or Commands, Read Memory, Modify Memory

Demonstrative Examples

In the code snippet below, an untrusted integer value is used to reference an object in an array.
Bad
public String getValue(int index) {return array[index];}
If index is outside of the range of the array, this may result in an ArrayIndexOutOfBounds Exception being raised.
The following example takes a user-supplied value to allocate an array of objects and then operates on the array.
Bad
private void buildList ( int untrustedListSize ){if ( 0 > untrustedListSize ){die("Negative value supplied for list size, die evil hacker!");}Widget[] list = new Widget [ untrustedListSize ];list[0] = new Widget();}
This example attempts to build a list from a user-specified value, and even checks to ensure a non-negative value is supplied. If, however, a 0 value is provided, the code will build an array of size 0 and then try to store a new Widget in the first location, causing an exception to be thrown.
In the following code, the method retrieves a value from an array at a specific array index location that is given as an input parameter to the method
Bad
int getValueFromArray(int *array, int len, int index) {
                        
                           int value;
                           
                           // check that the array index is less than the maximum
                           
                           
                           // length of the array
                           if (index < len) {
                              
                                 // get the value at the specified index of the array
                                 value = array[index];
                           }
                           // if array index is invalid then output error message
                           
                           
                           // and return value indicating error
                           else {printf("Value is: %d\n", array[index]);value = -1;}
                           return value;
                     }
However, this method only verifies that the given array index is less than the maximum length of the array but does not check for the minimum value (CWE-839). This will allow a negative value to be accepted as the input array index, which will result in reading data before the beginning of the buffer (CWE-127) and may allow access to sensitive memory. The input array index should be checked to verify that is within the maximum and minimum range required for the array (CWE-129). In this example the if statement should be modified to include a minimum range check, as shown below.
Good
...
                     
                     // check that the array index is within the correct
                     
                     
                     // range of values for the array
                     if (index >= 0 && index < len) {
                     ...
The following example retrieves the sizes of messages for a pop3 mail server. The message sizes are retrieved from a socket that returns in a buffer the message number and the message size, the message number (num) and size (size) are extracted from the buffer and the message size is placed into an array using the message number for the array index.
Bad
/* capture the sizes of all messages */
                     int getsizes(int sock, int count, int *sizes) {
                        ...char buf[BUFFER_SIZE];int ok;int num, size;
                           
                           // read values from socket and added to sizes array
                           while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0){
                              
                                 // continue read from socket until buf only contains '.'
                                 if (DOTLINE(buf))break;
                                 else if (sscanf(buf, "%d %d", &num, &size) == 2)sizes[num - 1] = size;
                              
                           }...
                        
                     }
In this example the message number retrieved from the buffer could be a value that is outside the allowable range of indices for the array and could possibly be a negative number. Without proper validation of the value to be used for the array index an array overflow could occur and could potentially lead to unauthorized access to memory addresses and system crashes. The value of the array index should be validated to ensure that it is within the allowable range of indices for the array as in the following code.
Good
/* capture the sizes of all messages */
                     int getsizes(int sock, int count, int *sizes) {
                        ...char buf[BUFFER_SIZE];int ok;int num, size;
                           
                           // read values from socket and added to sizes array
                           while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0){
                              
                                 
                                 // continue read from socket until buf only contains '.'
                                 if (DOTLINE(buf))break;
                                 else if (sscanf(buf, "%d %d", &num, &size) == 2) {
                                    if (num > 0 && num <= (unsigned)count)sizes[num - 1] = size;
                                       else
                                          
                                             
                                             /* warn about possible attempt to induce buffer overflow */
                                             report(stderr, "Warning: ignoring bogus data for message sizes returned by server.\n");
                                       
                                    
                                 }
                           }...
                        
                     }

Mitigations & Prevention

Architecture and Design

Use an input validation framework such as Struts or the OWASP ESAPI Validation API. Note that using a framework does not automatically address all input validation problems; be mindful of weaknesses that could arise from misusing the framework itself (CWE-1173).

Architecture and Design

For any security checks that are performed on the client side, ensure that these checks are duplicated on the server side, in order to avoid CWE-602. Attackers can bypass the client-side checks by modifying values after the checks have been performed, or by changing the client to remove the client-side checks entirely. Then, these modified values would be submitted to the server. Even though client-side checks provide minimal benefits with respect to server-side security, the

Requirements

Use a language that does not allow this weakness to occur or provides constructs that make this weakness easier to avoid. For example, Ada allows the programmer to constrain the values of a variable and languages such as Java and Ruby will allow the programmer to handle exceptions when an out-of-bounds index is accessed.

OperationBuild and Compilation Defense in Depth

Run or compile the software using features or extensions that randomly arrange the positions of a program's executable and libraries in memory. Because this makes the addresses unpredictable, it can prevent an attacker from reliably jumping to exploitable code. Examples include Address Space Layout Randomization (ASLR) [REF-58] [REF-60] and Position-Independent Executables (PIE) [REF-64]. Imported modules may be similarly realigned if their default memory addresses conflict with other mo

Operation Defense in Depth

Use a CPU and operating system that offers Data Execution Protection (using hardware NX or XD bits) or the equivalent techniques that simulate this feature in software, such as PaX [REF-60] [REF-61]. These techniques ensure that any instruction executed is exclusively at a memory address that is part of the code segment. For more information on these techniques see D3-PSEP (Process Segment Execution Prevention) from D3FEND [REF-1336].

Implementation

Assume all input is malicious. Use an "accept known good" input validation strategy, i.e., use a list of acceptable inputs that strictly conform to specifications. Reject any input that does not strictly conform to specifications, or transform it into something that does. When performing input validation, consider all potentially relevant properties, including length, type of input, the full range of acceptable values, missing or extra inputs, syntax, consistency across relat

Implementation

Be especially careful to validate all input when invoking code that crosses language boundaries, such as from an interpreted language to native code. This could create an unexpected interaction between the language boundaries. Ensure that you are not violating any of the expectations of the language with which you are interfacing. For example, even though Java may not be susceptible to buffer overflows, providing a large argument in a call to native code might trigger an overflow.

Architecture and DesignOperation

Run your code using the lowest privileges that are required to accomplish the necessary tasks [REF-76]. If possible, create isolated accounts with limited privileges that are only used for a single task. That way, a successful attack will not immediately give the attacker access to the rest of the software or its environment. For example, database applications rarely need to run as the database administrator, especially in day-to-day operations.

Architecture and DesignOperation Limited

Run the code in a "jail" or similar sandbox environment that enforces strict boundaries between the process and the operating system. This may effectively restrict which files can be accessed in a particular directory or which commands can be executed by the software. OS-level examples include the Unix chroot jail, AppArmor, and SELinux. In general, managed code may provide some protection. For example, java.io.FilePermission in the Java SecurityManager allows the software to

Detection Methods

  • Automated Static Analysis High — This weakness can often be detected using automated static analysis tools. Many modern tools use data flow analysis or constraint-based techniques to minimize the number of false positives. Automated static analysis generally does not account for environmental considerations when
  • Automated Dynamic Analysis — This weakness can be detected using dynamic tools and techniques that interact with the software using large test suites with many diverse inputs, such as fuzz testing (fuzzing), robustness testing, and fault injection. The software's operation may slow down, but it should not become unstable, crash
  • Automated Dynamic Analysis Moderate — Use tools that are integrated during compilation to insert runtime error-checking mechanisms related to memory safety errors, such as AddressSanitizer (ASan) for C/C++ [REF-1518].
  • Black Box — Black box methods might not get the needed code coverage within limited time constraints, and a dynamic test might not produce any noticeable side effects even if it is successful.

Real-World CVE Examples

CVE IDDescription
CVE-2005-0369large ID in packet used as array index
CVE-2001-1009negative array index as argument to POP LIST command
CVE-2003-0721Integer signedness error leads to negative array index
CVE-2004-1189product does not properly track a count and a maximum number, which can lead to resultant array index overflow.
CVE-2007-5756Chain: device driver for packet-capturing software allows access to an unintended IOCTL with resultant array index error.
CVE-2005-2456Chain: array index error (CWE-129) leads to deadlock (CWE-833)

Taxonomy Mappings

  • CLASP: — Unchecked array indexing
  • PLOVER: — INDEX - Array index overflow
  • CERT C Secure Coding: ARR00-C — Understand how arrays work
  • CERT C Secure Coding: ARR30-C — Do not form or use out-of-bounds pointers or array subscripts
  • CERT C Secure Coding: ARR38-C — Do not add or subtract an integer to a pointer if the resulting value does not refer to a valid array element
  • CERT C Secure Coding: INT32-C — Ensure that operations on signed integers do not result in overflow
  • SEI CERT Perl Coding Standard: IDS32-PL — Validate any integer that is used as an array index
  • OMG ASCSM: ASCSM-CWE-129 —
  • Software Fault Patterns: SFP8 — Faulty Buffer Access

Frequently Asked Questions

What is CWE-129?

CWE-129 (Improper Validation of Array Index) is a software weakness identified by MITRE's Common Weakness Enumeration. It is classified as a Variant-level weakness. The product uses untrusted input when calculating or using an array index, but the product does not validate or incorrectly validates the index to ensure the index references a valid position within t...

How can CWE-129 be exploited?

Attackers can exploit CWE-129 (Improper Validation of Array Index) to dos: crash, exit, or restart. This weakness is typically introduced during the Implementation phase of software development.

How do I prevent CWE-129?

Key mitigations include: Use an input validation framework such as Struts or the OWASP ESAPI Validation API. Note that using a framework does not automatically address all input validation problems; be mindful of weaknesses t

What is the severity of CWE-129?

CWE-129 is classified as a Variant-level weakness (Low-Medium abstraction). It has been observed in 6 real-world CVEs.