Adding FMI source to MI app #5299
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,34 +16,79 @@ internal class ServiceFabricManagedIdentitySource : AbstractManagedIdentity | |
| private const string ServiceFabricMsiApiVersion = "2019-07-01-preview"; | ||
| private readonly Uri _endpoint; | ||
| private readonly string _identityHeaderValue; | ||
| private readonly bool _isFmiCredentialRequest; | ||
| private static string _mitsEndpointFmiPath => "/metadata/identity/oauth2/fmi/credential"; | ||
|
|
||
| public static AbstractManagedIdentity Create(RequestContext requestContext, bool isFmiCredentialRequest = false) | ||
| { | ||
| Uri endpointUri; | ||
| string identityEndpoint = EnvironmentVariables.IdentityEndpoint; | ||
|
|
||
| if (isFmiCredentialRequest) | ||
| { | ||
| VerifyFederatedEnvVariablesAreAvailable(); | ||
| requestContext.Logger.Info(() => "[Managed Identity] Service fabric federated managed identity is available."); | ||
| identityEndpoint = EnvironmentVariables.FmiServiceFabricEndpoint; | ||
| requestContext.Logger.Info(() => "[Managed Identity] Using FMI Service fabric endpoint."); | ||
|
|
||
| if (!Uri.TryCreate(identityEndpoint + _mitsEndpointFmiPath, UriKind.Absolute, out endpointUri)) | ||
| { | ||
| string errorMessage = string.Format(CultureInfo.InvariantCulture, MsalErrorMessage.ManagedIdentityEndpointInvalidUriError, | ||
| "APP_IDENTITY_ENDPOINT", identityEndpoint, "FMI Service Fabric"); | ||
|
|
||
| throw MsalServiceExceptionFactory.CreateManagedIdentityException( | ||
| MsalError.InvalidManagedIdentityEndpoint, | ||
| errorMessage, | ||
| null, | ||
| ManagedIdentitySource.ServiceFabric, | ||
| null); | ||
| } | ||
| } | ||
| else | ||
| { | ||
| requestContext.Logger.Info(() => "[Managed Identity] Service fabric managed identity is available."); | ||
|
|
||
| if (!Uri.TryCreate(identityEndpoint, UriKind.Absolute, out endpointUri)) | ||
| { | ||
| string errorMessage = string.Format(CultureInfo.InvariantCulture, MsalErrorMessage.ManagedIdentityEndpointInvalidUriError, | ||
| "IDENTITY_ENDPOINT", identityEndpoint, "Service Fabric"); | ||
|
|
||
| throw MsalServiceExceptionFactory.CreateManagedIdentityException( | ||
| MsalError.InvalidManagedIdentityEndpoint, | ||
| errorMessage, | ||
| null, | ||
| ManagedIdentitySource.ServiceFabric, | ||
| null); | ||
| } | ||
| } | ||
|
|
||
| requestContext.Logger.Verbose(() => $"[Managed Identity] Creating Service Fabric {(isFmiCredentialRequest ? "federated" : "")} managed identity. Endpoint URI: {identityEndpoint}"); | ||
|
|
||
| return new ServiceFabricManagedIdentitySource(requestContext, endpointUri, EnvironmentVariables.IdentityHeader, isFmiCredentialRequest); | ||
| } | ||
|
|
||
| private static void VerifyFederatedEnvVariablesAreAvailable() | ||
| { | ||
| if (string.IsNullOrEmpty(EnvironmentVariables.IdentityServerThumbprint)) | ||
| { | ||
| throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, MsalErrorMessage.ManagedIdentityFmiInvalidEnvVariableError, | ||
| "IDENTITY_SERVER_THUMBPRINT")); | ||
| } | ||
| if (string.IsNullOrEmpty(EnvironmentVariables.FmiServiceFabricEndpoint)) | ||
| { | ||
| throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, MsalErrorMessage.ManagedIdentityFmiInvalidEnvVariableError, | ||
| "APP_IDENTITY_ENDPOINT")); | ||
| } | ||
| if (string.IsNullOrEmpty(EnvironmentVariables.IdentityHeader)) | ||
| { | ||
| throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, MsalErrorMessage.ManagedIdentityFmiInvalidEnvVariableError, | ||
| "IDENTITY_HEADER")); | ||
| } | ||
| if (string.IsNullOrEmpty(EnvironmentVariables.FmiServiceFabricApiVersion)) | ||
| { | ||
| throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, MsalErrorMessage.ManagedIdentityFmiInvalidEnvVariableError, | ||
| "IDENTITY_API_VERSION", "FMI Service Fabric")); | ||
| } | ||
| } | ||
|
|
||
| internal override Func<HttpRequestMessage, X509Certificate2, X509Chain, SslPolicyErrors, bool> GetValidationCallback() | ||
|
|
@@ -62,11 +107,12 @@ private bool ValidateServerCertificateCallback(HttpRequestMessage message, X509C | |
| return string.Equals(certificate.GetCertHashString(), EnvironmentVariables.IdentityServerThumbprint, StringComparison.OrdinalIgnoreCase); | ||
| } | ||
|
|
||
| private ServiceFabricManagedIdentitySource(RequestContext requestContext, Uri endpoint, string identityHeaderValue, bool isFmi) : | ||
| base(requestContext, ManagedIdentitySource.ServiceFabric) | ||
| { | ||
| _endpoint = endpoint; | ||
| _identityHeaderValue = identityHeaderValue; | ||
| _isFmiCredentialRequest = isFmi; | ||
|
|
||
| if (requestContext.ServiceBundle.Config.ManagedIdentityId.IsUserAssigned) | ||
| { | ||
|
|
@@ -77,31 +123,43 @@ private ServiceFabricManagedIdentitySource(RequestContext requestContext, Uri en | |
| protected override ManagedIdentityRequest CreateRequest(string resource) | ||
| { | ||
| ManagedIdentityRequest request = new ManagedIdentityRequest(HttpMethod.Get, _endpoint); | ||
| request.Headers["secret"] = _identityHeaderValue; | ||
|
|
||
| if (_isFmiCredentialRequest) | ||
| { | ||
| _requestContext.Logger.Info("[Managed Identity] Request is for FMI, no ids or resource will be added to the request."); | ||
| request.QueryParameters["api-version"] = EnvironmentVariables.FmiServiceFabricApiVersion; | ||
| } | ||
| else | ||
| { | ||
| request.QueryParameters["api-version"] = ServiceFabricMsiApiVersion; | ||
| request.QueryParameters["resource"] = resource; | ||
|
|
||
| switch (_requestContext.ServiceBundle.Config.ManagedIdentityId.IdType) | ||
|
There was a problem hiding this comment. Shouldnt there be a default case? We could log the unexpected, that could give us additional information when troubleshooting. There was a problem hiding this comment. Technically yes, but this ID is a required parameter for the managed identity application. So it will always be set to something unless there is a catastrophic failure. There was a problem hiding this comment. It's still a good practice to throw an exception @trwalke on default. It will protect against a case where a new enum parameter is added. |
||
| { | ||
| case AppConfig.ManagedIdentityIdType.ClientId: | ||
| _requestContext.Logger.Info("[Managed Identity] Adding user assigned client id to the request."); | ||
| request.QueryParameters[Constants.ManagedIdentityClientId] = _requestContext.ServiceBundle.Config.ManagedIdentityId.UserAssignedId; | ||
| break; | ||
|
|
||
| case AppConfig.ManagedIdentityIdType.ResourceId: | ||
| _requestContext.Logger.Info("[Managed Identity] Adding user assigned resource id to the request."); | ||
| request.QueryParameters[Constants.ManagedIdentityResourceId] = _requestContext.ServiceBundle.Config.ManagedIdentityId.UserAssignedId; | ||
| break; | ||
|
|
||
| case AppConfig.ManagedIdentityIdType.ObjectId: | ||
| _requestContext.Logger.Info("[Managed Identity] Adding user assigned object id to the request."); | ||
| request.QueryParameters[Constants.ManagedIdentityObjectId] = _requestContext.ServiceBundle.Config.ManagedIdentityId.UserAssignedId; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| return request; | ||
| } | ||
|
|
||
| internal string GetEndpointForTesting() | ||
| { | ||
| return _endpoint.ToString(); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need an extra param here? Can't ManagedIdentity classes deal with this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, I can do that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, it is better to keep this here because there the check is needed for the experimental features to be enabled.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm ok with dropping the experimental feature flag if it leads to better design.