mirror of
https://github.com/juanfont/headscale.git
synced 2024-11-26 17:03:06 +00:00
45f5b15a9f
currently, the policy approach node to user matching with a quite naive approach looking at the username provided in the policy and matched it with the username on the nodes. This worked ok as long as usernames were unique and did not change. As usernames are no longer guarenteed to be unique in an OIDC environment we cant rely on this. This changes the mechanism that matches the user string (now user token) with nodes: - first find all potential users by looking up: - database ID - provider ID (OIDC) - username/email If more than one user is matching, then the query is rejected, and zero matching nodes are returned. When a single user is found, the node is matched against the User database ID, which are also present on the actual node. This means that from this commit, users can use the following to identify users in the policy: - provider identity (iss + sub) - username - email - database id There are more changes coming to this, so it is not recommended to start using any of these new abilities, with the exception of email, which will not change since it includes an @. Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
498 lines
12 KiB
Go
498 lines
12 KiB
Go
package mapper
|
|
|
|
import (
|
|
"fmt"
|
|
"net/netip"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/davecgh/go-spew/spew"
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/google/go-cmp/cmp/cmpopts"
|
|
"github.com/juanfont/headscale/hscontrol/policy"
|
|
"github.com/juanfont/headscale/hscontrol/types"
|
|
"gopkg.in/check.v1"
|
|
"gorm.io/gorm"
|
|
"tailscale.com/net/tsaddr"
|
|
"tailscale.com/tailcfg"
|
|
"tailscale.com/types/dnstype"
|
|
"tailscale.com/types/key"
|
|
)
|
|
|
|
var iap = func(ipStr string) *netip.Addr {
|
|
ip := netip.MustParseAddr(ipStr)
|
|
return &ip
|
|
}
|
|
|
|
func (s *Suite) TestGetMapResponseUserProfiles(c *check.C) {
|
|
mach := func(hostname, username string, userid uint) *types.Node {
|
|
return &types.Node{
|
|
Hostname: hostname,
|
|
UserID: userid,
|
|
User: types.User{
|
|
Model: gorm.Model{
|
|
ID: userid,
|
|
},
|
|
Name: username,
|
|
},
|
|
}
|
|
}
|
|
|
|
nodeInShared1 := mach("test_get_shared_nodes_1", "user1", 1)
|
|
nodeInShared2 := mach("test_get_shared_nodes_2", "user2", 2)
|
|
nodeInShared3 := mach("test_get_shared_nodes_3", "user3", 3)
|
|
node2InShared1 := mach("test_get_shared_nodes_4", "user1", 1)
|
|
|
|
userProfiles := generateUserProfiles(
|
|
nodeInShared1,
|
|
types.Nodes{
|
|
nodeInShared2, nodeInShared3, node2InShared1,
|
|
},
|
|
)
|
|
|
|
c.Assert(len(userProfiles), check.Equals, 3)
|
|
|
|
users := []string{
|
|
"user1", "user2", "user3",
|
|
}
|
|
|
|
for _, user := range users {
|
|
found := false
|
|
for _, userProfile := range userProfiles {
|
|
if userProfile.DisplayName == user {
|
|
found = true
|
|
|
|
break
|
|
}
|
|
}
|
|
c.Assert(found, check.Equals, true)
|
|
}
|
|
}
|
|
|
|
func TestDNSConfigMapResponse(t *testing.T) {
|
|
tests := []struct {
|
|
magicDNS bool
|
|
want *tailcfg.DNSConfig
|
|
}{
|
|
{
|
|
magicDNS: true,
|
|
want: &tailcfg.DNSConfig{
|
|
Routes: map[string][]*dnstype.Resolver{},
|
|
Domains: []string{
|
|
"foobar.headscale.net",
|
|
},
|
|
Proxied: true,
|
|
},
|
|
},
|
|
{
|
|
magicDNS: false,
|
|
want: &tailcfg.DNSConfig{
|
|
Domains: []string{"foobar.headscale.net"},
|
|
Proxied: false,
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(fmt.Sprintf("with-magicdns-%v", tt.magicDNS), func(t *testing.T) {
|
|
mach := func(hostname, username string, userid uint) *types.Node {
|
|
return &types.Node{
|
|
Hostname: hostname,
|
|
UserID: userid,
|
|
User: types.User{
|
|
Name: username,
|
|
},
|
|
}
|
|
}
|
|
|
|
baseDomain := "foobar.headscale.net"
|
|
|
|
dnsConfigOrig := tailcfg.DNSConfig{
|
|
Routes: make(map[string][]*dnstype.Resolver),
|
|
Domains: []string{baseDomain},
|
|
Proxied: tt.magicDNS,
|
|
}
|
|
|
|
nodeInShared1 := mach("test_get_shared_nodes_1", "shared1", 1)
|
|
|
|
got := generateDNSConfig(
|
|
&types.Config{
|
|
DNSConfig: &dnsConfigOrig,
|
|
},
|
|
nodeInShared1,
|
|
)
|
|
|
|
if diff := cmp.Diff(tt.want, got, cmpopts.EquateEmpty()); diff != "" {
|
|
t.Errorf("expandAlias() unexpected result (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_fullMapResponse(t *testing.T) {
|
|
mustNK := func(str string) key.NodePublic {
|
|
var k key.NodePublic
|
|
_ = k.UnmarshalText([]byte(str))
|
|
|
|
return k
|
|
}
|
|
|
|
mustDK := func(str string) key.DiscoPublic {
|
|
var k key.DiscoPublic
|
|
_ = k.UnmarshalText([]byte(str))
|
|
|
|
return k
|
|
}
|
|
|
|
mustMK := func(str string) key.MachinePublic {
|
|
var k key.MachinePublic
|
|
_ = k.UnmarshalText([]byte(str))
|
|
|
|
return k
|
|
}
|
|
|
|
hiview := func(hoin tailcfg.Hostinfo) tailcfg.HostinfoView {
|
|
return hoin.View()
|
|
}
|
|
|
|
created := time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC)
|
|
lastSeen := time.Date(2009, time.November, 10, 23, 9, 0, 0, time.UTC)
|
|
expire := time.Date(2500, time.November, 11, 23, 0, 0, 0, time.UTC)
|
|
|
|
user1 := types.User{Model: gorm.Model{ID: 0}, Name: "mini"}
|
|
user2 := types.User{Model: gorm.Model{ID: 1}, Name: "peer2"}
|
|
|
|
mini := &types.Node{
|
|
ID: 0,
|
|
MachineKey: mustMK(
|
|
"mkey:f08305b4ee4250b95a70f3b7504d048d75d899993c624a26d422c67af0422507",
|
|
),
|
|
NodeKey: mustNK(
|
|
"nodekey:9b2ffa7e08cc421a3d2cca9012280f6a236fd0de0b4ce005b30a98ad930306fe",
|
|
),
|
|
DiscoKey: mustDK(
|
|
"discokey:cf7b0fd05da556fdc3bab365787b506fd82d64a70745db70e00e86c1b1c03084",
|
|
),
|
|
IPv4: iap("100.64.0.1"),
|
|
Hostname: "mini",
|
|
GivenName: "mini",
|
|
UserID: user1.ID,
|
|
User: user1,
|
|
ForcedTags: []string{},
|
|
AuthKey: &types.PreAuthKey{},
|
|
LastSeen: &lastSeen,
|
|
Expiry: &expire,
|
|
Hostinfo: &tailcfg.Hostinfo{},
|
|
Routes: []types.Route{
|
|
{
|
|
Prefix: tsaddr.AllIPv4(),
|
|
Advertised: true,
|
|
Enabled: true,
|
|
IsPrimary: false,
|
|
},
|
|
{
|
|
Prefix: netip.MustParsePrefix("192.168.0.0/24"),
|
|
Advertised: true,
|
|
Enabled: true,
|
|
IsPrimary: true,
|
|
},
|
|
{
|
|
Prefix: netip.MustParsePrefix("172.0.0.0/10"),
|
|
Advertised: true,
|
|
Enabled: false,
|
|
IsPrimary: true,
|
|
},
|
|
},
|
|
CreatedAt: created,
|
|
}
|
|
|
|
tailMini := &tailcfg.Node{
|
|
ID: 0,
|
|
StableID: "0",
|
|
Name: "mini",
|
|
User: 0,
|
|
Key: mustNK(
|
|
"nodekey:9b2ffa7e08cc421a3d2cca9012280f6a236fd0de0b4ce005b30a98ad930306fe",
|
|
),
|
|
KeyExpiry: expire,
|
|
Machine: mustMK(
|
|
"mkey:f08305b4ee4250b95a70f3b7504d048d75d899993c624a26d422c67af0422507",
|
|
),
|
|
DiscoKey: mustDK(
|
|
"discokey:cf7b0fd05da556fdc3bab365787b506fd82d64a70745db70e00e86c1b1c03084",
|
|
),
|
|
Addresses: []netip.Prefix{netip.MustParsePrefix("100.64.0.1/32")},
|
|
AllowedIPs: []netip.Prefix{
|
|
netip.MustParsePrefix("100.64.0.1/32"),
|
|
tsaddr.AllIPv4(),
|
|
netip.MustParsePrefix("192.168.0.0/24"),
|
|
},
|
|
DERP: "127.3.3.40:0",
|
|
Hostinfo: hiview(tailcfg.Hostinfo{}),
|
|
Created: created,
|
|
Tags: []string{},
|
|
PrimaryRoutes: []netip.Prefix{netip.MustParsePrefix("192.168.0.0/24")},
|
|
LastSeen: &lastSeen,
|
|
MachineAuthorized: true,
|
|
|
|
CapMap: tailcfg.NodeCapMap{
|
|
tailcfg.CapabilityFileSharing: []tailcfg.RawMessage{},
|
|
tailcfg.CapabilityAdmin: []tailcfg.RawMessage{},
|
|
tailcfg.CapabilitySSH: []tailcfg.RawMessage{},
|
|
},
|
|
}
|
|
|
|
peer1 := &types.Node{
|
|
ID: 1,
|
|
MachineKey: mustMK(
|
|
"mkey:f08305b4ee4250b95a70f3b7504d048d75d899993c624a26d422c67af0422507",
|
|
),
|
|
NodeKey: mustNK(
|
|
"nodekey:9b2ffa7e08cc421a3d2cca9012280f6a236fd0de0b4ce005b30a98ad930306fe",
|
|
),
|
|
DiscoKey: mustDK(
|
|
"discokey:cf7b0fd05da556fdc3bab365787b506fd82d64a70745db70e00e86c1b1c03084",
|
|
),
|
|
IPv4: iap("100.64.0.2"),
|
|
Hostname: "peer1",
|
|
GivenName: "peer1",
|
|
UserID: user1.ID,
|
|
User: user1,
|
|
ForcedTags: []string{},
|
|
LastSeen: &lastSeen,
|
|
Expiry: &expire,
|
|
Hostinfo: &tailcfg.Hostinfo{},
|
|
Routes: []types.Route{},
|
|
CreatedAt: created,
|
|
}
|
|
|
|
tailPeer1 := &tailcfg.Node{
|
|
ID: 1,
|
|
StableID: "1",
|
|
Name: "peer1",
|
|
Key: mustNK(
|
|
"nodekey:9b2ffa7e08cc421a3d2cca9012280f6a236fd0de0b4ce005b30a98ad930306fe",
|
|
),
|
|
KeyExpiry: expire,
|
|
Machine: mustMK(
|
|
"mkey:f08305b4ee4250b95a70f3b7504d048d75d899993c624a26d422c67af0422507",
|
|
),
|
|
DiscoKey: mustDK(
|
|
"discokey:cf7b0fd05da556fdc3bab365787b506fd82d64a70745db70e00e86c1b1c03084",
|
|
),
|
|
Addresses: []netip.Prefix{netip.MustParsePrefix("100.64.0.2/32")},
|
|
AllowedIPs: []netip.Prefix{netip.MustParsePrefix("100.64.0.2/32")},
|
|
DERP: "127.3.3.40:0",
|
|
Hostinfo: hiview(tailcfg.Hostinfo{}),
|
|
Created: created,
|
|
Tags: []string{},
|
|
PrimaryRoutes: []netip.Prefix{},
|
|
LastSeen: &lastSeen,
|
|
MachineAuthorized: true,
|
|
|
|
CapMap: tailcfg.NodeCapMap{
|
|
tailcfg.CapabilityFileSharing: []tailcfg.RawMessage{},
|
|
tailcfg.CapabilityAdmin: []tailcfg.RawMessage{},
|
|
tailcfg.CapabilitySSH: []tailcfg.RawMessage{},
|
|
},
|
|
}
|
|
|
|
peer2 := &types.Node{
|
|
ID: 2,
|
|
MachineKey: mustMK(
|
|
"mkey:f08305b4ee4250b95a70f3b7504d048d75d899993c624a26d422c67af0422507",
|
|
),
|
|
NodeKey: mustNK(
|
|
"nodekey:9b2ffa7e08cc421a3d2cca9012280f6a236fd0de0b4ce005b30a98ad930306fe",
|
|
),
|
|
DiscoKey: mustDK(
|
|
"discokey:cf7b0fd05da556fdc3bab365787b506fd82d64a70745db70e00e86c1b1c03084",
|
|
),
|
|
IPv4: iap("100.64.0.3"),
|
|
Hostname: "peer2",
|
|
GivenName: "peer2",
|
|
UserID: user2.ID,
|
|
User: user2,
|
|
ForcedTags: []string{},
|
|
LastSeen: &lastSeen,
|
|
Expiry: &expire,
|
|
Hostinfo: &tailcfg.Hostinfo{},
|
|
Routes: []types.Route{},
|
|
CreatedAt: created,
|
|
}
|
|
|
|
tests := []struct {
|
|
name string
|
|
pol *policy.ACLPolicy
|
|
node *types.Node
|
|
peers types.Nodes
|
|
|
|
derpMap *tailcfg.DERPMap
|
|
cfg *types.Config
|
|
want *tailcfg.MapResponse
|
|
wantErr bool
|
|
}{
|
|
// {
|
|
// name: "empty-node",
|
|
// node: types.Node{},
|
|
// pol: &policy.ACLPolicy{},
|
|
// dnsConfig: &tailcfg.DNSConfig{},
|
|
// baseDomain: "",
|
|
// want: nil,
|
|
// wantErr: true,
|
|
// },
|
|
{
|
|
name: "no-pol-no-peers-map-response",
|
|
pol: &policy.ACLPolicy{},
|
|
node: mini,
|
|
peers: types.Nodes{},
|
|
derpMap: &tailcfg.DERPMap{},
|
|
cfg: &types.Config{
|
|
BaseDomain: "",
|
|
DNSConfig: &tailcfg.DNSConfig{},
|
|
LogTail: types.LogTailConfig{Enabled: false},
|
|
RandomizeClientPort: false,
|
|
},
|
|
want: &tailcfg.MapResponse{
|
|
Node: tailMini,
|
|
KeepAlive: false,
|
|
DERPMap: &tailcfg.DERPMap{},
|
|
Peers: []*tailcfg.Node{},
|
|
DNSConfig: &tailcfg.DNSConfig{},
|
|
Domain: "",
|
|
CollectServices: "false",
|
|
PacketFilter: []tailcfg.FilterRule{},
|
|
UserProfiles: []tailcfg.UserProfile{{LoginName: "mini", DisplayName: "mini"}},
|
|
SSHPolicy: &tailcfg.SSHPolicy{Rules: []*tailcfg.SSHRule{}},
|
|
ControlTime: &time.Time{},
|
|
Debug: &tailcfg.Debug{
|
|
DisableLogTail: true,
|
|
},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "no-pol-with-peer-map-response",
|
|
pol: &policy.ACLPolicy{},
|
|
node: mini,
|
|
peers: types.Nodes{
|
|
peer1,
|
|
},
|
|
derpMap: &tailcfg.DERPMap{},
|
|
cfg: &types.Config{
|
|
BaseDomain: "",
|
|
DNSConfig: &tailcfg.DNSConfig{},
|
|
LogTail: types.LogTailConfig{Enabled: false},
|
|
RandomizeClientPort: false,
|
|
},
|
|
want: &tailcfg.MapResponse{
|
|
KeepAlive: false,
|
|
Node: tailMini,
|
|
DERPMap: &tailcfg.DERPMap{},
|
|
Peers: []*tailcfg.Node{
|
|
tailPeer1,
|
|
},
|
|
DNSConfig: &tailcfg.DNSConfig{},
|
|
Domain: "",
|
|
CollectServices: "false",
|
|
PacketFilter: []tailcfg.FilterRule{},
|
|
UserProfiles: []tailcfg.UserProfile{{LoginName: "mini", DisplayName: "mini"}},
|
|
SSHPolicy: &tailcfg.SSHPolicy{Rules: []*tailcfg.SSHRule{}},
|
|
ControlTime: &time.Time{},
|
|
Debug: &tailcfg.Debug{
|
|
DisableLogTail: true,
|
|
},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "with-pol-map-response",
|
|
pol: &policy.ACLPolicy{
|
|
ACLs: []policy.ACL{
|
|
{
|
|
Action: "accept",
|
|
Sources: []string{"100.64.0.2"},
|
|
Destinations: []string{"mini:*"},
|
|
},
|
|
},
|
|
},
|
|
node: mini,
|
|
peers: types.Nodes{
|
|
peer1,
|
|
peer2,
|
|
},
|
|
derpMap: &tailcfg.DERPMap{},
|
|
cfg: &types.Config{
|
|
BaseDomain: "",
|
|
DNSConfig: &tailcfg.DNSConfig{},
|
|
LogTail: types.LogTailConfig{Enabled: false},
|
|
RandomizeClientPort: false,
|
|
},
|
|
want: &tailcfg.MapResponse{
|
|
KeepAlive: false,
|
|
Node: tailMini,
|
|
DERPMap: &tailcfg.DERPMap{},
|
|
Peers: []*tailcfg.Node{
|
|
tailPeer1,
|
|
},
|
|
DNSConfig: &tailcfg.DNSConfig{},
|
|
Domain: "",
|
|
CollectServices: "false",
|
|
PacketFilter: []tailcfg.FilterRule{
|
|
{
|
|
SrcIPs: []string{"100.64.0.2/32"},
|
|
DstPorts: []tailcfg.NetPortRange{
|
|
{IP: "100.64.0.1/32", Ports: tailcfg.PortRangeAny},
|
|
},
|
|
},
|
|
},
|
|
UserProfiles: []tailcfg.UserProfile{
|
|
{LoginName: "mini", DisplayName: "mini"},
|
|
},
|
|
SSHPolicy: &tailcfg.SSHPolicy{Rules: []*tailcfg.SSHRule{}},
|
|
ControlTime: &time.Time{},
|
|
Debug: &tailcfg.Debug{
|
|
DisableLogTail: true,
|
|
},
|
|
},
|
|
wantErr: false,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
mappy := NewMapper(
|
|
nil,
|
|
tt.cfg,
|
|
tt.derpMap,
|
|
nil,
|
|
)
|
|
|
|
got, err := mappy.fullMapResponse(
|
|
tt.node,
|
|
tt.peers,
|
|
[]types.User{user1, user2},
|
|
tt.pol,
|
|
0,
|
|
)
|
|
|
|
if (err != nil) != tt.wantErr {
|
|
t.Errorf("fullMapResponse() error = %v, wantErr %v", err, tt.wantErr)
|
|
|
|
return
|
|
}
|
|
|
|
spew.Dump(got)
|
|
|
|
if diff := cmp.Diff(
|
|
tt.want,
|
|
got,
|
|
cmpopts.EquateEmpty(),
|
|
// Ignore ControlTime, it is set to now and we dont really need to mock it.
|
|
cmpopts.IgnoreFields(tailcfg.MapResponse{}, "ControlTime"),
|
|
); diff != "" {
|
|
t.Errorf("fullMapResponse() unexpected result (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|