When using skills with user assigned managed identity , the msi endpoint fails with a 500

jamesemann commented 2 months ago

Version

Latest

Describe the bug

When using user assigned managed identity in azure app service, invoking a skill fails when requesting a token from the msi endpoint (http://127.0.0.1:41120/msi/token/?api-version=2019-08-01&resource=<redacted>&client_id=<redacted>) - which returns a HTTP 500 (with no detail) followed by the error below:

Failed to acquire token for client credentials. ([Managed Identity] Error Message: An unexpected error occurred while fetching the AAD Token. Managed Identity Correlation ID: 3b30b8c8-c05d-47d4-9e4b-c74af665aadc Use this Correlation ID for further investigation.)

To Reproduce

This is happening in our production system (where previously provisioned bots have been working), I have also reproduced it with a minimal repro on the bot builder skills sample

Clone this repo and open the samples/csharp_dotnetcore/80.skills-simple-bot-to-bot
You will need to setup the following in Azure (using the standard User assigned managed identity stuff)

An azure bot configured with User Assigned Managed Identity for the root
An azure bot configured with User Assigned Managed Identity for the child
A webapp for the root (parent), set it to use User assigned managed identity of the root bot. Also set the AZURE_CLIENT_ID application setting to point to the root bot managed identity client id .
A webapp for the child, set it to use User assigned managed identity of the child bot. Also set the AZURE_CLIENT_ID application setting to point to the child bot managed identity client id .
Set the messaging endpoints in the parent and root bot according to the sample
Now edit the appsettings in the EchoSkillBot (which will be deployed to the child webapp) to

{
  "MicrosoftAppType": "UserAssignedMSI",
  "MicrosoftAppTenantId": "<tenant id>",
  "MicrosoftAppId": "<child managed identity client id>",
  "AllowedCallers": [ "*" ]
}

Now edit the appsettings in the SimpleRootBot (which will be deployed to the root webapp) to

{

  "MicrosoftAppType": "UserAssignedMSI",
  "MicrosoftAppTenantId": "<tenant id>",
  "MicrosoftAppId": "<parent managed identity client id>",

  "SkillHostEndpoint": "https://<root webapp domain>/api/skills/",
  "BotFrameworkSkills": [
    {
      "Id": "EchoSkillBot",
      "AppId":  "<child managed identity client id>",
      "SkillEndpoint": "https://<child webapp domain>/api/messages"
    }
  ]
}

Publish both projects to their corresponding webapps
Test the parent bot in the Azure bot resource, type skill, you will see the following

ℹ️ If you look in the parent appinsights, you will see the error

Expected behavior

It should authenticate and communicate with the skill as expected.

Additional context

Please reach out if you need any further info, screen shares etc.

This is impacting a few of our customers, so is high priority for us. Thank you!

jamesemann commented 2 months ago

Hi @ceciliaavila @tracyboehrer would it be possible to triage this item? This is very high priority for our customers

tracyboehrer commented 2 months ago

@jamesemann Was this previously working in production with MSI?

jamesemann commented 2 months ago

@jamesemann Was this previously working in production with MSI?

Yes it was @tracyboehrer

tracyboehrer commented 2 months ago

@jamesemann When did it stop? Any updates to the SDK version?

jamesemann commented 2 months ago

@jamesemann When did it stop? Any updates to the SDK version?

@tracyboehrer i first spotted it yesterday as it is the first time I’ve provisioned a skill for a few weeks. No recent updates to the sdk version

jamesemann commented 2 months ago

@tracyboehrer apologies I was away from the computer yesterday so couldn't confirm the exact version. I've checked and:

our production code is using 4.21.1 (since 24th Nov 2023)
the repro using your EchoSkillBot is using 4.22.3

(I see the same behaviour in both)

tracyboehrer commented 2 months ago

@jamesemann Ya. I wouldn't expect any changes between those two versions. Was trying to isolate if a major jump in SDK version had been made. Like from 4.18 to 4.22 or something larger. We will get setup to repro. Worth noting, we haven't made any explicit changes to this. But dependency changes can be wicked on occasion.

tracyboehrer commented 2 months ago

@jamesemann How did you deploy the bots? One of us encounters a failure that matches your screenshot when they used AZ commands. I used the ARM Templates (and associated doc) and this sample appears to work normally.

jamesemann commented 2 months ago

@tracyboehrer thank you - interesting info. I created them through the Azure portal - in our product we use the Arm templates (through a template spec) though and the properties look the same.

Let me deploy a new set of resources for the sample using the Arm templates in the doc, and re-test. I'll report back as soon as possible

tracyboehrer commented 2 months ago

@jamesemann We should be able to compare here too.

jamesemann commented 2 months ago

@tracyboehrer unfortunately I'm getting the same error (HTTP 500 when requesting the managed identity token) after provisioning the resources using the templates in the bot builder repo.

It seems to be a global problem for me. One thing I haven't tried is deploying to a different Azure subscription, so I'll try that next. I'll report back with the result of that.

jamesemann commented 2 months ago

Update - same result using the arm templates on new subscription

jamesemann commented 2 months ago

@tracyboehrer I've found the underlying error when we see the HTTP 500. It is visible in the managed identity sign-in logs in Azure AD/Entra

AppId: '{appId}' can not use Managed Service Identity (MSI) as audience in token as it is unsupported. MSI should not be set as audience as it does not accept tokens.

(I can share the activity details privately, if necessary)

tracyboehrer commented 2 months ago

@jamesemann Still conferring with some about this.

jamesemann commented 1 month ago

@tracyboehrer any luck on this?

One question I did have was that the sample worked for you - did you use an existing managed identity or create a new one? One thing I have noticed is that this seems to be a problem only with recently created managed identities. We have a lot of existing managed identities for other customers and are not seeing the same behaviour.

tracyboehrer commented 1 month ago

@jamesemann I created new ones, which is what the ARM templates do. I have confirmed that our support folks can't get the Skill to work. It remains a mystery why mine do. I have confirmed both Root and Skill are MSI.

jamesemann commented 1 month ago

Hi @tracyboehrer , is there any additional context (or anything!) I can provide to help move this forward? It is unfortunately still impacting our tenant and our customers

tracyboehrer commented 1 month ago

Status at the moment is that for some it works fine. For example, I don't have an issue, and multiple internal MS groups haven't had issues switching to MSI with Skills.

jamesemann commented 1 month ago

Thank you @tracyboehrer, can you explain how that impacts the status of this ticket. For example, will it continue to be investigated?

We have several large existing customers this impacts and it will impact new customers too. This problem unfortunately doesn’t seem to be going away , so need a plan.

tracyboehrer commented 1 month ago

@jamesemann It doesn't change the status at all. Still actively being worked on.

tracyboehrer commented 1 month ago

@jamesemann These would be customers on their own tenant, correct? Microsoft in general is required to switch from secret based to UserAssignedMSI or certificate. Though some customers are moving to SingleTenant. Still secret based though.

jamesemann commented 1 month ago

Yes that is correct. We have a few app reg backed bots, mostly on our saas platform but >95% of our marketplace customers (who host an instance of our platform on their own azure tenant) have exclusively user assigned managed identity bots.

shusson commented 1 month ago

I don't have a lot of context here, but Microsoft recently started blocking MSI as Audience in a token. Tenants that were using this flow before/around April, should be on an allow list.

jamesemann commented 1 month ago

@shusson do you have a source for this? This is our suspicion too, although new MSIs on our tenant (created within the last few weeks) are failing. Existing MSIs seem ok.

tracyboehrer commented 1 month ago

@jamesemann Can you confirm that the MSI client ID is being used as the MicrosoftAppId, and the version of the SDK?

jamesemann commented 1 month ago

@tracyboehrer yes it is, and the version is 4.22.3.

It is also happening for version 4.21.1 which we have been using in production since 24th November.

tracyboehrer commented 1 month ago

@jamesemann Thanks. I wouldn't expect there to be a difference in the SDK versions, rather checking out the MSAL dependencies in use.

jamesemann commented 1 month ago

Hi @tracyboehrer

We have had an ongoing ticket with Azure support for this. We've received the following update which basically confirms our suspicion regarding MSI now being invalid as audience.

Product group was able confirm tenant "<tenant>.onmicrosoft.com" is not in the allowed list. You will need to use a different audience (service principal) for token, as MSI should not be used as audience in token.

Sharing in case of 1) It's useful info 2) Do you know how we can be added to the allow list to preserve the old behaviour?

tracyboehrer commented 1 month ago

@jamesemann I rather doubt there is a way to get on that list, and I've had this suspicion its working for some now on borrowed time. The alternative would be certificate auth. This has been confirmed to work in JS. Fix merged in DotNet, expecting a patch release this week.

jamesemann commented 1 month ago

Ok thanks @tracyboehrer . Will there also be a fix for managed identity? I am assuming (maybe incorrectly - please correct me if so) that certificate auth uses an Azure AD/Entra ID app - we have some restrictions around creating Azure AD apps in our customers tenants (we can't create them)

tracyboehrer commented 1 month ago

@jamesemann There is no known "fix" for MSI at the moment. At least in code. All of this goes through the MS auth packages. There could be other ways to configure this though.

tracyboehrer commented 1 week ago

@jamesemann Have you every captured the response from MSAL when this happens? I may have found the correct group to talk to. I believe they are going to require the response since it contains the trace and correlation ids. You can send this to me out-of-band.

jamesemann commented 1 week ago

@tracyboehrer thank you - I can definitely provide this. Can you let me how to capture it and I will prioritise getting it to you

microsoft / botbuilder-dotnet