Shibplone

Enabling Access to Applications with Shibboleth:
Adding Shibboleth Logins to the Plone CMS
Alan Brenner
http://tid.ithaka.org/shibplone.pdf
Overview
• Zope and Plone
• Zope as the Application Server
• Plone as the Content Management System running in Zope
• End User Login Sequence Overview
• Apache Configuration
• Apache as the Shibboleth Service Provider
• Getting data from Apache to Zope
• AutoUserMakerPASPlugin
• Overview and Installation
• Configuration options
• Python Source
• ShibbolethLogin
• Installation, Configuration and Python Source
• ShibbolethPermissions
• Installation and Configuration
• Users grant permissions to their stuff
• Python Source
Who is Ithaka and Who am I?
• “Ithaka is an independent not-for-profit organization with a mission to
accelerate the productive uses of information technologies for the
benefit of higher education worldwide.”
• Research, Strategic Services, Shared Services (IT, HR, etc.)
• Affiliated with JSTOR and ARTstor
• “Incubating” Aluka, NITLE and Portico
• http://www.ithaka.org/
• I am a Senior Engineer in the Technology Innovation and Development

group. I develop software, run web sites, databases, and email and
VoIP systems, and administer several servers. I have developed these
Plone ‘Products’ under the direction of the Research in Information
Technology program of the Andrew W. Mellon Foundation.
• http://tid.ithaka.org/
• http://rit.mellon.org/
3
Zope and Plone
• Python
• Both Zope and Plone are (mostly) written in Python, with a bit of C in
Zope for performance in it’s built-in database
• http://www.python.org/
• Zope
• “An open source application server for building content management
systems, intranets, portals and custom applications”
• http://www.zope.org/
• Plone
• “A ready-to-run content management system”
• Like Zope, it is extensible with ‘Products’ and Python modules
• http://plone.org/
• Currently at 3.0. The Shibboleth integration code is still for Plone 2.5.
4
Initial Login Sequence
I focus on the Apache to

Zope communication in
this presentation.
5
Plone: Login Sequence #1
This is the default initial

page. ShibbolethLogin
modifies the page at the
“log in” link in the upper
right. You can easily
remove the “log in” box
(‘portlet’) on the left.
6
ShibbolethLogin adds these

‘Where are you from’ links to
Shibboleth Identity
Providers. You specify the
link titles and targets in the
Zope Management Interface.
The “Account details” box

encloses the login for local to
Plone accounts.
7
Login Sequence #3
Firefox briefly displays

the redirect that came
from the IdP.
8
And now I’m logged in.
Note my full name, and the

sharing tab. My name is there
because Shibboleth provided a
header that got saved as my
name. ShibbolethPermissions
uses sharing tab.
9
Apache Configuration
• Install mod_shib
• mod_php is helpful during setup.
• Create an index.php like:
<html><head><title>env</title></head><body><?php phpinfo(); ?></body></html>
• This shows all of the values that are (or are not) getting set by mod_shib
• Configure Apache to proxy HTTP connections for Zope
• Configure Apache to rewrite HTTPS connections for Zope
10
Apache: httpd.conf and modules
• This can go in the httpd.conf:
# Load the SHIBBOLETH module

LoadModule mod_shib /usr/local/shibboleth-sp-1.3/libexec/mod_shib_22.so
# This is the XML file that contains all the global, non-apache-specific
# configuration. Look at this file for most of your configuration parameters.
ShibSchemaDir /usr/local/shibboleth-sp-1.3/share/xml/shibboleth
ShibConfig /usr/local/shibboleth-sp-1.3/etc/shibboleth/shibboleth.xml
• These modules also get loaded in the httpd.conf:
LoadModule proxy_module modules/mod_proxy.so

LoadModule proxy_http_module modules/mod_proxy_http.so
LoadModule rewrite_module modules/mod_rewrite.so
11
Apache: HTTP Proxy
• (Almost) Minimal configuration:
<VirtualHost 192.168.191.1:80>
ServerName alan.ithaka.org
ServerAdmin alan.brenner@ithaka.org
DocumentRoot /usr/local/apache-httpd-2.2.4/htdocs
ProxyRequests Off
ProxyPass /index.php !
ProxyPass / http://127.0.0.1:8253/VirtualHostBase/http/alan.ithaka.org:
80/test/VirtualHostRoot/
</VirtualHost>
• This configures Apache to get pages from localhost port 8253.
• This tells Zope that pages it returns have http://alan.ithaka.org/ as the
base URL.
• It also tells Zope to fetch all pages from its /test folder (my Plone install).
• You might want to add Apache caching, other non-proxied URLs, etc.
• This is standard Apache in front of Zope, as documented at Plone’s
web site.
12
Apache: HTTPS Rewriting 1
• Apache listens on 443
<VirtualHost 192.168.191.1:443>
• Tell Apache to Proxy everything
• Sort of, since we don’t tell Apache to proxy
• This gets most of the HTTP Headers passed through to Zope
<Proxy *>
Order deny,allow
Allow from all
</Proxy>
• Tell Apache to rewrite the header to set X_REMOTE_USER

• The REMOTE_USER value is looked up
• The value is stored temporarily
• The value is saved in the X_REMOTE_USER header
RewriteEngine On
RewriteCond %{LA-U:REMOTE_USER} (.+)
RewriteRule .* - [E=RW_RU:%1]
RequestHeader set X_REMOTE_USER %{RW_RU}e
13
Apache: HTTPS Rewriting 2
• Tell Apache not to rewrite these (my IdP is on the same Apache)
RewriteCond %{REQUEST_URI} !^/(shibboleth-(sp|idp)|Shibboleth.sso|SAML)
• Tell Apache to rewrite everything else to Zope
• Mostly like the HTTP proxy.
• Add $1 to the end of the Zope URL to pass the rest of the URL.
RewriteRule ^/(.*) http://127.0.0.1:8253/VirtualHostBase/https/
alan.ithaka.org:443/test/VirtualHostRoot/$1 [L,P]
• Setup Shibboleth Authentication

<Location />
AuthType shibboleth
ShibRequireSession Off
require shibboleth
</Location>
</VirtualHost>
14
AutoUserMakerPASPlugin Overview
• Overview
• PAS is the “Pluggable Authentication System” added to Plone 2.5
• AutoUserMakerPASPlugin allows Zope to delegate authentication
• Works with any authentication system available to Apache, not just Shibboleth
• Can use values from Apache for authorization (to set Plone roles) as well
• Origin
• Originally a Zope/Plone Product called apachepas by Rocky Burt on behalf of Zest
Software (http://zestsoftware.nl/)
• Updated and turned in to AutoMemberMakerPASPlugin by Erik Rose of the WebLion
project at Penn State (http://weblion.psu.edu/)
• Installation
• Standard Plone Product install (same for ShibbolethLogin and ShibbolethPermissions)
• Unzip in the Plone $INSTANCE_HOME/Products directory
• Restart Zope
• Go to the Add/Remove Products page, click the checkbox by the product
name and the install button
15
Plone: Installing the Products
16
Plone: After Installing the Products
17
AutoUserMakerPASPlugin Configuration
• Configured through the “Zope Management Interface”, ZMI
• Configure domain name removal (if needed--probably should change)
• The default is to remove all domain names from user ID’s
• This can map multiple people to the same Plone account
(abrenner@ithaka.org and abrenner@internet2.edu both are abrenner to Plone)
• Configure the HTTP headers to look for (if needed)
• Configure the headers to user for authorization (if needed)
• If you add headers to the the User Mappings field, the AuthZ tab will allow
you to assign Plone roles and groups, and to map existing Plone users, to
header values.
• If you add headers to the User Sharing fields, users can grant permissions
to people who have not ever logged in (limited to what they have
permissions on). AutoUserMakerPASPlugin will assign the granted
permissions to a new user, immediately after it creates the user.
18
ZMI: acl_users
/test is the Plone install in the

Zope environment.
acl_users is the user and group

repository.
The AutoUserMakerPASPlugin
and other entries are links to
the configuration pages.
19
ZMI: AutoUserMakerPASPlugin 1
Only use the strip all

option when you know
there will not be ID
duplication.
Use the strip from list

option when you already
have users in Plone and
want to migrate to
external authentication.
20
ZMI: AutoUserMakerPASPlugin 1 Example
I recommend a
configuration like this,
unless you absolutely
know you will not have
user ID conflicts.
21
The defaults might be all

you need.
You can list sources for

each field. AUMPP will
use the first non-empty
entry in the list.
22
Plone: Display of the User Setup Headers
AutoUserMakerPASPlugin fills
these values in, when the
User Setup Headers have data.
As mentioned in the login
sequence, Plone shows the
“Full Name” instead of the
userid when this has data.
23
You only need to fill these

in when you, or your users,
want to grant permissions
to users authenticated via
AutoUserMakerPASPlugin.
24
ZMI: AutoUserMakerPASPlugin 3 Example
When you add lines to the

User Mapping Headers,
AutoUserMakerPASPlugin
enables assigning global
Plone roles.
Adding User Sharing Headers

allows users to grant
permissions to users who
don’t exist yet.
25
ZMI: AutoUserMakerPASPlugin AuthZ 1
The initial role mapping shows anyone with

‘a brenner’ in the HTTP_X_REMOTE_USER
getting assigned to the Administors group
at first log in.
26
After clicking the Add button,

AutoUserMakerPASPlugin has
a mapping, so it shows it with
some edit/delete options. 27
This shows that the external user

‘a brenner’ will be the Plone user
‘me’. Handy for migrating existing
Plone sites, so users have one less 28
password to deal with.
AutoUserMakerPASPlugin Source
• AutoUserMakerPASPlugin/Extensions/Install.py
• Instantiates and activates as the Authentication and Extraction interfaces
• AutoUserMakerPASPlugin/auth.py
• Defines the ExtractionPlugin class
• Implements the IExtractionPlugin interface
• The extractCredentials method gets the HTTP request values configured by the Plone
administrator and stores them for use by a class that implements the
IAuthenticationPlugin interface.
• Defines the AutoUserMakerPASPlugin class
• Implements the IAuthenticationPlugin interface
• The authenticateCredentials method creates Plone users from Shibboleth authenticated
users, and assigns roles and permissions to those users.
• Defines the ApacheAuthPluginHandler class
• handles the ZMI configuration forms
29
ShibbolethLogin
• Installing this modifies the default login_form, adding a section that
show the configured Identity Providers.
• This only works when you haven’t modified the default login_form.
• You can use the tal:block in a customized form:
<tal:block tal:define="wayf here/acl_users/ShibbolethLogin">
<p i18n:translate="description_external_login"
tal:repeat="idp python:wayf.getWayf(came_from)">
Log in with a <a href="" tal:attributes="href python:idp[1]"><span
tal:content="python: idp[0]">PROVIDER</span></a> user id.
</p>
</tal:block>
• Configuration is all on one page in the ZMI (acl_users/ShibbolethLogin).

• The configuration page has 2 defaults as examples.
• The first example should have all of the ‘localhost’s replaced with your configuration.
• The second example works as-is: ProtectNetwork’s identity provider.
• The Plone administrator needs to configure this right after installation.
• At least remove the “localhost” entries.
30
ZMI: ShibbolethLogin Configuration
Replace at least all of the

‘localhost’s with your
ser ver.
The big fields are a (meta-)

WAYF.
31
ShibbolethLogin Python
• ShibbolethLogin/Extensions/Install.py
• Instantiates an instance in the acl_users folder
• Gets the default login_form, modifies it to add the TAL block, and saves
the updated form in portal_skins/custom
• Installs a custom logout_form that redirects users back to the HTTP site.
• ShibbolethLogin/redirector.py
• Defines a ShibbolethLogin class
• retrieves configuration values for the login and logout forms
• Defines a ShibbolethLoginHandler class
• handles the ZMI configuration forms
32
ShibbolethPermissions
• Installing this modifies the default Plone sharing page, adding a
section for granting permissions to new users based on incoming
attributes.
• Already existing Plone users, regardless of how they authenticate, are
handled by the existing Plone sharing mechanism.
• Site administrators configure the fields available to users in the
AutoUserMakerPASPlugin ZMI page.
• The ShibbolethPermissions ZMI page shows all existing grants.
• The administrator can delete them on this page.
• This page has links to each page that has user sharing; edit them there.
• Users grant permissions by clicking on the “sharing” tab of any page
that they have permissions on.
• This will probably require some user education.
• Fields are regular expressions, which includes simple strings.
• Some fields can have complex values like LDAP distinguishing names.
• Fields that don’t have values match everybody.
• There is no simple match everybody except syntax. 33
Plone: User Sharing 1
This is the top of the

sharing tab. Scroll
down to get to the
ShibbolethPermissions
section.
34
The titles come from the

AutoUserMakerPASPlugin
configuration.
Adding a grant to a specific

abrenner. A User ID of just
abrenner would match
abrenner@ithaka.org too.
35
Since we’ve set up a

permission, we’ve now
got an edit area.
36
ZMI: ShibbolethPermissions
The path is a link to the

page that the user has
shared.
The attribute list shows

those items the user filled
in, with the actual HTTP
header names.
37
ShibbolethPermissions Python
• ShibbolethPermissions/Extensions/Install.py
• Instantiates an instance in the acl_users folder
• Gets the default folder_localrole_form, inserts the TAL based Shibboleth
forms, and saves the updated form in portal_skins/custom
• Installs several small functions that get called by the forms to get and set
the configuration
• ShibbolethPermissions/permissions.py
• Defines the ShibbolethPermissions class
• Handles the storage of the user’s permission sharing (CRUD)
• Defines the ShibbolethPermissionsHandler class
• Handles the ZMI forms
38
Summary
• The software is available at:
• http://www.python.org/
• http://www.zope.org/
• http://plone.org/
• The Plone site has complete python/zope/plone installers for Windows, OS X and SuSE
Linux, with a “Unified Installer” for other Linuxes, BSDs and Solaris.
• Installing by hand is just the common ./configure; make; make install process for
Zope, running mkzopeinstance to create a directory tree and unzipping Plone in it.
• http://tid.ithaka.org/software/
• AutoUserMakerPASPlugin
• ShibbolethLogin
• ShibbolethPermissions
39

Shibplone

Uploaded by

Document Informationclick to expand document information

Copyright:

Available Formats

Shibplone

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Shibplone

Uploaded by

Copyright:

Available Formats

Enabling Access to Applications with Shibboleth:

Adding Shibboleth Logins to the Plone CMS

• I am a Senior Engineer in the Technology Innovation and Development

I focus on the Apache to

This is the default initial

ShibbolethLogin adds these

The “Account details” box

Firefox briefly displays

And now I’m logged in.

Note my full name, and the

# Load the SHIBBOLETH module

• These modules also get loaded in the httpd.conf:

LoadModule proxy_module modules/mod_proxy.so

• Tell Apache to rewrite the header to set X_REMOTE_USER

• Setup Shibboleth Authentication

/test is the Plone install in the

acl_users is the user and group

Only use the strip all

Use the strip from list

The defaults might be all

You can list sources for

You only need to fill these

When you add lines to the

Adding User Sharing Headers

The initial role mapping shows anyone with

After clicking the Add button,

This shows that the external user

• Configuration is all on one page in the ZMI (acl_users/ShibbolethLogin).

Replace at least all of the

The big fields are a (meta-)

This is the top of the

The titles come from the

Adding a grant to a specific

Since we’ve set up a

The path is a link to the

The attribute list shows

You might also like