Skip to content

Fix magic dns and uppercase letters #387

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.

Sign up for GitHub

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

Merged
kradalby merged 8 commits into from
Mar 8, 2022
Merged

Fix magic dns and uppercase letters #387

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
44a5372
fix(poll): Normalize hostname
restanrm Mar 3, 2022
6f172a6
fix(acls): remove dead error code
restanrm Mar 3, 2022
dcf3ea5
Merge branch 'main' into fix-magic-dns-and-uppercase-letters
juanfont Mar 6, 2022
1114449
change: update name of method to check and normalize Domain name
restanrm Mar 6, 2022
6cc8bbc
feat(api): add normalisation at machine register step
restanrm Mar 7, 2022
f19c048
fix: change normalization function name
restanrm Mar 7, 2022
2b68c90
chore: update changelog
restanrm Mar 7, 2022
41efe98
fix: apply fmt and fix missing name changes
restanrm Mar 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion acls.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ func expandGroup(
errInvalidGroup,
)
}
grp, err := NormalizeNamespaceName(group, stripEmailDomain)
grp, err := NormalizeName(group, stripEmailDomain)
Copy link
Collaborator

@kradalby kradalby Mar 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think as mentioned this is a bit to generic, for a unknown user to understand the context, it needs to either have FQDN or Domain or some reference to the RFC and limitations in the name.

if err != nil {
return []string{}, fmt.Errorf(
"failed to normalize group %q, err: %w",
Expand Down
14 changes: 7 additions & 7 deletions namespaces.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ type Namespace struct {
// CreateNamespace creates a new Namespace. Returns error if could not be created
// or another namespace already exists.
func (h *Headscale) CreateNamespace(name string) (*Namespace, error) {
err := CheckNamespaceName(name)
err := CheckName(name)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -104,7 +104,7 @@ func (h *Headscale) RenameNamespace(oldName, newName string) error {
if err != nil {
return err
}
err = CheckNamespaceName(newName)
err = CheckName(newName)
if err != nil {
return err
}
Expand Down Expand Up @@ -150,7 +150,7 @@ func (h *Headscale) ListNamespaces() ([]Namespace, error) {

// ListMachinesInNamespace gets all the nodes in a given namespace.
func (h *Headscale) ListMachinesInNamespace(name string) ([]Machine, error) {
err := CheckNamespaceName(name)
err := CheckName(name)
if err != nil {
return nil, err
}
Expand All @@ -169,7 +169,7 @@ func (h *Headscale) ListMachinesInNamespace(name string) ([]Machine, error) {

// SetMachineNamespace assigns a Machine to a namespace.
func (h *Headscale) SetMachineNamespace(machine *Machine, namespaceName string) error {
err := CheckNamespaceName(namespaceName)
err := CheckName(namespaceName)
if err != nil {
return err
}
Expand Down Expand Up @@ -237,9 +237,9 @@ func (n *Namespace) toProto() *v1.Namespace {
}
}

// NormalizeNamespaceName will replace forbidden chars in namespace
// NormalizeName will replace forbidden chars in namespace
// it can also return an error if the namespace doesn't respect RFC 952 and 1123.
func NormalizeNamespaceName(name string, stripEmailDomain bool) (string, error) {
func NormalizeName(name string, stripEmailDomain bool) (string, error) {
name = strings.ToLower(name)
name = strings.ReplaceAll(name, "'", "")
atIdx := strings.Index(name, "@")
Expand All @@ -263,7 +263,7 @@ func NormalizeNamespaceName(name string, stripEmailDomain bool) (string, error)
return name, nil
}

func CheckNamespaceName(name string) error {
func CheckName(name string) error {
if len(name) > labelHostnameLength {
return fmt.Errorf(
"Namespace must not be over 63 chars. %v doesn't comply with this rule: %w",
Expand Down
8 changes: 4 additions & 4 deletions namespaces_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ func (s *Suite) TestGetMapResponseUserProfiles(c *check.C) {
c.Assert(found, check.Equals, true)
}

func TestNormalizeNamespaceName(t *testing.T) {
func TestNormalizeName(t *testing.T) {
type args struct {
name string
stripEmailDomain bool
Expand Down Expand Up @@ -310,7 +310,7 @@ func TestNormalizeNamespaceName(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := NormalizeNamespaceName(tt.args.name, tt.args.stripEmailDomain)
got, err := NormalizeName(tt.args.name, tt.args.stripEmailDomain)
if (err != nil) != tt.wantErr {
t.Errorf(
"NormalizeNamespaceName() error = %v, wantErr %v",
Expand All @@ -327,7 +327,7 @@ func TestNormalizeNamespaceName(t *testing.T) {
}
}

func TestCheckNamespaceName(t *testing.T) {
func TestCheckName(t *testing.T) {
type args struct {
name string
}
Expand Down Expand Up @@ -366,7 +366,7 @@ func TestCheckNamespaceName(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if err := CheckNamespaceName(tt.args.name); (err != nil) != tt.wantErr {
if err := CheckName(tt.args.name); (err != nil) != tt.wantErr {
t.Errorf("CheckNamespaceName() error = %v, wantErr %v", err, tt.wantErr)
}
})
Expand Down
2 changes: 1 addition & 1 deletion oidc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ func (h *Headscale) OIDCCallback(ctx *gin.Context) {
return
}

namespaceName, err := NormalizeNamespaceName(
namespaceName, err := NormalizeName(
claims.Email,
h.cfg.OIDC.StripEmaildomain,
)
Expand Down
2 changes: 1 addition & 1 deletion poll.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ func (h *Headscale) PollNetMapHandler(ctx *gin.Context) {
Str("machine", machine.Name).
Msg("Found machine in database")

hname, err := NormalizeNamespaceName(
hname, err := NormalizeName(
req.Hostinfo.Hostname,
h.cfg.OIDC.StripEmaildomain,
)
Expand Down