Skip to content

Commit

Permalink
Merge pull request #43 from Onlineberatung/feat-remove-user-context-f…
Browse files Browse the repository at this point in the history 
…rom-jwt

feat: remove user context claim from JWT token
  • Loading branch information
@webatspeed
webatspeed authored Jun 30, 2022
2 parents 7ae9f79 + c513abd commit 9785730
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 59 deletions.
2 changes: 1 addition & 1 deletion src/main/java/de/caritas/cob/videoservice/api/facade/StartVideoCallFacade.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public CreateVideoCallResponseDTO startVideoCall(Long sessionId, String initiato

var videoCallUuid = uuidRegistry.generateUniqueUuid();
var videoCallUrls = this.videoCallUrlGeneratorService
.generateVideoCallUrls(consultantSessionDto.getAskerUserName(), videoCallUuid);
.generateVideoCallUrls(videoCallUuid);

this.liveEventNotificationService
.sendVideoCallRequestLiveEvent(buildLiveEventMessage(consultantSessionDto,
Expand Down
5 changes: 2 additions & 3 deletions ...main/java/de/caritas/cob/videoservice/api/service/video/VideoCallUrlGeneratorService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,12 @@ public class VideoCallUrlGeneratorService {
/**
* Generates the {@link VideoCallUrls} for guest, asker and consultant.
*
* @param askerName the username of the asker
* @param uuid the uuid of the video call
* @return the generated {@link VideoCallUrls}
*/
public VideoCallUrls generateVideoCallUrls(String askerName, String uuid) {
public VideoCallUrls generateVideoCallUrls(String uuid) {

var token = this.tokenGeneratorService.generateNonModeratorToken(uuid, askerName);
var token = this.tokenGeneratorService.generateNonModeratorVideoCallToken(uuid);

return VideoCallUrls.builder()
.userVideoUrl(buildUrl(uuid, token.getUserRelatedToken()))
Expand Down
29 changes: 4 additions & 25 deletions src/main/java/de/caritas/cob/videoservice/api/service/video/jwt/TokenGeneratorService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,9 @@
import com.auth0.jwt.algorithms.Algorithm;
import de.caritas.cob.videoservice.api.authorization.VideoUser;
import de.caritas.cob.videoservice.api.exception.httpresponse.InternalServerErrorException;
import de.caritas.cob.videoservice.api.service.decoder.UsernameDecoder;
import de.caritas.cob.videoservice.api.service.video.jwt.model.VideoCallToken;
import java.sql.Date;
import java.time.LocalDateTime;
import java.util.HashMap;
import java.util.Map;
import lombok.NonNull;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
Expand All @@ -37,12 +34,9 @@ public TokenGeneratorService(

private final @NonNull VideoUser videoUser;

private static final String CONTEXT_CLAIM = "context";
private static final String ROOM_CLAIM = "room";
private static final String MODERATOR_CLAIM = "moderator";
private static final String GUEST_URL_CLAIM = "guestVideoCallUrl";
private static final String CONTEXT_USER = "user";
private static final String USER_NAME = "name";

@Value("${video.call.security.jwt.audience}")
private String audience;
Expand Down Expand Up @@ -79,16 +73,15 @@ public String generateToken(String roomId) {
}

/**
* Generates the {@link VideoCallToken} for anonymous user and asker (containing user name).
* Generates the {@link VideoCallToken} for anonymous user and asker.
*
* @param roomId the generated unique roomId
* @param askerName the username of the asker
* @return the generated {@link VideoCallToken}
*/
public VideoCallToken generateNonModeratorToken(String roomId, String askerName) {
public VideoCallToken generateNonModeratorVideoCallToken(String roomId) {
return VideoCallToken.builder()
.guestToken(generateNonModeratorToken(roomId))
.userRelatedToken(buildUserRelatedJwt(roomId, askerName))
.userRelatedToken(buildUserRelatedJwt(roomId))
.build();
}

Expand All @@ -114,21 +107,11 @@ private Date buildThreeHoursValidityDate() {
return new Date(epochMilli);
}

private String buildUserRelatedJwt(String roomId, String askerName) {
private String buildUserRelatedJwt(String roomId) {
return buildBasicJwt(roomId)
.withClaim(CONTEXT_CLAIM, createUserContext(askerName))
.sign(algorithm);
}

private Map<String, Map<String, String>> createUserContext(String askerName) {
Map<String, Map<String, String>> context = new HashMap<>();
Map<String, String> user = new HashMap<>();
user.put(USER_NAME, new UsernameDecoder().decodeUsername(askerName));
context.put(CONTEXT_USER, user);

return context;
}

/**
* Generates the {@link VideoCallToken} for the currently logged in moderator.
*
Expand All @@ -153,18 +136,14 @@ public String generateModeratorToken(String roomId, String guestVideoCallUrl) {
* @return token
*/
public String generateModeratorToken(String roomId) {
var userContext = createUserContext(videoUser.getUsername());

return buildBasicJwt(roomId)
.withClaim(MODERATOR_CLAIM, true)
.withClaim(CONTEXT_CLAIM, userContext)
.sign(algorithm);
}

private String buildModeratorJwt(String roomId, String guestVideoCallUrl) {
return buildBasicJwt(roomId)
.withClaim(MODERATOR_CLAIM, true)
.withClaim(CONTEXT_CLAIM, createUserContext(videoUser.getUsername()))
.withClaim(GUEST_URL_CLAIM, guestVideoCallUrl)
.sign(algorithm);
}
Expand Down
6 changes: 3 additions & 3 deletions src/test/java/de/caritas/cob/videoservice/api/facade/StartVideoCallFacadeTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public void startVideoCall_Should_ReturnCorrectVideoCallUrl_When_UrlWasGenerated

when(sessionService.findSessionOfCurrentConsultant(SESSION_ID))
.thenReturn(consultantSessionDto);
when(videoCallUrlGeneratorService.generateVideoCallUrls(any(), any())).thenReturn(videoCallUrls);
when(videoCallUrlGeneratorService.generateVideoCallUrls(any())).thenReturn(videoCallUrls);

CreateVideoCallResponseDTO result = startVideoCallFacade.startVideoCall(SESSION_ID, "rcUserId");

Expand All @@ -88,7 +88,7 @@ public void startVideoCall_Should_CallLiveServiceAndBuildCorrectLiveEventMessage

when(sessionService.findSessionOfCurrentConsultant(SESSION_ID))
.thenReturn(consultantSessionDto);
when(videoCallUrlGeneratorService.generateVideoCallUrls(any(), any()))
when(videoCallUrlGeneratorService.generateVideoCallUrls(any()))
.thenReturn(videoCallUrls);
when(authenticatedUser.getUsername()).thenReturn(USERNAME);
ArgumentCaptor<LiveEventMessage> argument = ArgumentCaptor.forClass(LiveEventMessage.class);
Expand Down Expand Up @@ -131,7 +131,7 @@ public void startVideoCall_Should_FireAssignSessionStatisticsEvent() {

when(sessionService.findSessionOfCurrentConsultant(SESSION_ID))
.thenReturn(consultantSessionDto);
when(videoCallUrlGeneratorService.generateVideoCallUrls(any(), any())).thenReturn(videoCallUrls);
when(videoCallUrlGeneratorService.generateVideoCallUrls(any())).thenReturn(videoCallUrls);

CreateVideoCallResponseDTO result = startVideoCallFacade.startVideoCall(SESSION_ID, "rcUserId");

Expand Down
9 changes: 4 additions & 5 deletions .../java/de/caritas/cob/videoservice/api/service/video/VideoCallUrlGeneratorServiceTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
import static org.springframework.test.util.ReflectionTestUtils.setField;

import de.caritas.cob.videoservice.api.exception.httpresponse.InternalServerErrorException;
import de.caritas.cob.videoservice.api.service.UuidRegistry;
import de.caritas.cob.videoservice.api.service.video.jwt.TokenGeneratorService;
import de.caritas.cob.videoservice.api.service.video.jwt.model.VideoCallToken;
import de.caritas.cob.videoservice.api.service.video.jwt.model.VideoCallUrls;
Expand Down Expand Up @@ -35,13 +34,13 @@ public void generateVideoCallUrls_Should_generateExpectedVideoCallUrls_When_aske
setField(this.videoCallUrlGeneratorService, FIELD_NAME_VIDEO_CALL_URL, VIDEO_CALL_URL);
VideoCallToken videoCallToken = new EasyRandom().nextObject(VideoCallToken.class);
String moderatorToken = "moderatorToken";
when(this.tokenGeneratorService.generateNonModeratorToken(any(), any()))
when(this.tokenGeneratorService.generateNonModeratorVideoCallToken(any()))
.thenReturn(videoCallToken);
when(this.tokenGeneratorService.generateModeratorToken(any(), any()))
.thenReturn(moderatorToken);

VideoCallUrls videoCallUrls = this.videoCallUrlGeneratorService
.generateVideoCallUrls("asker123", "uniqueId");
.generateVideoCallUrls("uniqueId");

assertThat(videoCallUrls.getUserVideoUrl(),
is(VIDEO_CALL_URL + "/uniqueId?jwt=" + videoCallToken.getUserRelatedToken()));
Expand All @@ -52,10 +51,10 @@ public void generateVideoCallUrls_Should_generateExpectedVideoCallUrls_When_aske
@Test(expected = InternalServerErrorException.class)
public void generateVideoCallUrls_Should_throwInternalServerErrorException_When_videoUrlIsInvalid() {
VideoCallToken videoCallToken = new EasyRandom().nextObject(VideoCallToken.class);
when(this.tokenGeneratorService.generateNonModeratorToken(any(), any()))
when(this.tokenGeneratorService.generateNonModeratorVideoCallToken(any()))
.thenReturn(videoCallToken);

this.videoCallUrlGeneratorService.generateVideoCallUrls("asker123", "uniqueId");
this.videoCallUrlGeneratorService.generateVideoCallUrls("uniqueId");
}

}
24 changes: 2 additions & 22 deletions ...est/java/de/caritas/cob/videoservice/api/service/video/jwt/TokenGeneratorServiceTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ private void verifyBasicTokenFields(String jwt, String expectedRoomId) {

@Test
public void generateNonModeratorToken_Should_returnExpectedTokens_When_roomIdIsGiven() {
VideoCallToken token = this.tokenGeneratorService.generateNonModeratorToken("validRoomId", "");
VideoCallToken token = this.tokenGeneratorService.generateNonModeratorVideoCallToken("validRoomId");

String guestToken = token.getGuestToken();
String userToken = token.getUserRelatedToken();
Expand All @@ -70,26 +70,14 @@ public void generateNonModeratorToken_Should_returnExpectedTokens_When_roomIdIsG

@Test
public void generateNonModeratorToken_Should_returnExpectedTokens_When_roomIdAndAskerAreEmpty() {
VideoCallToken token = this.tokenGeneratorService.generateNonModeratorToken("", "");
VideoCallToken token = this.tokenGeneratorService.generateNonModeratorVideoCallToken("");

String guestToken = token.getGuestToken();
String userToken = token.getUserRelatedToken();

verifyBasicTokenFields(guestToken, "");
verifyBasicTokenFields(userToken, "");
assertThat(JWT.decode(guestToken).getClaim("context"), instanceOf(NullClaim.class));
assertThat(JWT.decode(userToken).getClaim("context").asMap().get("user").toString(),
is("{name=}"));
}

@Test
public void generateNonModeratorToken_Should_returnExpectedContextInUserToken_When_askerUsernameIsGiven() {
VideoCallToken token = this.tokenGeneratorService.generateNonModeratorToken("", "asker123");

String userToken = token.getUserRelatedToken();

assertThat(JWT.decode(userToken).getClaim("context").asMap().get("user").toString(),
is("{name=asker123}"));
}

@Test(expected = InternalServerErrorException.class)
Expand All @@ -109,31 +97,24 @@ public void generateModeratorToken_Should_ThrowInternalServerErrorException_When

@Test
public void generateModeratorToken_Should_returnExpectedToken_When_ParamsAreGiven() {
when(authenticatedUser.getUsername()).thenReturn(USERNAME);

String moderatorToken = this.tokenGeneratorService
.generateModeratorToken("validRoomId", GUEST_VIDEO_CALL_URL);

verifyBasicTokenFields(moderatorToken, "validRoomId");
assertThat(JWT.decode(moderatorToken).getClaim("moderator").asBoolean(),
is(true));
assertThat(JWT.decode(moderatorToken).getClaim("context").asMap().get("user").toString(),
is("{name=" + USERNAME + "}"));
assertThat(JWT.decode(moderatorToken).getClaim("guestVideoCallUrl").asString(),
is(GUEST_VIDEO_CALL_URL));
}

@Test
public void generateToken_should_generate_moderator_token_if_user_is_consultant() {
when(authenticatedUser.getUsername()).thenReturn(USERNAME);
when(authenticatedUser.isConsultant()).thenReturn(true);

var moderatorToken = tokenGeneratorService.generateToken("privateRoom4711");

verifyBasicTokenFields(moderatorToken, "privateRoom4711");
assertThat(JWT.decode(moderatorToken).getClaim("moderator").asBoolean(), is(true));
assertThat(JWT.decode(moderatorToken).getClaim("context").asMap().get("user").toString(),
is("{name=" + USERNAME + "}"));
}

@Test
Expand All @@ -143,7 +124,6 @@ public void generateToken_should_generate_non_moderator_token_if_user_is_no_cons
var moderatorToken = tokenGeneratorService.generateToken("privateRoom4711");

assertThat(JWT.decode(moderatorToken).getClaim("moderator").isNull(), is(true));
assertThat(JWT.decode(moderatorToken).getClaim("context").isNull(), is(true));
verifyBasicTokenFields(moderatorToken, "privateRoom4711");
}
}

0 comments on commit 9785730

Please sign in to comment.