2023-03-08 06:38:11 +11:00
package workspaceapps_test
import (
"context"
2025-03-18 13:50:52 +02:00
"database/sql"
2023-03-08 06:38:11 +11:00
"fmt"
2023-03-31 00:24:51 +11:00
"io"
2023-03-08 06:38:11 +11:00
"net"
"net/http"
"net/http/httptest"
"net/http/httputil"
"net/url"
2023-03-31 00:24:51 +11:00
"strings"
2025-03-18 13:50:52 +02:00
"sync/atomic"
2023-03-08 06:38:11 +11:00
"testing"
"time"
2024-10-25 17:14:35 +01:00
"github.com/go-jose/go-jose/v4/jwt"
2023-03-08 06:38:11 +11:00
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
2023-09-26 12:05:19 +01:00
"github.com/coder/coder/v2/agent/agenttest"
2023-08-18 13:55:43 -05:00
"github.com/coder/coder/v2/coderd/coderdtest"
2025-07-15 14:36:06 +10:00
"github.com/coder/coder/v2/coderd/connectionlog"
2025-03-18 13:50:52 +02:00
"github.com/coder/coder/v2/coderd/database"
2023-08-18 13:55:43 -05:00
"github.com/coder/coder/v2/coderd/httpmw"
2024-10-25 17:14:35 +01:00
"github.com/coder/coder/v2/coderd/jwtutils"
2025-03-18 13:50:52 +02:00
"github.com/coder/coder/v2/coderd/tracing"
2023-08-18 13:55:43 -05:00
"github.com/coder/coder/v2/coderd/workspaceapps"
2024-01-17 10:41:42 -06:00
"github.com/coder/coder/v2/coderd/workspaceapps/appurl"
2023-08-18 13:55:43 -05:00
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/provisioner/echo"
"github.com/coder/coder/v2/provisionersdk/proto"
"github.com/coder/coder/v2/testutil"
2023-03-08 06:38:11 +11:00
)
func Test_ResolveRequest ( t * testing . T ) {
t . Parallel ()
const (
agentName = "agent"
appNameOwner = "app-owner"
appNameAuthed = "app-authed"
appNamePublic = "app-public"
appNameInvalidURL = "app-invalid-url"
2024-02-12 22:30:49 -08:00
// Users can access unhealthy and initializing apps (as of 2024-02).
appNameUnhealthy = "app-unhealthy"
appNameInitializing = "app-initializing"
2024-04-09 12:06:22 -04:00
appNameEndsInS = "app-ends-in-s"
2023-03-31 00:24:51 +11:00
// This agent will never connect, so it will never become "connected".
2024-02-12 22:30:49 -08:00
// Users cannot access unhealthy agents.
2023-03-31 00:24:51 +11:00
agentNameUnhealthy = "agent-unhealthy"
appNameAgentUnhealthy = "app-agent-unhealthy"
2023-03-08 06:38:11 +11:00
// This is not a valid URL we listen on in the test, but it needs to be
// set to a value.
appURL = "http://localhost:8080"
)
allApps := [] string { appNameOwner , appNameAuthed , appNamePublic }
2023-03-31 00:24:51 +11:00
// Start a listener for a server that always responds with 500 for the
// unhealthy app.
unhealthySrv := httptest . NewServer ( http . HandlerFunc ( func ( w http . ResponseWriter , r * http . Request ) {
w . WriteHeader ( http . StatusInternalServerError )
_ , _ = w . Write ([] byte ( "unhealthy" ))
}))
2024-02-12 22:30:49 -08:00
t . Cleanup ( unhealthySrv . Close )
// Start a listener for a server that never responds.
initializingServer , err := net . Listen ( "tcp" , "localhost:0" )
require . NoError ( t , err )
t . Cleanup ( func () {
_ = initializingServer . Close ()
})
initializingURL := fmt . Sprintf ( "http://%s" , initializingServer . Addr (). String ())
2023-03-31 00:24:51 +11:00
2023-03-07 15:10:01 -06:00
deploymentValues := coderdtest . DeploymentValues ( t )
deploymentValues . DisablePathApps = false
deploymentValues . Dangerous . AllowPathAppSharing = true
deploymentValues . Dangerous . AllowPathAppSiteOwnerAccess = true
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
t . Cleanup ( func () {
if t . Failed () {
return
}
2025-07-15 14:36:06 +10:00
assert . Len ( t , connLogger . ConnectionLogs (), 0 , "one or more test cases produced unexpected connection logs, did you replace the auditor or forget to call ResetLogs?" )
2025-03-18 13:50:52 +02:00
})
2023-03-08 06:38:11 +11:00
client , closer , api := coderdtest . NewWithAPI ( t , & coderdtest . Options {
2023-04-17 14:57:21 -05:00
AppHostname : "*.test.coder.com" ,
2023-03-07 15:10:01 -06:00
DeploymentValues : deploymentValues ,
2023-03-08 06:38:11 +11:00
IncludeProvisionerDaemon : true ,
AgentStatsRefreshInterval : time . Millisecond * 100 ,
MetricsCacheRefreshInterval : time . Millisecond * 100 ,
RealIPConfig : & httpmw . RealIPConfig {
TrustedOrigins : [] * net . IPNet {{
IP : net . ParseIP ( "127.0.0.1" ),
Mask : net . CIDRMask ( 8 , 32 ),
}},
TrustedHeaders : [] string {
"CF-Connecting-IP" ,
},
},
2025-07-15 14:36:06 +10:00
ConnectionLogger : connLogger ,
2023-03-08 06:38:11 +11:00
})
t . Cleanup ( func () {
_ = closer . Close ()
})
2024-10-25 17:14:35 +01:00
ctx := testutil . Context ( t , testutil . WaitMedium )
2023-03-08 06:38:11 +11:00
firstUser := coderdtest . CreateFirstUser ( t , client )
me , err := client . User ( ctx , codersdk . Me )
require . NoError ( t , err )
2025-03-18 13:50:52 +02:00
secondUserClient , secondUser := coderdtest . CreateAnotherUser ( t , client , firstUser . OrganizationID )
2023-03-08 06:38:11 +11:00
agentAuthToken := uuid . NewString ()
version := coderdtest . CreateTemplateVersion ( t , client , firstUser . OrganizationID , & echo . Responses {
Parse : echo . ParseComplete ,
2023-08-25 10:10:15 +04:00
ProvisionPlan : echo . PlanComplete ,
ProvisionApply : [] * proto . Response {{
Type : & proto . Response_Apply {
Apply : & proto . ApplyComplete {
2023-03-08 06:38:11 +11:00
Resources : [] * proto . Resource {{
Name : "example" ,
Type : "aws_instance" ,
2023-03-31 00:24:51 +11:00
Agents : [] * proto . Agent {
{
Id : uuid . NewString (),
Name : agentName ,
Auth : & proto . Agent_Token {
Token : agentAuthToken ,
2023-03-08 06:38:11 +11:00
},
2023-03-31 00:24:51 +11:00
Apps : [] * proto . App {
{
Slug : appNameOwner ,
DisplayName : appNameOwner ,
SharingLevel : proto . AppSharingLevel_OWNER ,
Url : appURL ,
},
{
Slug : appNameAuthed ,
DisplayName : appNameAuthed ,
SharingLevel : proto . AppSharingLevel_AUTHENTICATED ,
Url : appURL ,
},
{
Slug : appNamePublic ,
DisplayName : appNamePublic ,
SharingLevel : proto . AppSharingLevel_PUBLIC ,
Url : appURL ,
},
{
Slug : appNameInvalidURL ,
DisplayName : appNameInvalidURL ,
SharingLevel : proto . AppSharingLevel_PUBLIC ,
Url : "test:path/to/app" ,
},
{
Slug : appNameUnhealthy ,
DisplayName : appNameUnhealthy ,
SharingLevel : proto . AppSharingLevel_PUBLIC ,
Url : appURL ,
Healthcheck : & proto . Healthcheck {
Url : unhealthySrv . URL ,
Interval : 1 ,
Threshold : 1 ,
},
},
2024-02-12 22:30:49 -08:00
{
Slug : appNameInitializing ,
DisplayName : appNameInitializing ,
SharingLevel : proto . AppSharingLevel_PUBLIC ,
Url : appURL ,
Healthcheck : & proto . Healthcheck {
Url : initializingURL ,
Interval : 30 ,
Threshold : 1000 ,
},
},
2024-04-09 12:06:22 -04:00
{
Slug : appNameEndsInS ,
DisplayName : appNameEndsInS ,
SharingLevel : proto . AppSharingLevel_OWNER ,
Url : appURL ,
},
2023-03-08 06:38:11 +11:00
},
},
2023-03-31 00:24:51 +11:00
{
Id : uuid . NewString (),
Name : agentNameUnhealthy ,
Auth : & proto . Agent_Token {
Token : uuid . NewString (),
},
Apps : [] * proto . App {
{
Slug : appNameAgentUnhealthy ,
DisplayName : appNameAgentUnhealthy ,
SharingLevel : proto . AppSharingLevel_PUBLIC ,
Url : appURL ,
},
},
},
},
2023-03-08 06:38:11 +11:00
}},
},
},
}},
})
template := coderdtest . CreateTemplate ( t , client , firstUser . OrganizationID , version . ID )
2023-10-03 11:02:56 -06:00
coderdtest . AwaitTemplateVersionJobCompleted ( t , client , version . ID )
2024-07-30 10:44:02 -06:00
workspace := coderdtest . CreateWorkspace ( t , client , template . ID )
2023-10-03 11:02:56 -06:00
coderdtest . AwaitWorkspaceBuildJobCompleted ( t , client , workspace . LatestBuild . ID )
2023-03-08 06:38:11 +11:00
2023-09-26 12:05:19 +01:00
_ = agenttest . New ( t , client . URL , agentAuthToken )
2023-03-31 00:24:51 +11:00
resources := coderdtest . AwaitWorkspaceAgents ( t , client , workspace . ID , agentName )
2023-03-08 06:38:11 +11:00
agentID := uuid . Nil
for _ , resource := range resources {
for _ , agnt := range resource . Agents {
if agnt . Name == agentName {
agentID = agnt . ID
2025-03-18 13:50:52 +02:00
break
2023-03-08 06:38:11 +11:00
}
}
}
require . NotEqual ( t , uuid . Nil , agentID )
2025-03-18 13:50:52 +02:00
// Reset audit logs so cleanup check can pass.
2025-07-15 14:36:06 +10:00
connLogger . Reset ()
2025-03-18 13:50:52 +02:00
2023-03-08 06:38:11 +11:00
t . Run ( "OK" , func ( t * testing . T ) {
t . Parallel ()
cases := [] struct {
name string
workspaceNameOrID string
agentNameOrID string
}{
{
name : "Names" ,
workspaceNameOrID : workspace . Name ,
agentNameOrID : agentName ,
},
{
name : "IDs" ,
workspaceNameOrID : workspace . ID . String (),
agentNameOrID : agentID . String (),
},
}
for _ , c := range cases {
t . Run ( c . name , func ( t * testing . T ) {
t . Parallel ()
2023-04-04 10:59:41 +10:00
// Try resolving a request for each app as the owner, without a
// token, then use the token to resolve each app.
2023-03-08 06:38:11 +11:00
for _ , app := range allApps {
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : c . workspaceNameOrID ,
AgentNameOrID : c . agentNameOrID ,
AppSlugOrPort : app ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2025-07-15 14:36:06 +10:00
auditableUA := "Noitcennoc"
2025-03-18 13:50:52 +02:00
2023-03-08 06:38:11 +11:00
t . Log ( "app" , app )
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
r . Header . Set ( "User-Agent" , auditableUA )
2023-03-08 06:38:11 +11:00
2023-04-04 10:59:41 +10:00
// Try resolving the request without a token.
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
w := rw . Result ()
if ! assert . True ( t , ok ) {
dump , err := httputil . DumpResponse ( w , true )
require . NoError ( t , err , "error dumping failed response" )
t . Log ( string ( dump ))
return
}
_ = w . Body . Close ()
2023-04-04 10:59:41 +10:00
require . Equal ( t , & workspaceapps . SignedToken {
2024-10-25 17:14:35 +01:00
RegisteredClaims : jwtutils . RegisteredClaims {
Expiry : jwt . NewNumericDate ( token . Expiry . Time ()),
},
2025-07-30 13:42:39 -07:00
Request : req ,
UserID : me . ID ,
WorkspaceID : workspace . ID ,
AgentID : agentID ,
AppURL : appURL ,
CORSBehavior : codersdk . CORSBehaviorSimple ,
2023-04-04 10:59:41 +10:00
}, token )
require . NotZero ( t , token . Expiry )
2024-10-25 17:14:35 +01:00
require . WithinDuration ( t , time . Now (). Add ( workspaceapps . DefaultTokenExpiry ), token . Expiry . Time (), time . Minute )
2023-03-08 06:38:11 +11:00
2023-04-04 10:59:41 +10:00
// Check that the token was set in the response and is valid.
2023-03-08 06:38:11 +11:00
require . Len ( t , w . Cookies (), 1 )
cookie := w . Cookies ()[ 0 ]
2023-08-28 18:34:52 -07:00
require . Equal ( t , codersdk . SignedAppTokenCookie , cookie . Name )
2023-03-08 06:38:11 +11:00
require . Equal ( t , req . BasePath , cookie . Path )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , app , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2025-03-18 13:50:52 +02:00
2024-10-25 17:14:35 +01:00
var parsedToken workspaceapps . SignedToken
err := jwtutils . Verify ( ctx , api . AppSigningKeyCache , cookie . Value , & parsedToken )
2023-03-08 06:38:11 +11:00
require . NoError ( t , err )
2023-04-04 10:59:41 +10:00
// normalize expiry
2024-10-25 17:14:35 +01:00
require . WithinDuration ( t , token . Expiry . Time (), parsedToken . Expiry . Time (), 2 * time . Second )
2023-04-04 10:59:41 +10:00
parsedToken . Expiry = token . Expiry
require . Equal ( t , token , & parsedToken )
2023-03-08 06:38:11 +11:00
2023-04-04 10:59:41 +10:00
// Try resolving the request with the token only.
2023-03-08 06:38:11 +11:00
rw = httptest . NewRecorder ()
r = httptest . NewRequest ( "GET" , "/app" , nil )
r . AddCookie ( cookie )
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
secondToken , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
require . True ( t , ok )
2023-04-04 10:59:41 +10:00
// normalize expiry
2024-10-25 17:14:35 +01:00
require . WithinDuration ( t , token . Expiry . Time (), secondToken . Expiry . Time (), 2 * time . Second )
2023-04-04 10:59:41 +10:00
secondToken . Expiry = token . Expiry
require . Equal ( t , token , secondToken )
2025-07-15 14:36:06 +10:00
require . Len ( t , connLogger . ConnectionLogs (), 1 , "no new connection log, FromRequest returned the same token and is not logged" )
2023-03-08 06:38:11 +11:00
}
})
}
})
t . Run ( "AuthenticatedOtherUser" , func ( t * testing . T ) {
t . Parallel ()
for _ , app := range allApps {
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : app ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-08 06:38:11 +11:00
t . Log ( "app" , app )
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , secondUserClient . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
w := rw . Result ()
_ = w . Body . Close ()
if app == appNameOwner {
require . False ( t , ok )
2023-04-04 10:59:41 +10:00
require . Nil ( t , token )
2023-03-08 06:38:11 +11:00
require . NotZero ( t , w . StatusCode )
require . Equal ( t , http . StatusNotFound , w . StatusCode )
2025-07-15 14:36:06 +10:00
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-08 06:38:11 +11:00
return
}
require . True ( t , ok )
2023-04-04 10:59:41 +10:00
require . NotNil ( t , token )
2023-03-08 06:38:11 +11:00
require . Zero ( t , w . StatusCode )
2025-03-18 13:50:52 +02:00
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , app , database . ConnectionTypeWorkspaceApp , secondUser . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-08 06:38:11 +11:00
}
})
t . Run ( "Unauthenticated" , func ( t * testing . T ) {
t . Parallel ()
for _ , app := range allApps {
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : app ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-08 06:38:11 +11:00
t . Log ( "app" , app )
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
w := rw . Result ()
if app != appNamePublic {
require . False ( t , ok )
2023-04-04 10:59:41 +10:00
require . Nil ( t , token )
2023-03-08 06:38:11 +11:00
require . NotZero ( t , rw . Code )
require . NotEqual ( t , http . StatusOK , rw . Code )
2025-03-18 13:50:52 +02:00
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , app , database . ConnectionTypeWorkspaceApp , uuid . Nil )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-08 06:38:11 +11:00
} else {
if ! assert . True ( t , ok ) {
dump , err := httputil . DumpResponse ( w , true )
require . NoError ( t , err , "error dumping failed response" )
t . Log ( string ( dump ))
return
}
2023-04-04 10:59:41 +10:00
require . NotNil ( t , token )
2023-03-08 06:38:11 +11:00
if rw . Code != 0 && rw . Code != http . StatusOK {
t . Fatalf ( "expected 200 (or unset) response code, got %d" , rw . Code )
}
2025-03-18 13:50:52 +02:00
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , app , database . ConnectionTypeWorkspaceApp , uuid . Nil )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-08 06:38:11 +11:00
}
_ = w . Body . Close ()
}
})
t . Run ( "Invalid" , func ( t * testing . T ) {
t . Parallel ()
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : "invalid" ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-08 06:38:11 +11:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
require . False ( t , ok )
2023-04-04 10:59:41 +10:00
require . Nil ( t , token )
2025-07-15 14:36:06 +10:00
require . Len ( t , connLogger . ConnectionLogs (), 0 )
2023-03-08 06:38:11 +11:00
})
t . Run ( "SplitWorkspaceAndAgent" , func ( t * testing . T ) {
t . Parallel ()
cases := [] struct {
name string
workspaceAndAgent string
workspace string
agent string
ok bool
}{
{
2023-03-31 00:24:51 +11:00
name : "WorkspaceOnly" ,
2023-03-08 06:38:11 +11:00
workspaceAndAgent : workspace . Name ,
workspace : workspace . Name ,
agent : "" ,
ok : true ,
},
{
name : "WorkspaceAndAgent" ,
workspaceAndAgent : fmt . Sprintf ( "%s.%s" , workspace . Name , agentName ),
workspace : workspace . Name ,
agent : agentName ,
ok : true ,
},
{
name : "WorkspaceID" ,
workspaceAndAgent : workspace . ID . String (),
workspace : workspace . ID . String (),
agent : "" ,
ok : true ,
},
{
name : "WorkspaceIDAndAgentID" ,
workspaceAndAgent : fmt . Sprintf ( "%s.%s" , workspace . ID , agentID ),
workspace : workspace . ID . String (),
agent : agentID . String (),
ok : true ,
},
{
name : "Invalid1" ,
workspaceAndAgent : "invalid" ,
ok : false ,
},
{
name : "Invalid2" ,
workspaceAndAgent : "." ,
ok : false ,
},
{
name : "Slash" ,
workspaceAndAgent : fmt . Sprintf ( "%s/%s" , workspace . Name , agentName ),
ok : false ,
},
}
for _ , c := range cases {
t . Run ( c . name , func ( t * testing . T ) {
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceAndAgent : c . workspaceAndAgent ,
AppSlugOrPort : appNamePublic ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-08 06:38:11 +11:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
w := rw . Result ()
if ! assert . Equal ( t , c . ok , ok ) {
dump , err := httputil . DumpResponse ( w , true )
require . NoError ( t , err , "error dumping failed response" )
t . Log ( string ( dump ))
return
}
if c . ok {
2023-04-04 10:59:41 +10:00
require . NotNil ( t , token )
require . Equal ( t , token . WorkspaceNameOrID , c . workspace )
require . Equal ( t , token . AgentNameOrID , c . agent )
require . Equal ( t , token . WorkspaceID , workspace . ID )
require . Equal ( t , token . AgentID , agentID )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , token . AppSlugOrPort , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-08 06:38:11 +11:00
} else {
2023-04-04 10:59:41 +10:00
require . Nil ( t , token )
2025-07-15 14:36:06 +10:00
require . Len ( t , connLogger . ConnectionLogs (), 0 )
2023-03-08 06:38:11 +11:00
}
_ = w . Body . Close ()
})
}
})
2023-04-04 10:59:41 +10:00
t . Run ( "TokenDoesNotMatchRequest" , func ( t * testing . T ) {
2023-03-08 06:38:11 +11:00
t . Parallel ()
2023-04-04 10:59:41 +10:00
badToken := workspaceapps . SignedToken {
2023-08-28 18:34:52 -07:00
Request : ( workspaceapps . Request {
2023-03-31 00:24:51 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
// App name differs
AppSlugOrPort : appNamePublic ,
2023-08-28 18:34:52 -07:00
}). Normalize (),
2024-10-25 17:14:35 +01:00
RegisteredClaims : jwtutils . RegisteredClaims {
Expiry : jwt . NewNumericDate ( time . Now (). Add ( time . Minute )),
},
2023-03-31 00:24:51 +11:00
UserID : me . ID ,
WorkspaceID : workspace . ID ,
AgentID : agentID ,
AppURL : appURL ,
2023-03-08 06:38:11 +11:00
}
2024-10-25 17:14:35 +01:00
badTokenStr , err := jwtutils . Sign ( ctx , api . AppSigningKeyCache , badToken )
2023-03-08 06:38:11 +11:00
require . NoError ( t , err )
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
// App name differs
AppSlugOrPort : appNameOwner ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-08 06:38:11 +11:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
r . AddCookie ( & http . Cookie {
2023-08-28 18:34:52 -07:00
Name : codersdk . SignedAppTokenCookie ,
2023-04-04 10:59:41 +10:00
Value : badTokenStr ,
2023-03-08 06:38:11 +11:00
})
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-08 06:38:11 +11:00
2023-04-04 10:59:41 +10:00
// Even though the token is invalid, we should still perform request
// resolution without failure since we'll just ignore the bad token.
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
require . True ( t , ok )
2023-04-04 10:59:41 +10:00
require . NotNil ( t , token )
require . Equal ( t , appNameOwner , token . AppSlugOrPort )
2023-03-08 06:38:11 +11:00
// Cookie should be set in response, and it should be a different
2023-04-04 10:59:41 +10:00
// token.
2023-03-08 06:38:11 +11:00
w := rw . Result ()
_ = w . Body . Close ()
cookies := w . Cookies ()
require . Len ( t , cookies , 1 )
2023-08-28 18:34:52 -07:00
require . Equal ( t , cookies [ 0 ]. Name , codersdk . SignedAppTokenCookie )
2023-04-04 10:59:41 +10:00
require . NotEqual ( t , cookies [ 0 ]. Value , badTokenStr )
2024-10-25 17:14:35 +01:00
var parsedToken workspaceapps . SignedToken
err = jwtutils . Verify ( ctx , api . AppSigningKeyCache , cookies [ 0 ]. Value , & parsedToken )
2023-03-08 06:38:11 +11:00
require . NoError ( t , err )
2023-04-04 10:59:41 +10:00
require . Equal ( t , appNameOwner , parsedToken . AppSlugOrPort )
2025-03-18 13:50:52 +02:00
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , appNameOwner , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-08 06:38:11 +11:00
})
t . Run ( "PortPathBlocked" , func ( t * testing . T ) {
t . Parallel ()
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : "8080" ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-08 06:38:11 +11:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
require . False ( t , ok )
2023-04-04 10:59:41 +10:00
require . Nil ( t , token )
2025-03-18 13:50:52 +02:00
w := rw . Result ()
_ = w . Body . Close ()
// TODO(mafredri): Verify this is the correct status code.
require . Equal ( t , http . StatusInternalServerError , w . StatusCode )
2025-07-15 14:36:06 +10:00
require . Len ( t , connLogger . ConnectionLogs (), 0 , "no connection logs for port path blocked requests" )
2023-03-08 06:38:11 +11:00
})
t . Run ( "PortSubdomain" , func ( t * testing . T ) {
t . Parallel ()
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : workspaceapps . AccessMethodSubdomain ,
BasePath : "/" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : "9090" ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-08 06:38:11 +11:00
rw := httptest . NewRecorder ()
2023-03-31 00:24:51 +11:00
r := httptest . NewRequest ( "GET" , "/" , nil )
2023-03-08 06:38:11 +11:00
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
require . True ( t , ok )
2023-04-04 10:59:41 +10:00
require . Equal ( t , req . AppSlugOrPort , token . AppSlugOrPort )
require . Equal ( t , "http://127.0.0.1:9090" , token . AppURL )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , "9090" , database . ConnectionTypePortForwarding , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-08 06:38:11 +11:00
})
2024-04-09 12:06:22 -04:00
t . Run ( "PortSubdomainHTTPSS" , func ( t * testing . T ) {
t . Parallel ()
req := ( workspaceapps . Request {
AccessMethod : workspaceapps . AccessMethodSubdomain ,
BasePath : "/" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : "9090ss" ,
}). Normalize ()
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2024-04-09 12:06:22 -04:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2024-04-09 12:06:22 -04:00
2025-07-15 14:36:06 +10:00
_ , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2024-04-09 12:06:22 -04:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
// should parse as app and fail to find app "9090ss"
require . False ( t , ok )
w := rw . Result ()
_ = w . Body . Close ()
b , err := io . ReadAll ( w . Body )
require . NoError ( t , err )
require . Contains ( t , string ( b ), "404 - Application Not Found" )
2025-03-18 13:50:52 +02:00
require . Equal ( t , http . StatusNotFound , w . StatusCode )
2025-07-15 14:36:06 +10:00
require . Len ( t , connLogger . ConnectionLogs (), 0 )
2024-04-09 12:06:22 -04:00
})
t . Run ( "SubdomainEndsInS" , func ( t * testing . T ) {
t . Parallel ()
req := ( workspaceapps . Request {
AccessMethod : workspaceapps . AccessMethodSubdomain ,
BasePath : "/" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : appNameEndsInS ,
}). Normalize ()
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2024-04-09 12:06:22 -04:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2024-04-09 12:06:22 -04:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2024-04-09 12:06:22 -04:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
require . True ( t , ok )
require . Equal ( t , req . AppSlugOrPort , token . AppSlugOrPort )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , appNameEndsInS , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2024-04-09 12:06:22 -04:00
})
2023-03-31 00:24:51 +11:00
t . Run ( "Terminal" , func ( t * testing . T ) {
t . Parallel ()
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-31 00:24:51 +11:00
AccessMethod : workspaceapps . AccessMethodTerminal ,
BasePath : "/app" ,
AgentNameOrID : agentID . String (),
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-31 00:24:51 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-31 00:24:51 +11:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-31 00:24:51 +11:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-31 00:24:51 +11:00
require . True ( t , ok )
2023-04-04 10:59:41 +10:00
require . Equal ( t , req . AccessMethod , token . AccessMethod )
require . Equal ( t , req . BasePath , token . BasePath )
require . Empty ( t , token . UsernameOrID )
require . Empty ( t , token . WorkspaceNameOrID )
require . Equal ( t , req . AgentNameOrID , token . Request . AgentNameOrID )
require . Empty ( t , token . AppSlugOrPort )
require . Empty ( t , token . AppURL )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , "terminal" , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-31 00:24:51 +11:00
})
2023-03-08 06:38:11 +11:00
t . Run ( "InsufficientPermissions" , func ( t * testing . T ) {
t . Parallel ()
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : appNameOwner ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-08 06:38:11 +11:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , secondUserClient . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-08 06:38:11 +11:00
require . False ( t , ok )
2023-04-04 10:59:41 +10:00
require . Nil ( t , token )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , appNameOwner , database . ConnectionTypeWorkspaceApp , secondUser . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-08 06:38:11 +11:00
})
2023-03-10 18:09:28 +00:00
t . Run ( "UserNotFound" , func ( t * testing . T ) {
t . Parallel ()
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-10 18:09:28 +00:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : "thisuserdoesnotexist" ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : appNameOwner ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-10 18:09:28 +00:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-10 18:09:28 +00:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-10 18:09:28 +00:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-10 18:09:28 +00:00
require . False ( t , ok )
2023-04-04 10:59:41 +10:00
require . Nil ( t , token )
2025-07-15 14:36:06 +10:00
require . Len ( t , connLogger . ConnectionLogs (), 0 )
2023-03-10 18:09:28 +00:00
})
2023-03-08 06:38:11 +11:00
t . Run ( "RedirectSubdomainAuth" , func ( t * testing . T ) {
t . Parallel ()
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-08 06:38:11 +11:00
AccessMethod : workspaceapps . AccessMethodSubdomain ,
BasePath : "/" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : appNameOwner ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-08 06:38:11 +11:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/some-path" , nil )
2023-04-17 14:57:21 -05:00
// Should not be used as the hostname in the redirect URI.
2023-03-08 06:38:11 +11:00
r . Host = "app.com"
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-08 06:38:11 +11:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
AppPath : "/some-path" ,
})
2023-03-08 06:38:11 +11:00
require . False ( t , ok )
2023-04-04 10:59:41 +10:00
require . Nil ( t , token )
2023-03-08 06:38:11 +11:00
w := rw . Result ()
defer w . Body . Close ()
2023-04-17 14:57:21 -05:00
require . Equal ( t , http . StatusSeeOther , w . StatusCode )
2025-03-18 13:50:52 +02:00
// Note that we don't capture the owner UUID here because the apiKey
// check/authorization exits early.
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , appNameOwner , database . ConnectionTypeWorkspaceApp , uuid . Nil )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-08 06:38:11 +11:00
loc , err := w . Location ()
require . NoError ( t , err )
require . Equal ( t , api . AccessURL . Scheme , loc . Scheme )
require . Equal ( t , api . AccessURL . Host , loc . Host )
require . Equal ( t , "/api/v2/applications/auth-redirect" , loc . Path )
redirectURIStr := loc . Query (). Get ( workspaceapps . RedirectURIQueryParam )
redirectURI , err := url . Parse ( redirectURIStr )
require . NoError ( t , err )
2024-01-17 10:41:42 -06:00
appHost := appurl . ApplicationURL {
2023-10-11 07:02:39 +11:00
Prefix : "" ,
2023-09-08 16:01:57 +02:00
AppSlugOrPort : req . AppSlugOrPort ,
AgentName : req . AgentNameOrID ,
WorkspaceName : req . WorkspaceNameOrID ,
Username : req . UsernameOrID ,
}
host := strings . Replace ( api . AppHostname , "*" , appHost . String (), 1 )
2023-04-17 14:57:21 -05:00
2023-03-08 06:38:11 +11:00
require . Equal ( t , "http" , redirectURI . Scheme )
2023-04-17 14:57:21 -05:00
require . Equal ( t , host , redirectURI . Host )
2023-03-08 06:38:11 +11:00
require . Equal ( t , "/some-path" , redirectURI . Path )
})
2023-03-31 00:24:51 +11:00
t . Run ( "UnhealthyAgent" , func ( t * testing . T ) {
t . Parallel ()
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-31 00:24:51 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentNameUnhealthy ,
AppSlugOrPort : appNameAgentUnhealthy ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-31 00:24:51 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-31 00:24:51 +11:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-31 00:24:51 +11:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2023-03-31 00:24:51 +11:00
require . False ( t , ok , "request succeeded even though agent is not connected" )
2023-04-04 10:59:41 +10:00
require . Nil ( t , token )
2023-03-31 00:24:51 +11:00
w := rw . Result ()
defer w . Body . Close ()
require . Equal ( t , http . StatusBadGateway , w . StatusCode )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentNameUnhealthy , appNameAgentUnhealthy , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2023-03-31 00:24:51 +11:00
body , err := io . ReadAll ( w . Body )
require . NoError ( t , err )
bodyStr := string ( body )
bodyStr = strings . ReplaceAll ( bodyStr , """ , `"` )
// It'll either be "connecting" or "disconnected". Both are OK for this
// test.
require . Contains ( t , bodyStr , `Agent state is "` )
})
2024-02-12 22:30:49 -08:00
// Initializing apps are now permitted to connect anyways. This wasn't
// always the case, but we're testing the behavior to ensure it doesn't
// change back accidentally.
t . Run ( "InitializingAppPermitted" , func ( t * testing . T ) {
t . Parallel ()
ctx , cancel := context . WithTimeout ( context . Background (), testutil . WaitShort )
defer cancel ()
agent , err := client . WorkspaceAgent ( ctx , agentID )
require . NoError ( t , err )
for _ , app := range agent . Apps {
if app . Slug == appNameInitializing {
t . Log ( "app is" , app . Health )
require . Equal ( t , codersdk . WorkspaceAppHealthInitializing , app . Health )
break
}
}
req := ( workspaceapps . Request {
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : appNameInitializing ,
}). Normalize ()
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2024-02-12 22:30:49 -08:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2024-02-12 22:30:49 -08:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2024-02-12 22:30:49 -08:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
require . True ( t , ok , "ResolveRequest failed, should pass even though app is initializing" )
require . NotNil ( t , token )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , token . AppSlugOrPort , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2024-02-12 22:30:49 -08:00
})
// Unhealthy apps are now permitted to connect anyways. This wasn't always
// the case, but we're testing the behavior to ensure it doesn't change back
// accidentally.
t . Run ( "UnhealthyAppPermitted" , func ( t * testing . T ) {
2023-03-31 00:24:51 +11:00
t . Parallel ()
require . Eventually ( t , func () bool {
ctx , cancel := context . WithTimeout ( context . Background (), testutil . WaitShort )
defer cancel ()
agent , err := client . WorkspaceAgent ( ctx , agentID )
if err != nil {
t . Log ( "could not get agent" , err )
return false
}
for _ , app := range agent . Apps {
if app . Slug == appNameUnhealthy {
t . Log ( "app is" , app . Health )
return app . Health == codersdk . WorkspaceAppHealthUnhealthy
}
}
t . Log ( "could not find app" )
return false
}, testutil . WaitLong , testutil . IntervalFast , "wait for app to become unhealthy" )
2023-08-28 18:34:52 -07:00
req := ( workspaceapps . Request {
2023-03-31 00:24:51 +11:00
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : appNameUnhealthy ,
2023-08-28 18:34:52 -07:00
}). Normalize ()
2023-03-31 00:24:51 +11:00
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
2023-03-31 00:24:51 +11:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
2025-03-18 13:50:52 +02:00
r . RemoteAddr = auditableIP
2023-03-31 00:24:51 +11:00
2025-07-15 14:36:06 +10:00
token , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2023-04-17 14:57:21 -05:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
2024-02-12 22:30:49 -08:00
require . True ( t , ok , "ResolveRequest failed, should pass even though app is unhealthy" )
require . NotNil ( t , token )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , token . AppSlugOrPort , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2025-03-18 13:50:52 +02:00
})
2025-07-15 14:36:06 +10:00
t . Run ( "ConnectionLogging" , func ( t * testing . T ) {
2025-03-18 13:50:52 +02:00
t . Parallel ()
for _ , app := range allApps {
req := ( workspaceapps . Request {
AccessMethod : workspaceapps . AccessMethodPath ,
BasePath : "/app" ,
UsernameOrID : me . Username ,
WorkspaceNameOrID : workspace . Name ,
AgentNameOrID : agentName ,
AppSlugOrPort : app ,
}). Normalize ()
2025-07-15 14:36:06 +10:00
connLogger := connectionlog . NewFake ()
2025-03-18 13:50:52 +02:00
auditableIP := testutil . RandomIPv6 ( t )
t . Log ( "app" , app )
2025-07-15 14:36:06 +10:00
// First request, new connection log.
2025-03-18 13:50:52 +02:00
rw := httptest . NewRecorder ()
r := httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
r . RemoteAddr = auditableIP
2025-07-15 14:36:06 +10:00
_ , ok := workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2025-03-18 13:50:52 +02:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
require . True ( t , ok )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , app , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 1 )
2025-03-18 13:50:52 +02:00
// Second request, no audit log because the session is active.
rw = httptest . NewRecorder ()
r = httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
r . RemoteAddr = auditableIP
2025-07-15 14:36:06 +10:00
_ , ok = workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2025-03-18 13:50:52 +02:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
require . True ( t , ok )
2025-07-15 14:36:06 +10:00
require . Len ( t , connLogger . ConnectionLogs (), 1 , "single connection log, previous session active" )
2025-03-18 13:50:52 +02:00
// Third request, session timed out, new audit log.
rw = httptest . NewRecorder ()
r = httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
r . RemoteAddr = auditableIP
2025-07-15 14:36:06 +10:00
sessionTimeoutTokenProvider := signedTokenProviderWithConnLogger ( t , api . WorkspaceAppsProvider , connLogger , 0 )
2025-03-18 13:50:52 +02:00
_ , ok = workspaceappsResolveRequest ( t , nil , rw , r , workspaceapps . ResolveRequestOptions {
Logger : api . Logger ,
SignedTokenProvider : sessionTimeoutTokenProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
require . True ( t , ok )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , app , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 2 , "two connection logs, session timed out" )
2025-03-18 13:50:52 +02:00
// Fourth request, new IP produces new audit log.
auditableIP = testutil . RandomIPv6 ( t )
rw = httptest . NewRecorder ()
r = httptest . NewRequest ( "GET" , "/app" , nil )
r . Header . Set ( codersdk . SessionTokenHeader , client . SessionToken ())
r . RemoteAddr = auditableIP
2025-07-15 14:36:06 +10:00
_ , ok = workspaceappsResolveRequest ( t , connLogger , rw , r , workspaceapps . ResolveRequestOptions {
2025-03-18 13:50:52 +02:00
Logger : api . Logger ,
SignedTokenProvider : api . WorkspaceAppsProvider ,
DashboardURL : api . AccessURL ,
PathAppBaseURL : api . AccessURL ,
AppHostname : api . AppHostname ,
AppRequest : req ,
})
require . True ( t , ok )
2025-07-15 14:36:06 +10:00
assertConnLogContains ( t , rw , r , connLogger , workspace , agentName , app , database . ConnectionTypeWorkspaceApp , me . ID )
require . Len ( t , connLogger . ConnectionLogs (), 3 , "three connection logs, new IP" )
2025-03-18 13:50:52 +02:00
}
2023-03-31 00:24:51 +11:00
})
2023-03-08 06:38:11 +11:00
}
2025-03-18 13:50:52 +02:00
2025-07-15 14:36:06 +10:00
func workspaceappsResolveRequest ( t testing . TB , connLogger connectionlog . ConnectionLogger , w http . ResponseWriter , r * http . Request , opts workspaceapps . ResolveRequestOptions ) ( token * workspaceapps . SignedToken , ok bool ) {
2025-03-18 13:50:52 +02:00
t . Helper ()
2025-07-15 14:36:06 +10:00
if opts . SignedTokenProvider != nil && connLogger != nil {
opts . SignedTokenProvider = signedTokenProviderWithConnLogger ( t , opts . SignedTokenProvider , connLogger , time . Hour )
2025-03-18 13:50:52 +02:00
}
tracing . StatusWriterMiddleware ( http . HandlerFunc ( func ( w http . ResponseWriter , r * http . Request ) {
httpmw . AttachRequestID ( http . HandlerFunc ( func ( w http . ResponseWriter , r * http . Request ) {
token , ok = workspaceapps . ResolveRequest ( w , r , opts )
})). ServeHTTP ( w , r )
})). ServeHTTP ( w , r )
return token , ok
}
2025-07-15 14:36:06 +10:00
func signedTokenProviderWithConnLogger ( t testing . TB , provider workspaceapps . SignedTokenProvider , connLogger connectionlog . ConnectionLogger , sessionTimeout time . Duration ) workspaceapps . SignedTokenProvider {
2025-03-18 13:50:52 +02:00
t . Helper ()
p , ok := provider .( * workspaceapps . DBTokenProvider )
require . True ( t , ok , "provider is not a DBTokenProvider" )
shallowCopy := * p
2025-07-15 14:36:06 +10:00
shallowCopy . ConnectionLogger = & atomic . Pointer [ connectionlog . ConnectionLogger ]{}
shallowCopy . ConnectionLogger . Store ( & connLogger )
2025-03-18 13:50:52 +02:00
shallowCopy . WorkspaceAppAuditSessionTimeout = sessionTimeout
return & shallowCopy
}
2025-07-15 14:36:06 +10:00
func assertConnLogContains ( t * testing . T , rr * httptest . ResponseRecorder , r * http . Request , connLogger * connectionlog . FakeConnectionLogger , workspace codersdk . Workspace , agentName string , slugOrPort string , typ database . ConnectionType , userID uuid . UUID ) {
t . Helper ()
2025-03-18 13:50:52 +02:00
2025-07-15 14:36:06 +10:00
resp := rr . Result ()
defer resp . Body . Close ()
2025-03-18 13:50:52 +02:00
2025-07-15 14:36:06 +10:00
require . True ( t , connLogger . Contains ( t , database . UpsertConnectionLogParams {
OrganizationID : workspace . OrganizationID ,
WorkspaceOwnerID : workspace . OwnerID ,
WorkspaceID : workspace . ID ,
WorkspaceName : workspace . Name ,
AgentName : agentName ,
Type : typ ,
Ip : database . ParseIP ( r . RemoteAddr ),
UserAgent : sql . NullString { Valid : r . UserAgent () != "" , String : r . UserAgent ()},
Code : sql . NullInt32 {
Int32 : int32 ( resp . StatusCode ), // nolint:gosec
Valid : true ,
},
UserID : uuid . NullUUID {
UUID : userID ,
Valid : true ,
},
SlugOrPort : sql . NullString { Valid : slugOrPort != "" , String : slugOrPort },
}))
2025-03-18 13:50:52 +02:00
}