-
Notifications
You must be signed in to change notification settings - Fork 67
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[WIP] Implement Zitadel IDP #549
Draft
Foxtrek64
wants to merge
2
commits into
CommunityToolkit:main
Choose a base branch
from
Foxtrek64:Feature/ZitadelIntegration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+147
−0
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
src/CommunityToolkit.Aspire.Hosting.Zitadel/CommunityToolkit.Aspire.Hosting.Zitadel.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<Project Sdk="Microsoft.NET.Sdk"> | ||
|
||
<PropertyGroup> | ||
<AdditionalPackageTags>Zitadel</AdditionalPackageTags> | ||
<Description>Provides Zitadel IDP integration for Aspire.</Description> | ||
</PropertyGroup> | ||
|
||
<ItemGroup> | ||
<PackageReference Include="Aspire.Hosting" /> | ||
<PackageReference Include="Zitadel" /> | ||
</ItemGroup> | ||
|
||
</Project> |
22 changes: 22 additions & 0 deletions
22
src/CommunityToolkit.Aspire.Hosting.Zitadel/ZitadelContainerImageTags.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
namespace CommunityToolkit.Aspire.Hosting.Zitadel; | ||
|
||
/// <summary> | ||
/// Contains strings which describes the Zitadel container registry. | ||
/// </summary> | ||
internal static class ZitadelContainerImageTags | ||
{ | ||
/// <summary> | ||
/// ghcr.io | ||
/// </summary> | ||
public const string Registry = "ghcr.io"; | ||
|
||
/// <summary> | ||
/// zitadel/zitadel | ||
/// </summary> | ||
public const string Image = "zitadel/zitadel"; | ||
|
||
/// <summary> | ||
/// latest | ||
/// </summary> | ||
public const string Tag = "latest"; | ||
} |
38 changes: 38 additions & 0 deletions
38
src/CommunityToolkit.Aspire.Hosting.Zitadel/ZitadelResource.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
using Aspire.Hosting; | ||
using Aspire.Hosting.ApplicationModel; | ||
using System.Security.Cryptography.Xml; | ||
|
||
namespace CommunityToolkit.Aspire.Hosting.Zitadel; | ||
|
||
/// <summary> | ||
/// A resource that represents a Zitadel resource. | ||
/// <param name="name">The name of the resource.</param> | ||
/// <param name="admin">A parameter that contains the Zitadel admin, or <see langword="null"/> to use a default value.</param> | ||
/// <param name="adminPassword">A parameter that contains the Zitadel admin password.</param> | ||
/// </summary> | ||
public sealed class ZitadelResource(string name, ParameterResource? admin, ParameterResource adminPassword) | ||
: ContainerResource(name), IResourceWithServiceDiscovery | ||
{ | ||
private const string DefaultAdmin = "zitadel-admin"; | ||
|
||
/// <summary> | ||
/// Gets the parameter that contains the Zitadel admin username. | ||
/// </summary> | ||
public ParameterResource? AdminUserNameParameter { get; } = admin; | ||
|
||
/// <summary> | ||
/// Gets the parameter that contains the Zitadel admin username. | ||
/// </summary> | ||
internal ReferenceExpression AdminReference | ||
=> AdminUserNameParameter is not null | ||
? ReferenceExpression.Create($"{AdminUserNameParameter}") | ||
: ReferenceExpression.Create($"{DefaultAdmin}"); | ||
|
||
/// <summary> | ||
/// Gets the parameter that contains the Zitadel admin password. | ||
/// </summary> | ||
public ParameterResource AdminPasswordParameter { get; } = adminPassword ?? throw new ArgumentNullException(nameof(adminPassword)); | ||
} |
67 changes: 67 additions & 0 deletions
67
src/CommunityToolkit.Aspire.Hosting.Zitadel/ZitadelResourceBuilderExtensions.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
using Aspire.Hosting; | ||
using Aspire.Hosting.ApplicationModel; | ||
|
||
namespace CommunityToolkit.Aspire.Hosting.Zitadel; | ||
|
||
/// <summary> | ||
/// Provides extension methods for adding Zitadel resources to an <see cref="IDistributedApplicationBuilder"/>. | ||
/// </summary> | ||
public static class ZitadelResourceBuilderExtensions | ||
{ | ||
private const string AdminEnvVarName = "ZITADEL_DEFAULTINSTANCE_ORG_HUMAN_USERNAME"; | ||
private const string AdminEnvVarPassword = "ZITADEL_DEFAULTINSTANCE_ORG_HUMAN_PASSWORD"; | ||
|
||
private const int DefaultcontainerPort = 8080; // ZITADEL_PORT | ||
private const string ManagementEndpointName = "management"; | ||
|
||
/// <summary> | ||
/// Adds a Zitadel container to the application model. | ||
/// </summary> | ||
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param> | ||
/// <param name="name">The name of the resource. </param> | ||
/// <param name="port">The host port that the underlying container is bound to when running locally.</param> | ||
/// <param name="adminUsername">The parameter used as the admin for the Zitadel resource. If <see langword="null"/> a default value will be used.</param> | ||
/// <param name="adminPassword">The parameter used as the admin password for the Zitadel resource. If <see langword="null"/> a default password will be used.</param> | ||
/// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns> | ||
public static IResourceBuilder<ZitadelResource> AddZitadel | ||
( | ||
this IDistributedApplicationBuilder builder, | ||
string name, | ||
int? port = null, | ||
IResourceBuilder<ParameterResource>? adminUsername = null, | ||
IResourceBuilder<ParameterResource>? adminPassword = null | ||
) | ||
{ | ||
ArgumentNullException.ThrowIfNull(builder); | ||
ArgumentException.ThrowIfNullOrEmpty(name); | ||
|
||
var passwordParameter = adminPassword?.Resource ?? | ||
builder.AddParameter | ||
( | ||
name: $"{name}-password", | ||
valueGetter: () => "Password1!", | ||
secret: true | ||
).Resource; | ||
|
||
var resource = new ZitadelResource(name, adminUsername?.Resource, passwordParameter); | ||
|
||
// TODO: Add health check | ||
var zitadel = builder | ||
.AddResource(resource) | ||
.WithImage(ZitadelContainerImageTags.Image) | ||
.WithImageRegistry(ZitadelContainerImageTags.Registry) | ||
.WithImageTag(ZitadelContainerImageTags.Tag) | ||
.WithHttpEndpoint(port: port, targetPort: DefaultcontainerPort) | ||
.WithEnvironment(context => | ||
{ | ||
context.EnvironmentVariables[AdminEnvVarName] = resource.AdminReference; | ||
context.EnvironmentVariables[AdminEnvVarPassword] = resource.AdminPasswordParameter; | ||
// TODO: Implement Postgres/Cockroach DB integration. See https://zitadel.com/docs/self-hosting/deploy/compose | ||
}); | ||
|
||
return zitadel; | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Take a look at how the other resources implement default passwords. None are hardcoded and we do random password generation. https://github.com/dotnet/aspire/blob/cf14299e30838ccfd369ee416c5d962409fd4e5a/src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs#L35
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Saw that. Wasn't sure if I should use the documented default value or generate it. I'll switch to the generated password.