File: sysparams.go

package info (click to toggle)
snapd 2.72-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 80,412 kB
  • sloc: sh: 16,506; ansic: 16,211; python: 11,213; makefile: 1,919; exp: 190; awk: 58; xml: 22
file content (123 lines) | stat: -rw-r--r-- 3,348 bytes parent folder | download | duplicates (3)
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
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2023 Canonical Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package sysparams

import (
	"bufio"
	"fmt"
	"os"
	"strings"

	"github.com/snapcore/snapd/dirs"
	"github.com/snapcore/snapd/osutil"
)

// For mocking in tests
var (
	osutilAtomicWriteFile = osutil.AtomicWriteFile
)

// SystemParams manages certain system configuration parameters
// aspects like the homedirs configuration that must be available
// for other binaries, as snap-confine.
type SystemParams struct {
	// rootdir is stored to allow for updating the same
	// system-params file.
	rootdir string
	// Homedirs is the comma-delimited list of user specified home
	// directories that should be mounted.
	Homedirs string
}

func parseSystemParams(contents string) (*SystemParams, error) {
	params := &SystemParams{}
	seen := make(map[string]bool)
	scanner := bufio.NewScanner(strings.NewReader(contents))
	for scanner.Scan() {
		line := scanner.Text()

		// ignore empty lines and comments
		if len(line) == 0 || strings.HasPrefix(line, "#") {
			continue
		}

		tokens := strings.SplitN(line, "=", 2)
		if len(tokens) != 2 {
			return nil, fmt.Errorf("invalid line: %q", line)
		}

		// ensure that each configuration value only appears once
		if ok := seen[tokens[0]]; ok {
			return nil, fmt.Errorf("duplicate entry found: %q", tokens[0])
		}
		seen[tokens[0]] = true

		if tokens[0] == "homedirs" {
			params.Homedirs = tokens[1]
		} else {
			return nil, fmt.Errorf("invalid line: %q", line)
		}
	}

	if err := scanner.Err(); err != nil {
		return nil, err
	}
	return params, nil
}

func sysparamsFile(rootdir string) string {
	if rootdir == "" {
		rootdir = dirs.GlobalRootDir
	}
	return dirs.SnapSystemParamsUnder(rootdir)
}

// Open either reads the existing file at <rootdir>/var/lib/snapd/system-params
// or in case the file does not exist, it will initialize and return a
// new SystemParams structure.
func Open(rootdir string) (*SystemParams, error) {
	sspFile := sysparamsFile(rootdir)
	if !osutil.FileExists(sspFile) {
		return &SystemParams{rootdir: rootdir}, nil
	}

	data, err := os.ReadFile(sspFile)
	if err != nil {
		return nil, fmt.Errorf("cannot read system-params: %v", err)
	}

	params, err := parseSystemParams(string(data))
	if err != nil {
		return nil, fmt.Errorf("cannot parse system-params: %v", err)
	}
	params.rootdir = rootdir
	return params, nil
}

// Write updates the system-params file with the values in the
// SystemParams instance.
func (ssp *SystemParams) Write() error {
	sspFile := sysparamsFile(ssp.rootdir)
	contents := fmt.Sprintf("homedirs=%s\n", ssp.Homedirs)
	if err := osutilAtomicWriteFile(sspFile, []byte(contents), 0644, 0); err != nil {
		return fmt.Errorf("cannot write system-params: %v", err)
	}
	return nil
}