AppleAuth.NET 1.0.2

AppleAuth.NET is a simple library that facilitates the implementation of "Sign in with Apple" in a .NET application.

Install-Package AppleAuth.NET -Version 1.0.2
dotnet add package AppleAuth.NET --version 1.0.2
<PackageReference Include="AppleAuth.NET" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AppleAuth.NET --version 1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: AppleAuth.NET, 1.0.2"
For F# scripts that support #r syntax, copy this into the source code to reference the package.

What is AppleAuth.NET?

AppleAuth is a very simple library for .NET that encapsulates the logic for communicating with Apple's REST API for Sign in with Apple.
The main goal is to make the implementation of Sign in with Apple easier for any web application.

How to use it?

Installation

To install the package execute the following command in your Package Manager Console:

PM> Install-Package AppleAuth.NET

Or alternatively just install the package using Nuget package manager. The project can be found here:
Link to NuGet

Prerequisites

Configure Sign in with Apple from the Developer Portal

In order to use Sign in with Apple you must enroll in the Apple Developer Program.
After you have enrolled in the program go to Developer Account Help and navigate to Configure app capabilities > Sign in with Apple.
There you can find the information for configuring Sign in with Apple for your app.

Display the "Sign in with Apple" button

Next, you have to configure your web page for Sign in with Apple. Follow the guidelines from the official documentation. You can also refer to this link to see how to setup the styles of the buttons.

Example

NOTE:
If you are deploying your app to an Azure Web App make sure you add the following setting: WEBSITE_LOAD_USER_PROFILE = 1, so IIS can access the private key storage under the user account store.
You can apply this from the Azure portal from Configuration > Application Settings, or you can run the following command in Cloud Shell:
az webapp config appsettings set --name <app-name> --resource-group <resource-group-name> --settings WEBSITE_LOAD_USER_PROFILE=1.
It's also important to note that this setting is available only for non-shared pricing tiers.

Using AppleAuthProvider.cs

Create new instance of AppleAuthProvider, pass the required parameters and you are good to go. Use the GetAuthorizationToken method to get an authorization token from Apple; Use the GetRefreshToken method to verify if a user is still using 'Sign in with Apple' to sign in your system; Use the GetButtonHref method to get a query string for the 'Sign in with Apple' button.

Handling initial response from Apple

After the user clicks on the "Sign in with Apple" button on your page they will be redirected to https://appleid.apple.com/. After they provide their credentials Apple will make a POST request to the url that you have specified as Redirect URL. You can handle the request using InitialTokenResponse.cs. In order to retrieve an authorization token you should first create new instance of AppleAuthProvider with the required parameters.
After that just call GetAuthorizationToken() method passing code from your InitialTokenResponse object and your private key. Here is a sample implementation in C#:

        [HttpPost]
        public async Task HandleResponseFromApple(AppleAuth.TokenObjects.InitialTokenResponse response)
        {
            string privateKey = System.IO.File.ReadAllText("path/to/file.p8");

            AppleAuth.AppleAuthProvider provider = new AppleAuth.AppleAuthProvider("MyClientID", "MyTeamID", "MyKeyID", "MyRedirectUrl", "SomeState");

            AppleAuth.TokenObjects.AuthorizationToken authorizationToken = await provider.GetAuthorizationToken(response.code, privateKey);
        }

Keep in mind that tokens returned from Apple are short-lived, so you should create a session or a user in your system using the returned AppleAuth.TokenObjects.AuthorizationToken object. After that you can verify if the user is still logged in using "Sign in with Apple" by retrieving a refresh token using the GetRefreshToken method:

        [HttpPost]
        public async Task<bool> IsUserUsingAppleID()
        {
            string privateKey = System.IO.File.ReadAllText("path/to/file.p8");

            AppleAuth.AppleAuthProvider provider = new AppleAuthProvider("MyClientID", "MyTeamID", "MyKeyID", "https://myredirecturl.com/HandleResponseFromApple", "SomeState");

            AppleAuth.TokenObjects.AuthorizationToken refreshToken = await provider.GetRefreshToken(authorizationToken.RefreshToken, privateKey);

            return refreshToken != null;
        }

Contributing

You are more than welcome to contribute to the project and make it better. When contributing please try to maintain a strictly professional, respectful and friendly attitude. Also make sure you communicate the change you want to make via issue or any other method with the owners of this repository.

Creating a pull request

We do not have any strict guidelines for creating pull requests, but you can use the already known GitHub flow for general guidelines.

License

This project is licensed under the MIT License - see LICENSE.md for details

What is AppleAuth.NET?

AppleAuth is a very simple library for .NET that encapsulates the logic for communicating with Apple's REST API for Sign in with Apple.
The main goal is to make the implementation of Sign in with Apple easier for any web application.

How to use it?

Installation

To install the package execute the following command in your Package Manager Console:

PM> Install-Package AppleAuth.NET

Or alternatively just install the package using Nuget package manager. The project can be found here:
Link to NuGet

Prerequisites

Configure Sign in with Apple from the Developer Portal

In order to use Sign in with Apple you must enroll in the Apple Developer Program.
After you have enrolled in the program go to Developer Account Help and navigate to Configure app capabilities > Sign in with Apple.
There you can find the information for configuring Sign in with Apple for your app.

Display the "Sign in with Apple" button

Next, you have to configure your web page for Sign in with Apple. Follow the guidelines from the official documentation. You can also refer to this link to see how to setup the styles of the buttons.

Example

NOTE:
If you are deploying your app to an Azure Web App make sure you add the following setting: WEBSITE_LOAD_USER_PROFILE = 1, so IIS can access the private key storage under the user account store.
You can apply this from the Azure portal from Configuration > Application Settings, or you can run the following command in Cloud Shell:
az webapp config appsettings set --name <app-name> --resource-group <resource-group-name> --settings WEBSITE_LOAD_USER_PROFILE=1.
It's also important to note that this setting is available only for non-shared pricing tiers.

Using AppleAuthProvider.cs

Create new instance of AppleAuthProvider, pass the required parameters and you are good to go. Use the GetAuthorizationToken method to get an authorization token from Apple; Use the GetRefreshToken method to verify if a user is still using 'Sign in with Apple' to sign in your system; Use the GetButtonHref method to get a query string for the 'Sign in with Apple' button.

Handling initial response from Apple

After the user clicks on the "Sign in with Apple" button on your page they will be redirected to https://appleid.apple.com/. After they provide their credentials Apple will make a POST request to the url that you have specified as Redirect URL. You can handle the request using InitialTokenResponse.cs. In order to retrieve an authorization token you should first create new instance of AppleAuthProvider with the required parameters.
After that just call GetAuthorizationToken() method passing code from your InitialTokenResponse object and your private key. Here is a sample implementation in C#:

        [HttpPost]
        public async Task HandleResponseFromApple(AppleAuth.TokenObjects.InitialTokenResponse response)
        {
            string privateKey = System.IO.File.ReadAllText("path/to/file.p8");

            AppleAuth.AppleAuthProvider provider = new AppleAuth.AppleAuthProvider("MyClientID", "MyTeamID", "MyKeyID", "MyRedirectUrl", "SomeState");

            AppleAuth.TokenObjects.AuthorizationToken authorizationToken = await provider.GetAuthorizationToken(response.code, privateKey);
        }

Keep in mind that tokens returned from Apple are short-lived, so you should create a session or a user in your system using the returned AppleAuth.TokenObjects.AuthorizationToken object. After that you can verify if the user is still logged in using "Sign in with Apple" by retrieving a refresh token using the GetRefreshToken method:

        [HttpPost]
        public async Task<bool> IsUserUsingAppleID()
        {
            string privateKey = System.IO.File.ReadAllText("path/to/file.p8");

            AppleAuth.AppleAuthProvider provider = new AppleAuthProvider("MyClientID", "MyTeamID", "MyKeyID", "https://myredirecturl.com/HandleResponseFromApple", "SomeState");

            AppleAuth.TokenObjects.AuthorizationToken refreshToken = await provider.GetRefreshToken(authorizationToken.RefreshToken, privateKey);

            return refreshToken != null;
        }

Contributing

You are more than welcome to contribute to the project and make it better. When contributing please try to maintain a strictly professional, respectful and friendly attitude. Also make sure you communicate the change you want to make via issue or any other method with the owners of this repository.

Creating a pull request

We do not have any strict guidelines for creating pull requests, but you can use the already known GitHub flow for general guidelines.

License

This project is licensed under the MIT License - see LICENSE.md for details

Release Notes

Prevent potenial NullReferenceException.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.2 236 2/11/2021
1.0.1 3,880 5/15/2020
1.0.0 132 5/12/2020