internal/exec/util/util.go - main - githubmirror/ignition

internal/exec/util/util.go
143 строки4 KB
Madhu Pillai
Support LUKS encryption using IBM CEX secure keys on s390x
13 май 2024, 19:25
13 май 2024, 19:25d078c9f
// Copyright 2015 CoreOS, 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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package util

import (
	"os"
	"path/filepath"

	"github.com/coreos/ignition/v2/internal/log"
	"github.com/coreos/ignition/v2/internal/resource"
	"github.com/coreos/ignition/v2/internal/state"
)

// Util encapsulates logging and destdir indirection for the util methods.
type Util struct {
	DestDir string // directory prefix to use in applying fs paths.
	Fetcher resource.Fetcher
	*log.Logger
	State *state.State
}

// SplitPath splits /a/b/c/d into [a, b, c, d]
// golang-- for making me write this

func SplitPath(p string) []string {
	dir, file := filepath.Split(p)
	if dir == "" || dir == "/" {
		return []string{file}
	}
	dir = filepath.Clean(dir)
	return append(SplitPath(dir), file)
}

// ResolveSymlink resolves the symlink path, respecting the u.DestDir root. If
// the path is not a symlink, returns "". Otherwise, returns an unprefixed path
// to the target.
func (u Util) ResolveSymlink(path string) (string, error) {
	prefixedPath := filepath.Join(u.DestDir, path)
	s, err := os.Lstat(prefixedPath)
	if err != nil || s.Mode()&os.ModeSymlink == 0 {
		return "", err
	}

	symlinkPath, err := os.Readlink(prefixedPath)
	if err != nil {
		return "", err
	}
	if !filepath.IsAbs(symlinkPath) {
		symlinkPath = filepath.Join(filepath.Dir(path), symlinkPath)
	}
	return filepath.Clean(symlinkPath), nil
}

// JoinPath returns a path into the context ala filepath.Join(d, args)
// It resolves symlinks as if they were rooted at u.DestDir. This means
// that the resulting path will always be under u.DestDir.
// The last element of the path is never followed.
func (u Util) JoinPath(path ...string) (string, error) {
	components := []string{}
	for _, tmp := range path {
		components = append(components, SplitPath(tmp)...)
	}
	last := components[len(components)-1]
	components = components[:len(components)-1]

	realpath := "/"
	for _, component := range components {
		tmp := filepath.Join(realpath, component)

		symlinkPath, err := u.ResolveSymlink(tmp)
		if err != nil && !os.IsNotExist(err) {
			return "", err
		} else if os.IsNotExist(err) || symlinkPath == "" {
			realpath = tmp
		} else {
			realpath = symlinkPath
		}
	}

	return filepath.Join(u.DestDir, realpath, last), nil
}

// NotateMkdirAll creates directories relative to the u.DestDir root,
// including any missing parents, and records the paths to any created
// directories in the State for future use.
func (u Util) NotateMkdirAll(path string, perm os.FileMode) error {
	destPath, err := u.JoinPath(path)
	if err != nil {
		return err
	}

	if exists, err := PathExists(filepath.Dir(destPath)); err != nil {
		return err
	} else if !exists {
		if err := u.NotateMkdirAll(filepath.Dir(path), perm); err != nil {
			return err
		}
	}

	if exists, err := PathExists(destPath); err != nil {
		return err
	} else if !exists {
		if err := os.Mkdir(destPath, perm); err != nil {
			return err
		}
		u.State.NotatedDirectories = append(u.State.NotatedDirectories, path)
	}

	return nil
}

// PathExists checks if the path exists for a given config.
func PathExists(path string) (bool, error) {
	if _, err := os.Stat(path); err != nil {
		if !os.IsNotExist(err) {
			return false, err
		}
		return false, nil
	}
	return true, nil
}

// Helper function to concatenate the key files.
func ZkeySecureKeyRepoFiles(l string) map[string]string {
	ret := make(map[string]string)
	zfprefix := "ignition-luks-" + l
	for _, zext := range []string{".info", ".skey"} {
		ret[zext] = zfprefix + zext
	}
	return ret
}