Configuring Twitter authentication

By Valeriy Novytskyy and Rick Anderson

This tutorial shows you how to enable your users to sign in with their Twitter account using a sample ASP.NET Core 2.0 project created on the previous page.

Create the app in Twitter

  • Navigate to https://apps.twitter.com/ and sign in. If you don't already have a Twitter account, use the Sign up now link to create one. After signing in, the Application Management page is shown:

Twitter Application Management open in Microsoft Edge

  • Tap Create New App and fill out the application Name, Description and public Website URI (this can be temporary until you register the domain name):

Create an application page

  • Enter your development URI with /signin-twitter appended into the Valid OAuth Redirect URIs field (for example: https://localhost:44320/signin-twitter). Twitter middleware configured later in this tutorial will automatically handle requests at /signin-twitter route to implement the OAuth flow.

  • Fill out the rest of the form and tap Create your Twitter application. New application details are displayed:

Details tab on Application page

  • When deploying the site you'll need to revisit the Application Management page and register a new public URI.

Storing Twitter ConsumerKey and ConsumerSecret

Link sensitive settings like Twitter Consumer Key and Consumer Secret to your application configuration using the Secret Manager. For the purposes of this tutorial, name the tokens Authentication:Twitter:ConsumerKey and Authentication:Twitter:ConsumerSecret.

These tokens can be found on the Keys and Access Tokens tab after creating your new Twitter application:

Keys and Access Tokens tab

Configure Twitter middleware

The project template used in this tutorial ensures that Microsoft.AspNetCore.Authentication.Twitter package is already installed.

  • To install this package with Visual Studio 2017, right-click on the project and select Manage NuGet Packages.
  • To install with .NET Core CLI, execute the following in your project directory:

    dotnet add package Microsoft.AspNetCore.Authentication.Twitter

Add the Twitter middleware in the Configure method in Startup.cs file:

app.UseTwitterAuthentication(new TwitterOptions()
{
    ConsumerKey = Configuration["Authentication:Twitter:ConsumerKey"],
    ConsumerSecret = Configuration["Authentication:Twitter:ConsumerSecret"]
});

See the TwitterOptions class in ASP.NET Core repository for more information on configuration options supported by Twitter middleware. This can be used to request different information about the user.

Sign in with Twitter

Run your application and click Log in. An option to sign in with Twitter appears:

Web application: User not authenticated

Clicking on Twitter redirects to Twitter for authentication:

Twitter authentication page

After entering your Twitter credentials, you are redirected back to the web site where you can set your email.

You are now logged in using your Twitter credentials:

Web application: User authenticated

Troubleshooting

  • If Identity is not configured by calling services.AddIdentity in ConfigureServices, attempting to authenticate will result in ArgumentException: The 'SignInScheme' option must be provided. The project template used in this tutorial ensures that this is done.
  • If the site database has not been created by applying the initial migration, you will get A database operation failed while processing the request error. Tap Apply Migrations to create the database and refresh to continue past the error.

Next steps

  • This article showed how you can authenticate with Twitter. You can follow a similar approach to authenticate with other providers listed on the previous page.

  • Once you publish your web site to Azure web app, you should reset the ConsumerSecret in the Twitter developer portal.

  • Set the Authentication:Twitter:ConsumerKey and Authentication:Twitter:ConsumerSecret as application settings in the Azure portal. The configuration system is set up to read keys from environment variables.