The Shibboleth V2 IdP and SP software have reached End of Life and are no longer supported. This documentation is available for historical purposes only. See the IDP v4 and SP v3 wiki spaces for current documentation on the supported versions.

IdPMDUIRecommendations

Owned by Rod Widdowson
Last updated: Oct 09, 2015 by Walter Hoehn

Metadata Extensions supported by the Shibboleth IdP

This page gives software recommendations to service providers regarding the Metadata Extensions for Login and Discovery, often referred to as the mdui extensions.

Note that federations may (and are expected to) make further recommendations.

IdP 2.3 (and later) supports the use of these extensions in its login and error pages, and the default page makes use of some of them.
The uApprove consent engine, compatible with Shibboleth IdP 2.2 (and later), also makes uses of these elements. The consent page planned for the Shibboleth IdP 3.0 will make use of the mdui extension elements as well.

SPs following these recommendations assure their users of the best possible experience at the IdP. Federations are encouraged to discuss these recommendations and the corresponding recommendations for IdPs with their customers.

Utilization of mdui Extension Elements

 

Taglib support available in IdP

IdP Default Login Page

uApprove > 2.3 (with IdP > 2.3)

IdP 3.0 Consent Page

<mdui:DisplayName>

Yes

Yes

Yes

Planned

<mdui:Description>

Yes

Yes

Yes

Planned

<mdui:Keywords>

No

No

No

<mdui:InformationURL>

Yes

No

Yes

Planned

<mdui:PrivacyStatementURL>

Yes

No

Yes

Planned

<mdui:Logo>

Yes

Yes

Yes

Planned

Recommendations regarding the mdui Extension Elements

International Languages

Content should be provided in one or more appropriate languages subject to federation requirements.

DisplayName

A concise, user-recognizable display name should be provided. It is strongly recommended that the <mdui:DisplayName> element be treated as a required child element of the <mdui:UIInfo> element.

Description

A brief description (100 characters or less) of the service should be provided.
On systems that support a pointing device (such as a mouse), the content of the <mdui:Description> element will pop up when the user hovers over the SP display name.

Keywords

No recommendations are currently made.

InformationURL

A link to a more comprehensive information page may be provided. This page should expand on the content of the <mdui:Description> element.

PrivacyStatementURL

A link to the SP's Privacy Policy may be provided.

Some federations (such as the InCommon Federation) strongly encourage a Privacy Policy by noting the omission of this element on their user interfaces.

Usable logos have the following characteristics:

  • logos must be specified using an HTTPS URL
  • logo size should be between 64px - 350px wide and 64px - 146px high
  • logos should have transparent backgrounds
  • logos look better if they have a landscape rather than a portrait aspect ratio

Logos that are too small are ignored, while logos that are too large will be scaled as best as possible.