ASP.NET Core を使用した Twitter の外部サインインセットアップTwitter external sign-in setup with ASP.NET Core

作成者: Valeriy NovytskyyRick AndersonBy Valeriy Novytskyy and Rick Anderson

このサンプルでは、前のページで作成したサンプル ASP.NET Core 3.0 プロジェクトを使用して、ユーザーがTwitter アカウントを使用してサインインできるようにする方法を示します。This sample shows how to enable users to sign in with their Twitter account using a sample ASP.NET Core 3.0 project created on the previous page.

Twitter でアプリを作成するCreate the app in Twitter

  • AspNetCore NuGet パッケージをプロジェクトに追加します。Add the Microsoft.AspNetCore.Authentication.Twitter NuGet package to the project.

  • に移動し https://apps.twitter.com/ てサインインします。Navigate to https://apps.twitter.com/ and sign in. まだ Twitter アカウントをお持ちでない場合は、[ 今すぐサインアップ ] リンクを使用して作成します。If you don't already have a Twitter account, use the Sign up now link to create one.

  • [ アプリの作成 ] を選択します。Select Create an app . アプリ名アプリケーションの説明 、およびパブリック web サイト の URI を入力します (これは、ドメイン名を登録するまで一時的な場合があります)。Fill out the App name , Application description and public Website URI (this can be temporary until you register the domain name):

  • [ Twitter でのサインインを有効 にする] の横にあるチェックボックスをオンにします。Check the box next to Enable Sign in with Twitter

  • AspNetCore。IdentityMicrosoft.AspNetCore.Identity 既定では、ユーザーは電子メールアドレスを持っている必要があります。requires users to have an email address by default. [ アクセス許可 ] タブにアクセスし、[ 編集 ] ボタンをクリックして、[ ユーザーに電子メールアドレスを要求 する] の横にあるチェックボックスをオンにします。Go to the Permissions tab, click the Edit button and check the box next to Request email address from users .

  • /signin-twitter[ コールバック url ] フィールドに追加された開発 URI を入力します (例: https://webapp128.azurewebsites.net/signin-twitter )。Enter your development URI with /signin-twitter appended into the Callback URLs field (for example: https://webapp128.azurewebsites.net/signin-twitter). このサンプルで後で構成される Twitter 認証スキームは、OAuth フローを実装するために、ルートで要求を自動的に処理し /signin-twitter ます。The Twitter authentication scheme configured later in this sample will automatically handle requests at /signin-twitter route to implement the OAuth flow.

    注意

    URI セグメント /signin-twitter は、Twitter 認証プロバイダーの既定のコールバックとして設定されます。The URI segment /signin-twitter is set as the default callback of the Twitter authentication provider. TwitterOptionsクラスの 継承された[remoteauthenticationoptions]プロパティを使用して、Twitter 認証ミドルウェアを構成するときに、既定のコールバック URI を変更できます。You can change the default callback URI while configuring the Twitter authentication middleware via the inherited RemoteAuthenticationOptions.CallbackPath property of the TwitterOptions class.

  • フォームの残りの部分を入力し、[ 作成 ] を選択します。Fill out the rest of the form and select Create . 新しいアプリケーションの詳細が表示されます。New application details are displayed:

Twitter コンシューマー API キーとシークレットを格納するStore the Twitter consumer API key and secret

Twitter コンシューマー API キーや secret Managerとシークレットなどの機微な設定を格納します。Store sensitive settings such as the Twitter consumer API key and secret with Secret Manager. このサンプルでは、次の手順を使用します。For this sample, use the following steps:

  1. シークレットストレージを有効にする」の手順に従って、シークレットストレージのプロジェクトを初期化します。Initialize the project for secret storage per the instructions at Enable secret storage.

  2. 秘密キーとシークレットキーを使用して、機密設定をローカルシークレットストアに保存 Authentication:Twitter:ConsumerKeyAuthentication:Twitter:ConsumerSecret ます。Store the sensitive settings in the local secret store with the secrets keys Authentication:Twitter:ConsumerKey and Authentication:Twitter:ConsumerSecret:

    dotnet user-secrets set "Authentication:Twitter:ConsumerAPIKey" "<consumer-api-key>"
    dotnet user-secrets set "Authentication:Twitter:ConsumerSecret" "<consumer-secret>"
    

: の区切り記号は、すべてのプラットフォームの環境変数階層キーには対応していません。The : separator doesn't work with environment variable hierarchical keys on all platforms. __(ダブルアンダースコア)は、__, the double underscore, is:

  • すべてのプラットフォームに対応しています。Supported by all platforms. たとえば、Bash: の区切り記号には対応していませんが、__ には対応しています。For example, the : separator is not supported by Bash, but __ is.
  • 自動で : に置換されます。Automatically replaced by a :

これらのトークンは、新しい Twitter アプリケーションを作成した後の [ キーとアクセストークン ] タブにあります。These tokens can be found on the Keys and Access Tokens tab after creating a new Twitter application:

Twitter 認証の構成Configure Twitter Authentication

ConfigureServices Startup.cs ファイルのメソッドに Twitter サービスを追加します。Add the Twitter service in the ConfigureServices method in Startup.cs file:

{
    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(
            Configuration.GetConnectionString("DefaultConnection")));
    services.AddDefaultIdentity<IdentityUser>(options =>
        options.SignIn.RequireConfirmedAccount = true)
            .AddEntityFrameworkStores<ApplicationDbContext>();
    services.AddRazorPages();

    services.AddAuthentication().AddTwitter(twitterOptions =>
    {
        twitterOptions.ConsumerKey = Configuration["Authentication:Twitter:ConsumerAPIKey"];
        twitterOptions.ConsumerSecret = Configuration["Authentication:Twitter:ConsumerSecret"];
        twitterOptions.RetrieveUserDetails = true;
    });

}

Addauthentication (文字列)オーバーロードは、 defaultschemeプロパティを設定します。The AddAuthentication(String) overload sets the DefaultScheme property. Addauthentication (Action<authenticationoptions>)オーバーロードでは、さまざまな目的で既定の認証方式を設定するために使用できる認証オプションを構成できます。The AddAuthentication(Action<AuthenticationOptions>) overload allows configuring authentication options, which can be used to set up default authentication schemes for different purposes. それ以降のAddAuthentication呼び出しでは、以前に構成されたauthenticationoptionsプロパティがオーバーライドされます。Subsequent calls to AddAuthentication override previously configured AuthenticationOptions properties.

認証ハンドラーを登録するAuthenticationbuilder拡張メソッドは、認証スキームごとに1回だけ呼び出すことができます。AuthenticationBuilder extension methods that register an authentication handler may only be called once per authentication scheme. スキームのプロパティ、スキーム名、および表示名の構成を可能にするオーバーロードが存在します。Overloads exist that allow configuring the scheme properties, scheme name, and display name.

複数の認証プロバイダーMultiple authentication providers

アプリが複数のプロバイダーを必要とする場合、AddAuthentication の背後にあるプロバイダーの拡張メソッドをチェインします。When the app requires multiple providers, chain the provider extension methods behind AddAuthentication:

services.AddAuthentication()
    .AddMicrosoftAccount(microsoftOptions => { ... })
    .AddGoogle(googleOptions => { ... })
    .AddTwitter(twitterOptions => { ... })
    .AddFacebook(facebookOptions => { ... });

Twitter 認証でサポートされる構成オプションの詳細については、 TwitterOptions API リファレンスを参照してください。See the TwitterOptions API reference for more information on configuration options supported by Twitter authentication. これは、ユーザーに関するさまざまな情報を要求するために使用できます。This can be used to request different information about the user.

Twitter でのサインインSign in with Twitter

アプリを実行し、[ ログイン ] を選択します。Run the app and select Log in . Twitter でサインインするためのオプションが表示されます。An option to sign in with Twitter appears:

Twitter をクリックすると、認証のために twitter にリダイレクトされるようになります。Clicking on Twitter redirects to Twitter for authentication:

Twitter の資格情報を入力すると、電子メールを設定できる web サイトにリダイレクトされます。After entering your Twitter credentials, you are redirected back to the web site where you can set your email.

これで、Twitter の資格情報を使用してログインします。You are now logged in using your Twitter credentials:

プロキシまたはロード バランサーによる要求情報の転送Forward request information with a proxy or load balancer

アプリがプロキシ サーバーまたはロード バランサーの背後に展開されると、元の要求情報の一部が要求ヘッダー内でアプリに転送される場合があります。If the app is deployed behind a proxy server or load balancer, some of the original request information might be forwarded to the app in request headers. 通常、この情報にはセキュアな要求スキーム (https)、ホスト、およびクライアント IP アドレスが含まれます。This information usually includes the secure request scheme (https), host, and client IP address. アプリでは、これらの要求ヘッダーを自動的に読み取って、元の要求情報を検出して使用することはありません。Apps don't automatically read these request headers to discover and use the original request information.

スキームは、外部プロバイダーによる認証フローに影響を及ぼすリンクの生成に使用されます。The scheme is used in link generation that affects the authentication flow with external providers. セキュアなスキーム (https) が失われると、アプリでは、安全ではない不正なリダイレクト URL が生成されます。Losing the secure scheme (https) results in the app generating incorrect insecure redirect URLs.

Forwarded Headers Middleware を使用して、アプリが要求を処理する際に元の要求情報を利用できるようにします。Use Forwarded Headers Middleware to make the original request information available to the app for request processing.

詳細については、「プロキシ サーバーとロード バランサーを使用するために ASP.NET Core を構成する」を参照してください。For more information, see プロキシ サーバーとロード バランサーを使用するために ASP.NET Core を構成する.

トラブルシューティングTroubleshooting

  • **ASP.NET Core 2.x のみ:**Identityでを呼び出すことによって構成されていない場合 services.AddIdentity ConfigureServices 、認証を試みると ArgumentException が返され ます。 ' SignInScheme ' オプションを指定する必要があり ます。ASP.NET Core 2.x only: If Identity isn't 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 sample 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

  • この記事では、Twitter で認証する方法について説明しました。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.

  • Web サイトを Azure web アプリに発行したら、 ConsumerSecret Twitter 開発者ポータルでをリセットする必要があります。Once you publish your web site to Azure web app, you should reset the ConsumerSecret in the Twitter developer portal.

  • とを Authentication:Twitter:ConsumerKeyAuthentication:Twitter:ConsumerSecret Azure 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.