Changes between Initial Version and Version 1 of KualiReady


Ignore:
Timestamp:
07/11/12 17:18:22 (13 years ago)
Author:
dabantz@…
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • KualiReady

    v1 v1  
     1 
     2 
     3 {{{ 
     4Hopefully the attached document on installing shibboleth  
     5with Kuali Ready will answer your questions. 
     6  
     7Ken 
     8  
     9  
     10Ken Schroyer 
     11Kuali Ready Product Manager 
     12ITS Disaster Recovery Strategy Manager 
     13AIS Project Manager 
     14The Pennsylvania State University 
     15Administrative Information Services (AIS) 
     163K Shields Building 
     17University Park, PA  16802 
     18Voice:  (814)863-8888   Facsimile (814)863-6123 
     19email krs5@psu.edu 
     20AIS information  http://ais.its.psu.edu/ 
     21}}} 
     22-- 
     23 
     24Kuali Ready – Integration for Shibboleth access 
     25October 29, 2010 
     26 
     27This document describes the interactions between Kuali Ready and the federated identity management framework using the Shibboleth software and protocols. 
     28 
     29=== Shibboleth Service Provider (SP) Configuration === 
     30The Apache instance hosting Kuali Ready will use the “require shibboleth” directive to forward access control requests to Shibboleth to process via <!RequestMap> definitions in the shibboleth2.xml configuration file.  Currently, Path name=”secure”. 
     31 
     32In the United States, the Kuali Ready SP will use the !InCommon metadata to discover identity providers (IdP).  All institutions needing access to Kuali Ready must be registered with !InCommon. 
     33 
     34In Canada, the SP will use the Canadian Access Federation metadata (https://caf-shibops.ca/CoreServices/cafshib_metadata_signed.xml). 
     35 
     36The Kuali Ready SP will examine the SHIB_IDENTITY_PROVIDER attribute to determine whether to allow access to Kuali Ready.  Only IdP’s that are defined to Kuali Ready will be allowed access to the application.   
     37 
     38=== Shibboleth Authentication Details === 
     39 
     40__Location__ 
     41Kuali Ready will examine the SHIB_IDENTITY_PROVIDER header and compare this value to an application database table to determine the user’s Location.  In the context of the Kuali Ready application, Location means which database the user and their continuity plans will be placed in, as well as several other aspects of the application behavior.  It does not refer to the user’s physical location. 
     42 
     43__Identity Attributes__ 
     44Kuali Ready requires the following identifiers (detail below) for each user and the attribute ePPN value shouldn’t be changed within a campus context.  IdP must assert these attributes for their users to access Kuali Ready.  Also it is important that the email (mail) attribute value has to match your campus directory.  Please contact us (kualiready-tech-support@lists.berkeley.edu) if you have any questions about this. 
     45 
     46 '''''eduPersonPrincipalName''''' (OID: 1.3.6.1.4.1.5923.1.1.1.6) 
     47The ePPN value alone should be unique within the campus identity provider context.  It may conform to any format convention but may not exceed 256 characters in length.  Kuali Ready will use the complete ePPN value to uniquely identify a user. 
     48 
     49 '''''givenName'''''  (OID: 2.5.4.42) 
     50 
     51 '''''sn''''' (OID: 2.5.4.4) 
     52 
     53 '''''title''''' (OID: 2.5.4.12) 
     54 
     55 '''''mail''''' (OID: 0.9.2342.19200300.100.1.3) 
     56 
     57 '''''telephoneNumber''''' (OID: 2.5.4.20) 
     58 
     59 '''''displayName''''' (OID: 2.16.840.1.113730.3.1.241) 
     60 
     61When using Shibboleth authentication, user attributes such as name, email address and phone number will not be updateable via the Kuali Ready application.  User attributes cached in Kuali Ready will be refreshed each time the user accesses the application. 
     62 
     63  
     64Integration of Kuali Ready with Shibboleth  
     65 
     66This section describes the steps a campus takes to integrate its web single sign-on system with Kuali Ready via Shibboleth.  
     67 
     68Membership in InCommon (for US) or CAF (for Canada) is required. 
     69 
     70Initial Setup  
     71 
     72Send email to kualiready-tech-support@lists.berkeley.edu and provide the following information:  
     731.      Shibboleth technical contact name, telephone number and email address.  
     742.      Helpdesk contact name, telephone number and email address for production support issues with identity provider.  
     753.      Anticipated IdP QA testing date and go live date. 
     764.      EntityID of your IdP  
     77 
     78Once this information is provided, the Kuali Ready SP will be configured to recognize your IdP. 
     79 
     80The metadata for the Kuali Ready SP is registered with the InCommon or CAF.  Campuses should use the following metadata to configure their IdP to access Kuali Ready. 
     81For US, use http://www.incommonfederation.org/metadata.html 
     82For Canada, use https://caf-shibops.ca/CoreServices/cafshib_metadata_signed.xml 
     83 
     84Testing 
     85 
     86The Shibboleth entry point for the Kuali Ready staging system is: 
     87https://xxx.ready-staging.kuali.org/yyy 
     88Where xxx is either ‘us’ for the United States or ‘ca’ for Canada. 
     89And yyy* is a custom assigned acronym for your campus. 
     90For example, University of California, Berkeley is: 
     91https://us.ready-staging.kuali.org/ucb and University of Toronto is: 
     92https://ca.ready-staging.kuali.org/ut 
     93 
     94The Shibboleth entry point for the Kuali Ready production system is:  
     95https://xxx.ready.kuali.org/yyy 
     96Where xxx is either ‘us’ for the United States or ‘ca’ for Canada. 
     97And yyy* is a custom assigned acronym for your campus. 
     98* The custom assigned url for your campus will be emailed to you when they are assigned. 
     99 
     100Once the IdP has been configured for the Kuali Ready SP, you may proceed to test.  
     1011.      Access the staging URL above.   
     1022.      Authenticate to your IdP. 
     1033.      If the Shibboleth transaction is successful, you should see the Kuali Ready welcome page. 
     1044.      If the Kuali Ready logon page appears, then either a value was not asserted for ePPN or your location is not yet defined to Kuali Ready.  An error message will explain the condition. 
     105 
     106We recommend the custom assigned url to be added as a link on your continuity planning website. 
     107 
     108 
     109Support  
     110 
     111If there is any issue with accessing Kuali Ready via Shibboleth send email to our technical support email kualiready-tech-support@lists.berkeley.edu. 
     112 
     113Notify our System Administrators (kualiready@berkeley.edu) 48 hours in advance to any scheduled maintenance to your campus IdP.  
     114 
     115The Kuali Ready System Administrators will notify your campus IdP Helpdesk 48 hours in advance of any scheduled maintenance to our production system.