Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Now in preview] Add support for Azure AD service Principals #506

Closed
jessehouwing opened this issue Jul 2, 2023 · 19 comments
Closed

[Now in preview] Add support for Azure AD service Principals #506

jessehouwing opened this issue Jul 2, 2023 · 19 comments

Comments

@jessehouwing
Copy link
Collaborator

jessehouwing commented Jul 2, 2023 •
edited
Loading

I've created a sample workflow that uses a AzureCLI step to overwrite the PAT with a OIDC job token:

https://jessehouwing.net/publish-azure-devops-extensions-using-workload-identity-oidc/

In the future I want to move that functionality straight into the task.
@pownkel
Copy link

pownkel commented Mar 22, 2024

+1, PAT tokens must be rotated manually and long-lived PATs are a potential security risk. My team would find it very helpful if there was a built-in way to use AD/Entra tokens for these tasks.

@michvllni
Copy link

+1, especially now as MSI and service principal authentication are out of preview in Azure DevOps

@jessehouwing
Copy link
Collaborator Author

@michvllni Make sure you check out the blog, it allows you to already switch over.

@smfields
Copy link

smfields commented May 3, 2024

@jessehouwing there are some scenarios where overriding service connection values using task.setendpoint is blocked due to restricted commands.

It would be really great to have this as part of the task itself for those scenarios where the workaround doesn't work.

@madalynrose madalynrose mentioned this issue May 9, 2024
Merged
1 task
madalynrose added a commit to microsoft/accessibility-insights-action that referenced this issue May 20, 2024
@madalynrose
chore: update publishing pipelines to use federated credentials inste…
47c93b1 
…ad of PATs and client secrets (#2082)

#### Details

Our release pipelines for the ADO extension utilize a Visual Studio
Marketplace Service Connection with a PAT to publish to the Visual
Studio Marketplace. This PR creates a new template task
(`generate-vs-marketplace-token.yaml`) that uses AzureCLI to generate an
access token for that service connection to use instead. This template
is then used directly before the tasks that involve the VS Marketplace
SC (the `QueryVersion` task in `package-vsix-file.yaml` and the
`PublishAzureDevOpsExtension` task in `publish-vsix-file.yaml`).

Additionally, this PR implements the new ESRP signing task that uses
managed identity with federated credentials instead of client secrets to
authenticate.

It also deletes the yaml file for the pipeline that creates a new ESRP
service connection since that type of service connection is no longer
used in the signing task and we won't need to regenerate the entire SC
during secret rotation anymore.

##### Motivation

Security improvements

##### Context

This solution for removing PAT usage in the VS Marketplace Publishing
step was based on [this
workflow](https://jessehouwing.net/publish-azure-devops-extensions-using-workload-identity-oidc/),
linked from [this
issue](microsoft/azure-devops-extension-tasks#506)
in microsoft/azure-devops-extension-tasks.

These changes coincide with the addition of the following new variables
to the pipeline in ADO (documenting here in case they ever need to be
changed):
`linuxImage`: the name of the linux image in the hosted pool to be used
for this pipeline (currently set to `ubuntu-22.04-secure`)
`MARKETPLACE_RESOURCE_ID`: the resource ID of the VS Marketplace SC
`esrp-app-registration-client-id`: the client ID of the ESRP Signing app
registration
`esrp-app-registration-tenant-id`: the tenant where the ESRP Signing app
registration lives

#### Pull request checklist
<!-- If a checklist item is not applicable to this change, write "n/a"
in the checkbox -->
- [n/a] Addresses an existing issue: Fixes #0000
- [n/a] Added relevant unit test for your changes. (`yarn test`)
- [n/a] Verified code coverage for the changes made. Check coverage
report at: `<rootDir>/test-results/unit/coverage`
- [x] Ran precheckin (`yarn precheckin`)
@tintse-thxsky-MSFT
Copy link

Is there an ETA for merging 204ae18 to main branch? This help for those that uses version query.

@jessehouwing
Copy link
Collaborator Author

Is there an ETA for merging 204ae18 to main branch? This help for those that uses version query.

Version query should work fine with the workaround described in my blog.

I originally started with this hack, but I don't want to support yet another sneak-solution to infinity.

@tintse-thxsky-MSFT
Copy link

@jessehouwing Yea the workaround in your blog is helpful, but for me the setendpoint doesn't work. I suspect it is because my WIF is connecting to a different tenant. And due to policy/design I can't move the service principal to the same tenant with my azure devops.

@jessehouwing
Copy link
Collaborator Author

Then the environment variables override isn't going to help you I'm afraid.

@winstliu
Copy link
Member

winstliu commented May 24, 2024 •
edited
Loading

From the public preview blog post, it looks like Azure is the only service connection that supports WIF right now.
With that in mind, @jessehouwing do you think it would make sense to create a new major version of the tasks that also allow AzureRM service connections? (I could take a stab at this)

@jessehouwing
Copy link
Collaborator Author

jessehouwing commented May 24, 2024 •
edited
Loading

I'd love that. There is an existing npm package that already contains all the magic to get the access token.

https://github.com/microsoft/azure-pipelines-tasks-common-packages/tree/main/common-npm-packages/artifacts-common

Ideally the Azure DevOps Service connection would have an option to select Azure or the existing service connection and optionally a text box for a token input.

Be sure to set the defaults in such a way that existing tasks don't break.

@winstliu winstliu mentioned this issue May 28, 2024
Closed
@jessehouwing
Copy link
Collaborator Author

Just merged #905 through #906. Made a few more changes. Awaiting publication of test builds. Thanks @50Wliu <3

@tintse-thxsky-MSFT
Copy link

@jessehouwing Sorry I am not familiar with the flow of release of this task. When will the v5 be available to use? Can't wait to use it :)

@jessehouwing
Copy link
Collaborator Author

First pipelines now running v5. Doing a bit more testing, then shipping tomorrow

jessehouwing/azure-pipelines-variable-tasks@a994947
https://dev.azure.com/jessehouwing/azure-devops-extensions/_build/results?buildId=5743&view=results

@jessehouwing
Copy link
Collaborator Author

jessehouwing commented Jun 12, 2024 •
edited
Loading

Shipped: https://github.com/microsoft/azure-devops-extension-tasks/releases/tag/v5.0.37
Marketplace: https://marketplace.visualstudio.com/items?itemName=ms-devlabs.vsts-developer-tools-build-tasks
Sample workflow: https://github.com/jessehouwing/azure-pipelines-variable-tasks/blob/main/azure-pipelines.yml

@jessehouwing
Copy link
Collaborator Author

Please upgrade your projects and report back with any issues you find.

@jessehouwing jessehouwing changed the title Add support for Azure AD service Principals [Now in preview] Add support for Azure AD service Principals Jun 13, 2024
@winstliu
Copy link
Member

Hmm. I successfully log in, but then I get ##[error]__dirname is not defined when trying to publish a VS extension.

@winstliu
Copy link
Member

Oh, because https://github.com/microsoft/azure-devops-extension-tasks/blob/main/BuildTasks/PublishVSExtension/v5/Utils.ts#L10. I'll send in a PR later.

@jessehouwing
Copy link
Collaborator Author

@winstliu
Copy link
Member

With 5.0.65 I was able to publish both a VS & ADO extension to the Marketplace 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Allow authentication using Azure service connections winstliu/azure-devops-extension-tasks
6 participants
@winstliu @jessehouwing @michvllni @smfields @pownkel @tintse-thxsky-MSFT