|
| 1 | +# Azure Identity Brokered Authentication client library for .NET |
| 2 | + The library extends the Azure.Identity library to provide authentication broker support. It includes the necessary dependencies, and provides the `InteractiveBrowserCredentialBrokerOptions` class. This options class can be used to create an `InteractiveBrowserCredential` capable of using the system authentication broker in lieu of the system browser when available. |
| 3 | + |
| 4 | + [Source code][source] | [Package (nuget)][package] | [API reference documentation][identity_api_docs] | [Azure Active Directory documentation][aad_doc] |
| 5 | + |
| 6 | +## Getting started |
| 7 | + |
| 8 | +### Install the package |
| 9 | + |
| 10 | +Install the Azure Identity client library for .NET with [NuGet][nuget]: |
| 11 | + |
| 12 | +```PowerShell |
| 13 | +dotnet add package Azure.Identity.BrokeredAuthentication --prerelease |
| 14 | +``` |
| 15 | + |
| 16 | +### Prerequisites |
| 17 | +* The [Azure.Identity][azure_identity] library is a dependency of Azure.Identity.BrokeredAuthentication. |
| 18 | + |
| 19 | +### Authenticate the client |
| 20 | + |
| 21 | +## Key concepts |
| 22 | + |
| 23 | +## Examples |
| 24 | + |
| 25 | +### Configuring the `InteractiveBrowserCredential` to use the system authentication broker |
| 26 | + |
| 27 | +This example demonstrates configuring the `InteractiveBrowserCredential` with the specialized options type `InteractiveBrowserCredentialBrokerOptions` to enable brokered authentication. |
| 28 | + |
| 29 | +```C# Snippet:ConfigureInteractiveBrowserToUseBroker |
| 30 | +// Create an interactive browser credential which will use the system authentication broker |
| 31 | +var credential = new InteractiveBrowserCredential(new InteractiveBrowserCredentialBrokerOptions()); |
| 32 | + |
| 33 | +// Use the credential to authenticate a secret client |
| 34 | +var client = new SecretClient(new Uri("https://myvault.vault.azure.net/"), credential); |
| 35 | +``` |
| 36 | + |
| 37 | +## Troubleshooting |
| 38 | + |
| 39 | +See the [troubleshooting guide](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios. |
| 40 | + |
| 41 | +### Error Handling |
| 42 | +Errors arising from authentication can be raised on any service client method which makes a request to the service. This is because the first time the token is requested from the credential is on the first call to the service, and any subsequent calls might need to refresh the token. In order to distinguish these failures from failures in the service client Azure Identity classes raise the `AuthenticationFailedException` with details to the source of the error in the exception message as well as possibly the error message. Depending on the application these errors may or may not be recoverable. |
| 43 | + |
| 44 | +``` c# |
| 45 | +using Azure.Identity; |
| 46 | +using Azure.Security.KeyVault.Secrets; |
| 47 | + |
| 48 | +// Create a secret client using the DefaultAzureCredential |
| 49 | +var client = new SecretClient(new Uri("https://myvault.vault.azure.net/"), new DefaultAzureCredential()); |
| 50 | + |
| 51 | +try |
| 52 | +{ |
| 53 | + KeyVaultSecret secret = await client.GetSecretAsync("secret1"); |
| 54 | +} |
| 55 | +catch (AuthenticationFailedException e) |
| 56 | +{ |
| 57 | + Console.WriteLine($"Authentication Failed. {e.Message}"); |
| 58 | +} |
| 59 | +``` |
| 60 | + |
| 61 | +For more details on dealing with errors arising from failed requests to Azure Active Directory, or managed identity endpoints please refer to the Azure Active Directory [documentation on authorization error codes][aad_err_doc]. |
| 62 | + |
| 63 | +### Logging |
| 64 | + |
| 65 | +The Azure Identity library provides the same [logging capabilities](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md#logging) as the rest of the Azure SDK. |
| 66 | + |
| 67 | +The simplest way to see the logs to help debug authentication issues is to enable the console logging. |
| 68 | + |
| 69 | +``` c# |
| 70 | +// Setup a listener to monitor logged events. |
| 71 | +using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(); |
| 72 | +``` |
| 73 | + |
| 74 | +All credentials can be configured with diagnostic options, in the same way as other clients in the SDK. |
| 75 | + |
| 76 | +``` c# |
| 77 | +DefaultAzureCredentialOptions options = new DefaultAzureCredentialOptions() |
| 78 | +{ |
| 79 | + Diagnostics = |
| 80 | + { |
| 81 | + LoggedHeaderNames = { "x-ms-request-id" }, |
| 82 | + LoggedQueryParameters = { "api-version" }, |
| 83 | + IsLoggingContentEnabled = true |
| 84 | + } |
| 85 | +}; |
| 86 | +``` |
| 87 | + |
| 88 | +> CAUTION: Requests and responses in the Azure Identity library contain sensitive information. Precaution must be taken to protect logs when customizing the output to avoid compromising account security. |
| 89 | +
|
| 90 | +### Thread safety |
| 91 | +We guarantee that all credential instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). |
| 92 | +This ensures that the recommendation of reusing credential instances is always safe, even across threads. |
| 93 | + |
| 94 | +### Additional concepts |
| 95 | +[Client options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | |
| 96 | +[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | |
| 97 | +[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md) | |
| 98 | +[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#mocking) | |
| 99 | +[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) |
| 100 | + |
| 101 | +## Next steps |
| 102 | + |
| 103 | +### Client libraries supporting authentication with Azure Identity |
| 104 | + |
| 105 | +Many of the client libraries listed [here](https://azure.github.io/azure-sdk/releases/latest/dotnet.html) support authenticating with `TokenCredential` and the Azure Identity library. |
| 106 | +There you will also find links where you can learn more about their use, including additional documentation and samples. |
| 107 | + |
| 108 | +### Known Issues |
| 109 | + |
| 110 | +This library does not currently support scenarios relating to the [AAD B2C](https://docs.microsoft.com/azure/active-directory-b2c/overview) service. |
| 111 | + |
| 112 | +Currently open issues for the Azure.Identity library can be found [here](https://github.com/Azure/azure-sdk-for-net/issues?q=is%3Aissue+is%3Aopen+label%3AAzure.Identity). |
| 113 | + |
| 114 | +## Contributing |
| 115 | +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. |
| 116 | + |
| 117 | +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. |
| 118 | + |
| 119 | +This project has adopted the [Microsoft Open Source Code of Conduct ][code_of_conduct]. For more information see the [Code of Conduct FAQ ][code_of_conduct_faq] or contact [email protected] with any additional questions or comments. |
| 120 | + |
| 121 | +<!-- LINKS --> |
| 122 | +[azure_cli]: https://docs.microsoft.com/cli/azure |
| 123 | +[azure_powerShell]: https://docs.microsoft.com/powershell/azure |
| 124 | +[azure_sub]: https://azure.microsoft.com/free/dotnet/ |
| 125 | +[azure_identity]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity/README.md |
| 126 | +[source]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity.BrokeredAuthentication/src |
| 127 | +[package]: https://www.nuget.org/packages?q=Azure.Identity.BrokeredAuthentication |
| 128 | +[aad_doc]: https://docs.microsoft.com/azure/active-directory/ |
| 129 | +[aad_err_doc]: https://docs.microsoft.com/azure/active-directory/develop/reference-aadsts-error-codes |
| 130 | +[certificates_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/keyvault/Azure.Security.KeyVault.Certificates |
| 131 | +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ |
| 132 | +[code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/ |
| 133 | +[nuget]: https://www.nuget.org/ |
| 134 | +[keys_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/keyvault/Azure.Security.KeyVault.Keys |
| 135 | +[secrets_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/keyvault/Azure.Security.KeyVault.Secrets |
| 136 | +[blobs_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.Blobs |
| 137 | +[queues_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.Queues |
| 138 | +[eventhubs_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/eventhub/Azure.Messaging.EventHubs |
| 139 | +[azure_core_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/core/Azure.Core |
| 140 | +[identity_api_docs]: https://docs.microsoft.com/dotnet/api/azure.identity?view=azure-dotnet |
| 141 | +[vs_login_image]: https://raw.githubusercontent.com/Azure/azure-sdk-for-net/main/sdk/identity/Azure.Identity/images/VsLoginDialog.png |
| 142 | +[azure_cli_login_image]: https://raw.githubusercontent.com/Azure/azure-sdk-for-net/main/sdk/identity/Azure.Identity/images/AzureCliLogin.png |
| 143 | +[azure_cli_login_device_code_image]: https://raw.githubusercontent.com/Azure/azure-sdk-for-net/main/sdk/identity/Azure.Identity/images/AzureCliLoginDeviceCode.png |
| 144 | +[default_azure_credential_authflow_image]: https://raw.githubusercontent.com/Azure/azure-sdk-for-net/main/sdk/identity/Azure.Identity/images/DefaultAzureCredentialAuthenticationFlow.png |
| 145 | +[ref_DefaultAzureCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet |
| 146 | +[ref_ChainedTokenCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.chainedtokencredential?view=azure-dotnet |
| 147 | +[ref_EnvironmentCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.environmentcredential?view=azure-dotnet |
| 148 | +[ref_ManagedIdentityCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.managedidentitycredential?view=azure-dotnet |
| 149 | +[ref_ClientSecretCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.clientsecretcredential?view=azure-dotnet |
| 150 | +[ref_ClientCertificateCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.clientcertificatecredential?view=azure-dotnet |
| 151 | +[ref_InteractiveBrowserCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.interactivebrowsercredential?view=azure-dotnet |
| 152 | +[ref_DeviceCodeCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.devicecodecredential?view=azure-dotnet |
| 153 | +[ref_UsernamePasswordCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.usernamepasswordcredential?view=azure-dotnet |
| 154 | +[ref_AuthorizationCodeCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.authorizationcodecredential?view=azure-dotnet |
| 155 | +[ref_AzureCliCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.azureclicredential?view=azure-dotnet |
| 156 | +[ref_AzurePowerShellCredential]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/AzurePowerShellCredential.cs |
| 157 | +[ref_VisualStudioCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.visualstudiocredential?view=azure-dotnet |
| 158 | +[ref_VisualStudioCodeCredential]: https://docs.microsoft.com/dotnet/api/azure.identity.visualstudiocodecredential?view=azure-dotnet |
| 159 | + |
| 160 | + |
0 commit comments