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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* Copyright 2023 Daniel Raper (me@danr.uk)
*
* 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.
*/
package org.traccar.database;
import org.traccar.config.Config;
import org.traccar.config.Keys;
import org.traccar.api.resource.SessionResource;
import org.traccar.api.security.LoginService;
import org.traccar.model.User;
import org.traccar.storage.StorageException;
import org.traccar.helper.LogAction;
import org.traccar.helper.ServletHelper;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse.BodyHandlers;
import java.security.GeneralSecurityException;
import java.util.List;
import java.util.Map;
import java.io.IOException;
import javax.servlet.http.HttpServletRequest;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.inject.Inject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.nimbusds.oauth2.sdk.http.HTTPResponse;
import com.nimbusds.oauth2.sdk.AuthorizationCode;
import com.nimbusds.oauth2.sdk.ResponseType;
import com.nimbusds.oauth2.sdk.Scope;
import com.nimbusds.oauth2.sdk.AuthorizationGrant;
import com.nimbusds.oauth2.sdk.TokenRequest;
import com.nimbusds.oauth2.sdk.TokenResponse;
import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant;
import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.AuthorizationResponse;
import com.nimbusds.oauth2.sdk.auth.Secret;
import com.nimbusds.oauth2.sdk.auth.ClientSecretBasic;
import com.nimbusds.oauth2.sdk.auth.ClientAuthentication;
import com.nimbusds.oauth2.sdk.token.BearerAccessToken;
import com.nimbusds.oauth2.sdk.id.State;
import com.nimbusds.oauth2.sdk.id.ClientID;
import com.nimbusds.openid.connect.sdk.OIDCTokenResponse;
import com.nimbusds.openid.connect.sdk.OIDCTokenResponseParser;
import com.nimbusds.openid.connect.sdk.UserInfoResponse;
import com.nimbusds.openid.connect.sdk.UserInfoRequest;
import com.nimbusds.openid.connect.sdk.AuthenticationRequest;
import com.nimbusds.openid.connect.sdk.claims.UserInfo;
public class OpenIdProvider {
private static final Logger LOGGER = LoggerFactory.getLogger(OpenIdProvider.class);
private final Boolean force;
private final ClientID clientId;
private final ClientAuthentication clientAuth;
private URI callbackUrl;
private URI authUrl;
private URI tokenUrl;
private URI userInfoUrl;
private URI baseUrl;
private final String adminGroup;
private final String allowGroup;
private LoginService loginService;
@Inject
public OpenIdProvider(
Config config, LoginService loginService, HttpClient httpClient, ObjectMapper objectMapper
) throws InterruptedException, IOException {
this.loginService = loginService;
force = config.getBoolean(Keys.OPENID_FORCE);
clientId = new ClientID(config.getString(Keys.OPENID_CLIENT_ID));
clientAuth = new ClientSecretBasic(clientId, new Secret(config.getString(Keys.OPENID_CLIENT_SECRET)));
try {
callbackUrl = new URI(config.getString(Keys.WEB_URL, "") + "/api/session/openid/callback");
baseUrl = new URI(config.getString(Keys.WEB_URL, ""));
if (config.hasKey(Keys.OPENID_ISSUER_URL)) {
HttpRequest httpRequest = HttpRequest.newBuilder(
URI.create(config.getString(Keys.OPENID_ISSUER_URL) + "/.well-known/openid-configuration"))
.header("Accept", "application/json")
.build();
String httpResponse = httpClient.send(httpRequest, BodyHandlers.ofString()).body();
Map<String, Object> discoveryMap = objectMapper.readValue(
httpResponse, new TypeReference<Map<String, Object>>() { });
authUrl = new URI((String) discoveryMap.get("authorization_endpoint"));
tokenUrl = new URI((String) discoveryMap.get("token_endpoint"));
userInfoUrl = new URI((String) discoveryMap.get("userinfo_endpoint"));
LOGGER.info("OpenID Connect auto discovery successful");
} else {
authUrl = new URI(config.getString(Keys.OPENID_AUTH_URL));
tokenUrl = new URI(config.getString(Keys.OPENID_TOKEN_URL));
userInfoUrl = new URI(config.getString(Keys.OPENID_USERINFO_URL));
}
} catch (URISyntaxException error) {
LOGGER.error("Invalid URIs provided in OpenID configuration");
}
adminGroup = config.getString(Keys.OPENID_ADMIN_GROUP);
allowGroup = config.getString(Keys.OPENID_ALLOW_GROUP);
}
public URI createAuthUri() {
Scope scope = new Scope("openid", "profile", "email");
if (adminGroup != null) {
scope.add("groups");
}
AuthenticationRequest.Builder request = new AuthenticationRequest.Builder(
new ResponseType("code"),
scope,
clientId,
callbackUrl);
return request.endpointURI(authUrl)
.state(new State())
.build()
.toURI();
}
private OIDCTokenResponse getToken(
AuthorizationCode code) throws IOException, ParseException, GeneralSecurityException {
AuthorizationGrant codeGrant = new AuthorizationCodeGrant(code, callbackUrl);
TokenRequest tokenRequest = new TokenRequest(tokenUrl, clientAuth, codeGrant);
HTTPResponse tokenResponse = tokenRequest.toHTTPRequest().send();
TokenResponse token = OIDCTokenResponseParser.parse(tokenResponse);
if (!token.indicatesSuccess()) {
throw new GeneralSecurityException("Unable to authenticate with the OpenID Connect provider.");
}
return (OIDCTokenResponse) token.toSuccessResponse();
}
private UserInfo getUserInfo(BearerAccessToken token) throws IOException, ParseException, GeneralSecurityException {
HTTPResponse httpResponse = new UserInfoRequest(userInfoUrl, token)
.toHTTPRequest()
.send();
UserInfoResponse userInfoResponse = UserInfoResponse.parse(httpResponse);
if (!userInfoResponse.indicatesSuccess()) {
throw new GeneralSecurityException(
"Failed to access OpenID Connect user info endpoint. Please contact your administrator.");
}
return userInfoResponse.toSuccessResponse().getUserInfo();
}
public URI handleCallback(
URI requestUri, HttpServletRequest request
) throws StorageException, ParseException, IOException, GeneralSecurityException {
AuthorizationResponse response = AuthorizationResponse.parse(requestUri);
if (!response.indicatesSuccess()) {
throw new GeneralSecurityException(response.toErrorResponse().getErrorObject().getDescription());
}
AuthorizationCode authCode = response.toSuccessResponse().getAuthorizationCode();
if (authCode == null) {
throw new GeneralSecurityException("Malformed OpenID callback.");
}
OIDCTokenResponse tokens = getToken(authCode);
BearerAccessToken bearerToken = tokens.getOIDCTokens().getBearerAccessToken();
UserInfo userInfo = getUserInfo(bearerToken);
List<String> userGroups = userInfo.getStringListClaim("groups");
Boolean administrator = adminGroup != null && userGroups.contains(adminGroup);
if (!(administrator || allowGroup == null || userGroups.contains(allowGroup))) {
throw new GeneralSecurityException("Your OpenID Groups do not permit access to Traccar.");
}
User user = loginService.login(userInfo.getEmailAddress(), userInfo.getName(), administrator);
request.getSession().setAttribute(SessionResource.USER_ID_KEY, user.getId());
LogAction.login(user.getId(), ServletHelper.retrieveRemoteAddress(request));
return baseUrl;
}
public boolean getForce() {
return force;
}
}
|
