Skip to content

Add null checks to CborUtils and test cases. #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vikram-gaur wants to merge 2 commits into from
Closed

Add null checks to CborUtils and test cases. #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05c806f
Add support for newer SDKs.
vikram-gaur Jul 25, 2026
d6f10f5
Add null checks to CborUtils and test cases.
vikram-gaur Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
target/
*.class
51 changes: 36 additions & 15 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>32.1.1-android</version>
<version>33.6.0-android</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.google.crypto.tink/tink-android -->
<dependency>
<groupId>com.google.crypto.tink</groupId>
<artifactId>tink-android</artifactId>
<version>1.10.0</version>
<version>1.23.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.bouncycastle/bcprov-jdk15on -->
<dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bcprov-jdk15on</artifactId>
<version>1.69</version>
<artifactId>bcprov-jdk18on</artifactId>
<version>1.84</version>
</dependency>
</dependencies>
<packaging>jar</packaging>
Expand All @@ -42,10 +42,8 @@
<properties>
<!-- Override this with -Dtest.include="**/SomeTest.java" on the CLI -->
<test.include>%regex[.*.class]</test.include>
<truth.version>1.1.2</truth.version>
<checker-framework.version>3.12.0</checker-framework.version>
<maven-javadoc-plugin.version>3.1.0</maven-javadoc-plugin.version>
<maven-source-plugin.version>3.2.1</maven-source-plugin.version>
<maven-javadoc-plugin.version>3.12.0</maven-javadoc-plugin.version>
<maven-source-plugin.version>3.4.0</maven-source-plugin.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<issueManagement>
Expand Down Expand Up @@ -126,14 +124,37 @@
-->
<source>8</source>
<target>8</target>
<fork>true</fork>
<compilerArgs>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED</arg>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED</arg>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED</arg>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED</arg>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED</arg>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED</arg>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED</arg>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED</arg>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED</arg>
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED</arg>
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED</arg>
</compilerArgs>
</configuration>
</plugin>
</plugins>
<pluginManagement>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<version>3.15.0</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
Expand All @@ -145,14 +166,14 @@
<path>
<groupId>com.google.errorprone</groupId>
<artifactId>error_prone_core</artifactId>
<version>2.14.0</version>
<version>2.49.0</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
<plugin>
<artifactId>maven-jar-plugin</artifactId>
<version>3.2.0</version>
<version>3.5.0</version>
</plugin>
<plugin>
<artifactId>maven-source-plugin</artifactId>
Expand Down Expand Up @@ -192,15 +213,15 @@
</plugin>
<plugin>
<artifactId>maven-dependency-plugin</artifactId>
<version>3.1.1</version>
<version>3.11.0</version>
</plugin>
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.6</version>
<version>3.2.0</version>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
<version>3.5.6</version>
<configuration>
<includes>
<include>${test.include}</include>
Expand All @@ -216,7 +237,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>3.0.0-M3</version>
<version>3.6.3</version>
</plugin>
</plugins>
</pluginManagement>
Expand Down
36 changes: 35 additions & 1 deletion src/com/google/cose/utils/CborUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,18 @@ public class CborUtils {
* @return DataItem cbor object
*/
public static DataItem decode(final byte[] data) throws CborException {
if (data == null) {
throw new CborException("data cannot be null");
}
final ByteArrayInputStream bais = new ByteArrayInputStream(data);
final List<DataItem> dataItems = new CborDecoder(bais).decode();
final CborDecoder decoder = new CborDecoder(bais);
decoder.setMaxPreallocationSize(data.length);
final List<DataItem> dataItems;
try {
dataItems = new CborDecoder(bais).decode();
} catch (OutOfMemoryError e) {
throw new CborException("CBOR declared size exceeds input length", e);
}
if (dataItems.size() != 1) {
throw new CborException("Byte stream cannot be decoded properly. Expected 1 item, found "
+ dataItems.size());
Expand All @@ -61,6 +71,9 @@ public static DataItem decode(final byte[] data) throws CborException {
* @return encoded bytes
*/
public static byte[] encode(final DataItem dataItem) throws CborException {
if (dataItem == null) {
throw new CborException("dataItem cannot be null");
}
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
CborEncoder encoder = new CborEncoder(baos);
encoder.encode(dataItem);
Expand All @@ -73,6 +86,9 @@ public static byte[] encode(final DataItem dataItem) throws CborException {
* @return Map object
*/
public static Map asMap(final DataItem dataItem) throws CborException {
if (dataItem == null) {
throw new CborException("dataItem cannot be null");
}
if (dataItem.getMajorType() != MajorType.MAP) {
throw new CborException(
String.format("Expected a map, got %s", dataItem.getMajorType().name()));
Expand All @@ -86,6 +102,9 @@ public static Map asMap(final DataItem dataItem) throws CborException {
* @return Array object
*/
public static Array asArray(final DataItem dataItem) throws CborException {
if (dataItem == null) {
throw new CborException("dataItem cannot be null");
}
if (dataItem.getMajorType() != MajorType.ARRAY) {
throw new CborException(
String.format("Expected an array, got %s", dataItem.getMajorType().name()));
Expand All @@ -95,6 +114,9 @@ public static Array asArray(final DataItem dataItem) throws CborException {

public static Array asArray(final DataItem dataItem, final int length,
final String semanticName) throws CborException {
if (semanticName == null) {
throw new CborException("semanticName cannot be null");
}
Array item = asArray(dataItem);
if (item.getDataItems().size() != length) {
throw new CborException(String.format("Expected %s to be of size %d, recieved %d",
Expand All @@ -118,6 +140,9 @@ public static List<DataItem> getDataItems(final DataItem dataItem) throws CborEx
* @return ByteString object
*/
public static ByteString asByteString(final DataItem dataItem) throws CborException {
if (dataItem == null) {
throw new CborException("dataItem cannot be null");
}
if (dataItem.getMajorType() != MajorType.BYTE_STRING) {
throw new CborException(
String.format("Expected a byte string, got %s", dataItem.getMajorType().name()));
Expand All @@ -140,6 +165,9 @@ public static byte[] getBytes(final DataItem dataItem) throws CborException {
* @return UnicodeString object
*/
public static UnicodeString asUnicodeString(final DataItem dataItem) throws CborException {
if (dataItem == null) {
throw new CborException("dataItem cannot be null");
}
if (dataItem.getMajorType() != MajorType.UNICODE_STRING) {
throw new CborException(
String.format("Expected a unicode string, got %s", dataItem.getMajorType().name()));
Expand All @@ -163,6 +191,9 @@ public static String getString(final DataItem dataItem) throws CborException {
* @throws CborException if dataItem is neither UnsignedInteger not NegativeInteger
*/
public static int asInteger(final DataItem dataItem) throws CborException {
if (dataItem == null) {
throw new CborException("dataItem cannot be null");
}
if (dataItem.getMajorType() == MajorType.UNSIGNED_INTEGER) {
return ((UnsignedInteger) dataItem).getValue().intValue();
}
Expand All @@ -179,6 +210,9 @@ public static int asInteger(final DataItem dataItem) throws CborException {
* @return true if the item represents NULL
*/
public static boolean isNull(final DataItem item) {
if (item == null) {
return false;
}
return (item.getMajorType() == MajorType.SPECIAL)
&& ((Special) item).getSpecialType() == SpecialType.SIMPLE_VALUE
&& ((SimpleValue) item).getSimpleValueType() == SimpleValueType.NULL;
Expand Down
153 changes: 153 additions & 0 deletions test/com/google/cose/utils/CborUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
package com.google.cose.utils;

import co.nstant.in.cbor.CborException;
import co.nstant.in.cbor.model.Array;
import co.nstant.in.cbor.model.ByteString;
import co.nstant.in.cbor.model.DataItem;
import co.nstant.in.cbor.model.Map;
import co.nstant.in.cbor.model.NegativeInteger;
import co.nstant.in.cbor.model.SimpleValue;
import co.nstant.in.cbor.model.UnicodeString;
import co.nstant.in.cbor.model.UnsignedInteger;
import org.junit.Assert;
import org.junit.Test;

public class CborUtilsTest {
@Test
public void testDecodeNullThrows() {
Assert.assertThrows(CborException.class, () -> CborUtils.decode(null));
}

@Test
public void testEncodeNullThrows() {
Assert.assertThrows(CborException.class, () -> CborUtils.encode(null));
}

@Test
public void testAsMapNullThrows() {
Assert.assertThrows(CborException.class, () -> CborUtils.asMap(null));
}

@Test
public void testAsArrayNullThrows() {
Assert.assertThrows(CborException.class, () -> CborUtils.asArray(null));
}

@Test
public void testAsArrayThreeArgsNullSemanticNameThrows() {
Assert.assertThrows(CborException.class, () -> CborUtils.asArray(new Array(), 0, null));
}

@Test
public void testAsArrayThreeArgsNullDataItemThrows() {
Assert.assertThrows(CborException.class, () -> CborUtils.asArray(null, 0, "name"));
}

@Test
public void testAsByteStringNullThrows() {
Assert.assertThrows(CborException.class, () -> CborUtils.asByteString(null));
}

@Test
public void testAsUnicodeStringNullThrows() {
Assert.assertThrows(CborException.class, () -> CborUtils.asUnicodeString(null));
}

@Test
public void testAsIntegerNullThrows() {
Assert.assertThrows(CborException.class, () -> CborUtils.asInteger(null));
}

@Test
public void testIsNullReturnsFalseForNull() {
Assert.assertFalse(CborUtils.isNull(null));
}

@Test
public void testEncodeDecode() throws CborException {
UnicodeString item = new UnicodeString("test");
byte[] encoded = CborUtils.encode(item);
DataItem decoded = CborUtils.decode(encoded);
Assert.assertEquals(item, decoded);
}

@Test
public void testAsMapPositive() throws CborException {
Map map = new Map();
Assert.assertEquals(map, CborUtils.asMap(map));
}

@Test
public void testAsMapNegativeWrongType() {
Assert.assertThrows(CborException.class, () -> CborUtils.asMap(new Array()));
}

@Test
public void testAsArrayPositive() throws CborException {
Array array = new Array();
Assert.assertEquals(array, CborUtils.asArray(array));
}

@Test
public void testAsArrayNegativeWrongType() {
Assert.assertThrows(CborException.class, () -> CborUtils.asArray(new Map()));
}

@Test
public void testAsArrayThreeArgsPositive() throws CborException {
Array array = new Array();
array.add(new UnicodeString("item"));
Assert.assertEquals(array, CborUtils.asArray(array, 1, "test-array"));
}

@Test
public void testAsArrayThreeArgsWrongSizeThrows() {
Array array = new Array();
Assert.assertThrows(CborException.class, () -> CborUtils.asArray(array, 1, "test-array"));
}

@Test
public void testAsByteStringPositive() throws CborException {
ByteString bs = new ByteString(new byte[]{1, 2, 3});
Assert.assertEquals(bs, CborUtils.asByteString(bs));
Assert.assertArrayEquals(new byte[]{1, 2, 3}, CborUtils.getBytes(bs));
}

@Test
public void testAsByteStringNegativeWrongType() {
Assert.assertThrows(CborException.class, () -> CborUtils.asByteString(new UnicodeString("not bytes")));
}

@Test
public void testAsUnicodeStringPositive() throws CborException {
UnicodeString us = new UnicodeString("hello");
Assert.assertEquals(us, CborUtils.asUnicodeString(us));
Assert.assertEquals("hello", CborUtils.getString(us));
}

@Test
public void testAsUnicodeStringNegativeWrongType() {
Assert.assertThrows(CborException.class, () -> CborUtils.asUnicodeString(new ByteString(new byte[]{1})));
}

@Test
public void testAsIntegerPositive() throws CborException {
UnsignedInteger ui = new UnsignedInteger(123);
Assert.assertEquals(123, CborUtils.asInteger(ui));

NegativeInteger ni = new NegativeInteger(-123);
Assert.assertEquals(-123, CborUtils.asInteger(ni));
}

@Test
public void testAsIntegerNegativeWrongType() {
Assert.assertThrows(CborException.class, () -> CborUtils.asInteger(new UnicodeString("not a number")));
}

@Test
public void testIsNullPositive() {
Assert.assertTrue(CborUtils.isNull(SimpleValue.NULL));
Assert.assertFalse(CborUtils.isNull(SimpleValue.TRUE));
Assert.assertFalse(CborUtils.isNull(new UnicodeString("not null")));
}
}
Loading