Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

PassportIdentity Class

Provides a class to be used by PassportAuthenticationModule. It provides a way for an application to access the Ticket method. This class cannot be inherited.

For a list of all members of this type, see PassportIdentity Members.

System.Object
   System.Web.Security.PassportIdentity

[Visual Basic]
NotInheritable Public Class PassportIdentity
   Implements IIdentity
[C#]
public sealed class PassportIdentity : IIdentity
[C++]
public __gc __sealed class PassportIdentity : public IIdentity
[JScript]
public class PassportIdentity implements IIdentity

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Remarks

You must install the Passport SDK in order to use the .NET Passport classes and methods. Passport SDK version 1.4 is supported but not recommended. Passport SDK version 2.1 is both supported and recommended. The Passport SDK is available for download at http://www.microsoft.com/net/downloads.asp .

For more information on Passport authentication, see Passport Authentication Provider.

Note   In some methods of this class, the corresponding Passport method has optional parameters. Whenever a Passport method has optional integer or Boolean parameters, you can pass "-1" to indicate that Passport should use the default value. Whenever a Passport method has optional string parameters, you can pass a null reference (Nothing in Visual Basic) to indicate that Passport should use the default value. It is noted in the parameter description when a parameter can accept one of these default values.

Windows XP Platform Note:  Only Passport SDK version 2.1 is supported.

Example

[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.
-->

    . . . 
<%@ 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>

[C#] 
<!-- 
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.
-->

    . . . 
<%@ 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>

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Web.Security

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Web (in System.Web.dll)

See Also

PassportIdentity Members | System.Web.Security Namespace | Passport Authentication Provider

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.