Skip to content
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

fix: Do not include null values in JWT payloads #516

Merged
merged 3 commits into from
Feb 10, 2020
Merged

fix: Do not include null values in JWT payloads #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf10fd8
do not include null values in JWT payloads
thinkingserious Feb 9, 2020
742d14a
restore formatting
thinkingserious Feb 9, 2020
c3a6f8c
refactor some duplicate code, use jwt parser
thinkingserious Feb 10, 2020
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 src/main/java/com/twilio/jwt/accesstoken/ChatGrant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package com.twilio.jwt.accesstoken;

import com.fasterxml.jackson.annotation.JsonInclude;
/**
* Grant used to access Twilio Chat.
*
Expand Down Expand Up @@ -63,6 +64,7 @@ public Object getPayload() {
}

@SuppressWarnings("checkstyle:membername")
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Payload {
public final String service_sid;
public final String deployment_role_sid;
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/com/twilio/jwt/accesstoken/ConversationsGrant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package com.twilio.jwt.accesstoken;

import com.fasterxml.jackson.annotation.JsonInclude;

/**
* Grant used to access Twilio Conversations.
*
Expand Down Expand Up @@ -35,6 +37,7 @@ public Object getPayload() {


@SuppressWarnings("checkstyle:membername")
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Payload {
public final String configuration_profile_sid;

Expand Down
3 changes: 3 additions & 0 deletions src/main/java/com/twilio/jwt/accesstoken/IpMessagingGrant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package com.twilio.jwt.accesstoken;

import com.fasterxml.jackson.annotation.JsonInclude;

/**
* Grant used to access Twilio IP Messaging.
*
Expand Down Expand Up @@ -64,6 +66,7 @@ public Object getPayload() {
}

@SuppressWarnings("checkstyle:membername")
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Payload {
public final String service_sid;
public final String deployment_role_sid;
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/com/twilio/jwt/accesstoken/SyncGrant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package com.twilio.jwt.accesstoken;

import com.fasterxml.jackson.annotation.JsonInclude;

/**
* Grant used to access Twilio Sync.
*
Expand Down Expand Up @@ -44,6 +46,7 @@ public Object getPayload() {
}

@SuppressWarnings("checkstyle:membername")
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Payload {
public final String service_sid;
public final String endpoint_id;
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/com/twilio/jwt/accesstoken/TaskRouterGrant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package com.twilio.jwt.accesstoken;

import com.fasterxml.jackson.annotation.JsonInclude;

/**
* Grant used to access Twilio TaskRouter.
*
Expand Down Expand Up @@ -54,6 +56,7 @@ public Object getPayload() {
}

@SuppressWarnings("checkstyle:membername")
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Payload {
public final String workspace_sid;
public final String worker_sid;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/twilio/jwt/accesstoken/VideoGrant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public Object getPayload() {


@SuppressWarnings("checkstyle:membername")
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Payload {
public final String configuration_profile_sid;
public final String room;
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/twilio/jwt/accesstoken/VoiceGrant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package com.twilio.jwt.accesstoken;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.google.common.base.Strings;

import java.util.HashMap;
Expand Down Expand Up @@ -70,6 +71,7 @@ public Object getPayload() {
}

@SuppressWarnings("checkstyle:membername")
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Payload {
public Map<String, Object> incoming;
public Map<String, Object> outgoing;
Expand Down
92 changes: 37 additions & 55 deletions src/test/java/com/twilio/jwt/accesstoken/AccessTokenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ private void validateToken(Claims claims) {
Assert.assertTrue(claims.getExpiration().getTime() > new Date().getTime());
}

private Claims getClaimFromJwtToken(Jwt token) {
return Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
}

private void testVoiceToken(Boolean allow) {
Map<String, Object> params = new HashMap<>();
params.put("foo", "bar");
Expand All @@ -44,11 +51,7 @@ private void testVoiceToken(Boolean allow) {
.grant(pvg)
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);
Map<String, Object> decodedGrants = (Map<String, Object>) claims.get("grants");
Expand All @@ -71,11 +74,7 @@ public void testEmptyToken() {
new AccessToken.Builder(ACCOUNT_SID, SIGNING_KEY_SID, SECRET)
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);
}
Expand All @@ -88,11 +87,7 @@ public void testOptionalValues() {
.nbf(new Date())
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);
Assert.assertTrue(claims.getNotBefore().getTime() <= new Date().getTime());
Expand All @@ -106,11 +101,7 @@ public void testConversationGrant() {
.grant(cg)
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);

Expand All @@ -129,11 +120,7 @@ public void testVideoGrant() {
.grant(cg)
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);

Expand All @@ -156,11 +143,7 @@ public void testIpMessagingGrant() {
.grant(ipg)
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);

Expand All @@ -186,11 +169,7 @@ public void testChatGrant() {
.grant(cg)
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);

Expand All @@ -214,11 +193,7 @@ public void testSyncGrant() {
.grant(sg)
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);

Expand All @@ -242,11 +217,7 @@ public void testTaskRouterGrant() {
.grant(trg)
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);

Expand Down Expand Up @@ -276,11 +247,7 @@ public void testCompleteToken() {
.nbf(new Date())
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);
Assert.assertTrue(claims.getNotBefore().getTime() <= new Date().getTime());
Expand Down Expand Up @@ -317,11 +284,7 @@ public void testVoiceTokenWithoutIncoming() {
.grant(pvg)
.build();

Claims claims =
Jwts.parser()
.setSigningKey(SECRET.getBytes())
.parseClaimsJws(token.toJwt())
.getBody();
Claims claims = getClaimFromJwtToken(token);

validateToken(claims);
Map<String, Object> decodedGrants = (Map<String, Object>) claims.get("grants");
Expand All @@ -336,4 +299,23 @@ public void testVoiceTokenWithoutIncoming() {
Assert.assertEquals("AP123", outgoing.get("application_sid"));
Assert.assertEquals("bar", outgoingParams.get("foo"));
}

@Test()
public void testNullValues() {
ChatGrant cg = new ChatGrant().setDeploymentRoleSid("RL123");
Jwt token =
new AccessToken.Builder(ACCOUNT_SID, SIGNING_KEY_SID, SECRET)
.grant(cg)
.build();

Claims claims = getClaimFromJwtToken(token);

validateToken(claims);

Map<String, Object> decodedGrants = (Map<String, Object>) claims.get("grants");
Map<String, Object> grant = (Map<String, Object>) decodedGrants.get("chat");

Assert.assertEquals("RL123", grant.get("deployment_role_sid"));
Assert.assertFalse(grant.containsKey("endpoint_id"));
}
}