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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/*
* Copyright 2017 - 2023 Anton Tananaev (anton@traccar.org)
*
* 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.api.security;
import org.traccar.config.Config;
import org.traccar.config.Keys;
import org.traccar.api.resource.SessionResource;
import org.traccar.model.User;
import org.traccar.storage.Storage;
import org.traccar.storage.StorageException;
import org.traccar.storage.query.Request;
import org.traccar.storage.query.Columns;
import org.traccar.helper.LogAction;
import org.traccar.helper.ServletHelper;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Date;
import java.util.List;
import java.io.IOException;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.core.Response;
import com.google.inject.Inject;
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.Nonce;
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 {
public final Boolean force;
private final ClientID clientId;
private final Secret clientSecret;
private URI callbackUrl;
private URI authUrl;
private URI tokenUrl;
private URI userInfoUrl;
private URI baseUrl;
private final String adminGroup;
private Config config;
private LoginService loginService;
private Storage storage;
@Inject
public OpenIDProvider(Config config, LoginService loginService, Storage storage) {
force = config.getBoolean(Keys.OIDC_FORCE);
clientId = new ClientID(config.getString(Keys.OIDC_CLIENTID));
clientSecret = new Secret(config.getString(Keys.OIDC_CLIENTSECRET));
this.config = config;
this.storage = storage;
this.loginService = loginService;
try {
callbackUrl = new URI(config.getString(Keys.WEB_URL, "") + "/api/session/openid/callback");
authUrl = new URI(config.getString(Keys.OIDC_AUTHURL, ""));
tokenUrl = new URI(config.getString(Keys.OIDC_TOKENURL, ""));
userInfoUrl = new URI(config.getString(Keys.OIDC_USERINFOURL, ""));
baseUrl = new URI(config.getString(Keys.WEB_URL, ""));
} catch (URISyntaxException e) {
}
adminGroup = config.getString(Keys.OIDC_ADMINGROUP);
}
public URI createAuthRequest() {
AuthenticationRequest request = new AuthenticationRequest.Builder(
new ResponseType("code"),
new Scope("openid", "profile", "email", "groups"),
this.clientId,
this.callbackUrl)
.endpointURI(this.authUrl)
.state(new State())
.nonce(new Nonce())
.build();
return request.toURI();
}
private OIDCTokenResponse getToken(AuthorizationCode code) {
// Credentials to authenticate us to the token endpoint
ClientAuthentication clientAuth = new ClientSecretBasic(this.clientId, this.clientSecret);
AuthorizationGrant codeGrant = new AuthorizationCodeGrant(code, this.callbackUrl);
TokenRequest request = new TokenRequest(this.tokenUrl, clientAuth, codeGrant);
TokenResponse tokenResponse;
try {
HTTPResponse tokenReq = request.toHTTPRequest().send();
tokenResponse = OIDCTokenResponseParser.parse(tokenReq);
if (!tokenResponse.indicatesSuccess()) {
return null;
}
return (OIDCTokenResponse) tokenResponse.toSuccessResponse();
} catch (IOException e) {
return null;
} catch (ParseException e) {
return null;
}
}
private AuthorizationCode parseCallback(URI requri) {
AuthorizationResponse response;
try {
response = AuthorizationResponse.parse(requri);
} catch (ParseException e) {
return null;
}
if (!response.indicatesSuccess()) {
return null;
}
return response.toSuccessResponse().getAuthorizationCode();
}
private UserInfo getUserInfo(BearerAccessToken token) {
UserInfoResponse userInfoResponse;
try {
HTTPResponse httpResponse = new UserInfoRequest(this.userInfoUrl, token)
.toHTTPRequest()
.send();
userInfoResponse = UserInfoResponse.parse(httpResponse);
} catch (IOException e) {
return null;
} catch (ParseException e) {
return null;
}
if (!userInfoResponse.indicatesSuccess()) {
// User info request failed - usually from expiring
return null;
}
return userInfoResponse.toSuccessResponse().getUserInfo();
}
private User createUser(String name, String email, Boolean administrator) throws StorageException {
User user = new User();
user.setName(name);
user.setEmail(email);
user.setFixedEmail(true);
user.setDeviceLimit(this.config.getInteger(Keys.USERS_DEFAULT_DEVICE_LIMIT));
int expirationDays = this.config.getInteger(Keys.USERS_DEFAULT_EXPIRATION_DAYS);
if (expirationDays > 0) {
user.setExpirationTime(new Date(System.currentTimeMillis() + expirationDays * 86400000L));
}
if (administrator) {
user.setAdministrator(true);
}
user.setId(this.storage.addObject(user, new Request(new Columns.Exclude("id"))));
return user;
}
public Response handleCallback(URI requri, HttpServletRequest request) throws StorageException {
// Parse callback
AuthorizationCode authCode = this.parseCallback(requri);
if (authCode == null) {
return Response.ok().entity("Callback parse fail").build();
}
// Get token from IDP
OIDCTokenResponse tokens = this.getToken(authCode);
if (tokens == null) {
return Response.ok().entity("Token request failed").build();
}
BearerAccessToken bearerToken = tokens.getOIDCTokens().getBearerAccessToken();
// Get user info from IDP
UserInfo idpUser = this.getUserInfo(bearerToken);
if (idpUser == null) {
return Response.ok().entity("User info request failed").build();
}
String email = idpUser.getEmailAddress();
String name = idpUser.getName();
// Check if user exists
User user = this.loginService.lookup(email);
// If user does not exist, create one
if (user == null) {
List<String> groups = idpUser.getStringListClaim("groups");
Boolean administrator = groups.contains(this.adminGroup);
user = this.createUser(name, email, administrator);
}
// Set user session and redirect to homepage
request.getSession().setAttribute(SessionResource.USER_ID_KEY, user.getId());
LogAction.login(user.getId(), ServletHelper.retrieveRemoteAddress(request));
return Response.seeOther(
baseUrl).build();
}
}
|
