nginx-ldap-auth-service

Overview

  • CHANGELOG
    • 2.6.2 (2026-02-21)
      • Enhancements
      • Bugfixes
    • 2.6.1 (2026-02-18)
      • Enhancements
    • 2.6.0 (2026-02-12)
      • Enhancements
    • 2.5.1 (2026-01-27)
      • Bugfixes
    • 2.5.0 (2026-01-27)
      • Enhancements
      • Bugfixes
    • 2.4.2 (2026-01-16)
      • Enhancements
    • 2.4.1 (2026-01-13)
      • Enhancements
    • 2.4.0 (2026-01-12)
      • Enhancements
    • 2.3.0 (2025-10-29)
    • 2.2.0 (2025-10-03)
      • Enhancements
    • 2.1.8 (2025-06-25)
      • Documentation
    • 2.1.7 (2025-06-23)
      • Enhancements
    • 2.1.6 (2025-05-02)
      • Enhancements
      • Documentation
    • 2.1.5 (2025-03-17)
      • Enhancements
      • Bugfixes
    • 2.1.4 (2025-02-19)
      • Enhancements
    • 2.1.3 (2025-02-11)
      • Bugfixes
    • 2.1.2 (2025-01-30)
      • Bugfixes
    • 2.1.1 (2025-01-30)
      • Enhancements
      • Bugfixes
    • 2.1.0 (2025-01-30)
      • Enhancements
      • Documentation
    • 2.0.5 (2023-07-23)
      • Bugfixes
    • 2.0.4 (2023-07-14)
      • Enhancements
      • Bugfixes
      • Documentation
    • 2.0.3 (2023-07-11)
      • Bugfixes
      • Documentation
    • 2.0.2 (2023-07-11)
      • Enhancements
      • Bugfixes
    • 2.0.1 (2023-07-11)
      • Documentation
    • 1.0.0 (2023-07-07)
      • Enhancements
  • Installation
    • From Source
    • From Docker Hub
  • Running nginx_ldap_auth_service
    • nginx-ldap-auth command line
      • Arguments
    • Deployments
      • Docker sidecar container
      • As a daemon
  • Configuration Overview
    • Command Line
    • nginx Header Configuration
    • Mandatory Headers
    • Optional Headers
    • Environment
      • Web Server
      • Login form and sessions
      • Duo MFA
      • LDAP
  • Configuring nginx
    • ngx_http_auth_request_module
    • nginx.conf
  • Monitoring nginx_ldap_auth_service
    • /status
    • /status/ldap
  • Contributing
    • Instructions for contributors
    • Preconditions for working on nginx-ldap-auth-service
    • Precondiions for running the docker-compose stack in development
    • Prepare the docker environment
    • Build the Docker image
    • Run the stack
    • Run the tests
    • Use your dev environment

Developer Interface

  • Views
  • Models
    • UserManager
      • UserManager.model
      • UserManager.settings
      • UserManager.pool
      • UserManager.client
      • UserManager.create_pool
      • UserManager.authenticate
      • UserManager.exists
      • UserManager.is_authorized
      • UserManager.get
      • UserManager.cleanup
    • User
      • User.uid
      • User.full_name
      • User.authenticate
      • User.parse_ldap
      • User.model_config
  • LDAP
    • TimeLimitedAIOLDAPConnection
      • TimeLimitedAIOLDAPConnection.is_expired
      • TimeLimitedAIOLDAPConnection.abandon
      • TimeLimitedAIOLDAPConnection.add
      • TimeLimitedAIOLDAPConnection.close
      • TimeLimitedAIOLDAPConnection.closed
      • TimeLimitedAIOLDAPConnection.delete
      • TimeLimitedAIOLDAPConnection.fileno
      • TimeLimitedAIOLDAPConnection.get_result
      • TimeLimitedAIOLDAPConnection.is_async
      • TimeLimitedAIOLDAPConnection.modify_password
      • TimeLimitedAIOLDAPConnection.open
      • TimeLimitedAIOLDAPConnection.paged_search
      • TimeLimitedAIOLDAPConnection.search
      • TimeLimitedAIOLDAPConnection.virtual_list_search
      • TimeLimitedAIOLDAPConnection.whoami
    • TimeLimitedAIOConnectionPool
      • TimeLimitedAIOConnectionPool.get
      • TimeLimitedAIOConnectionPool.close
      • TimeLimitedAIOConnectionPool.closed
      • TimeLimitedAIOConnectionPool.empty
      • TimeLimitedAIOConnectionPool.idle_connection
      • TimeLimitedAIOConnectionPool.max_connection
      • TimeLimitedAIOConnectionPool.open
      • TimeLimitedAIOConnectionPool.put
      • TimeLimitedAIOConnectionPool.shared_connection
      • TimeLimitedAIOConnectionPool.spawn
  • Middleware
    • SessionMiddleware
      • SessionMiddleware.COOKIE_NAME_HEADER
      • SessionMiddleware.COOKIE_DOMAIN_HEADER
    • ExceptionLoggingMiddleware
      • ExceptionLoggingMiddleware.dispatch
  • Settings
    • Settings
      • Settings.debug
      • Settings.loglevel
      • Settings.log_type
      • Settings.auth_realm
      • Settings.insecure
      • Settings.cookie_name
      • Settings.cookie_domain
      • Settings.secret_key
      • Settings.session_max_age
      • Settings.use_rolling_session
      • Settings.session_backend
      • Settings.redis_url
      • Settings.redis_prefix
      • Settings.ldap_uri
      • Settings.ldap_binddn
      • Settings.ldap_password
      • Settings.ldap_starttls
      • Settings.ldap_validate_cert
      • Settings.ldap_ca_cert_name
      • Settings.ldap_ca_cert_dir
      • Settings.ldap_disable_referrals
      • Settings.ldap_basedn
      • Settings.ldap_user_basedn
      • Settings.ldap_username_attribute
      • Settings.ldap_full_name_attribute
      • Settings.ldap_get_user_filter
      • Settings.ldap_authorization_filter
      • Settings.allow_authorization_filter_header
      • Settings.ldap_timeout
      • Settings.ldap_min_pool_size
      • Settings.ldap_max_pool_size
      • Settings.ldap_pool_connection_lifetime_seconds
      • Settings.duo_enabled
      • Settings.duo_host
      • Settings.duo_ikey
      • Settings.duo_skey
      • Settings.sentry_url
      • Settings.model_config
      • Settings.redis_url_required_if_session_type_is_redis
      • Settings.duo_settings_required_if_enabled
      • Settings.ensure_authorization_filter_header_is_a_valid_ldap_filter
      • Settings.ensure_get_user_filter_is_a_valid_ldap_filter
      • Settings.ensure_ca_cert_cert
      • Settings.construct
      • Settings.copy
      • Settings.dict
      • Settings.from_orm
      • Settings.json
      • Settings.model_computed_fields
      • Settings.model_construct
      • Settings.model_copy
      • Settings.model_dump
      • Settings.model_dump_json
      • Settings.model_extra
      • Settings.model_fields
      • Settings.model_fields_set
      • Settings.model_json_schema
      • Settings.model_parametrized_name
      • Settings.model_post_init
      • Settings.model_rebuild
      • Settings.model_validate
      • Settings.model_validate_json
      • Settings.model_validate_strings
      • Settings.parse_file
      • Settings.parse_obj
      • Settings.parse_raw
      • Settings.schema
      • Settings.schema_json
      • Settings.settings_customise_sources
      • Settings.update_forward_refs
      • Settings.validate
nginx-ldap-auth-service
  • Overview: module code

All modules for which code is available

  • nginx_ldap_auth.app.middleware
  • nginx_ldap_auth.app.models
  • nginx_ldap_auth.ldap
  • nginx_ldap_auth.settings

© Copyright 2023, Caltech IMSS ADS.