Skip to content

[SDK-2751] Serialize audience claim when a List #512

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

Merged
jimmyjames merged 1 commit into from
Sep 10, 2021
Merged

[SDK-2751] Serialize audience claim when a List #512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
70 changes: 40 additions & 30 deletions lib/src/main/java/com/auth0/jwt/impl/PayloadSerializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
import com.fasterxml.jackson.databind.ser.std.StdSerializer;

import java.io.IOException;
import java.util.Date;
import java.util.Map;
import java.util.*;

/**
* Jackson serializer implementation for converting into JWT Payload parts.
Expand All @@ -30,40 +29,51 @@ public void serialize(ClaimsHolder holder, JsonGenerator gen, SerializerProvider

gen.writeStartObject();
for (Map.Entry<String, Object> e : holder.getClaims().entrySet()) {
switch (e.getKey()) {
case PublicClaims.AUDIENCE:
if (e.getValue() instanceof String) {
gen.writeFieldName(e.getKey());
gen.writeString((String) e.getValue());
break;
}
String[] audArray = (String[]) e.getValue();
if (audArray.length == 1) {
gen.writeFieldName(e.getKey());
gen.writeString(audArray[0]);
} else if (audArray.length > 1) {
gen.writeFieldName(e.getKey());
gen.writeStartArray();
for (String aud : audArray) {
gen.writeString(aud);
}
gen.writeEndArray();
}
break;
default:
gen.writeFieldName(e.getKey());
if (e.getValue() instanceof Date) { // true for EXPIRES_AT, ISSUED_AT, NOT_BEFORE
gen.writeNumber(dateToSeconds((Date) e.getValue()));
} else {
gen.writeObject(e.getValue());
}
break;
if (PublicClaims.AUDIENCE.equals(e.getKey())) {
writeAudience(gen, e);
} else {
gen.writeFieldName(e.getKey());
if (e.getValue() instanceof Date) { // true for EXPIRES_AT, ISSUED_AT, NOT_BEFORE
gen.writeNumber(dateToSeconds((Date) e.getValue()));
} else {
gen.writeObject(e.getValue());
}
}
}

gen.writeEndObject();
}

private void writeAudience(JsonGenerator gen, Map.Entry<String, Object> e) throws IOException {
if (e.getValue() instanceof String) {
gen.writeFieldName(e.getKey());
gen.writeString((String) e.getValue());
} else {
List<String> audArray = new ArrayList<>();
if (e.getValue() instanceof String[]) {
audArray = Arrays.asList((String[]) e.getValue());
} else if (e.getValue() instanceof List) {
List<?> audList = (List<?>) e.getValue();
for (Object aud : audList) {
if (aud instanceof String) {
audArray.add((String)aud);
}
}
}
if (audArray.size() == 1) {
gen.writeFieldName(e.getKey());
gen.writeString(audArray.get(0));
} else if (audArray.size() > 1) {
gen.writeFieldName(e.getKey());
gen.writeStartArray();
for (String aud : audArray) {
gen.writeString(aud);
}
gen.writeEndArray();
}
}
}

private long dateToSeconds(Date date) {
return date.getTime() / 1000;
}
Expand Down
59 changes: 55 additions & 4 deletions lib/src/test/java/com/auth0/jwt/impl/PayloadSerializerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@
import org.junit.Test;

import java.io.StringWriter;
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.*;

import static org.hamcrest.Matchers.*;
import static org.junit.Assert.assertThat;
Expand Down Expand Up @@ -80,6 +77,60 @@ public void shouldSkipSerializationOnEmptyAudience() throws Exception {
assertThat(writer.toString(), is(equalTo("{}")));
}

@Test
public void shouldSerializeSingleItemAudienceAsArrayWhenAList() throws Exception {
ClaimsHolder holder = holderFor("aud", Collections.singletonList("auth0"));
serializer.serialize(holder, jsonGenerator, serializerProvider);
jsonGenerator.flush();

assertThat(writer.toString(), is(equalTo("{\"aud\":\"auth0\"}")));
}

@Test
public void shouldSerializeMultipleItemsAudienceAsArrayWhenAList() throws Exception {
ClaimsHolder holder = holderFor("aud", Arrays.asList("auth0", "auth10"));
serializer.serialize(holder, jsonGenerator, serializerProvider);
jsonGenerator.flush();

assertThat(writer.toString(), is(equalTo("{\"aud\":[\"auth0\",\"auth10\"]}")));
}

@Test
public void shouldSkipSerializationOnEmptyAudienceWhenList() throws Exception {
ClaimsHolder holder = holderFor("aud", new ArrayList());
serializer.serialize(holder, jsonGenerator, serializerProvider);
jsonGenerator.flush();

assertThat(writer.toString(), is(equalTo("{}")));
}

@Test
public void shouldSkipNonStringsOnAudienceWhenSingleItemList() throws Exception {
ClaimsHolder holder = holderFor("aud", Collections.singletonList(2));
serializer.serialize(holder, jsonGenerator, serializerProvider);
jsonGenerator.flush();

assertThat(writer.toString(), is(equalTo("{}")));
}

@Test
public void shouldSkipNonStringsOnAudienceWhenList() throws Exception {
ClaimsHolder holder = holderFor("aud", Arrays.asList("auth0", 2, "auth10"));
serializer.serialize(holder, jsonGenerator, serializerProvider);
jsonGenerator.flush();

assertThat(writer.toString(), is(equalTo("{\"aud\":[\"auth0\",\"auth10\"]}")));
}

@Test
public void shouldSkipNonStringsOnAudience() throws Exception {
ClaimsHolder holder = holderFor("aud", 4);
serializer.serialize(holder, jsonGenerator, serializerProvider);
jsonGenerator.flush();

assertThat(writer.toString(), is(equalTo("{}")));
}

@Test
public void shouldSerializeNotBeforeDateInSeconds() throws Exception {
ClaimsHolder holder = holderFor("nbf", new Date(1478874000));
Expand Down