PassportIdentity Class

Reference

Definition

Namespace:: System.Web.Security

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

This type is obsolete. The Passport authentication product is no longer supported and has been superseded by Live ID.

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

public ref class PassportIdentity sealed : System::Security::Principal::IIdentity

public ref class PassportIdentity sealed : IDisposable, System::Security::Principal::IIdentity

public sealed class PassportIdentity : System.Security.Principal.IIdentity

public sealed class PassportIdentity : IDisposable, System.Security.Principal.IIdentity

[System.Obsolete("This type is obsolete. The Passport authentication product is no longer supported and has been superseded by Live ID.")]
public sealed class PassportIdentity : IDisposable, System.Security.Principal.IIdentity

type PassportIdentity = class
    interface IIdentity

type PassportIdentity = class
    interface IIdentity
    interface IDisposable

[<System.Obsolete("This type is obsolete. The Passport authentication product is no longer supported and has been superseded by Live ID.")>]
type PassportIdentity = class
    interface IIdentity
    interface IDisposable

Public NotInheritable Class PassportIdentity
Implements IIdentity

Public NotInheritable Class PassportIdentity
Implements IDisposable, IIdentity

Inheritance: Object
PassportIdentity

Attributes: ObsoleteAttribute

Implements: IIdentity IDisposable

Examples

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

<!-- 
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" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.SetNoStore(); 


            // Get a version of the Identity value that is cast as type
            // PassportIdentity. 
//<Snippet4>
//<Snippet5>
//<Snippet6>
            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());
//</Snippet6>
                // 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>");
                }
            }
//</Snippet5>            
    
            // 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);
            }
//</Snippet4>

            // 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 occurred while working with the " +
                "Passport SDK.");
        }
    }
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
    <head>
    <title>ASP.NET Example</title>
</head>
    <body>
        <form id="form1" runat="server">
        </form>
    </body>
</html>

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


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.SetNoStore()
            
            ' Get a version of the Identity value that is cast as type
            ' PassportIdentity. 
'<Snippet4>
'<Snippet5>
'<Snippet6>
            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())
'</Snippet6>
                ' 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
'</Snippet5>            
    
            ' 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)
'</Snippet4>

            ' 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 occurred while working with the " & _
                "Passport SDK. The following result was returned: " & _
                comError.ErrorCode)
        End Try
    End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
    <head>
    <title>ASP.NET Example</title>
</head>

    <body>
        <form id="form1" runat="server">
        </form>
    </body>
</html>

Remarks

This class has been deprecated and is no longer supported. Microsoft Passport Network was replaced by Windows Live ID.

Constructors

PassportIdentity()

Initializes a new instance of the PassportIdentity class. This class is deprecated.

Properties

AuthenticationType	Gets the type of authentication used to identify the user. This class is deprecated.
Error	Gets a value indicating the error state associated with the current Passport ticket. This class is deprecated.
GetFromNetworkServer	Gets information on a Passport server connection and query string. This class is deprecated.
HasSavedPassword	Gets information on whether the Passport member's password was saved. This class is deprecated.
HasTicket	Gets a value indicating whether the query string includes a Passport ticket as a cookie. This class is deprecated.
HexPUID	Gets the Passport Unique Identifier (PUID) for the currently authenticated user, in hexadecimal form. This class is deprecated.
IsAuthenticated	Gets a value indicating whether the user is authenticated against a Passport authority. This class is deprecated.
Item[String]	Gets Passport profile attributes. This class is deprecated.
Name	Gets the name of the current user. This class is deprecated.
TicketAge	Gets the time, in seconds, since the last ticket was issued or refreshed. This class is deprecated.
TimeSinceSignIn	Gets the time, in seconds, since a member's logon to the Passport logon server. This class is deprecated.

Methods

AuthUrl()	Returns a string containing the Login server URL for a member, as well as with optional information sent to the Login server in the query string. This class is deprecated.
AuthUrl(String, Int32, Boolean, String, Int32, String, Int32, Boolean)	Returns the authentication server URL for a member. This class is deprecated.
AuthUrl(String, Int32, Int32, String, Int32, String, Int32, Int32)	Returns a string containing the Login server URL for a member, along with the optional information sent to the Login server in the query string. This class is deprecated.
AuthUrl(String)	Returns a string containing the Login server URL for a member, along with optional information sent to the Login server in the query string. This class is deprecated.
AuthUrl2()	Returns a string containing the Login server URL for a member, as well as optional information sent to the Login server in the query string. This class is deprecated.
AuthUrl2(String, Int32, Boolean, String, Int32, String, Int32, Boolean)	Returns a string containing the Login server URL for a member, as well as the optional information sent to the Login server in the query string. This class is deprecated.
AuthUrl2(String, Int32, Int32, String, Int32, String, Int32, Int32)	Retrieves a string containing the Login server URL for a member, as well as the optional information sent to the Login server in the query string. This class is deprecated.
AuthUrl2(String)	Returns a string containing the Login server URL for a member, as well as optional information sent to the Login server in the query string. This class is deprecated.
Compress(String)	Compresses data. This class is deprecated.
CryptIsValid()	Gets the state of a flag indicating if the Passport Manager is in a valid state for encryption. This class is deprecated.
CryptPutHost(String)	Sets the key being used for Passport encryption and decryption. This class is deprecated.
CryptPutSite(String)	Sets the key being used for Passport encryption and decryption by referring to the site-name label assigned to that key when the key was first installed. This class is deprecated.
Decompress(String)	Decompresses data that has been compressed by the Compress(String) method. This class is deprecated.
Decrypt(String)	Decrypts data using the Passport participant key for the current site. This class is deprecated.
Encrypt(String)	Encrypts data using the Passport participant key for the current site. This class is deprecated.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize()	Allows this passport identity to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
GetCurrentConfig(String)	Gets the contents of a registry key under the HKLM\SW\Microsoft\Passport hive. This class is deprecated.
GetDomainAttribute(String, Int32, String)	Provides information for a Passport domain by querying the Passport manager for the requested domain attribute. This class is deprecated.
GetDomainFromMemberName(String)	Returns the Passport domain from the member name string. This class is deprecated.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetIsAuthenticated(Int32, Boolean, Boolean)	Indicates whether the user is authenticated by a central site responsible for Passport authentication. This class is deprecated.
GetIsAuthenticated(Int32, Int32, Int32)	Indicates whether the user is authenticated by a Passport authority. This class is deprecated.
GetLoginChallenge()	Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange. This class is deprecated.
GetLoginChallenge(String, Int32, Int32, String, Int32, String, Int32, Int32, Object)	Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange. This class is deprecated.
GetLoginChallenge(String)	Logs the user on by outputting the appropriate headers to either a 302 redirect URL or the initiation of a Passport-aware client authentication exchange. This class is deprecated.
GetOption(String)	Gets a specific Passport logon option. This class is deprecated.
GetProfileObject(String)	Returns Passport profile information for the specified profile attribute. This class is deprecated.
GetType()	Gets the Type of the current instance. (Inherited from Object)
HasFlag(Int32)	Indicates whether a given flag is set in this user's profile. This class is deprecated.
HasProfile(String)	Indicates whether a given profile attribute exists in this user's profile. This class is deprecated.
HaveConsent(Boolean, Boolean)	Indicates whether full consent is granted in this user's profile. This class is deprecated.
LoginUser()	Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange. This class is deprecated.
LoginUser(String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)	Logs the user on, either by generating a 302 redirect URL or by initiating a Passport-aware client authentication exchange. This class is deprecated.
LoginUser(String, Int32, Int32, String, Int32, String, Int32, Int32, Object)	Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange. This class is deprecated.
LoginUser(String)	Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange. This class is deprecated.
LogoTag()	Returns an HTML fragment containing an image tag for a Passport link. This class is deprecated.
LogoTag(String, Int32, Boolean, String, Int32, Boolean, String, Int32, Boolean)	Returns an HTML fragment containing an HTML <img> tag for a Passport link. This class is deprecated.
LogoTag(String, Int32, Int32, String, Int32, Int32, String, Int32, Int32)	Returns an HTML fragment containing an HTML <img> tag for a Passport link. This class is deprecated.
LogoTag(String)	Returns an HTML fragment containing an HTML <img> tag for a Passport link. This class is deprecated.
LogoTag2()	Returns an HTML fragment containing an image tag for a Passport link. This class is deprecated.
LogoTag2(String, Int32, Boolean, String, Int32, Boolean, String, Int32, Boolean)	Returns an HTML fragment containing an HTML <img> tag for a Passport link. This class is deprecated.
LogoTag2(String, Int32, Int32, String, Int32, Int32, String, Int32, Int32)	Returns an HTML fragment containing an HTML <img> tag for a Passport link. This class is deprecated.
LogoTag2(String)	Returns an HTML fragment containing an HTML <img> tag for a Passport link. This class is deprecated.
LogoutURL()	Returns the Passport logout URL string. This class is deprecated.
LogoutURL(String, String, Int32, String, Int32)	Returns the Passport logout URL string using the specified parameters. This class is deprecated.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
SetOption(String, Object)	Sets a specific Passport logon option. This class is deprecated.
SignOut(String)	Logs off the given Passport member from the current session. This class is deprecated.
Ticket(String)	Gets information on a specific attribute of the Passport authentication ticket. This class is deprecated.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IDisposable.Dispose()

Releases all resources used by the PassportIdentity class. This class is deprecated.

Applies to

Deila með