File: auth_requestor.go

package info (click to toggle)
snapd 2.74.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 81,428 kB
  • sloc: sh: 16,966; ansic: 16,788; python: 11,332; makefile: 1,897; exp: 190; awk: 58; xml: 22
file content (108 lines) | stat: -rw-r--r-- 3,279 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
// -*- Mode: Go; indent-tabs-mode: t -*-
//go:build !nosecboot

/*
 * Copyright (C) 2025 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 secboot

import (
	"bytes"
	"context"
	"errors"
	"fmt"
	"os"
	"os/exec"
	"path/filepath"
	"strings"

	sb "github.com/snapcore/secboot"

	"github.com/snapcore/snapd/systemd"
)

type systemdAuthRequestor struct {
}

func getAskPasswordMessage(authType sb.UserAuthType, name, path string) (string, error) {
	var fmtMsg string
	switch authType {
	case sb.UserAuthTypePassphrase:
		fmtMsg = "Enter passphrase for %[1]s (%[2]s):"
	case sb.UserAuthTypePIN:
		fmtMsg = "Enter PIN for %[1]s (%[2]s):"
	case sb.UserAuthTypeRecoveryKey:
		fmtMsg = "Enter recovery key for %[1]s (%[2]s):"
	case sb.UserAuthTypePassphrase | sb.UserAuthTypePIN:
		fmtMsg = "Enter passphrase or PIN for %[1]s (%[2]s):"
	case sb.UserAuthTypePassphrase | sb.UserAuthTypeRecoveryKey:
		fmtMsg = "Enter passphrase or recovery key for %[1]s (%[2]s):"
	case sb.UserAuthTypePIN | sb.UserAuthTypeRecoveryKey:
		fmtMsg = "Enter PIN or recovery key for %[1]s (%[2]s):"
	case sb.UserAuthTypePassphrase | sb.UserAuthTypePIN | sb.UserAuthTypeRecoveryKey:
		fmtMsg = "Enter passphrase, PIN or recovery key for %[1]s (%[2]s):"
	default:
		return "", errors.New("unexpected UserAuthType")
	}
	return fmt.Sprintf(fmtMsg, name, path), nil
}

// RequestUserCredential implements AuthRequestor.RequestUserCredential
func (r *systemdAuthRequestor) RequestUserCredential(ctx context.Context, name, path string, authTypes sb.UserAuthType) (string, error) {
	enableCredential := true
	err := systemd.EnsureAtLeast(249)
	if systemd.IsSystemdTooOld(err) {
		enableCredential = false
	}

	var args []string

	args = append(args, "--icon", "drive-harddisk")
	args = append(args, "--id", filepath.Base(os.Args[0])+":"+path)

	if enableCredential {
		args = append(args, "--credential=snapd.fde.password")
	}

	msg, err := getAskPasswordMessage(authTypes, name, path)
	if err != nil {
		return "", err
	}
	args = append(args, msg)

	cmd := exec.CommandContext(
		ctx, "systemd-ask-password",
		args...)
	out := new(bytes.Buffer)
	cmd.Stdout = out
	cmd.Stdin = os.Stdin
	if err := cmd.Run(); err != nil {
		return "", fmt.Errorf("cannot execute systemd-ask-password: %w", err)
	}
	result, err := out.ReadString('\n')
	if err != nil {
		// The only error returned from bytes.Buffer.ReadString is io.EOF.
		return "", errors.New("systemd-ask-password output is missing terminating newline")
	}
	return strings.TrimRight(result, "\n"), nil
}

// NewSystemdAuthRequestor creates an AuthRequestor
// which calls systemd-ask-password with credential parameter.
func NewSystemdAuthRequestor() sb.AuthRequestor {
	return &systemdAuthRequestor{}
}