Skip to content

feat: add session token injection to provisioner #7461

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
merged 12 commits into from
May 18, 2023
Merged

feat: add session token injection to provisioner #7461

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
478001a
feat: add session token to provisioner
sreya May 9, 2023
49fb3b5
add test
sreya May 9, 2023
8b52ca5
fix perms
sreya May 9, 2023
b49d18b
fix panic
sreya May 10, 2023
3ff4539
move api key generation to its own package
sreya May 10, 2023
01f7a5e
lint
sreya May 10, 2023
905cd1a
add apikey pkg test
sreya May 16, 2023
6ad169d
update provisionerd test
sreya May 16, 2023
bc6dec0
fix apikey test
sreya May 16, 2023
1d35967
pr comments
sreya May 17, 2023
4183989
rename proto field
sreya May 18, 2023
0bba543
stuff
sreya May 18, 2023
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
Prev Previous commit
Next Next commit
add apikey pkg test
  • Loading branch information
@sreya
sreya committed May 16, 2023
commit 905cd1afff7fac01161353c47b16cb057ca96770
163 changes: 163 additions & 0 deletions coderd/apikey/apikey_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
package apikey_test

import (
"crypto/sha256"
"strings"
"testing"
"time"

"github.com/google/uuid"
"github.com/stretchr/testify/require"

"github.com/coder/coder/cli/clibase"
"github.com/coder/coder/coderd/apikey"
"github.com/coder/coder/coderd/database"
"github.com/coder/coder/codersdk"
)

func TestGenerate(t *testing.T) {
t.Parallel()

type testcase struct {
name string
params apikey.CreateParams
fail bool
}

cases := []testcase{
{
name: "OK",
params: apikey.CreateParams{
UserID: uuid.New(),
LoginType: database.LoginTypeOIDC,
DeploymentValues: &codersdk.DeploymentValues{},
ExpiresAt: time.Now().Add(time.Hour),
LifetimeSeconds: int64(time.Hour.Seconds()),
TokenName: "hello",
RemoteAddr: "1.2.3.4",
Scope: database.APIKeyScopeApplicationConnect,
},
},
{
name: "InvalidScope",
params: apikey.CreateParams{
UserID: uuid.New(),
LoginType: database.LoginTypeOIDC,
DeploymentValues: &codersdk.DeploymentValues{},
ExpiresAt: time.Now().Add(time.Hour),
LifetimeSeconds: int64(time.Hour.Seconds()),
TokenName: "hello",
RemoteAddr: "1.2.3.4",
Scope: database.APIKeyScope("test"),
},
fail: true,
},
{
name: "DeploymentSessionDuration",
params: apikey.CreateParams{
UserID: uuid.New(),
LoginType: database.LoginTypeOIDC,
DeploymentValues: &codersdk.DeploymentValues{
SessionDuration: clibase.Duration(time.Hour),
},
LifetimeSeconds: 0,
ExpiresAt: time.Time{},
TokenName: "hello",
RemoteAddr: "1.2.3.4",
Scope: database.APIKeyScopeApplicationConnect,
},
},
{
name: "DefaultIP",
params: apikey.CreateParams{
UserID: uuid.New(),
LoginType: database.LoginTypeOIDC,
DeploymentValues: &codersdk.DeploymentValues{},
ExpiresAt: time.Now().Add(time.Hour),
LifetimeSeconds: int64(time.Hour.Seconds()),
TokenName: "hello",
RemoteAddr: "",
Scope: database.APIKeyScopeApplicationConnect,
},
},
{
name: "DefaultScope",
params: apikey.CreateParams{
UserID: uuid.New(),
LoginType: database.LoginTypeOIDC,
DeploymentValues: &codersdk.DeploymentValues{},
ExpiresAt: time.Now().Add(time.Hour),
LifetimeSeconds: int64(time.Hour.Seconds()),
TokenName: "hello",
RemoteAddr: "1.2.3.4",
Scope: database.APIKeyScopeApplicationConnect,
},
},
}

for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()

keystr, key, err := apikey.Generate(tc.params)
if tc.fail {
require.Error(t, err)
return
}
require.NoError(t, err)
require.NotEmpty(t, keystr)
require.NotEmpty(t, key.ID)
require.NotEmpty(t, key.HashedSecret)

// Assert the string secret is formatted correctly
keytokens := strings.Split(keystr, "-")
require.Len(t, keytokens, 2)
require.Equal(t, key.ID, keytokens[0])

// Assert that the hashed secret is correct.
hashed := sha256.Sum256([]byte(keytokens[1]))
require.ElementsMatch(t, hashed, key.HashedSecret[:])

require.Equal(t, tc.params.UserID, key.UserID)
require.WithinDuration(t, database.Now(), key.CreatedAt, time.Second*5)
require.WithinDuration(t, database.Now(), key.UpdatedAt, time.Second*5)

if tc.params.LifetimeSeconds > 0 {
require.Equal(t, tc.params.LifetimeSeconds, key.LifetimeSeconds)
} else if !tc.params.ExpiresAt.IsZero() {
// Should not be a delta greater than 5 seconds.
require.InDelta(t, time.Until(tc.params.ExpiresAt).Seconds(), key.LifetimeSeconds, 5)
} else {
require.Equal(t, int64(tc.params.DeploymentValues.SessionDuration.Value().Seconds()), key.LifetimeSeconds)
}

if !tc.params.ExpiresAt.IsZero() {
require.Equal(t, tc.params.ExpiresAt.UTC(), key.ExpiresAt)
} else if tc.params.LifetimeSeconds > 0 {
require.WithinDuration(t, database.Now().Add(time.Duration(tc.params.LifetimeSeconds)), key.ExpiresAt, time.Second*5)
} else {
require.WithinDuration(t, database.Now().Add(tc.params.DeploymentValues.SessionDuration.Value()), key.ExpiresAt, time.Second*5)
}

if tc.params.RemoteAddr != "" {
require.Equal(t, tc.params.RemoteAddr, key.IPAddress.IPNet.IP.String())
} else {
require.Equal(t, "0.0.0.0", key.IPAddress.IPNet.IP.String())
}

if tc.params.Scope != "" {
require.Equal(t, tc.params.Scope, key.Scope)
} else {
require.Equal(t, database.APIKeyScopeAll, key.Scope)
}

if tc.params.TokenName != "" {
require.Equal(t, tc.params.TokenName, key.TokenName)
}
if tc.params.LoginType != "" {
require.Equal(t, tc.params.LoginType, key.LoginType)
}
})
}
}