Skip to content

Commit 97190a8

Browse files
fadidurahfadidurah
committed
update lab calling pattern
1 parent 41f79a1 commit 97190a8

File tree

19 files changed

+684
-73
lines changed

19 files changed

+684
-73
lines changed

‎LabApiUtilities/src/main/com/microsoft/identity/labapi/utilities/client/ILabClient.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,13 @@ public interface ILabClient {
8989
String getPasswordForGuestUser(final LabGuestAccount guestUser) throws LabApiException;
9090

9191
/**
92-
* Get the value of a secret from Lab Api. This primarily includes secrets like passwords for
93-
* accounts but may also be used for any other secret that the Lab has stored in their KeyVault.
92+
* Get a secret from the MSIDLABS KeyVault
9493
*
9594
* @param secretName the name (identifier) of the secret that should be loaded
9695
* @return a String containing the value of the secret
9796
* @throws LabApiException if an error occurs while trying to load secret from lab
9897
*/
99-
String getSecret(String secretName) throws LabApiException;
98+
String getKeyVaultSecret(String secretName) throws LabApiException;
10099

101100
/**
102101
* Reset the password for the username given, then reset it back to the original password.

‎LabApiUtilities/src/main/com/microsoft/identity/labapi/utilities/client/LabClient.java‎

Lines changed: 46 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,24 @@
2222
// THE SOFTWARE.
2323
package com.microsoft.identity.labapi.utilities.client;
2424

25+
import static com.microsoft.identity.labapi.utilities.constants.LabConstants.DEFAULT_LAB_CLIENT_ID;
26+
import static com.microsoft.identity.labapi.utilities.constants.LabConstants.KEYVAULT_SCOPE;
27+
2528
import com.microsoft.identity.internal.test.labapi.ApiException;
2629
import com.microsoft.identity.internal.test.labapi.Configuration;
2730
import com.microsoft.identity.internal.test.labapi.api.ConfigApi;
2831
import com.microsoft.identity.internal.test.labapi.api.CreateTempUserApi;
2932
import com.microsoft.identity.internal.test.labapi.api.DeleteDeviceApi;
3033
import com.microsoft.identity.internal.test.labapi.api.DisablePolicyApi;
3134
import com.microsoft.identity.internal.test.labapi.api.EnablePolicyApi;
32-
import com.microsoft.identity.internal.test.labapi.api.LabSecretApi;
35+
import com.microsoft.identity.internal.test.labapi.api.KeyVaultSecretsApi;
3336
import com.microsoft.identity.internal.test.labapi.api.ResetApi;
3437
import com.microsoft.identity.internal.test.labapi.model.ConfigInfo;
3538
import com.microsoft.identity.internal.test.labapi.model.CustomSuccessResponse;
36-
import com.microsoft.identity.internal.test.labapi.model.SecretResponse;
39+
import com.microsoft.identity.internal.test.labapi.model.SecretBundle;
3740
import com.microsoft.identity.internal.test.labapi.model.TempUser;
3841
import com.microsoft.identity.internal.test.labapi.model.UserInfo;
42+
import com.microsoft.identity.labapi.utilities.BuildConfig;
3943
import com.microsoft.identity.labapi.utilities.authentication.LabApiAuthenticationClient;
4044
import com.microsoft.identity.labapi.utilities.constants.ProtectionPolicy;
4145
import com.microsoft.identity.labapi.utilities.constants.TempUserType;
@@ -57,6 +61,9 @@
5761
public class LabClient implements ILabClient {
5862

5963
private final LabApiAuthenticationClient mLabApiAuthenticationClient;
64+
private final LabApiAuthenticationClient mLabApiAuthenticationClientForKeyVault = new LabApiAuthenticationClient(
65+
BuildConfig.LAB_CLIENT_SECRET, KEYVAULT_SCOPE, DEFAULT_LAB_CLIENT_ID
66+
);
6067
private final long PASSWORD_RESET_WAIT_DURATION = TimeUnit.SECONDS.toMillis(65);
6168
private final long LAB_API_RETRY_WAIT = TimeUnit.SECONDS.toMillis(5);
6269

@@ -145,7 +152,7 @@ private ILabAccount getLabAccountObject(@NonNull final ConfigInfo configInfo) th
145152
}
146153

147154
private List<ConfigInfo> fetchConfigsFromLab(@NonNull final String upn) throws LabApiException {
148-
Configuration.getDefaultApiClient().setAccessToken(
155+
Configuration.getLabUserFetchApiClient().setAccessToken(
149156
mLabApiAuthenticationClient.getAccessToken()
150157
);
151158
try {
@@ -157,7 +164,7 @@ private List<ConfigInfo> fetchConfigsFromLab(@NonNull final String upn) throws L
157164
}
158165

159166
public List<ConfigInfo> fetchConfigsFromLab(@NonNull final LabQuery query) throws LabApiException {
160-
Configuration.getDefaultApiClient().setAccessToken(
167+
Configuration.getLabUserFetchApiClient().setAccessToken(
161168
mLabApiAuthenticationClient.getAccessToken()
162169
);
163170
try {
@@ -222,7 +229,10 @@ private ILabAccount createTempAccountInternal(@NonNull final TempUserType tempUs
222229
mLabApiAuthenticationClient.getAccessToken()
223230
);
224231

225-
final CreateTempUserApi createTempUserApi = new CreateTempUserApi();
232+
final String createTempUserFunctionCode = getKeyVaultSecret(
233+
CreateTempUserApi.AZURE_FUNCTION_CODE_SECRET_NAME
234+
);
235+
final CreateTempUserApi createTempUserApi = new CreateTempUserApi(createTempUserFunctionCode);
226236
createTempUserApi.getApiClient().setReadTimeout(TEMP_USER_API_READ_TIMEOUT);
227237
final TempUser tempUser;
228238

@@ -279,7 +289,7 @@ public String getPasswordForGuestUser(LabGuestAccount guestUser) throws LabApiEx
279289

280290
// Adding a second attempt here, api sometimes fails to get the lab secret.
281291
try {
282-
return getSecret(labName);
292+
return getKeyVaultSecret(labName);
283293
} catch (final LabApiException e){
284294
if (e.getErrorCode().equals(LabError.FAILED_TO_GET_SECRET_FROM_LAB)){
285295

@@ -291,23 +301,23 @@ public String getPasswordForGuestUser(LabGuestAccount guestUser) throws LabApiEx
291301
}
292302

293303
// Try to get the secret again
294-
return getSecret(labName);
304+
return getKeyVaultSecret(labName);
295305
} else {
296306
throw e;
297307
}
298308
}
299309
}
300310

301311
@Override
302-
public String getSecret(@NonNull final String secretName) throws LabApiException {
303-
Configuration.getDefaultApiClient().setAccessToken(
304-
mLabApiAuthenticationClient.getAccessToken()
312+
public String getKeyVaultSecret(@NonNull final String secretName) throws LabApiException {
313+
Configuration.getKeyVaultApiClient().setAccessToken(
314+
mLabApiAuthenticationClientForKeyVault.getAccessToken()
305315
);
306-
final LabSecretApi labSecretApi = new LabSecretApi();
316+
final KeyVaultSecretsApi keyVaultSecretsApi = new KeyVaultSecretsApi();
307317

308318
try {
309-
final SecretResponse secretResponse = labSecretApi.apiLabSecretGet(secretName);
310-
return secretResponse.getValue();
319+
final SecretBundle secretBundle = keyVaultSecretsApi.getKeyVaultSecret(secretName, "", "");
320+
return secretBundle.getValue();
311321
} catch (final com.microsoft.identity.internal.test.labapi.ApiException ex) {
312322
throw new LabApiException(LabError.FAILED_TO_GET_SECRET_FROM_LAB, ex);
313323
}
@@ -320,7 +330,10 @@ public boolean deleteDevice(@NonNull final String upn,
320330
mLabApiAuthenticationClient.getAccessToken()
321331
);
322332

323-
final DeleteDeviceApi deleteDeviceApi = new DeleteDeviceApi();
333+
final String deleteDeviceFunctionCode = getKeyVaultSecret(
334+
DeleteDeviceApi.AZURE_FUNCTION_CODE_SECRET_NAME
335+
);
336+
final DeleteDeviceApi deleteDeviceApi = new DeleteDeviceApi(deleteDeviceFunctionCode);
324337

325338
try {
326339
final CustomSuccessResponse successResponse = deleteDeviceApi.apiDeleteDeviceDelete(
@@ -397,13 +410,12 @@ private String getPassword(@NonNull final TempUser tempUser) throws LabApiExcept
397410
return getPassword(tempUser.getCredentialVaultKeyName());
398411
}
399412

400-
private String getPassword(final String credentialVaultKeyName) throws LabApiException {
413+
public String getPassword(final String credentialVaultKeyName) throws LabApiException {
401414
final String secretName = getLabSecretName(credentialVaultKeyName);
402415

403-
// Adding a second attempt here, api sometimes fails to get the lab secret.
404416
try {
405-
return getSecret(secretName);
406-
} catch (final LabApiException e){
417+
return getKeyVaultSecret(secretName);
418+
} catch (final LabApiException e) {
407419
if (e.getErrorCode().equals(LabError.FAILED_TO_GET_SECRET_FROM_LAB)){
408420

409421
// Wait for a bit
@@ -414,7 +426,7 @@ private String getPassword(final String credentialVaultKeyName) throws LabApiExc
414426
}
415427

416428
// Try to get the secret again
417-
return getSecret(secretName);
429+
return getKeyVaultSecret(secretName);
418430
} else {
419431
throw e;
420432
}
@@ -423,7 +435,10 @@ private String getPassword(final String credentialVaultKeyName) throws LabApiExc
423435

424436
@Override
425437
public boolean resetPassword(@NonNull final String upn) throws LabApiException {
426-
final ResetApi resetApi = new ResetApi();
438+
final String resetApiFunctionCode = getKeyVaultSecret(
439+
ResetApi.AZURE_FUNCTION_CODE_SECRET_NAME
440+
);
441+
final ResetApi resetApi = new ResetApi(resetApiFunctionCode);
427442
try {
428443
final CustomSuccessResponse resetResponse = resetApi.apiResetPut(upn, ResetOperation.PASSWORD.toString());
429444
if (resetResponse == null) {
@@ -494,7 +509,13 @@ private String getLabSecretName(final String credentialVaultKeyName) {
494509
* @return boolean value indicating policy enabled or not.
495510
*/
496511
public boolean enablePolicy(@NonNull final String upn, @NonNull final ProtectionPolicy policy) throws LabApiException {
497-
final EnablePolicyApi enablePolicyApi = new EnablePolicyApi();
512+
Configuration.getDefaultApiClient().setAccessToken(
513+
mLabApiAuthenticationClient.getAccessToken()
514+
);
515+
final String enablePolicyFunctionCode = getKeyVaultSecret(
516+
EnablePolicyApi.AZURE_FUNCTION_CODE_SECRET_NAME
517+
);
518+
final EnablePolicyApi enablePolicyApi = new EnablePolicyApi(enablePolicyFunctionCode);
498519
try {
499520
final CustomSuccessResponse enablePolicyResult = enablePolicyApi.apiEnablePolicyPut(upn, policy.toString());
500521
final String expectedResult = (policy + " Enabled for user : " + upn).toLowerCase();
@@ -516,7 +537,10 @@ public boolean enablePolicy(@NonNull final String upn, @NonNull final Protection
516537
* @return boolean value indicating policy is disabled or not for the upn.
517538
*/
518539
public boolean disablePolicy(@NonNull final String upn, @NonNull final ProtectionPolicy policy) throws LabApiException {
519-
final DisablePolicyApi disablePolicyApi = new DisablePolicyApi();
540+
final String disablePolicyFunctionCode = getKeyVaultSecret(
541+
DisablePolicyApi.AZURE_FUNCTION_CODE_SECRET_NAME
542+
);
543+
final DisablePolicyApi disablePolicyApi = new DisablePolicyApi(disablePolicyFunctionCode);
520544
try {
521545
final CustomSuccessResponse disablePolicyResponse = disablePolicyApi.apiDisablePolicyPut(upn, policy.toString());
522546
final String expectedResult = (policy + " Disabled for user : " + upn).toLowerCase();

‎LabApiUtilities/src/test/com/microsoft/identity/labapi/utilities/client/LabClientTest.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
import org.junit.After;
3434
import org.junit.Assert;
3535
import org.junit.Before;
36+
import org.junit.Ignore;
3637
import org.junit.Rule;
3738
import org.junit.Test;
3839

@@ -170,6 +171,7 @@ public void canCreateMAMCATempUser() {
170171
}
171172

172173
@Test
174+
@Ignore
173175
public void canResetPassword() {
174176
try {
175177
final ILabAccount labAccount = mLabClient.createTempAccount(TempUserType.BASIC);
@@ -181,6 +183,7 @@ public void canResetPassword() {
181183
}
182184

183185
@Test
186+
@Ignore
184187
public void canEnablePolicy() {
185188
try {
186189
final ILabAccount labAccount = mLabClient.createTempAccount(TempUserType.BASIC);
@@ -192,6 +195,7 @@ public void canEnablePolicy() {
192195
}
193196

194197
@Test
198+
@Ignore
195199
public void canDisablePolicy() {
196200
try {
197201
final ILabAccount labAccount = mLabClient.createTempAccount(TempUserType.MAM_CA);

‎labapi/src/main/java/com/microsoft/identity/internal/test/labapi/ApiClient.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@
5151

5252
public class ApiClient {
5353

54+
public static final String LAB_BASE_PATH = "https://labusermanagerapi.azurewebsites.net";
55+
public static final String USER_FETCH_BASE_PATH = "https://msidlab.com";
5456
private final String AUTH_TYPE = "Access Token";
55-
56-
private static final String DEFAULT_BASE_PATH = "https://msidlab.com";
5757
private String basePath;
5858
private boolean debugging = false;
5959
private Map<String, String> defaultHeaderMap = new HashMap<String, String>();
@@ -78,7 +78,7 @@ public class ApiClient {
7878
* No-parameter constructor will use default Base Path.
7979
*/
8080
public ApiClient() {
81-
this(DEFAULT_BASE_PATH);
81+
this("");
8282
}
8383

8484
/*

‎labapi/src/main/java/com/microsoft/identity/internal/test/labapi/Configuration.java‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,13 @@
1212

1313
package com.microsoft.identity.internal.test.labapi;
1414

15+
import static com.microsoft.identity.internal.test.labapi.ApiClient.LAB_BASE_PATH;
16+
import static com.microsoft.identity.internal.test.labapi.ApiClient.USER_FETCH_BASE_PATH;
17+
1518
@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-06-01T10:19:44.716-07:00[America/Los_Angeles]")public class Configuration {
16-
private static ApiClient defaultApiClient = new ApiClient();
19+
private static ApiClient defaultApiClient = new ApiClient(LAB_BASE_PATH);
20+
private static ApiClient labUserFetchApiClient = new ApiClient(USER_FETCH_BASE_PATH);
21+
private static ApiClient keyVaultApiClient = new ApiClient();
1722

1823
/**
1924
* Get the default API client, which would be used when creating API
@@ -25,6 +30,13 @@ public static ApiClient getDefaultApiClient() {
2530
return defaultApiClient;
2631
}
2732

33+
public static ApiClient getKeyVaultApiClient() {
34+
return keyVaultApiClient;
35+
}
36+
37+
public static ApiClient getLabUserFetchApiClient() {
38+
return labUserFetchApiClient;
39+
}
2840
/**
2941
* Set the default API client, which would be used when creating API
3042
* instances without providing an API client.

‎labapi/src/main/java/com/microsoft/identity/internal/test/labapi/api/ConfigApi.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public class ConfigApi {
3939
private ApiClient apiClient;
4040

4141
public ConfigApi() {
42-
this(Configuration.getDefaultApiClient());
42+
this(Configuration.getLabUserFetchApiClient());
4343
}
4444

4545
public ConfigApi(ApiClient apiClient) {

‎labapi/src/main/java/com/microsoft/identity/internal/test/labapi/api/CreateTempUserApi.java‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,16 @@
3737

3838
public class CreateTempUserApi {
3939
private ApiClient apiClient;
40+
private final String mAzureFunctionCode;
41+
public static final String AZURE_FUNCTION_CODE_SECRET_NAME = "CreateTempUser";
4042

41-
public CreateTempUserApi() {
42-
this(Configuration.getDefaultApiClient());
43+
public CreateTempUserApi(final String azureFunctionCode) {
44+
this(Configuration.getDefaultApiClient(), azureFunctionCode);
4345
}
4446

45-
public CreateTempUserApi(ApiClient apiClient) {
47+
public CreateTempUserApi(final ApiClient apiClient, final String azureFunctionCode) {
4648
this.apiClient = apiClient;
49+
mAzureFunctionCode = azureFunctionCode;
4750
}
4851

4952
public ApiClient getApiClient() {
@@ -73,6 +76,8 @@ public com.squareup.okhttp.Call apiCreateTempUserPostCall(String usertype, final
7376
if (usertype != null)
7477
localVarQueryParams.addAll(apiClient.parameterToPair("usertype", usertype));
7578

79+
localVarQueryParams.addAll(apiClient.parameterToPair("code", mAzureFunctionCode));
80+
7681
Map<String, String> localVarHeaderParams = new HashMap<String, String>();
7782

7883
Map<String, Object> localVarFormParams = new HashMap<String, Object>();

‎labapi/src/main/java/com/microsoft/identity/internal/test/labapi/api/DeleteDeviceApi.java‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,16 @@
3737

3838
public class DeleteDeviceApi {
3939
private ApiClient apiClient;
40+
private final String mAzureFunctionCode;
41+
public static final String AZURE_FUNCTION_CODE_SECRET_NAME = "DeleteDevice";
4042

41-
public DeleteDeviceApi() {
42-
this(Configuration.getDefaultApiClient());
43+
public DeleteDeviceApi(final String azureFunctionCode) {
44+
this(Configuration.getDefaultApiClient(), azureFunctionCode);
4345
}
4446

45-
public DeleteDeviceApi(ApiClient apiClient) {
47+
public DeleteDeviceApi(ApiClient apiClient, final String azureFunctionCode) {
4648
this.apiClient = apiClient;
49+
mAzureFunctionCode = azureFunctionCode;
4750
}
4851

4952
public ApiClient getApiClient() {
@@ -76,6 +79,8 @@ public com.squareup.okhttp.Call apiDeleteDeviceDeleteCall(String upn, String dev
7679
if (deviceid != null)
7780
localVarQueryParams.addAll(apiClient.parameterToPair("deviceid", deviceid));
7881

82+
localVarQueryParams.addAll(apiClient.parameterToPair("code", mAzureFunctionCode));
83+
7984
Map<String, String> localVarHeaderParams = new HashMap<String, String>();
8085

8186
Map<String, Object> localVarFormParams = new HashMap<String, Object>();

‎labapi/src/main/java/com/microsoft/identity/internal/test/labapi/api/DisablePolicyApi.java‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,16 @@
3636

3737
public class DisablePolicyApi {
3838
private ApiClient apiClient;
39+
private final String mAzureFunctionCode;
40+
public static final String AZURE_FUNCTION_CODE_SECRET_NAME = "DisablePolicy";
3941

40-
public DisablePolicyApi() {
41-
this(Configuration.getDefaultApiClient());
42+
public DisablePolicyApi(final String azureFunctionCode) {
43+
this(Configuration.getDefaultApiClient(), azureFunctionCode);
4244
}
4345

44-
public DisablePolicyApi(ApiClient apiClient) {
46+
public DisablePolicyApi(ApiClient apiClient, final String azureFunctionCode) {
4547
this.apiClient = apiClient;
48+
mAzureFunctionCode = azureFunctionCode;
4649
}
4750

4851
public ApiClient getApiClient() {
@@ -75,6 +78,8 @@ public com.squareup.okhttp.Call apiDisablePolicyPutCall(String upn, String polic
7578
if (policy != null)
7679
localVarQueryParams.addAll(apiClient.parameterToPair("policy", policy));
7780

81+
localVarQueryParams.addAll(apiClient.parameterToPair("code", mAzureFunctionCode));
82+
7883
Map<String, String> localVarHeaderParams = new HashMap<String, String>();
7984

8085
Map<String, Object> localVarFormParams = new HashMap<String, Object>();

0 commit comments

Comments
 (0)