PassportIdentity クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

PassportIdentity クラス

PassportAuthenticationModule が使用するクラスを提供します。このクラスでは、アプリケーションが Ticket メソッドにアクセスする手段を提供します。このクラスは継承できません。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 PassportIdentity
    Implements IIdentity, IDisposable

Visual Basic (使用法)

Dim instance As PassportIdentity

public sealed class PassportIdentity : IIdentity,
 IDisposable

C++

public ref class PassportIdentity sealed :
 IIdentity, IDisposable

public final class PassportIdentity implements
 IIdentity, IDisposable

JScript

public final class PassportIdentity implements
 IIdentity, IDisposable

解説

.NET Passport のクラスとメソッドを使用する場合は、Passport SDK をインストールしてください。Passport SDK バージョン 1.4 は、サポートしていますが、推奨はしていません。Passport SDK バージョン 2.1 はサポートされ、推奨されています。Passport SDK は、http://www.microsoft.com/japan/net/downloads.asp からダウンロードできます。

Passport 認証の詳細については、「Passport 認証プロバイダ」を参照してください。

メモ
このクラスのメソッドには、対応する Passport メソッドに省略可能なパラメータがある場合があります。Passport メソッドにオプションの整数または Boolean パラメータがある場合はいつでも、"-1" を渡して Passport で既定値を使用するように指定できます。Passport メソッドにオプションの文字列パラメータがある場合はいつでも、null 参照 (Visual Basic では Nothing) を渡して Passport で既定値を使用するように指定できます。パラメータがこれらの既定値のいずれかを受け入れる場合、パラメータの説明に記述されます。

メモ

このクラスのメソッドには、対応する Passport メソッドに省略可能なパラメータがある場合があります。Passport メソッドにオプションの整数または Boolean パラメータがある場合はいつでも、"-1" を渡して Passport で既定値を使用するように指定できます。Passport メソッドにオプションの文字列パラメータがある場合はいつでも、null 参照 (Visual Basic では Nothing) を渡して Passport で既定値を使用するように指定できます。パラメータがこれらの既定値のいずれかを受け入れる場合、パラメータの説明に記述されます。

Windows XP Home Edition, Windows XP Professional x64 Edition, Windows Server 2003 プラットフォームメモ : Passport SDK バージョン 2.1 だけがサポートされます。

Topic	Location
方法 : ASP.NET アプリケーションに Passport 認証を実装する	ASP .NET Web アプリケーションの作成

使用例

Visual Basic

<!-- 
This example demonstrates implementing the soft sign-in authentication approach.
 
In order for the example to
 work, the following requirements must be met. 
You can find details on these requirements in
 the Passport SDK documentation.

1. You must modify the Web.config file associated with this page
 so that 
authentication mode is set to
 "Passport".
2. You must have the Passport SDK installed.
3. You must have a Passport Site ID for the site where your page
 resides. 
If your Site ID is in the
 PREP environment, you will also need a PREP Passport.
4. You must have installed the encryption key you received after registering your
 
site and receiving a site ID.
5. You must have the Passport Manager object settings correctly
 configured for your site.
-->

<br /><span space="preserve">...</span><br
 /><%@ Page language="VB" AutoEventWireup="true"
 %>
<%@ Import Namespace="System.Drawing"
 %>
<%@ Import Namespace="System.Web.Security"
 %>
<%@ Import Namespace="System.Runtime.InteropServices"
 %>


<HTML>
    <HEAD>
        <SCRIPT runat="server">
            Private Sub Page_Load(sender As
 Object, e As System.EventArgs)
                Try 
                    ' Determine whether Passport is the type of authentication
                    ' this page is set to use. (Authentication information
                    ' is set in the Web.config file.)
                    If Not TypeOf(Me.Context.User.Identity)
 Is PassportIdentity Then
                        ' If this page isn't set to use Passport authentication
,
                        ' quit now.
                         Me.Response.Write("Error:
 Passport authentication failed. " & _
                             "Make sure that the Passport SDK
 is installed and your " & _
                             "Web.config file is configured correctly.")
                        Return
                    End If

                    ' Expire the page to avoid the browser's cache.
                    Response.Cache.SetCacheability(HttpCacheability.NoCache)
                    
                    ' Get a version of the Identity value that is cast
 as type
                    ' PassportIdentity. 
                    Dim identity As PassportIdentity
 = Me.Context.User.Identity
                    ' Determine whether the user is already signed in
 with a valid
                    ' and current ticket. Passing -1 for the parameter
 values 
                    ' indicates the default values will be used.
                    If (identity.GetIsAuthenticated(-1, -1, -1))
 Then
                        Me.Response.Write("Welcome
 to the site.<br><br>")
                        ' Print the Passport sign in button on the screen.
                        Me.Response.Write(identity.LogoTag2())
                        ' Make sure the user has core profile information
 before
                        ' trying to access it.
                        If (identity.HasProfile("core"))
 Then
                            Me.Response.Write("<b>You
 have been authenticated as " & _ 
                            "Passport identity:" &
 identity.Name & "</b></p>")
                        End If
    
                    ' Determine whether the user has a ticket.
                    ElseIf identity.HasTicket Then
                        ' If the user has a ticket but wasn't authenticated,
 that 
                        ' means the ticket is stale, so the login needs
 to be refreshed.
                        ' Passing true as the fForceLogin parameter
 value indicates that 
                        ' silent refresh will be accepted.
                        identity.LoginUser(Nothing, -1, True,
 Nothing, -1, Nothing, _
                            -1, True, Nothing)

                    ' If the user does not already have a ticket, ask
 the user
                    ' to sign in.
                    Else
                        Me.Response.Write("Please
 sign in using the link below.<br><br>")
                        ' Print the Passport sign in button on the screen.
                        Me.Response.Write(identity.LogoTag2())
                    End If

                Catch comError As System.Runtime.InteropServices.COMException
                    Me.Response.Write("An error
 occured while working with the " & _
                        "Passport SDK. The following result was
 returned: " & _
                        comError.ErrorCode)
                End Try
            End Sub
</SCRIPT>
    </HEAD>

    <body>
        <form runat="server">
        </form>
    </body>
</HTML>

<!-- 
This example demonstrates implementing the soft sign-in authentication
 approach. 
In order for the example to work, the following requirements must
 be met. 
You can find details on these requirements in the Passport SDK
 documentation.

1. You must modify the Web.config file associated with this page
 so that 
authentication mode is set to "Passport".
2. You must have the Passport SDK installed.
3. You must have a Passport Site ID for the site where your page
 resides. 
If your Site ID is in the PREP environment, you will also need
 a PREP Passport.
4. You must have installed the encryption key you received after registering 
your site and receiving a site ID.
5. You must have the Passport Manager object settings correctly configured for
 
your site.
-->

<br /><span space="preserve">...</span><br /><%@
 Page language="c#" AutoEventWireup="true"
 %>
<%@ Import Namespace="System.Drawing" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Runtime.InteropServices" %>
<HTML>
    <HEAD>
        <SCRIPT runat="server">
            private void Page_Load(object sender,
 System.EventArgs e)
            {
                try 
                {
                    // Determine whether Passport is the type of authentication
                    // this page is set to use. (Authentication information
                    // is set in the Web.config file.)
                    if (!(this.Context.User.Identity
 is PassportIdentity))
                    {
                        // If this page isn't set to use Passport authentication
,
                        // quit now.
                        this.Response.Write("Error: Passport
 authentication failed. " + 
                            "Make sure that the Passport SDK is installed "
 +
                            "and your Web.config file is configured correctly.");
                        return;
                    }

                    // Expire the page to avoid the browser's cache.
                    Response.Cache.SetCacheability(HttpCacheability.NoCache); 


                    // Get a version of the Identity value that is cast
 as type
                    // PassportIdentity. 
                    PassportIdentity identity = (this.Context.User.Identity
 as PassportIdentity);    
                    // Determine whether the user is already signed
 in with a valid
                    // and current ticket. Passing -1 for the parameter
 values 
                    // indicates the default values will be used.
                    if (identity.GetIsAuthenticated(-1, -1, -1))
                    {
                        this.Response.Write("Welcome to the
 site.<br><br>");
                        // Print the Passport sign in button on the
 screen.
                        this.Response.Write(identity.LogoTag2());
                        // Make sure the user has core profile information
 before
                        // trying to access it.
                        if (identity.HasProfile("core"))
                        {
                            this.Response.Write("<b>You
 have been authenticated as " + 
                                "Passport identity:" + identity.Name +
 "</b></p>");
                        }
                    }
    
                    // Determine whether the user has a ticket.
                    else if (identity.HasTicket)
                    {
                        // If the user has a ticket but wasn't authenticated,
 that 
                        // means the ticket is stale, so the login needs
 to be refreshed.
                        // Passing true as the fForceLogin parameter
 value indicates that 
                        // silent refresh will be accepted.
                        identity.LoginUser(null, -1, true,
 null, -1, null, -1, true,
 null);
                    }

                    // If the user does not already have a ticket, ask
 the user
                    // to sign in.
                    else
                    {
                        this.Response.Write("Please sign
 in using the link below.<br><br>");
                        // Print the Passport sign in button on the
 screen.
                        this.Response.Write(identity.LogoTag2());
                    }
                }
                catch (System.Runtime.InteropServices.COMException
 comError)
                {
                    this.Response.Write("An error occured
 while working with the " +
                        "Passport SDK.");
                }
            }
        </SCRIPT>
    </HEAD>
    <body>
        <form runat="server">
        </form>
    </body>
</HTML>