Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AzureAD/microsoft-authentication-cli
A command line utility for Azure authentication.
https://github.com/AzureAD/microsoft-authentication-cli
auth authentication azure identity
Last synced: 2 months ago
JSON representation
A command line utility for Azure authentication.
- Host: GitHub
- URL: https://github.com/AzureAD/microsoft-authentication-cli
- Owner: AzureAD
- License: other
- Created: 2022-02-25T01:33:08.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T23:30:01.000Z (8 months ago)
- Last Synced: 2024-05-28T08:48:09.018Z (8 months ago)
- Topics: auth, authentication, azure, identity
- Language: C#
- Homepage:
- Size: 1.15 MB
- Stars: 37
- Watchers: 2
- Forks: 8
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# Microsoft Authentication CLI
[](https://github.com/AzureAD/microsoft-authentication-cli/actions/workflows/dotnet-test.yml)
[](https://github.com/AzureAD/microsoft-authentication-cli/releases/tag/0.9.0)
[](./LICENSE.txt)
---
`AzureAuth` is a CLI wrapper for performing AAD Authentication. It makes use of [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-dotnet) for authentication and caching.
The CLI is designed for authenticating and returning an access token for public client AAD applications. This acts like a credential provider for Azure Devops and any other [public client app](https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-client-applications).
# Platform Support
> [!WARNING]
> AzureAuth support for Ubuntu was suspended as of version 0.8.6. Please file an issue if this lack of support causes issues for you.
> [!IMPORTANT]
> At this time AzureAuth does **NOT** support headless Linux environments unless you are using device code flow.
> See [msal#3033](https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/issues/3033)
> and [#410](https://github.com/AzureAD/microsoft-authentication-cli/issues/410) for more information.
| Operating System | Integrated Windows Auth | Auth Broker Integration | Web Auth Flow | Device Code Flow | Token Caching | Multi-Account Support |
| ------------------------------------------ | ----------------------- | ----------------------- | ------------------------ | ---------------- | ------------- | ------------------------------- |
| Windows | ✅ | ✅ | ✅ | ✅ | ✅ | ⚠️ `--domain` account filtering |
| OSX (MacOS) | N/A | ⚠️ via Web Browser | ✅ | ✅ | ✅ | ⚠️ `--domain` account filtering |
| Ubuntu (Linux) | N/A | ⚠️ via Edge | ⚠️ in GUI environments | ✅ | ⚠️ in GUI environments. See [msal#3033](https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/issues/3033) | ⚠️ `--domain` account filtering |
# Installation
## Windows
On Windows we provide a PowerShell bootstrap script, which will download and extract the application to
`%LOCALAPPDATA%\Programs\AzureAuth` and automatically add the `azureauth` binary to your `$PATH`. You can set an
alternative installation location via the `$AZUREAUTH_INSTALL_DIRECTORY` environment variable. We don't currently
provide a means of downloading the latest release, so you **must** specify your desired version via the
`$AZUREAUTH_VERSION` environment variable.
To install the application, run
```powershell
# 0.9.0 is an example. See https://github.com/AzureAD/microsoft-authentication-cli/releases for the latest.
$env:AZUREAUTH_VERSION = '0.9.0'
$script = "${env:TEMP}\install.ps1"
$url = "https://raw.githubusercontent.com/AzureAD/microsoft-authentication-cli/${env:AZUREAUTH_VERSION}/install/install.ps1"
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Invoke-WebRequest $url -OutFile $script; if ($?) { &$script }; if ($?) { rm $script }
```
**Note**: The script does not signal currently running processes to update their environments, so you'll need to
relaunch applications before the `$PATH` changes take effect.
**Note**: Uninstalling can be done with the uninstallation script. [Read more](docs/uninstall.md)
## macOS
On macOS we provide a shell bootstrap script, which will download and extract the application to `$HOME/.azureauth`
and automatically add the `azureauth` binary to your `$PATH`. You can set an alternative installation location via the
`$AZUREAUTH_INSTALL_DIRECTORY` environment variable. We don't currently provide a means of downloading the latest
release, so you **must** specify your desired version via the `$AZUREAUTH_VERSION` environment variable.
To install the application, run
```bash
# 0.9.0 is an example. See https://github.com/AzureAD/microsoft-authentication-cli/releases for the latest.
export AZUREAUTH_VERSION='0.9.0'
curl -sL https://raw.githubusercontent.com/AzureAD/microsoft-authentication-cli/$AZUREAUTH_VERSION/install/install.sh | sh
```
**Note**: The script currently only updates the `$PATH` in `~/.bashrc` and `~/.zshrc`. It does not update the environment
of currently running processes, so you'll need to relaunch applications (or source your shell profile) before the `$PATH`
changes take effect.
# Using AzureAuth
Instructions on using AzureAuth CLI in your applications are available [here](docs/usage.md).
# Data Collection Is Off By Default
No telemetry will be collected unless you set the `AZUREAUTH_APPLICATION_INSIGHTS_INGESTION_TOKEN` environment variable
or the registry key `ApplicationInsightsIngestionToken` under `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\AzureAuth`
to a valid [Application Insights](https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview)
ingestion token.
If you choose to turn data collection on, the software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use
this information to provide services and improve our products and services. You may turn off the telemetry as described
in the repository. There are also some features in the software that may enable you and Microsoft to collect data from
users of your applications. If you use these features, you must comply with applicable law, including providing
appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy
statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and
use in the help documentation and our privacy statement. Your use of the software operates as your consent to these
practices.
# Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow [Microsoft’s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft
sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.