README
¶
Welcome to Authd OpenID Connect Broker
This is the code repository for Authd OpenID Connect (OIDC) brokers. It is used in conjunction with Ubuntu authentication daemon authd.
This project contains specific code for different OpenID Connect providers. We build one binary for each and snap them based on build tags to integrate with the Ubuntu authentication daemon.
For general details, check the authd getting started guide. The same documentation reference hosts installation and configuration instructions.
Troubleshooting
More details on troubleshooting one of the OIDC brokers is available on the authd documentation.
Get involved
This is an open source project and we warmly welcome community contributions, suggestions, and constructive feedback. If you're interested in contributing, please take a look at our Contribution guidelines first.
- to report an issue, please file a bug report against our repository, using a bug template.
- for suggestions and constructive feedback, report a feature request bug report, using the proposed template.
Get in touch
We're friendly! We have a community forum at https://discourse.ubuntu.com where we discuss feature plans, development news, issues, updates and troubleshooting.
For news and updates, follow the Ubuntu twitter account and on Facebook.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
authd-oidc
Package main is the entry point.
|
Package main is the entry point. |
|
authd-oidc/daemon
Package daemon represents the oidc broker binary
|
Package daemon represents the oidc broker binary |
|
internal
|
|
|
broker
Package broker is the generic oidc business code.
|
Package broker is the generic oidc business code. |
|
broker/authmodes
Package authmodes lists the authentication modes that providers can support.
|
Package authmodes lists the authentication modes that providers can support. |
|
broker/sessionmode
Package sessionmode defines the session modes supported by the broker.
|
Package sessionmode defines the session modes supported by the broker. |
|
consts
Package consts defines the constants used by the project.
|
Package consts defines the constants used by the project. |
|
daemon
Package daemon handles the dbus daemon with systemd support.
|
Package daemon handles the dbus daemon with systemd support. |
|
dbusservice
Package dbusservice is the dbus service implementation delegating its functional call to brokers.
|
Package dbusservice is the dbus service implementation delegating its functional call to brokers. |
|
fileutils
Package fileutils provides utility functions for file operations.
|
Package fileutils provides utility functions for file operations. |
|
password
Package password provides functions for creating and using the hashed password file.
|
Package password provides functions for creating and using the hashed password file. |
|
providers
Package providers define provider-specific configurations and functions to be used by the OIDC broker.
|
Package providers define provider-specific configurations and functions to be used by the OIDC broker. |
|
providers/errors
Package errors provides custom error types which can be returned by the providers
|
Package errors provides custom error types which can be returned by the providers |
|
providers/google
Package google is the google specific extension.
|
Package google is the google specific extension. |
|
providers/info
Package info defines types used by the broker.
|
Package info defines types used by the broker. |
|
providers/msentraid
Package msentraid is the Microsoft Entra ID specific extension.
|
Package msentraid is the Microsoft Entra ID specific extension. |
|
providers/noprovider
Package noprovider is the generic oidc extension.
|
Package noprovider is the generic oidc extension. |
|
testutils
Package testutils provides utility functions and behaviors for testing.
|
Package testutils provides utility functions and behaviors for testing. |
|
testutils/golden
Package golden provides utilities to compare and update golden files in tests.
|
Package golden provides utilities to compare and update golden files in tests. |
|
token
Package token provides functions to save and load tokens from disk.
|
Package token provides functions to save and load tokens from disk. |
|
Package po allows embedding po files in project in development mode or windows.
|
Package po allows embedding po files in project in development mode or windows. |