File: rotate_ssh.go

package info (click to toggle)
tiup 1.16.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,384 kB
  • sloc: sh: 1,988; makefile: 138; sql: 16
file content (92 lines) | stat: -rw-r--r-- 2,534 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// Copyright 2020 PingCAP, 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,
// See the License for the specific language governing permissions and
// limitations under the License.

package task

import (
	"context"
	"fmt"
	"os"
	"strings"

	"github.com/joomcode/errorx"
	"github.com/pingcap/tiup/pkg/cluster/ctxt"
	"github.com/pingcap/tiup/pkg/cluster/executor"
)

// RotateSSH is used to rotate ssh key, e.g:
// 1. enable new public key
// 2. revoke old public key
type RotateSSH struct {
	host             string
	deployUser       string
	newPublicKeyPath string
}

// Execute implements the Task interface
func (e *RotateSSH) Execute(ctx context.Context) error {
	return e.exec(ctx)
}

func (e *RotateSSH) exec(ctx context.Context) error {
	wrapError := func(err error) *errorx.Error {
		return ErrEnvInitFailed.Wrap(err, "Failed to Rotate ssh public key on remote host '%s'", e.host)
	}

	exec, found := ctxt.GetInner(ctx).GetExecutor(e.host)
	if !found {
		panic(ErrNoExecutor)
	}

	pubKey, err := os.ReadFile(ctxt.GetInner(ctx).PublicKeyPath)
	if err != nil {
		return wrapError(err)
	}

	newPubKey, err := os.ReadFile(e.newPublicKeyPath)
	if err != nil {
		return wrapError(err)
	}

	sshAuthorizedKeys := executor.FindSSHAuthorizedKeysFile(ctx, exec)

	// enable new key
	cmd := fmt.Sprintf(`echo %s >> %s`, strings.TrimSpace(string(newPubKey)), sshAuthorizedKeys)
	_, _, err = exec.Execute(ctx, cmd, false)
	if err != nil {
		return wrapError(errEnvInitSubCommandFailed.
			Wrap(err, "Failed to write new public key to '%s' for user '%s'", sshAuthorizedKeys, e.deployUser))
	}

	// Revoke old key
	cmd = fmt.Sprintf(`sed -i '\|%[1]s|d' %[2]s`,
		strings.TrimSpace(string(pubKey)), sshAuthorizedKeys)

	_, _, err = exec.Execute(ctx, cmd, false)
	if err != nil {
		return wrapError(errEnvInitSubCommandFailed.
			Wrap(err, "Failed to revoke old key for user '%s'", e.deployUser))
	}

	return nil
}

// Rollback implements the Task interface
func (e *RotateSSH) Rollback(ctx context.Context) error {
	return ErrUnsupportedRollback
}

// String implements the fmt.Stringer interface
func (e *RotateSSH) String() string {
	return fmt.Sprintf("RotateSSH: user=%s, host=%s", e.deployUser, e.host)
}