Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
fix: unable to create users with rfc compliant emails (#2038)
Kyle Mendellfc5b7e438b51
diff --git a/backend/internal/huma/handlers/users.go b/backend/internal/huma/handlers/users.goindex 7b321cd9e..58b0d2ef8 100644--- a/backend/internal/huma/handlers/users.go+++ b/backend/internal/huma/handlers/users.go@@ -2,6 +2,8 @@ package handlersimport ("context"+ "errors"+ "strings""time""github.com/danielgtaylor/huma/v2"@@ -9,6 +11,7 @@ import ("github.com/getarcaneapp/arcane/backend/internal/models""github.com/getarcaneapp/arcane/backend/internal/services""github.com/getarcaneapp/arcane/backend/internal/utils/mapper"+ "github.com/getarcaneapp/arcane/backend/internal/utils/validation""github.com/getarcaneapp/arcane/types/base""github.com/getarcaneapp/arcane/types/user")@@ -194,6 +197,12 @@ func (h *UserHandler) CreateUser(ctx context.Context, input *CreateUserInput) (*return nil, err}+ normalizedEmail, err := normalizeOptionalEmailInternal(input.Body.Email)+ if err != nil {+ return nil, huma.Error400BadRequest(err.Error())+ }+ input.Body.Email = normalizedEmail+hashedPassword, err := h.userService.HashPassword(input.Body.Password)if err != nil {return nil, huma.Error500InternalServerError((&common.PasswordHashError{Err: err}).Error())@@ -276,6 +285,12 @@ func (h *UserHandler) UpdateUser(ctx context.Context, input *UpdateUserInput) (*return nil, huma.Error404NotFound((&common.UserNotFoundError{}).Error())}+ normalizedEmail, err := normalizeOptionalEmailInternal(input.Body.Email)+ if err != nil {+ return nil, huma.Error400BadRequest(err.Error())+ }+ input.Body.Email = normalizedEmail+if input.Body.Username != nil {userModel.Username = *input.Body.Username}@@ -344,3 +359,20 @@ func (h *UserHandler) DeleteUser(ctx context.Context, input *DeleteUserInput) (*},}, nil}++func normalizeOptionalEmailInternal(email *string) (*string, error) {+ if email == nil {+ return nil, nil+ }++ trimmedEmail := strings.TrimSpace(*email)+ if trimmedEmail == "" {+ return nil, nil+ }++ if !validation.IsValidUserEmail(trimmedEmail) {+ return nil, errors.New("must be a valid email")+ }++ return &trimmedEmail, nil+}diff --git a/backend/internal/utils/validation/email.go b/backend/internal/utils/validation/email.gonew file mode 100644index 000000000..3c6172abd--- /dev/null+++ b/backend/internal/utils/validation/email.go@@ -0,0 +1,89 @@+package validation++import (+ "net"+ "regexp"+ "strings"++ "golang.org/x/net/idna"+)++var localPartPattern = regexp.MustCompile(`^[A-Za-z0-9!#$%&'*+/=?^_` + "`" + `{|}~.-]+$`)++func IsValidUserEmail(email string) bool {+ trimmedEmail := strings.TrimSpace(email)+ if trimmedEmail == "" || strings.Contains(trimmedEmail, " ") {+ return false+ }++ localPart, domainPart, ok := strings.Cut(trimmedEmail, "@")+ if !ok || strings.Contains(domainPart, "@") {+ return false+ }++ return isValidLocalPartInternal(localPart) && isValidDomainPartInternal(domainPart)+}++func isValidLocalPartInternal(localPart string) bool {+ if localPart == "" || len(localPart) > 64 {+ return false+ }++ if strings.HasPrefix(localPart, ".") || strings.HasSuffix(localPart, ".") || strings.Contains(localPart, "..") {+ return false+ }++ return localPartPattern.MatchString(localPart)+}++func isValidDomainPartInternal(domainPart string) bool {+ if domainPart == "" || len(domainPart) > 255 {+ return false+ }++ if ip := net.ParseIP(domainPart); ip != nil && ip.To4() != nil {+ return true+ }++ if strings.HasPrefix(domainPart, "[") && strings.HasSuffix(domainPart, "]") {+ return isValidAddressLiteralInternal(domainPart)+ }++ asciiDomain, err := idna.Lookup.ToASCII(domainPart)+ if err != nil || asciiDomain == "" {+ return false+ }++ labels := strings.Split(asciiDomain, ".")+ if len(labels) == 4 {+ allNumeric := true+ for _, label := range labels {+ if label == "" || strings.Trim(label, "0123456789") != "" {+ allNumeric = false+ break+ }+ }+ if allNumeric {+ return false+ }+ }++ for _, label := range labels {+ if label == "" || len(label) > 63 || strings.HasPrefix(label, "-") || strings.HasSuffix(label, "-") {+ return false+ }+ }++ return true+}++func isValidAddressLiteralInternal(domainPart string) bool {+ literal := strings.TrimSuffix(strings.TrimPrefix(domainPart, "["), "]")+ if strings.HasPrefix(strings.ToLower(literal), "ipv6:") {+ ip := net.ParseIP(literal[5:])+ return ip != nil && ip.To4() == nil+ }++ ip := net.ParseIP(literal)+ return ip != nil && ip.To4() != nil && !strings.Contains(literal, ":")+}diff --git a/backend/internal/utils/validation/email_test.go b/backend/internal/utils/validation/email_test.gonew file mode 100644index 000000000..57f1ed0ed--- /dev/null+++ b/backend/internal/utils/validation/email_test.go@@ -0,0 +1,53 @@+package validation++import "testing"++func TestIsValidUserEmail_AllowsReportedFormats(t *testing.T) {+ t.Parallel()++ validEmails := []string{+ "[email protected]",+ "user@[IPv6:3ffe::32]",+ "user@localdomain",+ "user@website.日本",+ }++ for _, email := range validEmails {+ email := email+ t.Run(email, func(t *testing.T) {+ t.Parallel()+ if !IsValidUserEmail(email) {+ t.Fatalf("expected %q to be valid", email)+ }+ })+ }+}++func TestIsValidUserEmail_RejectsMalformedAddresses(t *testing.T) {+ t.Parallel()++ invalidEmails := []string{+ "",+ "user",+ "user@",+ "@example.com",+ "user@@example.com",+ "[email protected]",+ "[email protected]",+ "[email protected]",+ "user@[::1]",+ "user@[::ffff:1.2.3.4]",+ "user@[IPv6:not-an-ip]",+ "[email protected]",+ }++ for _, email := range invalidEmails {+ email := email+ t.Run(email, func(t *testing.T) {+ t.Parallel()+ if IsValidUserEmail(email) {+ t.Fatalf("expected %q to be invalid", email)+ }+ })+ }+}diff --git a/frontend/src/lib/components/sheets/user-form-sheet.svelte b/frontend/src/lib/components/sheets/user-form-sheet.svelteindex 9e8db69c5..26bcee55c 100644--- a/frontend/src/lib/components/sheets/user-form-sheet.svelte+++ b/frontend/src/lib/components/sheets/user-form-sheet.svelte@@ -6,6 +6,7 @@import type { User } from '$lib/types/user.type';import { z } from 'zod/v4';import { createForm, preventDefault } from '$lib/utils/form.utils';+ import { isValidUserEmail } from '$lib/utils/email.utils';import { m } from '$lib/paraglide/messages';import { AddIcon, SaveIcon } from '$lib/icons';@@ -36,7 +37,10 @@username: z.string().min(1, m.common_username_required()),password: z.string().optional(),displayName: z.string().optional(),- email: z.email(m.common_invalid_email()).optional().or(z.literal('')),+ email: z+ .string()+ .trim()+ .refine((value) => value === '' || isValidUserEmail(value), m.common_invalid_email()),isAdmin: z.boolean().default(false)});@@ -66,10 +70,13 @@const userData: Partial<User> & { password?: string } = {displayName: data.displayName,- email: data.email,roles: [data.isAdmin ? 'admin' : 'user']};+ if (data.email) {+ userData.email = data.email;+ }+// Only include username if we're creating a new user or if editing is allowedif (!isEditMode || canEditUsername) {userData.username = data.username;@@ -102,7 +109,7 @@contentClass="sm:max-w-[500px]">{#snippet children()}- <form onsubmit={preventDefault(handleSubmit)} class="grid gap-4 py-6">+ <form onsubmit={preventDefault(handleSubmit)} novalidate class="grid gap-4 py-6"><FormInputlabel={m.common_username()}type="text"@@ -136,9 +143,10 @@/><FormInputlabel={m.common_email()}- type="email"+ type="text"placeholder={m.users_email_placeholder()}description={m.users_email_description()}+ autocomplete="email"disabled={isOidcUser}bind:input={$inputs.email}/>diff --git a/frontend/src/lib/utils/email.utils.ts b/frontend/src/lib/utils/email.utils.tsnew file mode 100644index 000000000..b975d33d8--- /dev/null+++ b/frontend/src/lib/utils/email.utils.ts@@ -0,0 +1,115 @@+const LOCAL_PART_PATTERN = /^[A-Za-z0-9!#$%&'*+/=?^_`{|}~.-]+$/;+const DOMAIN_LABEL_PATTERN = /^[\p{L}\p{N}](?:[\p{L}\p{N}-]{0,61}[\p{L}\p{N}])?$/u;++export function isValidUserEmail(email: string): boolean {+ const trimmedEmail = email.trim();+ if (!trimmedEmail || trimmedEmail.includes(' ')) {+ return false;+ }++ const atIndex = trimmedEmail.indexOf('@');+ if (atIndex <= 0 || atIndex !== trimmedEmail.lastIndexOf('@') || atIndex === trimmedEmail.length - 1) {+ return false;+ }++ const localPart = trimmedEmail.slice(0, atIndex);+ const domainPart = trimmedEmail.slice(atIndex + 1);++ return isValidLocalPart(localPart) && isValidDomainPart(domainPart);+}++function isValidLocalPart(localPart: string): boolean {+ if (!localPart || localPart.length > 64 || localPart.startsWith('.') || localPart.endsWith('.') || localPart.includes('..')) {+ return false;+ }++ return LOCAL_PART_PATTERN.test(localPart);+}++function isValidDomainPart(domainPart: string): boolean {+ if (!domainPart || domainPart.length > 255) {+ return false;+ }++ if (isValidIPv4Literal(domainPart)) {+ return true;+ }++ if (isValidIPv6Literal(domainPart)) {+ return true;+ }++ const labels = domainPart.split('.');+ if (labels.length === 4 && labels.every((label) => /^\d+$/.test(label))) {+ return false;+ }++ if (labels.some((label) => !DOMAIN_LABEL_PATTERN.test(label))) {+ return false;+ }++ return true;+}++function isValidIPv4Literal(domainPart: string): boolean {+ const octets = domainPart.split('.');+ if (octets.length !== 4) {+ return false;+ }++ return octets.every((octet) => /^\d+$/.test(octet) && Number(octet) >= 0 && Number(octet) <= 255);+}++function isValidIPv6Literal(domainPart: string): boolean {+ if (!/^\[IPv6:[0-9A-Fa-f:.]+\]$/i.test(domainPart)) {+ return false;+ }++ const address = domainPart.slice(6, -1);+ return isValidIPv6Address(address);+}++function isValidIPv6Address(address: string): boolean {+ if (!address.includes(':') || address.includes(':::')) {+ return false;+ }++ const compressionIndex = address.indexOf('::');+ if (compressionIndex !== -1 && compressionIndex !== address.lastIndexOf('::')) {+ return false;+ }++ if (compressionIndex === -1) {+ return countIPv6Segments(address.split(':')) === 8;+ }++ const [left = '', right = ''] = address.split('::');+ const leftCount = left ? countIPv6Segments(left.split(':')) : 0;+ const rightCount = right ? countIPv6Segments(right.split(':')) : 0;++ return leftCount >= 0 && rightCount >= 0 && leftCount + rightCount < 8;+}++function countIPv6Segments(segments: string[]): number {+ let count = 0;++ for (let i = 0; i < segments.length; i += 1) {+ const segment = segments[i];+ if (!segment) {+ return -1;+ }++ const isLastSegment = i === segments.length - 1;+ if (segment.includes('.')) {+ return isLastSegment && isValidIPv4Literal(segment) ? count + 2 : -1;+ }++ if (!/^[0-9A-Fa-f]{1,4}$/.test(segment)) {+ return -1;+ }++ count += 1;+ }++ return count;+}diff --git a/types/user/user.go b/types/user/user.goindex 8b3c7b679..39a66e2f8 100644--- a/types/user/user.go+++ b/types/user/user.go@@ -5,7 +5,7 @@ type CreateUser struct {Username string `json:"username" minLength:"1" maxLength:"255" doc:"Username of the user" example:"johndoe"`Password string `json:"password" minLength:"8" doc:"Password of the user"` //nolint:gosec // API schema requires password field nameDisplayName *string `json:"displayName,omitempty" maxLength:"255" doc:"Display name of the user" example:"John Doe"`- Email *string `json:"email,omitempty" format:"email" doc:"Email address of the user" example:"[email protected]"`+ Email *string `json:"email,omitempty" doc:"Email address of the user" example:"[email protected]"`Roles []string `json:"roles,omitempty" doc:"Roles assigned to the user" example:"[\"user\"]"`Locale *string `json:"locale,omitempty" doc:"Locale preference of the user" example:"en-US"`}@@ -14,7 +14,7 @@ type CreateUser struct {type UpdateUser struct {Username *string `json:"username,omitempty" minLength:"1" maxLength:"255" doc:"Username of the user"`DisplayName *string `json:"displayName,omitempty" maxLength:"255" doc:"Display name of the user"`- Email *string `json:"email,omitempty" format:"email" doc:"Email address of the user"`+ Email *string `json:"email,omitempty" doc:"Email address of the user"`Roles []string `json:"roles,omitempty" doc:"Roles assigned to the user"`Locale *string `json:"locale,omitempty" doc:"Locale preference of the user"`Password *string `json:"password,omitempty" minLength:"8" doc:"New password for the user"` //nolint:gosec // API schema requires password field name