Skip to content

Commit 4622566

Browse files
committed
- fixes an issue where authentication could hand forvever
1 parent cd5d01e commit 4622566

5 files changed

Lines changed: 41 additions & 13 deletions

File tree

‎src/main/java/com/microsoft/graph/authentication/IAuthenticationProvider.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import javax.annotation.Nonnull;
44

5+
import com.microsoft.graph.exceptions.AuthenticationException;
56
import com.microsoft.graph.httpcore.IHttpRequest;
67

78
public interface IAuthenticationProvider {
@@ -11,6 +12,6 @@ public interface IAuthenticationProvider {
1112
*
1213
* @param request the request to authenticate
1314
*/
14-
void authenticateRequest(@Nonnull final IHttpRequest request);
15+
void authenticateRequest(@Nonnull final IHttpRequest request) throws AuthenticationException;
1516

1617
}

‎src/main/java/com/microsoft/graph/authentication/ICoreAuthenticationProvider.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
import javax.annotation.Nonnull;
66

7+
import com.microsoft.graph.exceptions.AuthenticationException;
8+
79
public interface ICoreAuthenticationProvider {
810
/**
911
* Authenticates the request
@@ -12,5 +14,5 @@ public interface ICoreAuthenticationProvider {
1214
* @return Request with Authorization header added to it
1315
*/
1416
@Nonnull
15-
Request authenticateRequest(@Nonnull final Request request);
17+
Request authenticateRequest(@Nonnull final Request request) throws AuthenticationException;
1618
}

‎src/main/java/com/microsoft/graph/authentication/TokenCredentialAuthProvider.java‎

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@
55
import com.azure.core.credential.TokenRequestContext;
66
import com.microsoft.graph.exceptions.AuthenticationException;
77
import com.microsoft.graph.exceptions.Error;
8+
import com.microsoft.graph.exceptions.ErrorConstants;
89
import com.microsoft.graph.httpcore.IHttpRequest;
910
import okhttp3.Request;
1011
import com.microsoft.graph.exceptions.ErrorConstants.*;
1112

1213
import java.net.MalformedURLException;
1314
import java.net.URL;
15+
import java.time.Duration;
1416
import java.util.Arrays;
1517
import java.util.HashSet;
1618
import java.util.List;
@@ -24,6 +26,8 @@ public class TokenCredentialAuthProvider implements ICoreAuthenticationProvider
2426
private TokenCredential tokenCredential;
2527
//Context options which can be optionally set by the user
2628
private TokenRequestContext context;
29+
// maximum delay to wait for token obtention
30+
private Duration tokenBlockTimeout;
2731

2832

2933
//TODO: Upon further review from Peter, this should include a Null check in the case that this is the first request
@@ -43,6 +47,7 @@ public TokenCredentialAuthProvider(@Nonnull final TokenCredential tokenCredenti
4347

4448
this.tokenCredential = tokenCredential;
4549
this.context = new TokenRequestContext();
50+
this.tokenBlockTimeout = Duration.ofMinutes(10);
4651
}
4752

4853
/**
@@ -57,13 +62,27 @@ public TokenCredentialAuthProvider(@Nonnull final List<String> scopes, @Nonnull
5762
this.context.setScopes(scopes);
5863
}
5964

65+
/**
66+
* Creates an Authentication provider using a TokenCredential and list of scopes
67+
*
68+
* @param tokenCredential Credential object inheriting the TokenCredential interface used to instantiate the Auth Provider
69+
* @param scopes Specified desired scopes of the Auth Provider
70+
* @param tokenObtentionTimeout Maximum time to wait for token obtention. Default 10 minutes. Use lower value on application with stable connectivity and no user interactions.
71+
* @throws AuthenticationException exception occurs if the TokenCredential parameter is null
72+
*/
73+
public TokenCredentialAuthProvider(@Nonnull final List<String> scopes, @Nonnull final Duration tokenObtentionTimeout, @Nonnull final TokenCredential tokenCredential) throws AuthenticationException {
74+
this(tokenCredential);
75+
this.context.setScopes(scopes);
76+
this.tokenBlockTimeout = tokenObtentionTimeout;
77+
}
78+
6079
/**
6180
* Authenticates the request
6281
*
6382
* @param request the request to authenticate
6483
*/
6584
@Override
66-
public void authenticateRequest(@Nonnull final IHttpRequest request) {
85+
public void authenticateRequest(@Nonnull final IHttpRequest request) throws AuthenticationException {
6786
if(ShouldAuthenticateRequest(request.getRequestUrl().toString())) {
6887
request.addHeader(AuthConstants.AUTHORIZATION_HEADER, AuthConstants.BEARER + getAccessToken());
6988
}
@@ -77,7 +96,7 @@ public void authenticateRequest(@Nonnull final IHttpRequest request) {
7796
*/
7897
@Override
7998
@Nonnull
80-
public Request authenticateRequest(@Nonnull final Request request) {
99+
public Request authenticateRequest(@Nonnull final Request request) throws AuthenticationException {
81100
if(ShouldAuthenticateRequest(request.url().toString())) {
82101
return request.newBuilder()
83102
.addHeader(AuthConstants.AUTHORIZATION_HEADER, AuthConstants.BEARER + getAccessToken())
@@ -104,14 +123,12 @@ private boolean ShouldAuthenticateRequest(@Nonnull final String requestUrl) {
104123
*
105124
* @return String representing the retrieved AccessToken
106125
*/
107-
private String getAccessToken() {
108-
String accessToken = null;
126+
private String getAccessToken() throws AuthenticationException {
109127
try {
110-
AccessToken token = this.tokenCredential.getToken(this.context).block();
111-
accessToken = token.getToken();
112-
} catch (Exception e) {
113-
e.printStackTrace();
128+
final AccessToken token = this.tokenCredential.getToken(this.context).block(this.tokenBlockTimeout);
129+
return token.getToken();
130+
} catch (RuntimeException e) {
131+
throw new AuthenticationException(new Error(ErrorConstants.Codes.GeneralException, ErrorConstants.Messages.AuthTimeOut), e);
114132
}
115-
return accessToken;
116133
}
117134
}

‎src/main/java/com/microsoft/graph/exceptions/ErrorConstants.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,7 @@ public static class Codes {
1515
public static class Messages {
1616
@Nonnull
1717
public final static String NullParameter = "%s parameter cannot be null.";
18+
@Nonnull
19+
public final static String AuthTimeOut = "Authentication failed or timed out.";
1820
}
1921
}

‎src/main/java/com/microsoft/graph/httpcore/AuthenticationHandler.java‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
import java.io.IOException;
44

55
import com.microsoft.graph.authentication.ICoreAuthenticationProvider;
6+
import com.microsoft.graph.exceptions.AuthenticationException;
7+
68
import javax.annotation.Nullable;
79
import javax.annotation.Nonnull;
810

@@ -32,8 +34,12 @@ public Response intercept(@Nonnull final Chain chain) throws IOException {
3234
originalRequest = originalRequest.newBuilder().tag(TelemetryOptions.class, new TelemetryOptions()).build();
3335
originalRequest.tag(TelemetryOptions.class).setFeatureUsage(TelemetryOptions.AUTH_HANDLER_ENABLED_FLAG);
3436

35-
Request authenticatedRequest = authProvider.authenticateRequest(originalRequest);
36-
return chain.proceed(authenticatedRequest);
37+
try {
38+
final Request authenticatedRequest = authProvider.authenticateRequest(originalRequest);
39+
return chain.proceed(authenticatedRequest);
40+
} catch (AuthenticationException ex) {
41+
throw new IOException(ex);
42+
}
3743
}
3844

3945
}

0 commit comments

Comments
 (0)