File: ssh_keygen.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 (143 lines) | stat: -rw-r--r-- 3,873 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
// 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"
	"crypto/rsa"
	"crypto/x509"
	"encoding/pem"
	"fmt"
	"os"
	"path/filepath"

	"github.com/pingcap/errors"
	"github.com/pingcap/tiup/pkg/cluster/ctxt"
	"github.com/pingcap/tiup/pkg/crypto/rand"
	"github.com/pingcap/tiup/pkg/utils"
	"golang.org/x/crypto/ssh"
)

// SSHKeyGen is used to generate SSH key
type SSHKeyGen struct {
	keypath string
}

// Execute implements the Task interface
func (s *SSHKeyGen) Execute(ctx context.Context) error {
	ctxt.GetInner(ctx).Ev.PublishTaskProgress(s, "Generate SSH keys")

	savePrivateFileTo := s.keypath
	savePublicFileTo := s.keypath + ".pub"

	// Skip ssh key generate
	if utils.IsExist(savePrivateFileTo) && utils.IsExist(savePublicFileTo) {
		ctxt.GetInner(ctx).PublicKeyPath = savePublicFileTo
		ctxt.GetInner(ctx).PrivateKeyPath = savePrivateFileTo
		return nil
	}

	bitSize := 4096

	ctxt.GetInner(ctx).Ev.PublishTaskProgress(s, "Generate private key")
	privateKey, err := s.generatePrivateKey(bitSize)
	if err != nil {
		return errors.Trace(err)
	}

	ctxt.GetInner(ctx).Ev.PublishTaskProgress(s, "Generate public key")
	publicKeyBytes, err := s.generatePublicKey(&privateKey.PublicKey)
	if err != nil {
		return errors.Trace(err)
	}

	privateKeyBytes := s.encodePrivateKeyToPEM(privateKey)

	ctxt.GetInner(ctx).Ev.PublishTaskProgress(s, "Persist keys")
	err = s.writeKeyToFile(privateKeyBytes, savePrivateFileTo)
	if err != nil {
		return errors.Trace(err)
	}

	err = s.writeKeyToFile(publicKeyBytes, savePublicFileTo)
	if err != nil {
		return errors.Trace(err)
	}

	ctxt.GetInner(ctx).PublicKeyPath = savePublicFileTo
	ctxt.GetInner(ctx).PrivateKeyPath = savePrivateFileTo
	return nil
}

// generatePrivateKey creates a RSA Private Key of specified byte size
func (s *SSHKeyGen) generatePrivateKey(bitSize int) (*rsa.PrivateKey, error) {
	// Private Key generation
	privateKey, err := rsa.GenerateKey(rand.Reader, bitSize)
	if err != nil {
		return nil, err
	}

	// Validate Private Key
	err = privateKey.Validate()
	if err != nil {
		return nil, err
	}

	return privateKey, nil
}

// encodePrivateKeyToPEM encodes Private Key from RSA to PEM format
func (s *SSHKeyGen) encodePrivateKeyToPEM(privateKey *rsa.PrivateKey) []byte {
	// Get ASN.1 DER format
	privDER := x509.MarshalPKCS1PrivateKey(privateKey)

	// pem.Block
	privBlock := pem.Block{
		Type:    "RSA PRIVATE KEY",
		Headers: nil,
		Bytes:   privDER,
	}

	// Private key in PEM format
	return pem.EncodeToMemory(&privBlock)
}

// generatePublicKey take a rsa.PublicKey and return bytes suitable for writing to .pub file
// returns in the format "ssh-rsa ..."
func (s *SSHKeyGen) generatePublicKey(privatekey *rsa.PublicKey) ([]byte, error) {
	publicRsaKey, err := ssh.NewPublicKey(privatekey)
	if err != nil {
		return nil, err
	}

	return ssh.MarshalAuthorizedKey(publicRsaKey), nil
}

// writePemToFile writes keys to a file
func (s *SSHKeyGen) writeKeyToFile(keyBytes []byte, saveFileTo string) error {
	if err := os.MkdirAll(filepath.Dir(saveFileTo), 0700); err != nil {
		return err
	}
	return os.WriteFile(saveFileTo, keyBytes, 0600)
}

// Rollback implements the Task interface
func (s *SSHKeyGen) Rollback(ctx context.Context) error {
	return os.Remove(s.keypath)
}

// String implements the fmt.Stringer interface
func (s *SSHKeyGen) String() string {
	return fmt.Sprintf("SSHKeyGen: path=%s", s.keypath)
}