OpenIDでログインできるサイトを作成する1 †

OpenIDでログインできるサイトをASP.NETで作成する方法を説明します。なおここではDotNetOpenIdというフリー（New BSD License）のライブラリを使った方法を紹介しますので、ほとんどがDotNetOpenIdの使い方の説明になります。

▲ ▼

OpenIDとは？ †

まずはOpenIDについて簡単に説明します。OpenIDとは、1つのIDとパスワードでOpenIDに対応したすべてのサイトにログインできるシステムです。または、そのIDをOpenIDと言うこともあります。OpenIDに対応したサイトはまだまだ少ないですが、Google、Yahooをはじめ、マイクロソフトのWindows Live IDもOpenIDとして使用できるようになるということなので、これからどんどん増えていくでしょう。

OpenIDの仕様は、「OpenID ≫ Read the Specifications」で公開されています。

実際にOpenIDを使った方が分かりやすいと思いますので、実際に使用する例を示します。

まずはOpenIDを取得します。OpenIDを発行しているサイトは、日本では、OpenID.ne.jp、livedoor、Yahoo! JAPAN、はてな、Jugemkey、mixi、BIGLOBE、エキサイトなどがあります。GoogleではBloggerで作成したブログのURLを、Six ApartではVoxで作成したブログのURLをOpenIDとして使用することができます。海外では、myOpenIDなどが有名です。

ここでは、OpenID.ne.jpでOpenIDを作成したものとします*1。登録に成功すると、"http://username.openid.ne.jp/"のような"OpenID URL"をもらえます。もし既にYahoo! JAPANなどのアカウントを持っているならば、サイトで簡単な手続きを行うことですぐにOpenIDを発行してもらえますので、それで十分でしょう。

次にこのOpenIDを使って、OpenIDに対応したサイトにログインします。ここではChoixというサイトにログインしてみます。（ただしユーザー登録が必要ですので、正確に言うと、OpenIDを使ってログインできるようにユーザー登録してみます。）

Choixのトップページの上に「ログイン」というリンクがありますので、これをクリックしてログインページに移動します。ログインページにはユーザー名とパスワードを入力するフォームがありますが、その右に「OpenIDでログイン」というフォームがあり、テキストボックスが1つだけあります。ここに先ほど取得したOpenID（http://username.openid.ne.jp/）を入力します。

chox1

ただし、Choixのログインページにも書かれていますが、ここにURLを入力しなくてもよい場合があります。例えば、Yahoo! JAPANでは"yahoo.co.jp"と入力することができます。また、サイトによっては、OpenIDを入力するテキストボックスが用意されておらず、その代りに「Yahoo!のアカウントでログイン」のようなリンクが用意されている場合もあります。なお、Choixのログインページにも同様のリンクがありますが、このリンクはOpenIDではないようです。

OpenIDを入力して「ログイン」ボタンを押すと、OpenID.ne.jpのページに飛ばされます。ここでパスワードを入力することを要求されます。ただし、すでにOpenID.ne.jpにログインしているときは、このページが表示されず、次の「OpenID 確認」ページが表示されます。

chox2

パスワードを入力して「ログイン」ボタンを押すと、今度は「OpenID 確認」というページに飛ばされます。

chox3

このページでは、

現在 https://www.choix.jpで、あなたのOpenid (http://username.openid.ne.jp/)があなたの個人情報と一致しているという証明を要求しています｡https://www.choix.jp に証明するための必要な個人情報を追加チェックし、認証してください｡

という文章が表示されます。そしてその下のチェックボックスでChoxに送信する個人情報を選択します。"Optional"となっている項目は送信を拒否しても問題ありませんが、"Required"となっている項目は必須項目ですので、送信を拒否するとログインできないなどの不具合が起こる可能性があります（Choixでは拒否しても問題ないようです）。Choixの場合はこのように個人情報を要求しますが、そうしないサイトも多いです。

その下に「一度だけ認証」「認証状態を保持」「認証拒否」という3つのボタンが表示されますが、ここでは「一度だけ認証」をクリックします。「認証状態を保持」をクリックすると、次にChoixにログインするときはこのページが表示されません。

ボタンをクリックすると、今度はChoixのページに戻ってきます。

chox4

「Choix IDの設定」という会員登録のフォームページが表示され、IDとメールアドレスを入力する必要があります。ただし、パスワードは必要ありません。また、個人情報を送った場合は、IDとメールアドレスにOpenID.ne.jpに登録されているニックネームとE-mailの情報があらかじめ入力されます。

Choixの会員登録が完了すれば、次回からはOpenIDでログインが可能になります。

▲ ▼

この記事で使用している用語 †

OpenIDでよく使われる用語があります。この記事でもこれらの用語を使いますので、まずは用語の説明をします（3つだけです）。

OpenID Provider
OPと略します。OpenIDの認証をするサーバーです。上記の例では、OpenID.ne.jpです。
Relying Party
RPと略します。OpenIDの認証を受け取る側のWebアプリケーションのことです。上記の例では、Choixのことです。この記事で紹介するのは、RPを作成する方法ということになります。
Claimed Identifier
ユーザーのOpenID URLのことです。上記の例では、"http://username.openid.ne.jp/"のことです。ちなみに、先ほどの例でOpenIDを入力する欄に"yahoo.co.jp"のように入力できると書きましたが、この"yahoo.co.jp"は"OP Identifier"といいます。Claimed IdentifierとOP Identifierを合わせて、"User-Supplied Identifier"と呼びます。

さらにここでは、エンドユーザー（OpenIDを使ってログインしようとしているユーザー）のことを単にユーザーと表記します。

▲ ▼

DotNetOpenIdを使ってRelying Partyを作成する †

それでは本題に入りましょう。ここではDotNetOpenIdを使いますので、まずはDotNetOpenIdのサイトからダウンロードして、適当なフォルダに展開してください。なお私が使用したDotNetOpenIdのバージョンは、2.5.4.9045 です。DotNetOpenIdのバージョンが2.xであれば.NET 2.0に対応しており、3以上ならば.NET 3.5に対応しているようです。

補足

DotNetOpenId以外にも.NET Frameworkで使用できるライブラリはいくつかあります。私が調べた限りでは、以下のようなライブラリが公開されています。

補足

DotNetOpenIdを使用したサンプルは、DotNetOpenIdアーカイブ内のSamplesフォルダにあります。RelyingPartyPortalプロジェクトは、RPを作成するサンプルです。RelyingPartyMvcプロジェクトは、RPをASP.NET MVCで作成するサンプルです（ASP.NET MVCがインストールされていないと開くことができません）。ProviderPortalプロジェクトは、OPを作成するサンプルです。

Visual StudioでRPのプロジェクトを新規に作成するか、すでにある場合は開きます。

Web.configの"authentication mode"が"Forms"以外の場合は、"Forms"にします。また、ログインページを"login.aspx"以外にする場合は、"loginUrl"も指定しておきます。

<configuration>
  <system.web>
    <authentication mode="Forms">
      <forms name="RelyingPartySession" loginUrl="login.aspx"/>
    </authentication>
  </system.web>
</configuration>

Visual Studioの左側にあるツールボックスで右クリックしてメニューを表示し、「アイテムの選択」を選択します。「ツールボックスアイテムの選択」ダイアログが表示されるので、下にある「参照」ボタンをクリックして、"DotNetOpenId.dll"を選択します。"OpenIdLogin"などが選択されますので、そのまま"OK"をクリックします。

DotNetOpenId2

これでツールボックスに"OpenIdLogin"などのコントロール追加されます。

ログインページ"login.aspx"を作成し、そのページにツールボックスから"OpenIdLogin"をドラッグ&ドロップして配置します。

OpenIdLogin1

OpenIdLoginコントロールを配置しただけのlogin.aspxのソースは以下のようになります。

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19

<%@ Page Language="vb" %>
<%@ Register assembly="DotNetOpenId" namespace="DotNetOpenId.RelyingParty"
 tagprefix="RP" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <RP:OpenIdLogin ID="OpenIdLogin1" runat="server" />
    </div>
    </form>
</body>
</html>
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22

<%@ Page Language="C#" %>
<%@ Register assembly="DotNetOpenId" namespace="DotNetOpenId.RelyingParty"
 tagprefix="RP" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
<script runat="server">
</script>
 
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <RP:OpenIdLogin ID="OpenIdLogin1" runat="server" />
    </div>
    </form>
</body>
</html>

実はこれだけでRPが出来上がっています。しかしこれだけではログインできたか分かりませんので、"Default.aspx"ページにLoginStatusコントロールとLoginNameコントロールを配置しておきます。"Default.aspx"のソースは以下のようになります。

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18

<%@ Page Language="vb" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:LoginName ID="LoginName1" runat="server" />
        <asp:LoginStatus ID="LoginStatus1" runat="server" />
    </div>
    </form>
</body>
</html>
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21

<%@ Page Language="C#" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
<script runat="server">
</script>
 
<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:LoginName ID="LoginName1" runat="server" />
        <asp:LoginStatus ID="LoginStatus1" runat="server" />
    </div>
    </form>
</body>
</html>

これで完了です。早速実行してみましょう。

Default.aspxをWebブラウザで開くと、LoginStatusコントロールの「ログイン」リンクがあります。これをクリックすると、login.aspxが開きます。

OpenIdLogin2

このページでOpenIDを入力し、「Login」ボタンをクリックします。すると、先ほどのChoixの例と同じように、OPのページに飛んでログインを行い、再びDefault.aspxに戻ってきます。OpenIDの認証に成功すると、Default.aspxのLoginNameコントロールにOpenID（Claimed Identifier）が表示され、LoginStatusコントロールは「ログアウト」となりますので、実際にログインできたことが確認できます。このようにOpenIdLoginコントロールはOpenIDの認証に成功すると自動的にログインします。

たったこれだけでRPを作れてしまいました。

▲ ▼

Claimed Identifierを取得する †

認証に成功した時、OPが送信するユーザーのClaimed Identifierを取得するには、IAuthenticationResponse.ClaimedIdentifierプロパティを使います。IAuthenticationResponseを取得するには、OpenIdLoginコントロールのLoggedInイベントハンドラのパラメータであるOpenIdEventArgsオブジェクトのResponseプロパティを使います。

また、これとは別に、IAuthenticationResponse.FriendlyIdentifierForDisplayプロパティというものもあります。ClaimedIdentifierプロパティで取得できるClaimed Identifierが意味不明の文字列となる場合があり、このような文字列を表示されてもユーザーはピンと来ないかもしれません。FriendlyIdentifierForDisplayプロパティはより分かりやすい文字列を返しますので、表示用として適しています。具体的には、Claimed Identifierの"http://"が取られるなどするようです。ただし、FriendlyIdentifierForDisplayプロパティを表示以外の用途で使ってはいけません。例えば、Claimed Identifierでユーザーを特定する場合は、必ずClaimedIdentifierプロパティの値を使います。

ちなみに、LoginNameコントロールに表示される名前は、ClaimedIdentifierプロパティと同じものになるようです。

▲ ▼

OPに移動する前にキャンセルする †

例えば、OpenIdLoginコントロールのテキストボックスに入力されたURLを見て、このOpenID URLは拒否したいという場合もあります。そのようなときは、OpenIdLoginのLoggingInイベントでOpenIdEventArgs.CancelプロパティをTrueにすれば、OPのページに移動するのをキャンセルできます。

▲ ▼

OPからキャンセルされたり、認証が失敗した時 †

認証を行うOPのページでユーザーがキャンセルをすることもできます。この時、OpenIdLoginコントロールのCanceledイベントが発生します。

また、認証に失敗したときは、Failedイベントが発生します。エラーの詳細は、OpenIdEventArgs.Response.Exceptionプロパティに格納されます。

▲ ▼

LoggedIn、LoggingIn、Canceled、Failedイベントを使用した例 †

先に紹介したLoggedIn、LoggingIn、Canceled、Failedイベントを使用して"login.aspx"を書き換えた例を以下に紹介します。

LoggedInイベントハンドラでは、Claimed Identifierをセッションに保存しています。LoggingInイベントハンドラでは、ユーザーが入力したOpenID URLに"hogehoge.com"が含まれていたらキャンセルするようにしています。Canceledイベントハンドラでは、Labelコントロールにキャンセルされたというメッセージを表示しています。Failedイベントハンドラでは、Labelコントロールにエラーメッセージを表示しています。

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62

<%@ Page Language="vb" %>
<%@ Register assembly="DotNetOpenId" namespace="DotNetOpenId.RelyingParty"
 tagprefix="RP" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
<script runat="server">
    
    'ログインしたとき 
    Protected Sub OpenIdLogin1_LoggedIn(ByVal sender As Object, _
                                        ByVal e As OpenIdEventArgs)
        'Claimed Identifierを覚えておく 
        Session("ClaimedIdentifier") = e.Response.ClaimedIdentifier
    End Sub
 
    'ログインする前 
    Protected Sub OpenIdLogin1_LoggingIn(ByVal sender As Object, _
                                         ByVal e As OpenIdEventArgs)
        'OpenID URLに"hogehoge.com"が含まれていたらキャンセルする 
        If OpenIdLogin1.Text.IndexOf("hogehoge.com") > -1 Then
            MessageLabel.Text = """hogehoge.com""はダメです。"
            e.Cancel = True
        Else
            MessageLabel.Text = ""
        End If
    End Sub
 
    'OPからキャンセルされたとき 
    Protected Sub OpenIdLogin1_Canceled(ByVal sender As Object, _
                                        ByVal e As OpenIdEventArgs)
        MessageLabel.Text = "キャンセルされました。"
    End Sub
 
    '認証が失敗したとき 
    Protected Sub OpenIdLogin1_Failed(ByVal sender As Object, _
                                      ByVal e As OpenIdEventArgs)
        MessageLabel.Text = "エラー : " & e.Response.Exception.Message
    End Sub
    
</script>
 
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <RP:OpenIdLogin ID="OpenIdLogin1" runat="server" 
            oncanceled="OpenIdLogin1_Canceled"
            onfailed="OpenIdLogin1_Failed" 
            onloggedin="OpenIdLogin1_LoggedIn"
            onloggingin="OpenIdLogin1_LoggingIn" />
    </div>
    <div>
        <asp:Label ID="MessageLabel" runat="server" EnableViewState="False">
        </asp:Label>
    </div>
    </form>
</body>
</html>
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64

<%@ Page Language="C#" %>
<%@ Register assembly="DotNetOpenId" namespace="DotNetOpenId.RelyingParty" tagprefix="RP" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
<script runat="server">
 
    //ログインしたとき
    protected void OpenIdLogin1_LoggedIn(object sender, OpenIdEventArgs e)
    {
        //Claimed Identifierを覚えておく
        Session["ClaimedIdentifier"] = e.Response.ClaimedIdentifier;
    }
    
    //ログインする前
    protected void OpenIdLogin1_LoggingIn(object sender, OpenIdEventArgs e)
    {
        //OpenID URLに"hogehoge.com"が含まれていたらキャンセルする
        if (OpenIdLogin1.Text.IndexOf("hogehoge.com") > -1)
        {
            MessageLabel.Text = "\"hogehoge.com\"はダメです。";
            e.Cancel = true;
        }
        else
        {
            MessageLabel.Text = "";
        }
    }
    
    //OPからキャンセルされたとき
    protected void OpenIdLogin1_Canceled(object sender, OpenIdEventArgs e)
    {
        MessageLabel.Text = "キャンセルされました。";
    }
 
    //認証が失敗したとき
    protected void OpenIdLogin1_Failed(object sender, OpenIdEventArgs e)
    {
        MessageLabel.Text = "エラー : " + e.Response.Exception.Message;
    }
    
</script>
 
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <RP:OpenIdLogin ID="OpenIdLogin1" runat="server" 
            oncanceled="OpenIdLogin1_Canceled"
            onfailed="OpenIdLogin1_Failed" 
            onloggedin="OpenIdLogin1_LoggedIn"
            onloggingin="OpenIdLogin1_LoggingIn" />
    </div>
    <div>
        <asp:Label ID="MessageLabel" runat="server" EnableViewState="False">
        </asp:Label>
    </div>
    </form>
</body>
</html>
▲ ▼

次回予告 †

次回はOpenIdLoginコントロールについてさらに詳しく紹介する予定です。

▲ ▼

コメント †


▲ ▼
ページ情報
*1 OpenID.ne.jpでOpenIDを作成することをお勧めしているわけではありません。
[ トップ ]   [ 編集 | 凍結 | 差分 | バックアップ | 添付 | 複製 | 名前変更 | リロード ]   [ 新規 | 子ページ作成 | 一覧 | 単語検索 | 最終更新 | ヘルプ ]