teleport/lib/web/apiserver_ping_test.go
Alan Parra 48dd429917
Return auto-enroll status on Ping (#24752)
* Return auto-enroll status on Ping

* Verify both old and new flags
2023-04-24 14:43:29 +00:00

236 lines
7.5 KiB
Go

// Copyright 2021 Gravitational, Inc
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package web
import (
"context"
"encoding/json"
"net/http"
"net/url"
"testing"
"github.com/gravitational/roundtrip"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/gravitational/teleport/api/client/webclient"
"github.com/gravitational/teleport/api/constants"
"github.com/gravitational/teleport/api/types"
"github.com/gravitational/teleport/lib/client"
"github.com/gravitational/teleport/lib/modules"
)
func TestPing(t *testing.T) {
ctx := context.Background()
env := newWebPack(t, 1)
authServer := env.server.Auth()
clt, err := client.NewWebClient(env.proxies[0].webURL.String(), roundtrip.HTTPClient(client.NewInsecureWebClient()))
require.NoError(t, err)
tests := []struct {
name string
buildType string // defaults to modules.BuildOSS
spec *types.AuthPreferenceSpecV2
assertResp func(cap types.AuthPreference, resp *webclient.PingResponse)
}{
{
name: "OK local auth",
spec: &types.AuthPreferenceSpecV2{
Type: constants.Local,
SecondFactor: constants.SecondFactorOptional,
U2F: &types.U2F{
AppID: "https://example.com",
},
Webauthn: &types.Webauthn{
RPID: "example.com",
},
},
assertResp: func(cap types.AuthPreference, resp *webclient.PingResponse) {
assert.Equal(t, cap.GetType(), resp.Auth.Type)
assert.Equal(t, cap.GetSecondFactor(), resp.Auth.SecondFactor)
assert.NotEmpty(t, cap.GetPreferredLocalMFA(), "preferred local MFA empty")
assert.NotNil(t, resp.Auth.Local, "Auth.Local expected")
u2f, _ := cap.GetU2F()
require.NotNil(t, resp.Auth.U2F)
assert.Equal(t, u2f.AppID, resp.Auth.U2F.AppID)
webCfg, _ := cap.GetWebauthn()
require.NotNil(t, resp.Auth.Webauthn)
assert.Equal(t, webCfg.RPID, resp.Auth.Webauthn.RPID)
},
},
{
name: "OK passwordless connector",
spec: &types.AuthPreferenceSpecV2{
Type: constants.Local,
SecondFactor: constants.SecondFactorOptional,
Webauthn: &types.Webauthn{
RPID: "example.com",
},
ConnectorName: constants.PasswordlessConnector,
},
assertResp: func(_ types.AuthPreference, resp *webclient.PingResponse) {
assert.True(t, resp.Auth.AllowPasswordless, "Auth.AllowPasswordless")
require.NotNil(t, resp.Auth.Local, "Auth.Local")
assert.Equal(t, constants.PasswordlessConnector, resp.Auth.Local.Name, "Auth.Local.Name")
},
},
{
name: "OK headless connector",
spec: &types.AuthPreferenceSpecV2{
Type: constants.Local,
SecondFactor: constants.SecondFactorOptional,
Webauthn: &types.Webauthn{
RPID: "example.com",
},
ConnectorName: constants.HeadlessConnector,
},
assertResp: func(_ types.AuthPreference, resp *webclient.PingResponse) {
assert.True(t, resp.Auth.AllowHeadless, "Auth.AllowHeadless")
require.NotNil(t, resp.Auth.Local, "Auth.Local")
assert.Equal(t, constants.HeadlessConnector, resp.Auth.Local.Name, "Auth.Local.Name")
},
},
{
name: "OK device trust mode=off",
buildType: modules.BuildOSS,
spec: &types.AuthPreferenceSpecV2{
// Configuration is unimportant, what counts here is that the build
// is OSS.
Type: constants.Local,
SecondFactor: constants.SecondFactorOptional,
Webauthn: &types.Webauthn{
RPID: "example.com",
},
},
assertResp: func(_ types.AuthPreference, resp *webclient.PingResponse) {
assert.True(t, resp.Auth.DeviceTrustDisabled, "Auth.DeviceTrustDisabled")
assert.True(t, resp.Auth.DeviceTrust.Disabled, "Auth.DeviceTrust.Disabled")
},
},
{
name: "OK device trust mode=optional",
buildType: modules.BuildEnterprise,
spec: &types.AuthPreferenceSpecV2{
Type: constants.Local,
SecondFactor: constants.SecondFactorOptional,
Webauthn: &types.Webauthn{
RPID: "example.com",
},
DeviceTrust: &types.DeviceTrust{
Mode: constants.DeviceTrustModeOptional,
},
},
assertResp: func(_ types.AuthPreference, resp *webclient.PingResponse) {
assert.False(t, resp.Auth.DeviceTrustDisabled, "Auth.DeviceTrustDisabled")
assert.False(t, resp.Auth.DeviceTrust.Disabled, "Auth.DeviceTrust.Disabled")
},
},
{
name: "OK device trust auto-enroll",
buildType: modules.BuildEnterprise,
spec: &types.AuthPreferenceSpecV2{
Type: constants.Local,
SecondFactor: constants.SecondFactorOptional,
Webauthn: &types.Webauthn{
RPID: "example.com",
},
DeviceTrust: &types.DeviceTrust{
Mode: constants.DeviceTrustModeOptional,
AutoEnroll: true,
},
},
assertResp: func(_ types.AuthPreference, resp *webclient.PingResponse) {
assert.False(t, resp.Auth.DeviceTrustDisabled, "Auth.DeviceTrustDisabled")
assert.False(t, resp.Auth.DeviceTrust.Disabled, "Auth.DeviceTrust.Disabled")
assert.True(t, resp.Auth.DeviceTrust.AutoEnroll, "Auth.DeviceTrust.AutoEnroll")
},
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
buildType := test.buildType
if buildType == "" {
buildType = modules.BuildOSS
}
modules.SetTestModules(t, &modules.TestModules{
TestBuildType: buildType,
})
cap, err := types.NewAuthPreference(*test.spec)
require.NoError(t, err)
require.NoError(t, authServer.SetAuthPreference(ctx, cap))
resp, err := clt.Get(ctx, clt.Endpoint("webapi", "ping"), url.Values{})
require.NoError(t, err)
var pingResp webclient.PingResponse
require.NoError(t, json.Unmarshal(resp.Bytes(), &pingResp))
test.assertResp(cap, &pingResp)
})
}
}
// TestPing_multiProxyAddr makes sure ping endpoint can be called over any of
// the proxy's configured public addresses.
func TestPing_multiProxyAddr(t *testing.T) {
env := newWebPack(t, 1)
proxy := env.proxies[0]
req, err := http.NewRequest(http.MethodGet, proxy.newClient(t).Endpoint("webapi", "ping"), nil)
require.NoError(t, err)
// Make sure ping endpoint can be reached over all proxy public addrs.
for _, proxyAddr := range proxy.handler.handler.cfg.ProxyPublicAddrs {
req.Host = proxyAddr.Host()
resp, err := client.NewInsecureWebClient().Do(req)
require.NoError(t, err)
require.NoError(t, resp.Body.Close())
}
}
// TestPing_minimalAPI tests that pinging the minimal web API works correctly.
func TestPing_minimalAPI(t *testing.T) {
env := newWebPack(t, 1, func(cfg *proxyConfig) {
cfg.minimalHandler = true
})
proxy := env.proxies[0]
tests := []struct {
name string
host string
}{
{
name: "Default ping",
host: proxy.handler.handler.cfg.ProxyPublicAddrs[0].Host(),
},
{
// This test ensures that the API doesn't try to launch an application.
name: "Ping with alternate host",
host: "example.com",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
req, err := http.NewRequest(http.MethodGet, proxy.newClient(t).Endpoint("webapi", "ping"), nil)
require.NoError(t, err)
req.Host = tc.host
resp, err := client.NewInsecureWebClient().Do(req)
require.NoError(t, err)
require.NoError(t, resp.Body.Close())
})
}
}