The only unsigned primitive integer type in Java is the 16 bit char datatype; all of the other primitive integer types are signed. To interoperate with native languages, such as C or C++, that use unsigned types extensively, read unsigned values into the next larger Java signed primitive integer type. For example, use a long to hold an unsigned 32-bit integer value obtained from native code.
Noncompliant Code Example
This noncompliant code example uses a generic method for reading in integer data without considering the signedness of the source. It assumes that the values read are always signed and treats the most significant bit (MSB) as the sign bit. When the data being read is unsigned, this causes misinterpretations of the actual sign and magnitude of the value.
public static int getInteger(DataInputStream is) throws IOException {
return is.readInt();
}
Compliant Solution
This compliant solution assumes that the values being read are 32-bit unsigned integers. It reads an unsigned integer value into a long variable using the readInt() method. The readInt() method assumes signed values and returns a signed Java int; the return value is converted to a long with sign extension. The code uses a logical-& operation to mask off the upper 32-bits of the long; this produces a value in the range of a 32-bit unsigned integer, as intended. The mask size should be chosen to match the size of the unsigned integer values being read.
public static long getInteger(DataInputStream is) throws IOException {
return is.readInt() & 0xFFFFFFFFL; // mask with 32 one-bits
}
As a general rule, you must be aware of the signed-ness of the data you are reading.
Risk Assessment
Treating unsigned data as though it were signed will produce incorrect values and can lead to lost or misinterpreted data.
Guideline |
Severity |
Likelihood |
Remediation Cost |
Priority |
Level |
|---|---|---|---|---|---|
INT08-J |
low |
unlikely |
medium |
P2 |
L3 |
Automated Detection
Automated detection is infeasible in the general case.
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this guideline on the CERT website.
Bibliography
[[API 2006]] Class DataInputStream: method readInt
[[Harold 1997]] Chapter 2: Primitive Data Types, Cross Platform Issues, Unsigned Integers
[[Hitchens 2002]] 2.4.5 Accessing Unsigned Data
INT07-J. Provide methods to read and write little-endian data 06. Integers (INT) INT09-J. Do not rely on the write() method to output integers outside the range 0 to 255