1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*
*
* Copyright (c) 2022. Deutsche Telekom AG
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
*
*
*/
package org.onap.portal.history.util;
import com.nimbusds.jwt.JWTClaimsSet;
import com.nimbusds.jwt.JWTParser;
import java.text.ParseException;
import org.onap.portal.history.exception.ProblemException;
import org.springframework.web.server.ServerWebExchange;
import org.zalando.problem.Problem;
import org.zalando.problem.Status;
import reactor.core.publisher.Mono;
/**
* Represents a function that handles the <a href="https://jwt.io/introduction">JWT</a> identity token.
* Use this to check if the incoming requests are authorized to call the given endpoint
*/
public final class IdTokenExchange {
public static final String X_AUTH_IDENTITY_HEADER = "X-Auth-Identity";
public static final String JWT_CLAIM_USERID = "sub";
private IdTokenExchange(){
}
/**
* Extract the identity header from the given {@link ServerWebExchange}.
* @param exchange the ServerWebExchange that contains information about the incoming request
* @param xRequestId the id of the request to use in error log
* @return the identity header in the form of <code>Bearer {@literal <Token>}<c/ode>
*/
private static Mono<String> extractIdentityHeader(ServerWebExchange exchange, String xRequestId) {
return Mono.just(exchange.getRequest().getHeaders().getOrEmpty(X_AUTH_IDENTITY_HEADER))
.map(headers -> headers.get(0))
.onErrorResume(Exception.class, ex -> Mono.error(ProblemException.builder()
.type(Problem.DEFAULT_TYPE)
.status(Status.FORBIDDEN)
.title("Forbidden access")
.detail(X_AUTH_IDENTITY_HEADER + " is not set")
.build()));
}
/**
* Extract the identity token from the given {@link ServerWebExchange}.
* @see <a href="https://openid.net/specs/openid-connect-core-1_0.html#IDToken">OpenId Connect ID Token</a>
* @param exchange the ServerWebExchange that contains information about the incoming request
* @param xRequestId the id of the request to use in error log
* @return the identity token that contains user roles
*/
private static Mono<String> extractIdToken(ServerWebExchange exchange, String xRequestId) {
return extractIdentityHeader(exchange, xRequestId)
.map(identityHeader -> identityHeader.replace("Bearer ", ""));
}
/**
* Extract the <code>userId</code> from the given {@link ServerWebExchange}
* @param exchange the ServerWebExchange that contains information about the incoming request
* @param xRequestId the id of the request to use in error log
* @return the id of the user
*/
public static Mono<String> extractUserId(ServerWebExchange exchange,String xRequestId) {
return extractIdToken(exchange, xRequestId)
.flatMap(idToken -> extractUserClaim(idToken));
}
private static Mono<String> extractUserClaim(String idToken) {
JWTClaimsSet jwtClaimSet;
try {
jwtClaimSet = JWTParser.parse(idToken).getJWTClaimsSet();
} catch (ParseException e) {
return Mono.error(e);
}
return Mono.just(String.class.cast(jwtClaimSet.getClaim(JWT_CLAIM_USERID)));
}
/**
* Validate if given <code>userId</code> is same as extracted from the given {@link ServerWebExchange}
* @param userId from the path parameter of the REST call
* @param exchange the ServerWebExchange that contains information about the incoming request
* @param xRequestId the id of the request to use in error log
* @return <code>empty Mono</code> userId is the same as extracted from {@link ServerWebExchange}
* <code>Forbidden</code> userId is <bold>not</bold> the same as extracted from {@link ServerWebExchange}
*/
public static Mono<Void> validateUserId(String userId, ServerWebExchange exchange, String xRequestId){
return extractUserId(exchange, xRequestId)
.map(userSub -> userSub.equals(userId))
.flatMap( match -> {
if (Boolean.TRUE.equals(match)) {
return Mono.empty();
} else{
Logger.errorLog(xRequestId,"Requested "+ userId + " did not match the JWT in the X-Auth-Identity header" , userId );
return Mono.error(ProblemException.builder()
.type(Problem.DEFAULT_TYPE)
.status(Status.FORBIDDEN)
.title("Forbidden access")
.detail("UserId did not match with JWT in " + X_AUTH_IDENTITY_HEADER)
.build());
}
});
}
}
|
