https://github.com/kiwitcms/python-social-auth-kerberos

Kerberos authentication backend for Python Social Auth
https://github.com/kiwitcms/python-social-auth-kerberos

Last synced: over 1 year ago
JSON representation

Kerberos authentication backend for Python Social Auth

• Host: GitHub
• URL: https://github.com/kiwitcms/python-social-auth-kerberos
• Owner: kiwitcms
• License: gpl-2.0
• Created: 2018-03-22T12:08:36.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-14T20:36:52.000Z (over 1 year ago)
• Last Synced: 2024-10-30T05:42:05.527Z (over 1 year ago)
• Language: Python
• Homepage: https://kiwitcms.org
• Size: 47.9 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Kerberos authentication backend for Python Social Auth

======================================================

.. image:: https://github.com/kiwitcms/python-social-auth-kerberos/workflows/integration%20test/badge.svg

    :target: https://github.com/kiwitcms/python-social-auth-kerberos/actions

.. image:: https://coveralls.io/repos/github/kiwitcms/python-social-auth-kerberos/badge.svg?branch=master

   :target: https://coveralls.io/github/kiwitcms/python-social-auth-kerberos?branch=master

.. image:: https://tidelift.com/badges/package/pypi/social-auth-kerberos

    :target: https://tidelift.com/subscription/pkg/pypi-social-auth-kerberos?utm_source=pypi-social-auth-kerberos&utm_medium=github&utm_campaign=readme

    :alt: Tidelift

.. image:: https://opencollective.com/kiwitcms/tiers/sponsor/badge.svg?label=sponsors&color=brightgreen

   :target: https://opencollective.com/kiwitcms#contributors

   :alt: Become a sponsor

.. image:: https://img.shields.io/twitter/follow/KiwiTCMS.svg

    :target: https://twitter.com/KiwiTCMS

    :alt: Kiwi TCMS on Twitter

This package provides Kerberos backend for Python Social Auth. It can be used to

enable passwordless authentication inside a Django app or any other application

that supports Python Social Auth. This is a pure Python implementation which doesn't

depend on Apache ``mod_auth_kerb``.

Installation

------------

To install::

    pip install social-auth-kerberos

**WARNING:** you will need gcc, Python and kerberos devel packages to

build the ``gssapi`` dependency because it doesn't provide binary packages. Try

``dnf install gcc krb5-devel python3-devel`` (Red Hat/Fedora) or

``apt-get install gcc libkrb5-dev libpython3-dev`` (Debian/Ubuntu).

Configuration

-------------

`Configure Python Social Auth `_

and then make sure you have the following settings enabled::

    AUTHENTICATION_BACKENDS = [

        'social_auth_kerberos.backend.KerberosAuth',

        'django.contrib.auth.backends.ModelBackend',

    ]

    SOCIAL_AUTH_KRB5_KEYTAB = '/Kiwi/your-application.keytab'

**IMPORTANT:**

The principal name for your Kiwi TCMS web service must be

``HTTP/@REALM.EXAMPLE.COM`` where ``fqdn.example.com`` is

the domain name of the Kiwi TCMS server and ``REALM.EXAMPLE.COM`` is the

Kerberos realm that is used in your organization.

``/Kiwi/your-application.keytab`` is the keytab file for your

web app principal! If you install this inside a Docker container make sure

to ``chown 1001:root``!

Pipeline configuration

----------------------

Python Social Auth, and by extension this plugin, will create new user accounts

upon first access of the web interface. In Kiwi TCMS users need to either be

in the special group *Tester* or have sufficient permissions to add/edit/delete

objects.

You can automatically assign new accounts to the *Tester* group if

you append ``social_auth_kerberos.pipeline.initiate_defaults`` to the end

of the ``SOCIAL_AUTH_PIPELINE`` setting.

**WARNING:** this is not done for you automatically because some administrators

may want to employ different behaviour for newly registered accounts!

Kerberos configuration

----------------------

For more information about Kerberos see:

- `How to configure Firefox for kerberos `_

- `How to configure kerberos on Fedora `_

- `How to generate a keytab file

  `_

or check out ``tests/Dockerfile.kerberos``.

Changelog

---------

v0.3.0 (17 Dec 2023)

~~~~~~~~~~~~~~~~~~~~

- Update gssapi from 1.6.12 to 1.8.3

- Update social-auth-core from 4.0.1 to 4.5.1

- Document the need to compile ``gssapi``. Fixes

  `Issue #3 `_

- Build and test with Python 3.11, Kiwi TCMS v12.7

- Remove unused import

v0.2.4 (24 Mar 2020)

~~~~~~~~~~~~~~~~~~~~

- Add ``social_auth_kerberos.pipeline`` with function to initialize

  default permissions for newly created accounts. See section

  *Pipeline configuration*

- Update README with more information how to configure this plugin

- Enable integration testing with Kerberos and coverage collection

v0.2.3 (22 Mar 2020)

~~~~~~~~~~~~~~~~~~~~

- Keep a reference to current user before checking anything else.

  Resolves a crash for clients which know that the server is

  Kerberos enabled and directly send the Authorization header

- Be more tolerant to authorization request headers which don't

  match RFC-4459, section 4.2

v0.2.2 (10 Nov 2019)

~~~~~~~~~~~~~~~~~~~~

- Pin license version to GPLv2 for Tidelift

v0.2.1 (10 Dec 2018)

~~~~~~~~~~~~~~~~~~~~

- Initial release