Authenticating users with the Electronic ID (eID) in SharePointHannes Decorte
Applies to:U2U nv/sa
This article guides you through all the required steps to enable the authentication of users in the Windows SharePoint Services and SharePoint Portal Server environment with an electronic identification (eID). Contents:
eID as a means of authenticationThe eID (or electronic Identity Card) is a personal identification card. It was introduced in Belgium on a national scale and contains information about the identity of the card holder such as the address, date and place of birth, and more. The card also can be used as an authentication mechanism since the holder can use it to identify himself to applications (e.g. Web apps) by means of a unique client certificate embedded in the chip of the card.
![]() Step1: Enabling Secure Sockets Layer (SSL) on the Virtual Server hosting the SharePoint siteTo enable SSL on a Virtual Server you first need a certificate. Certificates can be obtained from different authorities like VeriSign or GlobalSign. It’s also possible to use a self-signed certificate for testing purposes. We will discuss the last approach here in the article. The easiest way to create and install the self-signed certificate is to download and utilize the SSL Diagnostics Tool. The tool can be downloaded from the Microsoft site.
![]() A listing of all the virtual servers on the local machine will be displayed and the tool checks for any configuration errors. Note: The tool might also list that host headers are not supported with SSL. This can be ignored if SP 1 is installed on the Windows 2003 server. ![]() To install a test certificate you highlight the line listing the virtual server and click the Create New Cert menu item. ![]() Your next step is to configure the virtual server for SSL thus requiring a client certificate for authentication. To do this you open the Internet Information Service manager (IIS) located in the Administrative tools of the Control Panel. In the properties of the virtual server you select the Directory Security tab. Here you can set the SSL requirements by clicking Edit on the tab in the Secure Communication section. ![]() You check the “Require secure channel” checkbox and choose “Require client certificates”. If you now click View Certificate on the Directory Security tab, the server certificate installed by the SSL Diagnostics tool is shown. On the tab page Web Site you also specify 443 as SSL port. If you have a site configured with a host header and worry about host headers not being supported with SSL, don’t. Well that is if you have SP1 of Windows Server 2003 installed. For more information on this see Configuring Server Bindings for SSL Host Headers (IIS 6.0). ![]() Step 2: Setup the web server to accept eID certificatesBy following step 1, your SharePoint site can now only be accessed trough https and by using a client certificate. But how will the server know what certificates to accept?
![]() Step 3: Setting up eID software on the client machineNow let us focus on the client. There are some prerequisites you need to take care of on the client machine before the client will be able to present the web server with your eID client certificate.
![]() After installing the reader, you now install the “Belgium Identity Card Run-time” which can be found on Belgium Identity Card Run-time. There are several downloads on the page and you take the one referring to Windows and the preferred language. The downloaded compressed file contains one executable representing the installation. You can verify the client installation by introducing your eID card in the smart card reader and run the eIDGUI ( ![]() normally located in the C:\Program Files\Belgium Identity Card folder). You click the yellow chip on the GUI and after a few seconds the personal information appears. ![]() There is one final step to make sure you can use the eID to authenticate against a web server. You have to install the client certificates in the Personal Certificate Store of the client computer. This can be done by going to the Certificates tab and clicking Register for both certificates. You can verify the installation by opening Internet Explorer and checking via Tools|Internet Options|Content| Certificates, that the personal certificates are listed under the tab page Personal. ![]() ![]() Step 4: Mapping the eID client certificate to an Active Directory account trough IISThe client is now ready and the web server is also ready to accept the certificates. But is SharePoint ready? What we want to achieve is a scenario where a user only needs to supply his or her eID certificate and pin code (pin code only the first time) and he or she will seamlessly sign in into the SharePoint site.
You open the Secure Communications window by clicking the Edit button in the Secure Communications section on the Directory Security Tab. ![]() Check Enable client certificate mapping and click the Edit button. In the Account Mappings window, click Add to specify a new client certificate – Active Directory account mapping. Take the following steps:
![]() Step 5: Testing the authentication process.After all that work, everything is set to test our eID enabled SharePoint site. You introduce the eID smart card in the reader and browse to the SharePoint site. (Don’t forget to specify https.) First window that pops up is one where Internet Explorer presents the server certificate for approval.
![]() Clicking yes, Internet Explorer asks what certificate you want to use for authentication. ![]() After you select the correct certificate, you must provide the pin code (only the first time the eID card is used). When all of this is successful, Internet Explorer loads the SharePoint site and we are automatically signed in. Voila, eID in action! ![]() ![]() ConclusionIn this article we have shown the steps needed to enable eID authentication on a SharePoint site. In that way we have a more secure way of authenticating and authorizing the users of the sites. The eID is a wonderful way to start authenticating users, not only in Web applications but also in smart client applications such as the Office 2003 environment. We hope that we have inspired you with this article to start making us of this little handy thing all of us here in Belgium are starting to get in their pocket.
![]() References![]() About the author
| ||||||