The Shibboleth IdP V4 software will leave support on September 1, 2024.

DevelopmentGuide



Much of this documentation is out of date or incomplete. It will remain so barring a decision by the Consortium to fund its completion as a work item, but we are working to gradually improve it as time permits. If you have important needs, raise them on the dev@shibboleth.net so we can prioritize the time we spend on topics.

This document provides an overview of the design of the Identity Provider and material necessary to assist anybody working on extensions. Deployers of the Identity Provider, especially those with advanced needs, may find the material in here useful as well, but we do not intend that it be necessary for most deployers to read it.

If you're interested in developing with the code, or contributing to it, refer to https://shibboleth.atlassian.net/wiki/spaces/IDP4/pages/1265631879 and to https://shibboleth.atlassian.net/wiki/spaces/DEV/pages/1123450991 for help in getting started.

  1. General Architecture

  2. Persistence

  3. Profile Handling

  4. Authentication

  5. Sessions

  6. Subject Canonicalization

  7. Attribute Resolver

  8. Attribute Registry

  9. Attribute Filter

  10. Attribute Consent and Terms of Use

  11. Reloadable Configurations

  12. Administration

  13. Modules

  14. Building Extensions

If you use Eclipse, there are some projects the team uses for development testing that you may find useful.

Some additional information can be found in these topics until we integrate it into this material:

  1. Developing Attribute Resolver Extensions