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

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

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

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

  • 移動します 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.

  • [新しいアプリの作成] をタップし、アプリケーション説明、およびパブリックweb サイトURI を入力します (これは、ドメイン名を登録するまで一時的な場合があります)。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):

  • [有効な OAuth リダイレクト uri] フィールドに追加されたhttps://webapp128.azurewebsites.net/signin-twitter /signin-twitter開発 URI を入力します (例:)。Enter your development URI with /signin-twitter appended into the Valid OAuth Redirect URIs 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.

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

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

次のコマンドを実行してClientIdClientSecret シークレットマネージャーを安全に格納して使用します。Run the following commands to securely store ClientId and ClientSecret using Secret Manager:

dotnet user-secrets set Authentication:Twitter:ConsumerAPIKey <Key>
dotnet user-secrets set Authentication:Twitter:ConsumerSecret <Secret>

シークレットマネージャーを使用しConsumer KeyConsumer Secret 、Twitter やなどの機密性の高い設定をアプリケーション構成にリンクします。Link sensitive settings like Twitter Consumer Key and Consumer Secret to your application configuration using the Secret Manager. このサンプルでは、トークンAuthentication:Twitter:ConsumerKeyにととAuthentication:Twitter:ConsumerSecretいう名前を指定します。For the purposes of this sample, name the tokens Authentication:Twitter:ConsumerKey and Authentication:Twitter:ConsumerSecret.

これらのトークンは、新しい 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:

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(
            Configuration.GetConnectionString("DefaultConnection")));
    services.AddDefaultIdentity<IdentityUser>()
        .AddDefaultUI(UIFramework.Bootstrap4)
        .AddEntityFrameworkStores<ApplicationDbContext>();

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

    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

呼び出しAddDefaultIdentityスキームの既定の設定を構成します。The call to AddDefaultIdentity configures the default scheme settings. AddAuthentication(String)オーバー ロードのセット、プロパティ。The AddAuthentication(String) overload sets the DefaultScheme property. AddAuthentication (アクション<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 のみ:services.AddIdentity を呼び出すことによって id が構成されていない場合、認証を試みると ArgumentException が発生します。 ConfigureServices' 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 アプリに発行したら、Twitter 開発者ポータルConsumerSecretでをリセットする必要があります。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.