LINE Profile+ に対応した LINE ログイン Provider ライブラリを作りました

業務で LINE ログインを実装することになり、合わせて LINE Profile+ から情報を取得する必要が出ました。ということで LINE Profile+ をサポートした OAuth2 ライブラリを作りました！

弊社メンバーで Microsoft MVP for Azure の吉野くんが以前 .NET Core 2.x 世代向けに LINE ログインのライブラリを作っていたので、そこに相乗りさせてもらいました。

Getting Started

このライブラリは ASP.NET Core における外部プロバイダー認証の実装に準拠しています。なので、以下のような感じで始められます。

dotnet add package LineAuthentication

services
    .AddAuthentication()
    .AddLine(options =>
    {
        options.ClientId = Configuration["Authentication:Line:ChannelId"];
        options.ClientSecret = Configuration["Authentication:Line:ChannelSecret"];
    });

LINE Profile+ の情報取得

LineAuthentication-AspNetCore を利用すれば、OAuth の認可スコープを指定することでユーザーの LINE Profile+ から以下の情報を取得できるようになります。会員登録などで利用したいですね。

姓 / 名
姓 / 名 (カナ)
性別
生年月日
住所
電話番号
E-mail アドレス

ちょこっと注意が必要なのは、LINE Profile+ にアクセスするためには LINE 側への利用申請が必要な点です。個人情報を扱うのでこればっかりは致し方ない感じはあります。詳細は LINE Developers のドキュメントをご参照ください。

こんな感じで利用します。なんてことはなく、標準に準拠してるので他の外部ログインを実装したことがある方にとってはメッチャ簡単です。

services
    .AddAuthentication()
    .AddLine(options =>
    {
        options.ClientId = Configuration["Authentication:Line:ChannelId"];
        options.ClientSecret = Configuration["Authentication:Line:ChannelSecret"];

        // 認可スコープを追加
        options.Scope.Add("real_name");
        options.Scope.Add("gender");
        options.Scope.Add("birthdate");
        options.Scope.Add("address");
        options.Scope.Add("phone");
        options.Scope.Add("email");

        // JSON ペイロードとの Claim 情報のマッピング
        options.ClaimActions.MapJsonKey(ClaimTypes.Email, "email");

        // JSON ペイロードに丸ッとアクセス
        options.Events.OnCreatingTicket = context =>
        {
            // context.User に JsonElement 形式で入ってます
            var json = context.User.GetRawText();
            return Task.CompletedTask;
        };
    });