/
Connection.java
678 lines (608 loc) · 20.2 KB
/
Connection.java
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
/*******************************************************************************
* Copyright (c) 2015 Red Hat, Inc.
* Distributed under license by Red Hat, Inc. All rights reserved.
* This program is made available under the terms of the
* Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Red Hat, Inc. - initial API and implementation
******************************************************************************/
package org.jboss.tools.openshift.core.connection;
import static org.apache.commons.lang.StringUtils.isNotBlank;
import java.io.IOException;
import java.net.MalformedURLException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import org.apache.commons.lang.ObjectUtils;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.equinox.security.storage.StorageException;
import org.eclipse.osgi.util.NLS;
import org.jboss.tools.common.databinding.ObservablePojo;
import org.jboss.tools.openshift.common.core.ICredentialsPrompter;
import org.jboss.tools.openshift.common.core.IRefreshable;
import org.jboss.tools.openshift.common.core.connection.ConnectionType;
import org.jboss.tools.openshift.common.core.connection.ConnectionURL;
import org.jboss.tools.openshift.common.core.connection.IConnection;
import org.jboss.tools.openshift.common.core.utils.StringUtils;
import org.jboss.tools.openshift.common.core.utils.UrlUtils;
import org.jboss.tools.openshift.core.OpenShiftCoreUIIntegration;
import org.jboss.tools.openshift.core.preferences.OpenShiftCorePreferences;
import org.jboss.tools.openshift.internal.common.core.UsageStats;
import org.jboss.tools.openshift.internal.common.core.security.OpenShiftSecureStorageKey;
import org.jboss.tools.openshift.internal.common.core.security.SecureStore;
import org.jboss.tools.openshift.internal.common.core.security.SecureStoreException;
import org.jboss.tools.openshift.internal.core.OpenShiftCoreActivator;
import com.openshift.restclient.ClientBuilder;
import com.openshift.restclient.IClient;
import com.openshift.restclient.IResourceFactory;
import com.openshift.restclient.ISSLCertificateCallback;
import com.openshift.restclient.NotFoundException;
import com.openshift.restclient.OpenShiftException;
import com.openshift.restclient.authorization.BasicAuthorizationStrategy;
import com.openshift.restclient.authorization.IAuthorizationContext;
import com.openshift.restclient.authorization.IAuthorizationStrategy;
import com.openshift.restclient.authorization.TokenAuthorizationStrategy;
import com.openshift.restclient.authorization.UnauthorizedException;
import com.openshift.restclient.capability.CapabilityVisitor;
import com.openshift.restclient.capability.ICapability;
import com.openshift.restclient.capability.resources.IClientCapability;
import com.openshift.restclient.model.IResource;
import com.openshift.restclient.model.IResourceBuilder;
public class Connection extends ObservablePojo implements IRefreshable, IOpenShiftConnection {
public static final String SECURE_STORAGE_BASEKEY = "org.jboss.tools.openshift.core";
public static final String SECURE_STORAGE_PASSWORD_KEY = "password";
public static final String SECURE_STORAGE_TOKEN_KEY = "token";
private IClient client;
private String username;
private String password;
private String token;
private boolean passwordLoaded;
private boolean tokenLoaded;
private boolean rememberPassword;
private boolean rememberToken;
private boolean promptCredentialsEnabled = true;
private ICredentialsPrompter credentialsPrompter;
private ISSLCertificateCallback sslCertificateCallback;
private String authScheme;
private Map<String, Object> extendedProperties = new HashMap<>();
//TODO modify default client to take url and throw lib specific exception
public Connection(String url, ICredentialsPrompter credentialsPrompter, ISSLCertificateCallback sslCertCallback)
throws MalformedURLException {
this(new ClientBuilder(url).sslCertificateCallback(sslCertCallback).build(), credentialsPrompter, sslCertCallback);
}
public Connection(IClient client, ICredentialsPrompter credentialsPrompter, ISSLCertificateCallback sslCertCallback) {
this.client = client;
this.client.setSSLCertificateCallback(sslCertCallback);
this.credentialsPrompter = credentialsPrompter;
this.sslCertificateCallback = sslCertCallback;
}
@Override
public Map<String, Object> getExtendedProperties() {
return new HashMap<>(extendedProperties);
}
@Override
public void setExtendedProperty(String name, Object value) {
Map<String, Object> oldExt = new HashMap<>(extendedProperties);
extendedProperties.put(name, value);
firePropertyChange(PROPERTY_EXTENDED_PROPERTIES, oldExt, this.extendedProperties);
}
@Override
public void setExtendedProperties(Map<String, Object> ext) {
firePropertyChange(PROPERTY_EXTENDED_PROPERTIES, this.extendedProperties, this.extendedProperties = ext);
}
/**
* Retrieve the resource factory associated with this connection
* for stubbing versioned resources supported by th server
* @return an {@link IResourceFactory}
*/
public IResourceFactory getResourceFactory() {
return client.getResourceFactory();
}
@SuppressWarnings({ "rawtypes", "unchecked" })
public <B extends IResourceBuilder> B getResourceBuilder(Class<? extends ICapability> klass){
if(client.supports(klass)) {
ICapability cap = (ICapability) client.getCapability(klass);
if(cap instanceof IResourceBuilder) {
return (B) cap;
}
}
return null;
}
@Override
public String getUsername(){
return username;
}
@Override
public void setUsername(String userName) {
firePropertyChange(PROPERTY_USERNAME, this.username, this.username = userName);
}
@Override
public String getPassword() {
loadPassword();
return password;
}
@Override
public void setPassword(String password) {
firePropertyChange(PROPERTY_PASSWORD, this.password, this.password = password);
this.passwordLoaded = true;
}
/**
* Attempts to load the password from the secure storage, only at first time
* it is called.
*/
private void loadPassword() {
if (StringUtils.isEmpty(password)
&& !passwordLoaded) {
this.password = load(SECURE_STORAGE_PASSWORD_KEY);
this.passwordLoaded = true;
setRememberPassword(password != null);
}
}
@Override
public void setRememberPassword(boolean rememberPassword) {
firePropertyChange(PROPERTY_REMEMBER_PASSWORD, this.rememberPassword, this.rememberPassword = rememberPassword);
}
@Override
public boolean isRememberPassword() {
return rememberPassword;
}
public boolean isRememberToken() {
return rememberToken;
}
public void setRememberToken(boolean rememberToken) {
firePropertyChange(PROPERTY_REMEMBER_TOKEN, this.rememberToken, this.rememberToken = rememberToken);
}
@Override
public void enablePromptCredentials(boolean enable) {
this.promptCredentialsEnabled = enable;
}
@Override
public boolean isEnablePromptCredentials() {
return promptCredentialsEnabled;
}
public String getAuthScheme() {
return org.apache.commons.lang.StringUtils.defaultIfBlank(this.authScheme, IAuthorizationContext.AUTHSCHEME_OAUTH);
}
protected String load(String id) {
String value = null;
SecureStore store = getSecureStore(getHost(), getUsername());
if (store != null) {
try {
value = store.get(id);
} catch (SecureStoreException e) {
OpenShiftCoreActivator.pluginLog().logError(e.getMessage(), e);
}
}
return value;
}
private boolean saveOrClear(String id, String value, boolean saveOrClear) {
SecureStore store = getSecureStore(getHost(), getUsername());
if (store != null) {
try {
if (saveOrClear
&& !StringUtils.isEmpty(value)) {
store.put(id, value);
} else {
store.remove(id);
}
} catch (SecureStoreException e) {
firePropertyChange(SecureStoreException.ID, null, e);
OpenShiftCoreActivator.logError(NLS.bind("Exception saving {0} for connection to {1}",id, getHost()), e);
if(e.getCause() instanceof StorageException) {
return false;
}
}
}
return true;
}
/**
* Returns a secure store for the current host and username
*/
protected SecureStore getSecureStore(String host, String username) {
return new SecureStore(new OpenShiftSecureStorageKey(SECURE_STORAGE_BASEKEY, host, username));
}
@Override
public boolean connect() throws OpenShiftException {
if(authorize()) {
savePasswordOrToken();
saveAuthSchemePreference();
return true;
}
return false;
}
protected boolean authorize() {
client.setAuthorizationStrategy(createAuthorizationStrategy());
try {
IAuthorizationContext context = client.getContext(client.getBaseURL().toString());
if (context.isAuthorized()) {
String username = context.getUser().getName();
String token = context.getToken();
updateAuthorized(username, token);
} else {
if (promptCredentialsEnabled
&& credentialsPrompter != null) {
credentialsPrompter.promptAndAuthenticate(this, null);
}
}
} catch (UnauthorizedException e) {
if (promptCredentialsEnabled
&& credentialsPrompter != null) {
credentialsPrompter.promptAndAuthenticate(this, e.getAuthorizationDetails());
} else {
throw e;
}
}
return getToken() != null;
}
private void updateAuthorized(String username, String token) {
setToken(token);
if (IAuthorizationContext.AUTHSCHEME_OAUTH.equalsIgnoreCase(getAuthScheme())) {
setUsername(username);
}
// force auth strategy to token if authorized
TokenAuthorizationStrategy tokenStrategy = new TokenAuthorizationStrategy(token, username);
client.setAuthorizationStrategy(tokenStrategy);
}
private void savePasswordOrToken() {
// not using getters here because for save there should be no reason
// to trigger a load from storage.
if (IAuthorizationContext.AUTHSCHEME_BASIC.equals(getAuthScheme())) {
boolean success = saveOrClear(SECURE_STORAGE_PASSWORD_KEY, this.password, isRememberPassword());
if (success) {
//Avoid second secure storage prompt.
// Password is stored, token should be cleared.
clearToken();
}
} else if (IAuthorizationContext.AUTHSCHEME_OAUTH.equals(getAuthScheme())){
boolean success = saveOrClear(SECURE_STORAGE_TOKEN_KEY, getToken(), isRememberToken());
if(success) {
//Avoid second secure storage prompt.
//Token is stored, password should be cleared.
clearPassword();
}
}
}
private void clearPassword() {
setRememberPassword(false);
setPassword(null);
saveOrClear(SECURE_STORAGE_PASSWORD_KEY, null, false);
}
private void clearToken() {
setRememberToken(false);
setToken(null);
saveOrClear(SECURE_STORAGE_TOKEN_KEY, null, false);
}
protected void saveAuthSchemePreference() {
ConnectionURL url = ConnectionURL.safeForConnection(this);
if(!StringUtils.isEmpty(url)) {
OpenShiftCorePreferences.INSTANCE.saveAuthScheme(url.toString(), getAuthScheme());
}
}
private IAuthorizationStrategy createAuthorizationStrategy() {
if (org.apache.commons.lang.StringUtils.isNotEmpty(getToken())
|| IAuthorizationContext.AUTHSCHEME_OAUTH.equalsIgnoreCase(getAuthScheme())) {
return new TokenAuthorizationStrategy(getToken(), getUsername()); //always use the token if you have one?
} else if (IAuthorizationContext.AUTHSCHEME_BASIC.equalsIgnoreCase(getAuthScheme())) {
return new BasicAuthorizationStrategy(getUsername(), getPassword(), getToken());
}
throw new OpenShiftException("Authscheme '%s' is not supported.", getAuthScheme());
}
/**
* Computes authorization state of connection. May be a long running operation.
* @return
*/
public boolean isAuthorized(IProgressMonitor monitor) {
boolean needStrategy = initClientAuthorizationStrategy();
try {
IAuthorizationContext context = client.getContext(client.getBaseURL().toString());
boolean result = context.isAuthorized();
if(result && needStrategy) {
//Call connect() to set the correct strategy instance to the client
//in the case when no strategy has been set yet, and as we do it,
//we can discard the current result, which nevertheless
//being true, promises that connect will go smoothly.
return connect();
}
return result;
} catch (UnauthorizedException e) {
return false;
}
}
/**
* Return true if the client had no strategy instance and it was set to the value provided by
* method createAuthorizationStrategy()
*
* @return
*/
private boolean initClientAuthorizationStrategy() {
boolean needStrategy = client.getAuthorizationStrategy() == null;
if(needStrategy) {
client.setAuthorizationStrategy(createAuthorizationStrategy());
}
return needStrategy;
}
public void setAuthScheme(String scheme) {
firePropertyChange(PROPERTY_AUTHSCHEME, this.authScheme, this.authScheme = scheme);
}
@Override
public String getHost() {
return client.getBaseURL().toString();
}
@Override
public boolean isDefaultHost() {
// TODO: implement
return false;
}
@Override
public String getScheme() {
return client.getBaseURL().getProtocol() + UrlUtils.SCHEME_SEPARATOR;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((client == null) ? 0 : client.getBaseURL().hashCode());
result = prime * result + ((username == null) ? 0 : username.hashCode());
return result;
}
@Override
public IConnection clone() {
Connection connection = new Connection(client, credentialsPrompter, sslCertificateCallback);
connection.setUsername(username);
connection.setPassword(password);
connection.setRememberPassword(rememberPassword);
connection.setRememberToken(rememberToken);
connection.setToken(token);
connection.setAuthScheme(authScheme);
connection.promptCredentialsEnabled = promptCredentialsEnabled;
return connection;
}
@Override
public void update(IConnection connection) {
Assert.isLegal(connection instanceof Connection);
Connection otherConnection = (Connection) connection;
this.client = otherConnection.client;
this.credentialsPrompter = otherConnection.credentialsPrompter;
this.sslCertificateCallback = otherConnection.sslCertificateCallback;
this.username = otherConnection.username;
this.password = otherConnection.password;
this.rememberPassword = otherConnection.rememberPassword;
this.token = otherConnection.token;
this.rememberToken = otherConnection.rememberToken;
}
@Override
public void refresh() {
connect();
}
@Override
public ConnectionType getType() {
return ConnectionType.Kubernetes;
}
@Override
public String toString() {
return client.getBaseURL().toString();
}
/**
*
* @param resource
* @return
* @throws UnauthorizedException
*/
public <T extends IResource> T createResource(T resource) {
boolean needStrategy = initClientAuthorizationStrategy();
try {
return client.create(resource);
} catch (UnauthorizedException e) {
needStrategy = false;
return retryCreate(e, resource);
} finally {
if(needStrategy) {
connect();
}
}
}
/**
*
* @param resource
* @return
* @throws UnauthorizedException
*/
public <T extends IResource> T updateResource(T resource) {
boolean needStrategy = initClientAuthorizationStrategy();
try {
return client.update(resource);
} catch (UnauthorizedException e) {
needStrategy = false;
return retryUpdate(e, resource);
} finally {
if(needStrategy) {
connect();
}
}
}
/**
* Get a list of resource types in the default namespace
*
* @return List<IResource>
* @throws OpenShiftException
*/
@Override
public <T extends IResource> List<T> getResources(String kind) {
return getResources(kind,"");
}
@Override
public <T extends IResource> List<T> getResources(String kind, String namespace) {
boolean needStrategy = initClientAuthorizationStrategy();
try {
client.setSSLCertificateCallback(OpenShiftCoreUIIntegration.getInstance().getSSLCertificateCallback());
return client.list(kind, namespace);
} catch (UnauthorizedException e) {
needStrategy = false;
return retryList(e, kind, namespace);
} finally {
if(needStrategy) {
connect();
}
}
}
@Override
public <T extends IResource> T getResource(String kind, String namespace, String name) {
boolean needStrategy = initClientAuthorizationStrategy();
try {
return client.get(kind, name, namespace);
} catch (UnauthorizedException e) {
needStrategy = false;
return retryGet(e, kind, name, namespace);
} finally {
if(needStrategy) {
connect();
}
}
}
/**
* Get or refresh a resource
*
* @return List<IResource>
* @throws OpenShiftException
*/
public <T extends IResource> T getResource(IResource resource) {
boolean needStrategy = initClientAuthorizationStrategy();
try {
return client.get(resource.getKind(), resource.getName(), resource.getNamespace());
} catch (UnauthorizedException e) {
needStrategy = false;
return retryGet(e, resource.getKind(), resource.getName(), resource.getNamespace());
} finally {
if(needStrategy) {
connect();
}
}
}
private <T extends IResource> T retryGet(OpenShiftException e, String kind, String name, String namespace){
setToken(null);// token must be invalid, make sure not to try with
// cache
if (connect()) {
return client.get(kind, name, namespace);
}
throw e;
}
private <T extends IResource> T retryCreate(OpenShiftException e, T resource){
setToken(null);// token must be invalid, make sure not to try with
// cache
if (connect()) {
return client.create(resource);
}
throw e;
}
private <T extends IResource> T retryUpdate(OpenShiftException e, T resource){
setToken(null);// token must be invalid, make sure not to try with
// cache
if (connect()) {
return client.update(resource);
}
throw e;
}
private <T extends IResource> List<T> retryList(OpenShiftException e, String kind, String namespace){
setToken(null);// token must be invalid, make sure not to try with
// cache
if (connect()) {
return client.list(kind, namespace);
}
throw e;
}
/**
* Delete the resource from the namespace it is associated with. The delete operation
* return silently regardless if successful or not
*
* @param resource
* @throws OpenShiftException
*/
public void deleteResource(IResource resource) {
client.delete(resource);
}
@Override
public boolean canConnect() throws IOException {
try {
client.getOpenShiftAPIVersion();
return true;
} catch (NotFoundException e) {
return false;
}
}
public String getToken() {
loadToken();
return token;
}
/**
* Loads the token from the secure storage if it's not been loaded nor set yet.
*/
private synchronized void loadToken() {
if (StringUtils.isEmpty(token) && !tokenLoaded) {
setToken(load(SECURE_STORAGE_TOKEN_KEY));
tokenLoaded = true;
this.rememberToken = isNotBlank(token); //potential conflict with load password?
}
}
public void setToken(String token) {
firePropertyChange(SECURE_STORAGE_TOKEN_KEY, token, this.token = token);
this.tokenLoaded = true;
}
@Override
public void notifyUsage() {
UsageStats.getInstance().newV3Connection(getHost());
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
Connection other = (Connection) obj;
if (username == null) {
if (other.username != null)
return false;
} else if (!username.equals(other.username))
return false;
if (client == null) {
if (other.client != null)
return false;
} else if (other.client == null
|| !client.getBaseURL().toString().equals(other.client.getBaseURL().toString()))
return false;
return true;
}
@Override
public boolean credentialsEqual(IConnection connection) {
if(!equals(connection)) {
return false;
}
//It is safe to cast now.
Connection other = (Connection)connection;
//User name is already compared
if(!Objects.equals(password, other.password)) {
return false;
}
if(!Objects.equals(token, other.token)) {
return false;
}
return true;
}
public boolean ownsResource(IResource resource) {
if (resource == null) {
return false;
}
IClient client = resource.accept(new CapabilityVisitor<IClientCapability, IClient>() {
@Override
public IClient visit(IClientCapability capability) {
return capability.getClient();
}
}, null);
return ObjectUtils.equals(this.client, client);
}
}