Skip to content
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.

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

Make k8s get-join-token $hostname optional #452

Merged
merged 3 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 5 additions & 2 deletions src/k8s/cmd/k8s/k8s_get_join_token.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,30 @@
Use: "get-join-token <node-name>",
Short: "Create a token for a node to join the cluster",
PreRun: chainPreRunHooks(hookRequireRoot(env)),
Args: cmdutil.ExactArgs(env, 1),
Args: cmdutil.MaximumNArgs(env, 1),
Run: func(cmd *cobra.Command, args []string) {
name := args[0]
var name string
if len(args) == 1 {
name = args[0]
}

if opts.timeout < minTimeout {
cmd.PrintErrf("Timeout %v is less than minimum of %v. Using the minimum %v instead.\n", opts.timeout, minTimeout, minTimeout)

Check failure on line 29 in src/k8s/cmd/k8s/k8s_get_join_token.go

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

src/k8s/cmd/k8s/k8s_get_join_token.go:29:81 MD013/line-length Line length [Expected: 80; Actual: 129] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
opts.timeout = minTimeout
}

client, err := env.Client(cmd.Context())
if err != nil {
cmd.PrintErrf("Error: Failed to create a k8sd client. Make sure that the k8sd service is running.\n\nThe error was: %v\n", err)

Check failure on line 35 in src/k8s/cmd/k8s/k8s_get_join_token.go

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

src/k8s/cmd/k8s/k8s_get_join_token.go:35:81 MD013/line-length Line length [Expected: 80; Actual: 131] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
env.Exit(1)
return
}

ctx, cancel := context.WithTimeout(cmd.Context(), opts.timeout)
cobra.OnFinalize(cancel)
token, err := client.GetJoinToken(ctx, apiv1.GetJoinTokenRequest{Name: name, Worker: opts.worker})

Check failure on line 42 in src/k8s/cmd/k8s/k8s_get_join_token.go

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

src/k8s/cmd/k8s/k8s_get_join_token.go:42:81 MD013/line-length Line length [Expected: 80; Actual: 101] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
if err != nil {
cmd.PrintErrf("Error: Could not generate a join token for %q.\n\nThe error was: %v\n", name, err)

Check failure on line 44 in src/k8s/cmd/k8s/k8s_get_join_token.go

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

src/k8s/cmd/k8s/k8s_get_join_token.go:44:81 MD013/line-length Line length [Expected: 80; Actual: 101] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
env.Exit(1)
return
}
Expand All @@ -47,7 +50,7 @@
},
}

cmd.Flags().BoolVar(&opts.worker, "worker", false, "generate a join token for a worker node")

Check failure on line 53 in src/k8s/cmd/k8s/k8s_get_join_token.go

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

src/k8s/cmd/k8s/k8s_get_join_token.go:53:81 MD013/line-length Line length [Expected: 80; Actual: 94] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
cmd.Flags().DurationVar(&opts.timeout, "timeout", 90*time.Second, "the max time to wait for the command to execute")

Check failure on line 54 in src/k8s/cmd/k8s/k8s_get_join_token.go

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

src/k8s/cmd/k8s/k8s_get_join_token.go:54:81 MD013/line-length Line length [Expected: 80; Actual: 117] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
return cmd
}
3 changes: 2 additions & 1 deletion src/k8s/pkg/k8sd/api/worker.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,9 @@ func (e *Endpoints) postWorkerInfo(s *state.State, r *http.Request) response.Res
return response.InternalError(fmt.Errorf("add worker node transaction failed: %w", err))
}

workerToken := r.Header.Get("worker-token")
if err := s.Database.Transaction(s.Context, func(ctx context.Context, tx *sql.Tx) error {
return database.DeleteWorkerNodeToken(ctx, tx, workerName)
return database.DeleteWorkerNodeToken(ctx, tx, workerToken)
}); err != nil {
return response.InternalError(fmt.Errorf("delete worker node token transaction failed: %w", err))
}
Expand Down
1 change: 1 addition & 0 deletions src/k8s/pkg/k8sd/database/schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ var (
schemaApplyMigration("kubernetes-auth-tokens", "000-create.sql"),
schemaApplyMigration("cluster-configs", "000-create.sql"),
schemaApplyMigration("worker-nodes", "000-create.sql"),
schemaApplyMigration("worker-tokens", "000-create.sql"),
}

//go:embed sql/migrations
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
CREATE TABLE worker_tokens (
id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
name TEXT NOT NULL,
token TEXT NOT NULL
)

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
DELETE FROM
worker_tokens AS t
WHERE
t.token = ?
neoaggelos marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
INSERT INTO
neoaggelos marked this conversation as resolved.
Show resolved Hide resolved
worker_tokens(name, token)
VALUES
( ?, ? )
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
SELECT
t.name
FROM
worker_tokens AS t
WHERE
( t.token = ? )
LIMIT 1
27 changes: 9 additions & 18 deletions src/k8s/pkg/k8sd/database/worker.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ var (
"select-by-name": MustPrepareStatement("worker-nodes", "select-by-name.sql"),
"delete-node": MustPrepareStatement("worker-nodes", "delete.sql"),

"insert-token": MustPrepareStatement("cluster-configs", "insert-worker-token.sql"),
"select-token": MustPrepareStatement("cluster-configs", "select-worker-token.sql"),
"delete-token": MustPrepareStatement("cluster-configs", "delete-worker-token.sql"),
"insert-token": MustPrepareStatement("worker-tokens", "insert.sql"),
"select-token": MustPrepareStatement("worker-tokens", "select.sql"),
"delete-token": MustPrepareStatement("worker-tokens", "delete-by-token.sql"),
}
)

Expand All @@ -30,36 +30,27 @@ func CheckWorkerNodeToken(ctx context.Context, tx *sql.Tx, nodeName string, toke
if err != nil {
return false, fmt.Errorf("failed to prepare select statement: %w", err)
}
var realToken string
if selectTxStmt.QueryRowContext(ctx, nodeName).Scan(&realToken) == nil {
return subtle.ConstantTimeCompare([]byte(token), []byte(realToken)) == 1, nil
var tokenNodeName string
if selectTxStmt.QueryRowContext(ctx, token).Scan(&tokenNodeName) == nil {
return tokenNodeName == "" || subtle.ConstantTimeCompare([]byte(nodeName), []byte(tokenNodeName)) == 1, nil
}
return false, nil
}

// GetOrCreateWorkerNodeToken returns a token that can be used to join a worker node on the cluster.
// GetOrCreateWorkerNodeToken will return the existing token, if one already exists for the node.
func GetOrCreateWorkerNodeToken(ctx context.Context, tx *sql.Tx, nodeName string) (string, error) {
selectTxStmt, err := cluster.Stmt(tx, workerStmts["select-token"])
insertTxStmt, err := cluster.Stmt(tx, workerStmts["insert-token"])
if err != nil {
return "", fmt.Errorf("failed to prepare select statement: %w", err)
}
var token string
if selectTxStmt.QueryRowContext(ctx, fmt.Sprintf("worker-token::%s", nodeName)).Scan(&token) == nil {
return token, nil
return "", fmt.Errorf("failed to prepare insert statement: %w", err)
}

// generate random bytes for the token
b := make([]byte, 20)
if _, err := rand.Read(b); err != nil {
return "", fmt.Errorf("is the system entropy low? failed to get random bytes: %w", err)
}
token = fmt.Sprintf("worker::%s", hex.EncodeToString(b))

insertTxStmt, err := cluster.Stmt(tx, workerStmts["insert-token"])
if err != nil {
return "", fmt.Errorf("failed to prepare insert statement: %w", err)
}
token := fmt.Sprintf("worker::%s", hex.EncodeToString(b))
if _, err := insertTxStmt.ExecContext(ctx, nodeName, token); err != nil {
return "", fmt.Errorf("insert token query failed: %w", err)
}
Expand Down
96 changes: 57 additions & 39 deletions src/k8s/pkg/k8sd/database/worker_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,47 +11,65 @@ import (

func TestWorkerNodeToken(t *testing.T) {
WithDB(t, func(ctx context.Context, db DB) {
g := NewWithT(t)
err := db.Transaction(ctx, func(ctx context.Context, tx *sql.Tx) error {
exists, err := database.CheckWorkerNodeToken(ctx, tx, "somenode", "sometoken")
g.Expect(err).To(BeNil())
g.Expect(exists).To(BeFalse())

token, err := database.GetOrCreateWorkerNodeToken(ctx, tx, "somenode")
g.Expect(err).To(BeNil())
g.Expect(token).To(HaveLen(48))

othertoken, err := database.GetOrCreateWorkerNodeToken(ctx, tx, "someothernode")
g.Expect(err).To(BeNil())
g.Expect(othertoken).To(HaveLen(48))
g.Expect(othertoken).NotTo(Equal(token))

valid, err := database.CheckWorkerNodeToken(ctx, tx, "somenode", token)
g.Expect(err).To(BeNil())
g.Expect(valid).To(BeTrue())

valid, err = database.CheckWorkerNodeToken(ctx, tx, "someothernode", token)
g.Expect(err).To(BeNil())
g.Expect(valid).To(BeFalse())

valid, err = database.CheckWorkerNodeToken(ctx, tx, "someothernode", othertoken)
g.Expect(err).To(BeNil())
g.Expect(valid).To(BeTrue())

err = database.DeleteWorkerNodeToken(ctx, tx, "somenode")
g.Expect(err).To(BeNil())

valid, err = database.CheckWorkerNodeToken(ctx, tx, "somenode", token)
g.Expect(err).To(BeNil())
g.Expect(valid).To(BeFalse())

newToken, err := database.GetOrCreateWorkerNodeToken(ctx, tx, "somenode")
g.Expect(err).To(BeNil())
g.Expect(newToken).To(HaveLen(48))
g.Expect(newToken).ToNot(Equal(token))
_ = db.Transaction(ctx, func(ctx context.Context, tx *sql.Tx) error {
t.Run("Default", func(t *testing.T) {
g := NewWithT(t)
exists, err := database.CheckWorkerNodeToken(ctx, tx, "somenode", "sometoken")
g.Expect(err).To(BeNil())
g.Expect(exists).To(BeFalse())

token, err := database.GetOrCreateWorkerNodeToken(ctx, tx, "somenode")
g.Expect(err).To(BeNil())
g.Expect(token).To(HaveLen(48))

othertoken, err := database.GetOrCreateWorkerNodeToken(ctx, tx, "someothernode")
g.Expect(err).To(BeNil())
g.Expect(othertoken).To(HaveLen(48))
g.Expect(othertoken).NotTo(Equal(token))

valid, err := database.CheckWorkerNodeToken(ctx, tx, "somenode", token)
g.Expect(err).To(BeNil())
g.Expect(valid).To(BeTrue())

valid, err = database.CheckWorkerNodeToken(ctx, tx, "someothernode", token)
g.Expect(err).To(BeNil())
g.Expect(valid).To(BeFalse())

valid, err = database.CheckWorkerNodeToken(ctx, tx, "someothernode", othertoken)
g.Expect(err).To(BeNil())
g.Expect(valid).To(BeTrue())

err = database.DeleteWorkerNodeToken(ctx, tx, token)
g.Expect(err).To(BeNil())

valid, err = database.CheckWorkerNodeToken(ctx, tx, "somenode", token)
g.Expect(err).To(BeNil())
g.Expect(valid).To(BeFalse())

newToken, err := database.GetOrCreateWorkerNodeToken(ctx, tx, "somenode")
g.Expect(err).To(BeNil())
g.Expect(newToken).To(HaveLen(48))
g.Expect(newToken).ToNot(Equal(token))
})

t.Run("AnyNodeName", func(t *testing.T) {
g := NewWithT(t)
token, err := database.GetOrCreateWorkerNodeToken(ctx, tx, "")
g.Expect(err).To(BeNil())
g.Expect(token).To(HaveLen(48))

for _, name := range []string{"", "test", "other"} {
t.Run(name, func(t *testing.T) {
g := NewWithT(t)

valid, err := database.CheckWorkerNodeToken(ctx, tx, name, token)
g.Expect(err).To(BeNil())
g.Expect(valid).To(BeTrue())
})
}
})
return nil
})
g.Expect(err).To(BeNil())
})
}

Expand Down
Loading