Loosen restrictions for IAM user names

The only restriction for an IAM username is that it cannot start with
a '$'. An username that contains a ':' must escape it with another ':'
for use in a token for RTMP or SRT.
This commit is contained in:
Ingo Oppermann
2023-06-26 13:49:53 +02:00
parent 6f47f96f6e
commit abfe4918b4
8 changed files with 124 additions and 36 deletions

View File

@@ -1007,6 +1007,10 @@ func (c *cluster) AddIdentity(origin string, identity iamidentity.User) error {
return ErrDegraded return ErrDegraded
} }
if err := identity.Validate(); err != nil {
return fmt.Errorf("invalid identity: %w", err)
}
if !c.IsRaftLeader() { if !c.IsRaftLeader() {
return c.forwarder.AddIdentity(origin, identity) return c.forwarder.AddIdentity(origin, identity)
} }

45
encoding/token/token.go Normal file
View File

@@ -0,0 +1,45 @@
package token
import "strings"
func Marshal(username, token string) string {
username = strings.ReplaceAll(username, ":", "::")
return username + ":" + token
}
// Unmarshal splits a username/token combination into a username and
// token. If the input doesn't contain a username, the whole input
// is returned as token.
func Unmarshal(usertoken string) (string, string) {
r := []rune(usertoken)
count := 0
index := -1
for i, ru := range r {
if ru == ':' {
count++
continue
}
if count > 0 && count%2 != 0 {
index = i - 1
break
}
count = 0
}
if index == -1 {
return "", usertoken
}
before, after := r[:index], r[index+1:]
username := string(before)
token := string(after)
username = strings.ReplaceAll(username, "::", ":")
return username, token
}

View File

@@ -0,0 +1,41 @@
package token
import (
"testing"
"github.com/stretchr/testify/require"
)
func TestMarshal(t *testing.T) {
token := "xxx"
data := [][2]string{
{"", ""},
{"foo", "foo"},
{"foo:bar", "foo::bar"},
{"foo::bar", "foo::::bar"},
}
for _, d := range data {
encoded := Marshal(d[0], token)
require.Equal(t, d[1]+":"+token, encoded, d[1])
}
}
func TestUnmarshal(t *testing.T) {
data := [][3]string{
{"foo", "", "foo"},
{"fo::o", "", "fo::o"},
{"::foo", "", "::foo"},
{":xxx", "", "xxx"},
{"foo:xxx", "foo", "xxx"},
{"foo::bar:xxx", "foo:bar", "xxx"},
{"foo::::bar:xxx", "foo::bar", "xxx"},
}
for _, d := range data {
username, token := Unmarshal(d[0])
require.Equal(t, d[1], username, d[0])
require.Equal(t, d[2], token)
}
}

View File

@@ -744,7 +744,7 @@ func (h *ClusterHandler) DeleteProcess(c echo.Context) error {
func (h *ClusterHandler) AddIdentity(c echo.Context) error { func (h *ClusterHandler) AddIdentity(c echo.Context) error {
ctxuser := util.DefaultContext(c, "user", "") ctxuser := util.DefaultContext(c, "user", "")
superuser := util.DefaultContext(c, "superuser", false) superuser := util.DefaultContext(c, "superuser", false)
domain := util.DefaultQuery(c, "domain", "$none") domain := util.DefaultQuery(c, "domain", "")
user := api.IAMUser{} user := api.IAMUser{}
@@ -799,7 +799,7 @@ func (h *ClusterHandler) AddIdentity(c echo.Context) error {
func (h *ClusterHandler) UpdateIdentity(c echo.Context) error { func (h *ClusterHandler) UpdateIdentity(c echo.Context) error {
ctxuser := util.DefaultContext(c, "user", "") ctxuser := util.DefaultContext(c, "user", "")
superuser := util.DefaultContext(c, "superuser", false) superuser := util.DefaultContext(c, "superuser", false)
domain := util.DefaultQuery(c, "domain", "$none") domain := util.DefaultQuery(c, "domain", "")
name := util.PathParam(c, "name") name := util.PathParam(c, "name")
if !h.iam.Enforce(ctxuser, domain, "iam:"+name, "write") { if !h.iam.Enforce(ctxuser, domain, "iam:"+name, "write") {
@@ -880,7 +880,7 @@ func (h *ClusterHandler) UpdateIdentity(c echo.Context) error {
func (h *ClusterHandler) UpdateIdentityPolicies(c echo.Context) error { func (h *ClusterHandler) UpdateIdentityPolicies(c echo.Context) error {
ctxuser := util.DefaultContext(c, "user", "") ctxuser := util.DefaultContext(c, "user", "")
superuser := util.DefaultContext(c, "superuser", false) superuser := util.DefaultContext(c, "superuser", false)
domain := util.DefaultQuery(c, "domain", "$none") domain := util.DefaultQuery(c, "domain", "")
name := util.PathParam(c, "name") name := util.PathParam(c, "name")
if !h.iam.Enforce(ctxuser, domain, "iam:"+name, "write") { if !h.iam.Enforce(ctxuser, domain, "iam:"+name, "write") {
@@ -952,7 +952,7 @@ func (h *ClusterHandler) UpdateIdentityPolicies(c echo.Context) error {
// @Router /api/v3/cluster/db/user [get] // @Router /api/v3/cluster/db/user [get]
func (h *ClusterHandler) ListStoreIdentities(c echo.Context) error { func (h *ClusterHandler) ListStoreIdentities(c echo.Context) error {
ctxuser := util.DefaultContext(c, "user", "") ctxuser := util.DefaultContext(c, "user", "")
domain := util.DefaultQuery(c, "domain", "$none") domain := util.DefaultQuery(c, "domain", "")
updatedAt, identities := h.cluster.ListIdentities() updatedAt, identities := h.cluster.ListIdentities()
@@ -991,7 +991,7 @@ func (h *ClusterHandler) ListStoreIdentities(c echo.Context) error {
// @Router /api/v3/cluster/db/user/{name} [get] // @Router /api/v3/cluster/db/user/{name} [get]
func (h *ClusterHandler) ListStoreIdentity(c echo.Context) error { func (h *ClusterHandler) ListStoreIdentity(c echo.Context) error {
ctxuser := util.DefaultContext(c, "user", "") ctxuser := util.DefaultContext(c, "user", "")
domain := util.DefaultQuery(c, "domain", "$none") domain := util.DefaultQuery(c, "domain", "")
name := util.PathParam(c, "name") name := util.PathParam(c, "name")
if !h.iam.Enforce(ctxuser, domain, "iam:"+name, "read") { if !h.iam.Enforce(ctxuser, domain, "iam:"+name, "read") {
@@ -1069,7 +1069,7 @@ func (h *ClusterHandler) ReloadIAM(c echo.Context) error {
// @Router /api/v3/cluster/iam/user [get] // @Router /api/v3/cluster/iam/user [get]
func (h *ClusterHandler) ListIdentities(c echo.Context) error { func (h *ClusterHandler) ListIdentities(c echo.Context) error {
ctxuser := util.DefaultContext(c, "user", "") ctxuser := util.DefaultContext(c, "user", "")
domain := util.DefaultQuery(c, "domain", "$none") domain := util.DefaultQuery(c, "domain", "")
identities := h.iam.ListIdentities() identities := h.iam.ListIdentities()
@@ -1115,7 +1115,7 @@ func (h *ClusterHandler) ListIdentities(c echo.Context) error {
// @Router /api/v3/cluster/iam/user/{name} [get] // @Router /api/v3/cluster/iam/user/{name} [get]
func (h *ClusterHandler) ListIdentity(c echo.Context) error { func (h *ClusterHandler) ListIdentity(c echo.Context) error {
ctxuser := util.DefaultContext(c, "user", "") ctxuser := util.DefaultContext(c, "user", "")
domain := util.DefaultQuery(c, "domain", "$none") domain := util.DefaultQuery(c, "domain", "")
name := util.PathParam(c, "name") name := util.PathParam(c, "name")
if !h.iam.Enforce(ctxuser, domain, "iam:"+name, "read") { if !h.iam.Enforce(ctxuser, domain, "iam:"+name, "read") {

View File

@@ -2,10 +2,11 @@ package identity
import ( import (
"fmt" "fmt"
"regexp" "strings"
"sync" "sync"
"time" "time"
enctoken "github.com/datarhei/core/v16/encoding/token"
"github.com/datarhei/core/v16/iam/jwks" "github.com/datarhei/core/v16/iam/jwks"
"github.com/datarhei/core/v16/log" "github.com/datarhei/core/v16/log"
"github.com/google/uuid" "github.com/google/uuid"
@@ -45,16 +46,13 @@ type UserAuthServices struct {
Session []string `json:"session"` // Secrets for session JWT Session []string `json:"session"` // Secrets for session JWT
} }
func (u *User) validate() error { func (u *User) Validate() error {
if len(u.Name) == 0 { if len(u.Name) == 0 {
return fmt.Errorf("a name is required") return fmt.Errorf("a name is required")
} }
chars := `A-Za-z0-9._-` if strings.HasPrefix(u.Name, "$") {
return fmt.Errorf("name is not allowed to start with $")
re := regexp.MustCompile(`[^` + chars + `]`)
if re.MatchString(u.Name) {
return fmt.Errorf("the name can only contain [%s]", chars)
} }
if len(u.Auth.API.Auth0.User) != 0 { if len(u.Auth.API.Auth0.User) != 0 {
@@ -363,7 +361,7 @@ func (i *identity) GetServiceToken() string {
continue continue
} }
return i.Name() + ":" + token return enctoken.Marshal(i.Name(), token)
} }
return "" return ""
@@ -608,7 +606,7 @@ func (im *identityManager) Reload() error {
continue continue
} }
if err := u.validate(); err != nil { if err := u.Validate(); err != nil {
continue continue
} }
@@ -624,7 +622,7 @@ func (im *identityManager) Reload() error {
} }
func (im *identityManager) Create(u User) error { func (im *identityManager) Create(u User) error {
if err := u.validate(); err != nil { if err := u.Validate(); err != nil {
return err return err
} }
@@ -689,7 +687,7 @@ func (im *identityManager) create(u User) (*identity, error) {
} }
func (im *identityManager) Update(name string, u User) error { func (im *identityManager) Update(name string, u User) error {
if err := u.validate(); err != nil { if err := u.Validate(); err != nil {
return err return err
} }

View File

@@ -19,15 +19,19 @@ func createAdapter() (Adapter, error) {
func TestUserName(t *testing.T) { func TestUserName(t *testing.T) {
user := User{} user := User{}
err := user.validate() err := user.Validate()
require.Error(t, err) require.Error(t, err)
user.Name = "foobar_5" user.Name = "foobar_5"
err = user.validate() err = user.Validate()
require.NoError(t, err)
user.Name = "foobar:5"
err = user.Validate()
require.NoError(t, err) require.NoError(t, err)
user.Name = "$foob:ar" user.Name = "$foob:ar"
err = user.validate() err = user.Validate()
require.Error(t, err) require.Error(t, err)
} }

View File

@@ -12,6 +12,7 @@ import (
"time" "time"
"github.com/datarhei/core/v16/cluster/proxy" "github.com/datarhei/core/v16/cluster/proxy"
enctoken "github.com/datarhei/core/v16/encoding/token"
"github.com/datarhei/core/v16/iam" "github.com/datarhei/core/v16/iam"
iamidentity "github.com/datarhei/core/v16/iam/identity" iamidentity "github.com/datarhei/core/v16/iam/identity"
"github.com/datarhei/core/v16/log" "github.com/datarhei/core/v16/log"
@@ -212,7 +213,7 @@ func (s *server) log(who, handler, action, resource, message string, client net.
func GetToken(u *url.URL) (string, string) { func GetToken(u *url.URL) (string, string) {
q := u.Query() q := u.Query()
if q.Has("token") { if q.Has("token") {
// The token was in the query. Return the unmomdified path and the token // The token was in the query. Return the unmomdified path and the token.
return u.Path, q.Get("token") return u.Path, q.Get("token")
} }
@@ -471,18 +472,16 @@ func (s *server) findIdentityFromStreamKey(key string) (string, error) {
return "$anon", nil return "$anon", nil
} }
var identity iamidentity.Verifier var identity iamidentity.Verifier = nil
var err error var err error = nil
var token string var token string
before, after, found := strings.Cut(key, ":") username, token := enctoken.Unmarshal(key)
if !found { if len(username) == 0 {
identity = s.iam.GetDefaultVerifier() identity = s.iam.GetDefaultVerifier()
token = before
} else { } else {
identity, err = s.iam.GetVerifier(before) identity, err = s.iam.GetVerifier(username)
token = after
} }
if err != nil { if err != nil {

View File

@@ -10,6 +10,7 @@ import (
"time" "time"
"github.com/datarhei/core/v16/cluster/proxy" "github.com/datarhei/core/v16/cluster/proxy"
enctoken "github.com/datarhei/core/v16/encoding/token"
"github.com/datarhei/core/v16/iam" "github.com/datarhei/core/v16/iam"
iamidentity "github.com/datarhei/core/v16/iam/identity" iamidentity "github.com/datarhei/core/v16/iam/identity"
"github.com/datarhei/core/v16/log" "github.com/datarhei/core/v16/log"
@@ -493,15 +494,11 @@ func (s *server) findIdentityFromToken(key string) (string, error) {
var identity iamidentity.Verifier var identity iamidentity.Verifier
var err error var err error
var token string username, token := enctoken.Unmarshal(key)
if len(username) == 0 {
before, after, found := strings.Cut(key, ":")
if !found {
identity = s.iam.GetDefaultVerifier() identity = s.iam.GetDefaultVerifier()
token = before
} else { } else {
identity, err = s.iam.GetVerifier(before) identity, err = s.iam.GetVerifier(username)
token = after
} }
if err != nil { if err != nil {