Skip to content

Support specifying the values for OIDC authentication via a secret key reference #987

@nogweii

Description

@nogweii

Proposed functionality

Right now, in order to authenticate with an OIDC provider you must specify the OpenID Connect client ID & secret via a specifically structured Secret and reference the secret in values.yaml. I'd like to propose specific support for those two values in the chart to more flexibly fetch from an arbitrary Secret. Something like the following sample values.yaml:

remoteAuth:
  enabled: true
  backends:
    - social_core.backends.open_id_connect.OpenIdConnectAuth
  oidc:
    existingSecretName: 'netbox-oidc'
    existingSecretClientIdKey: client-id
    existingSecretClientSecretKey: oidc_secret

Further customization, notably groups or roles, would remain the same. It's specifically the two configuration settings for social auth that I think should have special support, SOCIAL_AUTH_OIDC_KEY and SOCIAL_AUTH_OIDC_SECRET.

Use case

Figuring out the exact structure I needed to put my Secret was a surprising pain. I'd like to make it easier for others configuring Netbox with a generic OpenID Connect provider.

OIDC is common enough and well-supported that I think it's worth the special handling. I would not expect to add special support for other social auth backends.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions