Skip to main content

Django database backends to use AWS Database IAM Authentication

Project description

Django IAM database backends

codecov pypi readthedocs tests

Usage

pip install django-iam-dbauth

In your settings use the following

DATABASES = {
    "default": {
        "HOST": "<hostname>",
        "USER": "<user>",
        "NAME": "<db name>",
        "ENGINE": 'django_iam_dbauth.aws.postgresql',
        "OPTIONS": {
            "use_iam_auth": True,
            "sslmode": "require",   # See discussion on SSL below
            "resolve_cname_enabled": True,
        }
    }
}

SSL and PostgreSQL

When using IAM authentication with RDS, SSL is required. If it's not used, such as when using a CNAME (see below), login will be denied with the below error:

django.db.utils.OperationalError: FATAL:  pg_hba.conf rejects connection for host "1.2.3.4", user "some_user", database "some_database", SSL off

SSL and MySQL

Acquired Token won't work with MySQL if use RDS instance name, which is a CNAME record, as a HOST, because by default it will be resolved to a cannonical name by django-iam-dbauth. As a result the hostname of the token will bi different. To prevent the module from resolving CNAME, set "resolve_cname_enabled" to False.

CNAME considerations

Currently, IAM authentication is not supported with CNAMEs. However, this package does CNAME resolution so that the signed request for a password will work. The issue with this approach is that from the DB library's point of view, the connection is initiated to the hostname as defined in the settings. If using SSL, certificate verification will fail. In this case, for PostgreSQL you may want to set sslmode to require or verify-ca.

Further documentation:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_iam_dbauth-0.2.1.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

django_iam_dbauth-0.2.1-py2.py3-none-any.whl (5.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django_iam_dbauth-0.2.1.tar.gz.

File metadata

  • Download URL: django_iam_dbauth-0.2.1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for django_iam_dbauth-0.2.1.tar.gz
Algorithm Hash digest
SHA256 a33885c81ecdfc8eef22842a56b6a8f545c3c1a1595945ce8e87453697481a62
MD5 97f0009308613ca5455ec1b4e46cecd7
BLAKE2b-256 f5b5c728057692226236617e53740b7b7660c8bb168e1582eb7ad9a9af387d11

See more details on using hashes here.

File details

Details for the file django_iam_dbauth-0.2.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_iam_dbauth-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c3ea606ce62bf872930af948a59c792c26c6372db61911ad93b0e536009f033d
MD5 ee353fd7159c22a981a0f934eff086ae
BLAKE2b-256 70f2ec8f768046939fdd762a92f0efdda79446f7319930e486eed01fff6f6f52

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page