Django AAI@EduHr

django-aai-eduhr is a Django application designed to simplify the integration of your projects with AAI@EduHr, a SAML-based Single Sign-On (SSO) service. It provides a ready-to-use authentication and authorization backend, with flexibility for customization and extensions. Additionally, the application includes a management command to quickly configure SAML settings, allowing you to focus on development without getting bogged down by configuration tasks.

This project is not officially affiliated with University Computing Center of University of Zagreb or AAI@EduHr project.

Overview

Django AAI@EduHr version 1.0.1.

django-aai-eduhr is built on top of djangosaml2 and pysaml2 and shares much of its configuration with these libraries.

• Supported Python versions: 3.12+

• Supported Django versions: 4.2

• Supported pysaml2 versions: 7.5.x

• Supported djangosaml2 versions: 1.9.x

• Reference LDAP scheme: hrEdu 1.3.1

The application provides authentication backend with support for authorisation based on configurable AAI@EduHr attributes. It also supports mapping of AAI data to your custom model fields, including related (child) models, and it can normalise multi-valued attributes by creating child model instances for each value.

In addition, the manage.py aai_quickstart simplifies the setup of basic SAML configuration, allowing you to dive into development right away.

Documentation

• Getting started
  • Installation
  • Applications and middleware
  • Authentication backend
  • URL configuration
  • SAML configuration
  • Attribute mapping
  • Resource registry
• Production
  • Security
  • Metadata
  • Description
  • Resource type
• Web API Considerations
  • Authentication method
  • Separate API and frontend domains
• Frequently asked questions
  • 1. Why do I have to set up HTTPS for my local development environment?
  • 2. Why do I get “Authentication Error” page on successful login?
  • 3. How can I display something other than “Authentication Error” page when a sign-on request fails?
  • 4. How can I run custom code before or after user has logged in?
• API Reference
  • Subpackages
  • Submodules
  • Module contents
  • Settings
• Contributing
  • Code style and quality
  • Additional guidelines