From 57866c1c51d1cef55cc079b0aa51539b6644ec6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marco=20Trevisan=20=28Trevi=C3=B1o=29?= Date: Fri, 22 Nov 2024 11:59:31 +0100 Subject: [PATCH] examplebroker: Move to internal package Now that authd can be imported we should not expose anything that isn't an API. --- README.md | 2 +- docs/index.md | 2 +- internal/brokers/withexamples.go | 2 +- .../ExampleBroker => internal/examplebroker/ExampleBroker.conf | 0 {examplebroker => internal/examplebroker}/broker.go | 0 .../examplebroker}/com.ubuntu.auth.ExampleBroker.conf | 0 .../examplebroker}/com.ubuntu.auth.ExampleBroker.xml | 0 {examplebroker => internal/examplebroker}/dbus.go | 0 8 files changed, 3 insertions(+), 3 deletions(-) rename examplebroker/ExampleBroker => internal/examplebroker/ExampleBroker.conf (100%) rename {examplebroker => internal/examplebroker}/broker.go (100%) rename {examplebroker => internal/examplebroker}/com.ubuntu.auth.ExampleBroker.conf (100%) rename {examplebroker => internal/examplebroker}/com.ubuntu.auth.ExampleBroker.xml (100%) rename {examplebroker => internal/examplebroker}/dbus.go (100%) diff --git a/README.md b/README.md index ff7980261..e43506fcc 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ A reference for [troubleshooting](https://github.com/ubuntu/authd/wiki/06--Troub ## Brokers -Authd uses brokers to interface with cloud identity providers through a [DBus API](https://github.com/ubuntu/authd/blob/HEAD/examplebroker/com.ubuntu.auth.ExampleBroker.xml). +Authd uses brokers to interface with cloud identity providers through a [DBus API](https://github.com/ubuntu/authd/blob/HEAD/internal/examplebroker/com.ubuntu.auth.ExampleBroker.xml). Currently [MS Entra ID](https://learn.microsoft.com/en-us/entra/fundamentals/whatis) is supported as an identity provider. The [MS Entra ID broker](https://github.com/ubuntu/oidc-broker) allows you to authenticate against MS Entra ID using MFA and the device authentication flow. diff --git a/docs/index.md b/docs/index.md index d278be5a7..4b3f51c43 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ Authd is a versatile authentication service for Ubuntu, designed to seamlessly i Authd features a modular structure, facilitating straightforward integration with different cloud services. This design aids in maintaining strong security and effective user authentication. It's well-suited for handling access to cloud identities, offering a balance of security and ease of use. -Authd uses brokers to interface with cloud identity providers through a [DBus API](https://github.com/ubuntu/authd/blob/HEAD/examplebroker/com.ubuntu.auth.ExampleBroker.xml). Currently only [MS Entra ID](https://learn.microsoft.com/en-us/entra/fundamentals/whatis) is supported. For development purposes, Authd also provides an example broker to help you develop your own. +Authd uses brokers to interface with cloud identity providers through a [DBus API](https://github.com/ubuntu/authd/blob/HEAD/examplebroker/internal/com.ubuntu.auth.ExampleBroker.xml). Currently only [MS Entra ID](https://learn.microsoft.com/en-us/entra/fundamentals/whatis) is supported. For development purposes, Authd also provides an example broker to help you develop your own. The [MS Entra ID broker](https://github.com/ubuntu/oidc-broker) allows you to authenticate against MS Entra ID using MFA and the device authentication flow. diff --git a/internal/brokers/withexamples.go b/internal/brokers/withexamples.go index 47371e0eb..130d7721f 100644 --- a/internal/brokers/withexamples.go +++ b/internal/brokers/withexamples.go @@ -6,7 +6,7 @@ import ( "context" "os" - "github.com/ubuntu/authd/examplebroker" + "github.com/ubuntu/authd/internal/examplebroker" "github.com/ubuntu/authd/internal/log" "github.com/ubuntu/authd/internal/testutils" ) diff --git a/examplebroker/ExampleBroker b/internal/examplebroker/ExampleBroker.conf similarity index 100% rename from examplebroker/ExampleBroker rename to internal/examplebroker/ExampleBroker.conf diff --git a/examplebroker/broker.go b/internal/examplebroker/broker.go similarity index 100% rename from examplebroker/broker.go rename to internal/examplebroker/broker.go diff --git a/examplebroker/com.ubuntu.auth.ExampleBroker.conf b/internal/examplebroker/com.ubuntu.auth.ExampleBroker.conf similarity index 100% rename from examplebroker/com.ubuntu.auth.ExampleBroker.conf rename to internal/examplebroker/com.ubuntu.auth.ExampleBroker.conf diff --git a/examplebroker/com.ubuntu.auth.ExampleBroker.xml b/internal/examplebroker/com.ubuntu.auth.ExampleBroker.xml similarity index 100% rename from examplebroker/com.ubuntu.auth.ExampleBroker.xml rename to internal/examplebroker/com.ubuntu.auth.ExampleBroker.xml diff --git a/examplebroker/dbus.go b/internal/examplebroker/dbus.go similarity index 100% rename from examplebroker/dbus.go rename to internal/examplebroker/dbus.go