Microsoft Sharepoint Products and Technologies Resource Kit eBook

Chapter 26: Single Sign-On in SharePoint Portal Server 2003 717
to specify it. For example, you would pass the specified port when the system
cannot detect which SSL port to use, such as when multiple SSL port mappings
exist. The required assembly for this class is Microsoft.SharePoint.Portal,
located in Microsoft.SharePoint.Portal.dll.
Table 26-1 Microsoft.SharePoint.Portal.SingleSignOn Namespace Core Classes
Class Description
Application Exposes functionality to add, get, and delete enterprise
application definitions
Credentials Exposes functionality to manage user and group credentials
and access tokens
SSOReturnCodes Contains all the return codes for SSOSrv service that the
SingleSignonException class will throw
SingleSignonException Instantiates an exception from the SSOSrv service with a
specific error code
Table 26-2 Microsoft.SharePoint.Portal.SingleSignOn Security Namespace Classes
Class Description
SingleSignOnPermission Allows security actions for SingleSignOnPermission to be
applied to code using declarative security.
SingleSignOnPermissionAttribute Represents a custom permission that controls the ability
to access Microsoft SharePoint Products and Technologies
resources to manage user and group credentials and
access tokens.
For example, let’s look into a code in the Web Part that retrieves the account
credentials for a back-end enterprise application from the single sign-on credentials
database. The corresponding application definition is configured to use individual
accounts. The code checks whether a requesting user’s credentials have already
been stored in the single sign-on credential database. If not, the user is redirected to
the Single Sign-On logon form to enter the required credentials for accessing the
back-end application.
The code should implement the following sequence:
1. Call the GetCredentials method of the Credentials class. Specify the application
name for which the credentials need to be retrieved from the single sign-on
database.
2. If the SSOSrv service cannot find credentials for the user for the enterprise application
specified, the GetCredentials method throws a SingleSignonException.
If the LastErrorCode property of the SingleSignonException is SSO_E_CREDS_
NOT_FOUND, call the GetCredentialEntryUrl(String) method—or the Get-
CredentialEntryUrl(String, Int) method—of the SingleSignonLocator class to build
the URL to the single sign-on logon form.