File: getent.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 (233 lines) | stat: -rw-r--r-- 5,206 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
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
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2024 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 user

import (
	"bufio"
	"bytes"
	"errors"
	"fmt"
	"os"
	"os/exec"
	"path/filepath"
	"strconv"
	"strings"
)

const (
	DefaultGetentSearchPath = "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
)

var (
	getentSearchPath = DefaultGetentSearchPath
)

func findGetent(searchPath string) (string, error) {
	// try to look for getent in a couple of places, such that even when running
	// with modified PATH we still can locate the executable
	for _, dir := range filepath.SplitList(searchPath) {
		p := filepath.Join(dir, "getent")
		if fi, err := os.Stat(p); err == nil {
			if !fi.IsDir() && fi.Mode().Perm()&0111 != 0 {
				return p, nil
			}
		}
	}
	return "", errors.New("cannot locate getent executable")
}

func getEnt(params ...string) ([]byte, error) {
	getentCmd, err := findGetent(getentSearchPath)
	if err != nil {
		return nil, err
	}

	cmd := exec.Command(getentCmd, params...)
	cmd.Stdin = nil

	outBuf, err := cmd.Output()
	if err != nil {
		var exitError *exec.ExitError
		if errors.As(err, &exitError) {
			if exitError.ExitCode() == 2 {
				return nil, nil
			}
			return nil, fmt.Errorf("getent returned an error: %q", exitError.Stderr)
		}
		return nil, fmt.Errorf("getent could not be executed: %w", err)
	}

	return outBuf, nil
}

// lookupFromGetent calls getent, parses and filters its output
// The component at `index` will need to match `expectedValue`.
// If `isKey`, then `expectedValue` will also be passed as parameter
// to getent along `database`. `numComponents` should be 4 for groups
// and 7 for users.
func lookupFromGetent(database string, index int, expectedValue string, isKey bool, numComponents int) ([]string, error) {
	params := []string{database}
	if isKey {
		params = append(params, expectedValue)
	}
	buf, err := getEnt(params...)
	if err != nil {
		return nil, err
	}
	scanner := bufio.NewScanner(bytes.NewReader(buf))
	for scanner.Scan() {
		components := strings.SplitN(scanner.Text(), ":", numComponents)
		if len(components) != numComponents {
			continue
		}

		if components[index] != expectedValue {
			continue
		}

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

func isNumeric(value string) bool {
	for _, c := range value {
		// We check only the first character
		return '0' <= c && c <= '9'
	}
	return false
}

func isKey(index int, expectedValue string) bool {
	numeric := isNumeric(expectedValue)
	return (index == 0 && !numeric) || (index == 2 && numeric)
}

type groupMatcher interface {
	index() int
	expectedValue() string
}

type groupnameMatcher struct {
	value string
}

func (m groupnameMatcher) index() int {
	return 0
}

func (m groupnameMatcher) expectedValue() string {
	return m.value
}

func groupMatchGroupname(groupname string) groupMatcher {
	return groupnameMatcher{
		value: groupname,
	}
}

func lookupGroupFromGetent(matcher groupMatcher) (*Group, error) {
	components, err := lookupFromGetent("group", matcher.index(), matcher.expectedValue(), isKey(matcher.index(), matcher.expectedValue()), 4)

	if err != nil {
		return nil, err
	}

	if components == nil {
		return nil, nil
	}

	return &Group{
		Name: components[0],
		Gid:  components[2],
	}, nil
}

type userMatcher interface {
	index() int
	expectedValue() string
}

type usernameMatcher struct {
	value string
}

func (m usernameMatcher) index() int {
	return 0
}

func (m usernameMatcher) expectedValue() string {
	return m.value
}

func userMatchUsername(username string) userMatcher {
	return usernameMatcher{
		value: username,
	}
}

type uidMatcher struct {
	value int
}

func (m uidMatcher) index() int {
	return 2
}

func (m uidMatcher) expectedValue() string {
	return strconv.Itoa(m.value)
}

func userMatchUid(uid int) userMatcher {
	return uidMatcher{
		value: uid,
	}
}

func lookupUserFromGetent(matcher userMatcher) (*User, error) {
	components, err := lookupFromGetent("passwd", matcher.index(), matcher.expectedValue(), isKey(matcher.index(), matcher.expectedValue()), 7)

	if err != nil {
		return nil, err
	}

	if components == nil {
		return nil, nil
	}

	return &User{
		Username: components[0],
		Uid:      components[2],
		Gid:      components[3],
		Name:     components[4],
		HomeDir:  components[5],
	}, nil
}

// OverrideGetentSearchPath allows overriding getent search path. Its only
// purpose is to be used in tests.
func OverrideGetentSearchPath(p string) {
	// TODO should use osutil.MustBeTestBinary() but we cannot import due to
	// cyclic dependencies
	getentSearchPath = p
}