Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/auth0/auth0-oidc-client-net
OIDC Client for .NET Desktop and Mobile applications
https://github.com/auth0/auth0-oidc-client-net
dx-sdk oidc-client xamarin
Last synced: 4 days ago
JSON representation
OIDC Client for .NET Desktop and Mobile applications
- Host: GitHub
- URL: https://github.com/auth0/auth0-oidc-client-net
- Owner: auth0
- License: apache-2.0
- Created: 2017-02-03T01:54:33.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T19:24:23.000Z (29 days ago)
- Last Synced: 2024-12-28T16:03:37.697Z (11 days ago)
- Topics: dx-sdk, oidc-client, xamarin
- Language: C#
- Homepage: https://auth0.github.io/auth0-oidc-client-net/
- Size: 7.16 MB
- Stars: 86
- Watchers: 15
- Forks: 49
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
OIDC Client for .NET Desktop (WinForms, WPF and UWP) as well as Xamarin-based iOS and Android mobile applications.
[](https://www.nuget.org/packages/Auth0.OidcClient.Core/)
[](https://opensource.org/licenses/Apache-2.0)
[](https://dev.azure.com/Auth0SDK/Auth0%20OIDC%20Client.NET/_build/latest?definitionId=4&branchName=master)
:books: [Documentation](#documentation) - :rocket: [Getting Started](#getting-started) - :computer: [API Reference](#api-reference) - :speech_balloon: [Feedback](#feedback)
This library makes use of the [IdentityModel/IdentityModel.OidcClient](https://github.com/IdentityModel/IdentityModel.OidcClient) library and uses code from the [IdentityModel/IdentityModel.OidcClient.Samples](https://github.com/IdentityModel/IdentityModel.OidcClient.Samples) repository to achieve browser integration.
## Documentation
- [MAUI Quickstart](https://auth0.com/docs/quickstart/native/maui) - our interactive guide for quickly adding login, logout and user information to a MAUI application using Auth0.
- [UWP Quickstart](https://auth0.com/docs/quickstart/native/windows-uwp-csharp) - our interactive guide for quickly adding login, logout and user information to a UWP application using Auth0.
- [WPF/WinForms Quickstart](https://auth0.com/docs/quickstart/native/wpf-winforms) - our interactive guide for quickly adding login, logout and user information to a WPF and WinForms application using Auth0.
- [Xamarin Quickstart](https://auth0.com/docs/quickstart/native/xamarin) - our interactive guide for quickly adding login, logout and user information to a Xamarin application using Auth0.
- [WPF Sample App](https://github.com/auth0-samples/auth0-WinFormsWPF-oidc-samples/tree/master/Quickstart/00-Starter-Seed/WPF) - a WPF application integrated with Auth0.
- [WinForms Sample App](https://github.com/auth0-samples/auth0-WinFormsWPF-oidc-samples/tree/master/Quickstart/00-Starter-Seed/WinForms) - a WinForms application integrated with Auth0.
- [Xamarin Sample App](https://github.com/auth0-samples/auth0-xamarin-oidc-samples/tree/master/Quickstart/01-Login) - a Xamarin application integrated with Auth0.
- [SDK docs](https://auth0.github.io/auth0-oidc-client-net/documentation/intro.html) - explore the documentation for this SDK.
- [Auth0 docs](https://www.auth0.com/docs) - explore our docs site and learn more about
## Getting started
### Requirements
For a list of supported platforms, please refer to the relevant documentation from Microsoft:
* [Xamarin](https://docs.microsoft.com/en-us/xamarin/get-started/supported-platforms)
* [UWP/WPF/WinForms](https://docs.microsoft.com/en-us/lifecycle/faq/windows)
### Installation
The SDK is available on [Nuget](https://www.nuget.org/packages?q=Auth0.OidcClient) for different platforms:
```
Install-Package Auth0.OidcClient.UWP
Install-Package Auth0.OidcClient.WPF
Install-Package Auth0.OidcClient.WinForms
Install-Package Auth0.OidcClient.iOS
Install-Package Auth0.OidcClient.AndroidX
Install-Package Auth0.OidcClient.MAUI
```
> *Note*: As `Auth0.OidcClient.Android` relies on [support libraries](https://developer.android.com/topic/libraries/support-library) which have been deprecated by Google since 2019, there is no way for `Auth0.OidcClient.Android` to ever work on .NET 6 and above. If you wish to integrate Auth0 in an Android application, use `Auth0.OidcClient.AndroidX` instead.
### Configure Auth0
Create a **Native Application** in the [Auth0 Dashboard](https://manage.auth0.com/#/applications).
> **If you're using an existing application**, verify that you have configured the following settings in your Native Application:
>
> - Click on the "Settings" tab of your application's page.
> - Scroll down and click on the "Show Advanced Settings" link.
> - Under "Advanced Settings", click on the "OAuth" tab.
> - Ensure that "JsonWebToken Signature Algorithm" is set to `RS256` and that "OIDC Conformant" is enabled.
Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:
- **Allowed Callback URLs**
- **Allowed Logout URLs**
> For the values for these URLs, please refer to the corresponding quickstart from our [documentation](#documentation).
Take note of the **Client ID** and **Domain** values under the "Basic Information" section. You'll need these values to configure the SDK.
### Configure the SDK
All platforms share the same interface, so you can use the following code to instantiate the `Auth0Client`:
```csharp
using Auth0.OidcClient;
// ...
var auth0Client = new Auth0Client(new Auth0ClientOptions
{
Domain = "YOUR_AUTH0_DOMAIN",
ClientId = "YOUR_AUTH0_CLIENT_ID"
});
```
> ℹ️ Note that MAUI needs more specific configuration, ensure to read [our instructions for MAUI](ster/src/Auth0.OidcClient.MAUI) when you are targetting MAUI.
## API reference
Read [the full API reference](https://auth0.github.io/auth0-oidc-client-net) to find out about the public API's this SDK exposes.
## Feedback
### Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
- [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
- [This repo's contribution guide](CONTRIBUTING.md)
### Raise an issue
To provide feedback or report a bug, please [raise an issue on our issue tracker](https://github.com/auth0/auth0-oidc-client-net/issues).
### Vulnerability Reporting
Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.
---
Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
This project is licensed under the Apache-2.0 license. See the LICENSE file for more info.