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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
|
package bundle
import (
"encoding/json"
"fmt"
"io"
"os"
"path"
"path/filepath"
"regexp"
"strconv"
"strings"
"time"
"github.com/Masterminds/semver/v3"
"github.com/crc-org/crc/v2/pkg/crc/constants"
"github.com/crc-org/crc/v2/pkg/crc/gpg"
"github.com/crc-org/crc/v2/pkg/crc/image"
"github.com/crc-org/crc/v2/pkg/crc/logging"
crcPreset "github.com/crc-org/crc/v2/pkg/crc/preset"
"github.com/crc-org/crc/v2/pkg/download"
)
// Metadata structure to unmarshal the crc-bundle-info.json file
type CrcBundleInfo struct {
Version string `json:"version"`
Type string `json:"type"`
Name string `json:"name"`
BuildInfo BuildInfo `json:"buildInfo"`
ClusterInfo ClusterInfo `json:"clusterInfo"`
Nodes []Node `json:"nodes"`
Storage Storage `json:"storage"`
DriverInfo DriverInfo `json:"driverInfo"`
cachedPath string
}
type BuildInfo struct {
BuildTime string `json:"buildTime"`
OpenshiftInstallerVersion string `json:"openshiftInstallerVersion"`
SncVersion string `json:"sncVersion"`
}
type ClusterInfo struct {
OpenShiftVersion *semver.Version `json:"openshiftVersion"`
ClusterName string `json:"clusterName"`
BaseDomain string `json:"baseDomain"`
AppsDomain string `json:"appsDomain"`
SSHPrivateKeyFile string `json:"sshPrivateKeyFile"`
KubeConfig string `json:"kubeConfig"`
OpenshiftPullSecret string `json:"openshiftPullSecret,omitempty"`
}
type Node struct {
Kind []string `json:"kind"`
Hostname string `json:"hostname"`
DiskImage string `json:"diskImage"`
KernelCmdLine string `json:"kernelCmdLine,omitempty"`
Initramfs string `json:"initramfs,omitempty"`
Kernel string `json:"kernel,omitempty"`
InternalIP string `json:"internalIP"`
PodmanVersion string `json:"podmanVersion,omitempty"`
}
type Storage struct {
DiskImages []DiskImage `json:"diskImages"`
Files []FileListItem `json:"fileList"`
}
type File struct {
Name string `json:"name"`
Size string `json:"size"`
Checksum string `json:"sha256sum"`
}
type DiskImage struct {
File
Format string `json:"format"`
}
type FileType string
const (
OcExecutable FileType = "oc-executable"
PodmanExecutable FileType = "podman-executable"
)
type FileListItem struct {
File
Type FileType `json:"type"`
}
type DriverInfo struct {
Name string `json:"name"`
}
func (bundle *CrcBundleInfo) resolvePath(filename string) string {
return filepath.Join(bundle.cachedPath, filename)
}
func (bundle *CrcBundleInfo) GetBundleName() string {
return bundle.Name
}
func (bundle *CrcBundleInfo) GetAPIHostname() string {
return fmt.Sprintf("api.%s.%s", bundle.ClusterInfo.ClusterName, bundle.ClusterInfo.BaseDomain)
}
func (bundle *CrcBundleInfo) GetAppHostname(appName string) string {
return fmt.Sprintf("%s.%s", appName, bundle.ClusterInfo.AppsDomain)
}
func (bundle *CrcBundleInfo) GetDiskImagePath() string {
return bundle.resolvePath(bundle.Storage.DiskImages[0].Name)
}
func (bundle *CrcBundleInfo) GetDiskImageFormat() string {
return bundle.Storage.DiskImages[0].Format
}
func (bundle *CrcBundleInfo) GetKubeConfigPath() string {
return bundle.resolvePath(bundle.ClusterInfo.KubeConfig)
}
func (bundle *CrcBundleInfo) getHelperPath(fileType FileType) string {
for _, file := range bundle.Storage.Files {
if file.Type == fileType {
return bundle.resolvePath(file.Name)
}
}
return ""
}
func (bundle *CrcBundleInfo) GetOcPath() string {
return bundle.getHelperPath(OcExecutable)
}
func (bundle *CrcBundleInfo) GetPodmanPath() string {
return bundle.getHelperPath(PodmanExecutable)
}
func (bundle *CrcBundleInfo) GetSSHKeyPath() string {
return bundle.resolvePath(bundle.ClusterInfo.SSHPrivateKeyFile)
}
func (bundle *CrcBundleInfo) GetKernelPath() string {
if bundle.Nodes[0].Kernel == "" {
return ""
}
return bundle.resolvePath(bundle.Nodes[0].Kernel)
}
func (bundle *CrcBundleInfo) GetInitramfsPath() string {
if bundle.Nodes[0].Initramfs == "" {
return ""
}
return bundle.resolvePath(bundle.Nodes[0].Initramfs)
}
func (bundle *CrcBundleInfo) GetKernelCommandLine() string {
return bundle.Nodes[0].KernelCmdLine
}
func (bundle *CrcBundleInfo) GetBundleBuildTime() (time.Time, error) {
return time.Parse(time.RFC3339, strings.TrimSpace(bundle.BuildInfo.BuildTime))
}
func (bundle *CrcBundleInfo) GetOpenshiftVersion() string {
return bundle.ClusterInfo.OpenShiftVersion.String()
}
func (bundle *CrcBundleInfo) GetPodmanVersion() string {
return bundle.Nodes[0].PodmanVersion
}
func (bundle *CrcBundleInfo) GetVersion() string {
switch bundle.GetBundleType() {
case crcPreset.Podman:
return bundle.GetPodmanVersion()
default:
return bundle.GetOpenshiftVersion()
}
}
func (bundle *CrcBundleInfo) GetBundleNameWithoutExtension() string {
return GetBundleNameWithoutExtension(bundle.GetBundleName())
}
func (bundle *CrcBundleInfo) GetBundleType() crcPreset.Preset {
bundleType := strings.TrimSuffix(bundle.Type, "_custom")
if bundleType == "snc" {
bundleType = "openshift"
}
return crcPreset.ParsePreset(bundleType)
}
func (bundle *CrcBundleInfo) IsOpenShift() bool {
preset := bundle.GetBundleType()
return preset == crcPreset.OpenShift || preset == crcPreset.OKD
}
func (bundle *CrcBundleInfo) IsMicroshift() bool {
return bundle.GetBundleType() == crcPreset.Microshift
}
func (bundle *CrcBundleInfo) IsPodman() bool {
return bundle.GetBundleType() == crcPreset.Podman
}
func (bundle *CrcBundleInfo) verify() error {
files := []string{
bundle.GetSSHKeyPath(),
bundle.GetDiskImagePath(),
bundle.GetKernelPath(),
bundle.GetInitramfsPath(),
}
if !bundle.IsPodman() {
files = append(files, []string{
bundle.GetOcPath(),
bundle.GetKubeConfigPath()}...)
}
for _, file := range files {
if file == "" {
continue
}
if _, err := os.Stat(file); err != nil {
if os.IsNotExist(err) {
return fmt.Errorf("%s not found in bundle", filepath.Base(file))
}
return err
}
}
return bundle.checkDiskImageSize()
}
func (bundle *CrcBundleInfo) checkDiskImageSize() error {
diskImagePath := bundle.GetDiskImagePath()
expectedSize, err := strconv.ParseInt(bundle.Storage.DiskImages[0].Size, 10, 64)
if err != nil {
return err
}
stat, err := os.Stat(diskImagePath)
if err != nil {
return err
}
gotSize := stat.Size()
if expectedSize != gotSize {
return fmt.Errorf("unexpected disk image size: got %d instead of %d", gotSize, expectedSize)
}
return nil
}
func GetBundleNameWithoutExtension(bundleName string) string {
return strings.TrimSuffix(bundleName, bundleExtension)
}
func GetBundleNameWithExtension(bundleName string) string {
if strings.HasSuffix(bundleName, bundleExtension) {
return bundleName
}
return fmt.Sprintf("%s%s", bundleName, bundleExtension)
}
func GetCustomBundleName(bundleFilename string) string {
re := regexp.MustCompile(`(?:_[0-9]+)*.crcbundle$`)
baseName := re.ReplaceAllLiteralString(bundleFilename, "")
return fmt.Sprintf("%s_%d%s", baseName, time.Now().Unix(), bundleExtension)
}
func GetBundleNameFromURI(bundleURI string) string {
// the URI is expected to have been validated by validation.ValidateBundlePath first
switch {
case strings.HasPrefix(bundleURI, "docker://"):
imageAndTag := strings.Split(path.Base(bundleURI), ":")
return constants.BundleForPreset(image.GetPresetName(imageAndTag[0]), imageAndTag[1])
case strings.HasPrefix(bundleURI, "http://"), strings.HasPrefix(bundleURI, "https://"):
return path.Base(bundleURI)
default:
// local path
return filepath.Base(bundleURI)
}
}
func getBundleDownloadInfo(preset crcPreset.Preset) (*download.RemoteFile, error) {
sha256sum, err := getDefaultBundleVerifiedHash(preset)
if err != nil {
return nil, fmt.Errorf("unable to get verified hash for default bundle: %w", err)
}
downloadInfo := download.NewRemoteFile(constants.GetDefaultBundleDownloadURL(preset), sha256sum)
return downloadInfo, nil
}
// getDefaultBundleVerifiedHash downloads the sha256sum.txt.sig file from mirror.openshift.com
// then verifies it is signed by redhat release key, if signature is valid it returns the hash
// for the default bundle of preset from the file
func getDefaultBundleVerifiedHash(preset crcPreset.Preset) (string, error) {
return getVerifiedHash(constants.GetDefaultBundleSignedHashURL(preset), constants.GetDefaultBundle(preset))
}
func getVerifiedHash(url string, file string) (string, error) {
res, err := download.InMemory(url)
if err != nil {
return "", err
}
defer res.Close()
signedHashes, err := io.ReadAll(res)
if err != nil {
return "", err
}
verifiedHashes, err := gpg.GetVerifiedClearsignedMsgV3(constants.RedHatReleaseKey, string(signedHashes))
if err != nil {
return "", fmt.Errorf("Invalid signature: %w", err)
}
logging.Debugf("Verified bundle hashes:\n%s", verifiedHashes)
lines := strings.Split(verifiedHashes, "\n")
for _, line := range lines {
if strings.HasSuffix(line, file) {
sha256sum := strings.TrimSuffix(line, " "+file)
return sha256sum, nil
}
}
return "", fmt.Errorf("%s hash is missing or shasums are malformed", file)
}
func downloadDefault(preset crcPreset.Preset) (string, error) {
downloadInfo, err := getBundleDownloadInfo(preset)
if err != nil {
return "", err
}
return downloadInfo.Download(constants.GetDefaultBundlePath(preset), 0664)
}
func Download(preset crcPreset.Preset, bundleURI string, enableBundleQuayFallback bool) (string, error) {
// If we are asked to download
// ~/.crc/cache/crc_podman_libvirt_4.1.1.crcbundle, this means we want
// are downloading the default bundle for this release. This uses a
// different codepath from user-specified URIs as for the default
// bundles, their sha256sums are known and can be checked.
if bundleURI == constants.GetDefaultBundlePath(preset) {
switch preset {
case crcPreset.OpenShift, crcPreset.Microshift:
downloadedBundlePath, err := downloadDefault(preset)
if err != nil && enableBundleQuayFallback {
logging.Info("Unable to download bundle from mirror, falling back to quay")
return image.PullBundle(constants.GetDefaultBundleImageRegistry(preset))
}
return downloadedBundlePath, err
case crcPreset.Podman, crcPreset.OKD:
fallthrough
default:
return image.PullBundle(constants.GetDefaultBundleImageRegistry(preset))
}
}
switch {
case strings.HasPrefix(bundleURI, "http://"), strings.HasPrefix(bundleURI, "https://"):
return download.Download(bundleURI, constants.MachineCacheDir, 0644, nil)
case strings.HasPrefix(bundleURI, "docker://"):
return image.PullBundle(bundleURI)
}
// the `bundleURI` parameter turned out to be a local path
return bundleURI, nil
}
type Version struct {
CrcVersion *semver.Version `json:"crcVersion"`
GitSha string `json:"gitSha"`
OpenshiftVersion string `json:"openshiftVersion"`
}
type ReleaseInfo struct {
Version Version `json:"version"`
Links map[string]string `json:"links"`
}
func FetchLatestReleaseInfo() (*ReleaseInfo, error) {
const releaseInfoLink = "https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/crc/latest/release-info.json"
response, err := download.InMemory(releaseInfoLink)
if err != nil {
return nil, err
}
defer response.Close()
releaseMetaData, err := io.ReadAll(response)
if err != nil {
return nil, err
}
var releaseInfo ReleaseInfo
if err := json.Unmarshal(releaseMetaData, &releaseInfo); err != nil {
return nil, fmt.Errorf("Error unmarshaling JSON metadata: %v", err)
}
return &releaseInfo, nil
}
|