TLG Saml Claims sps2013
TLG Saml Claims sps2013
TLG Saml Claims sps2013
Some examples depicted herein are provided for illustration only and are fictitious. No real association or
connection is intended or should be inferred.
This document does not provide you with any legal rights to any intellectual property in any Microsoft
product. You may copy and use this document for your internal, reference purposes.
August 4, 2013 Added a link to the overview video and incorporated technical updates.
November 28, Updated with standard text, graphics, and sections and technical
2012 corrections for claims mappings.
Aug 5, 2012 Updated with standard text, links to SharePoint Server 2013 and
community resources, and technical corrections for claims mappings.
Removed links to evaluation software.
Contents
Contents..........................................................................................................................................................3
Introduction.....................................................................................................................................................3
In this guide...............................................................................................................................................5
Step 1: Set up the SharePoint Server 2013 Three-tier farm test lab...................................................................7
Step 5: Change the default web application to use SAML claims-based authentication........................................10
Introduction
Microsoft® SharePoint® Server 2013 makes it easy for people to work together. SharePoint
Server 2013 enables you and your employees to set up web sites to share information with
others, manage documents from start to finish, and publish reports to help everyone make
better decisions.
Sites Provides a single infrastructure for all your business web sites. Share documents with
colleagues, manage projects with partners, and publish information to customers.
Composites Offers tools and components for creating do-it-yourself business solutions.
Build no-code solutions to rapidly respond to business needs.
Content Makes content management easy. Set up compliance measures ”behind the
scenes”—with features like document types, retention polices, and automatic content sorting
—and then let people work naturally in Microsoft Office.
Insights Gives everyone access to the information in databases, reports, and business
applications. Help people locate the information to make good decisions.
Search Cuts through the clutter. A unique combination of relevance, refinement, and social
cues helps people find the information and contacts they need to get their jobs done.
For more information about Microsoft SharePoint Server 2013, see the SharePoint 2013 Product
Information site and SharePoint 2013 for IT pros.
Microsoft Test Lab Guides (TLGs) are a set of documents that step you through the configuration
and demonstration of a Microsoft technology or product in a standardized test lab environment,
which starts with a common base configuration that mimics a simplified intranet and the
Internet. TLGs are designed to be modular, extensible, and stackable to configure complex,
multi-product solutions. TLGs make learning about products, technologies, and solutions easier
by providing that crucial hands-on, “I built it out myself” experience.
A TLG stack is a set of dependent TLGs that, when configured from the bottom of the stack,
create a meaningful test lab configuration. This TLG is at the top of the following TLG stack:
SharePoint Server 2013 takes advantage of claims that are included in security tokens that an
IP-STS provides to authorize users. In a claims-based authentication environment, an
application that accepts SAML tokens is known as a relying party STS (RP-STS). A relying party
application receives the SAML token and uses the claims inside to decide whether to grant the
client access to the requested resource. In SharePoint Server 2013, each web application that is
configured to use a SAML provider is added to the IP-STS server as a separate RP-STS entry. A
SharePoint farm can include multiple RP-STS entries.
In this test lab, you start with the three-tier SharePoint Server 2013farm, which uses Active
Directory Domain Services (AD DS) as its user directory. You then add Active Directory
Federation Services (AD FS) 2.0, which acts as the IP-STS, and configure AD FS with an RP–STS
entry that corresponds to the default team site for the Contoso corporation. Next, you configure
the SharePoint Server 2013 farm to trust the SAML tokens that AD FS issues and demonstrate
claims-based identity when accessing the default Contoso team site.
In this guide
This paper contains instructions for setting up a test lab that is based on the SharePoint Server
2013 Three-Tier Farm test lab guide and the Test Lab Guide Mini-Module: Install AD FS 2.0 by
using four server computers and one client computer. The resulting test lab demonstrates the
configuration and use of SAML-based claims authentication. This paper is the test lab guide
version of the procedures that are described in Configure SAML-based claims authentication with
ADFS.
For a short video that describes the configuration of this test lab, see the SharePoint Server
2013 SAML TLG overview.
Important
The following instructions configure a SharePoint Server 2013 test lab by using the minimum
number of computers. Individual computers are needed to separate services provided on the
network and to clearly show the desired functionality. This configuration is neither designed
to reflect best practices nor does it reflect a desired or recommended configuration for a
production network. The configuration, including IP addresses and all other configuration
parameters, is designed only to work on a separate test lab network. Attempting to adapt
this test lab configuration to a pilot or production deployment can result in configuration or
functionality issues. For more information, see Plan for user authentication methods in
SharePoint 2013 and Configure SAML-based claims authentication with ADFS.
One computer running Windows® Server® 2008 R2 Enterprise Edition with Service Pack 1
named DC1 that is configured as an intranet domain controller, Domain Name System (DNS)
server, Dynamic Host Configuration Protocol (DHCP) server, enterprise root certification
authority (CA), and AD FS 2.0 server.
One intranet member server running Windows Server 2008 R2 Enterprise Edition with
Service Pack 1 named SQL1 that is configured as a SQL database server.
One intranet member server running Windows Server 2008 R2 Enterprise Edition with
Service Pack 1 named APP1 that is configured as the SharePoint Server 2013 application
server.
One intranet member server running Windows Server 2008 R2 Enterprise Edition with
Service Pack 1 named WFE1 that is configured as the SharePoint front-end web server.
One member client computer running Windows 7 Enterprise or Ultimate named CLIENT1.
The SharePoint Server 2013 test lab consists of a single subnet named Corpnet (10.0.0.0/24)
that simulates a private intranet. Computers on the Corpnet subnet connect using a hub or
switch. See the following figure.
The product disc or files for Windows Server 2008 R2 with Service Pack 1.
The product disc or files for Microsoft SQL Server 2012 or Microsoft SQL Server 2008 R2 with
Service Pack 1.
One computer that meets the minimum hardware requirements for Windows Server 2008 R2
Enterprise Edition.
One computer that meets the minimum hardware requirements for Windows Server 2008 R2
Enterprise Edition and either Microsoft SQL Server 2012 or Microsoft SQL Server 2008 R2.
Two computers that meet the minimum hardware requirements for Windows Server 2008 R2
Enterprise Edition and SharePoint Server 2013.
One computer that meets the minimum hardware requirements for Windows 7 Enterprise or
Ultimate.
Note
You must be logged on as a member of the Domain Admins group or a member of the
Administrators group on each computer to complete the tasks described in this guide. If you
cannot complete a task while you are logged on with an account that is a member of the
Administrators group, try performing the task while you are logged on with an account that
is a member of the Domain Admins group.
The following sections provide details about how to perform these steps.
1. In the Rules Editor Management console, on the Issuance Transform Rules tab,
click Add Rule.
2. On the Select Rule Template page, click Send LDAP Attributes as Claims, and then
click Next.
3. On the Configure Rule page, type Email and UPN in Claim rule name.
4. In Attribute Store, click Active Directory.
5. In the empty row in Mapping of LDAP attributes to outgoing claim types, for LDAP
Attribute, click E-Mail-Addresses.
6. For Outgoing Claim Type, click E-Mail Address.
7. In the new empty row, for LDAP Attribute, click User-Principal-Name.
8. For Outgoing Claim Type, select UPN.
9. Click Finish, and then click OK.
In this procedure, you export the token signing certificate of the AD FS server.
1. In the navigation pane of the AD FS 2.0 console, expand Service, and then click
Certificates.
2. In the contents pane, in Token signing, right-click the certificate, and then click View
Certificate.
This displays the properties of the certificate.
3. Click the Details tab, and then click Copy to File.
This starts the Certificate Export Wizard.
4. On the Welcome to the Certificate Export Wizard page, click Next.
5. On the Export File Format page, click DER encoded binary X.509 (.CER), and then
click Next.
6. On the File to Export page, type C:\ADFS_Sign.cer, and then click Next.
7. On the Completing the Certificate Export Wizard page, click Finish.
1. On APP1, from the SharePoint 2013 Management Shell command prompt, create an
email address claim mapping by using the following command:
$emailClaimMap = New-SPClaimTypeMapping -IncomingClaimType
"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" -
IncomingClaimTypeDisplayName "EmailAddress" -SameAsIncoming
2. Create the UPN claim mapping by using the following command:
$upnClaimMap = New-SPClaimTypeMapping -IncomingClaimType
"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn" -
IncomingClaimTypeDisplayName "UPN" -SameAsIncoming
In this procedure, you add a new authentication provider named “ADFS for Contoso.” After you
define this new authentication provider, you can select it when you configure a trusted identity
provider for claims-based authentication for a new or existing SharePoint web application.
From the SharePoint 2013 Management Shell command prompt, create a new authentication
provider by using the following commands:
$realm = "urn:sharepoint:contoso"
$signInURL = "https://dc1.corp.contoso.com/adfs/ls"
$ap = New-SPTrustedIdentityTokenIssuer -Name "ADFS for Contoso" -
Description "SharePoint secured by SAML" -realm $realm -
ImportTrustCertificate $cert -ClaimsMappings $emailClaimMap,$upnClaimMap -
SignInUrl $signInURL -IdentifierClaim $emailClaimMap.InputClaimType
1. On APP1, click Start, click All Programs, click Microsoft SharePoint 2013 Products,
and then click SharePoint 2013 Central Administration.
2. In Central Administration, in the Application Management section, click Manage
web applications.
3. Click the SharePoint – 80 web application.
4. In the Security group of the ribbon, click Authentication Providers.
5. On Authentication Providers page, in the Zone column, click Default.
6. On the Edit Authentication page, in the Claims Authentication Types section, select
Trusted Identity provider.
7. Click ADFS for Contoso, click Save, and then close the Authentication Providers
window.
This configures both Windows and SAML claims-based authentication for this web
application.
8. Click Central Administration on the Quick Launch.
In this procedure, you configure the default web application created for the three-tier farm,
named SharePoint – 80, for SSL-based connections, which are required for protected
communications with DC1, the AD FS server.
In this procedure, you configure the email address of the corp\User1 account, previously
specified as [email protected], with permissions to access the SharePoint – 80 web application.
To access the default Contoso Corporation team site using SAML-based claims
authentication
test other SharePoint TLGs or test lab extensions or for your own experimentation and learning,
do the following:
1. On all physical computers or virtual machines in the test lab, close all windows and then
perform a graceful shutdown.
2. If your lab is based on virtual machines, save a snapshot of each virtual machine and
name the snapshots SP2013SAML. If your lab uses physical computers, create disk
images to save the SharePoint Server 2013 SAML-based claims authentication test lab
configuration.
Additional Resources
For more information about SharePoint Server 2013, see the SharePoint 2013 product
information web page and SharePoint 2013 for IT pros.
To provide the authors of this guide with feedback or suggestions for improvement, send an
email message to [email protected].
To submit your questions about this test lab or SharePoint 2013, see the SharePoint 2013 for IT
Professionals Forum.
For a list of TLGs related to this test lab or extensions to demonstrate additional functionality,
see SharePoint Server 2013 Test Lab in the TechNet Wiki.
Microsoft strongly encourages you to develop and publish your own TLG content for SharePoint
Server 2013. For example, you can publish in the TechNet Wiki (example: Test Lab Guide:
Demonstrate Remote Access VPNs) or in your own publishing forum (example: Test Lab Guide
(Part 1) - Demonstrate TMG PPTP, L2TP/IPsec and SSTP Remote Access VPN Server). See Wiki:
Creating and Publishing Test Lab Guide Content for information about the types of content you
can create and for links to guidance, templates, and examples.
For a list of additional Microsoft TLGs, see Test Lab Guides in the TechNet Wiki.