File: efi.go

package info (click to toggle)
golang-github-foxboron-go-uefi 0.0~git20250207.69fb7db-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 9,140 kB
  • sloc: makefile: 29; sh: 14
file content (187 lines) | stat: -rw-r--r-- 5,263 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
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
package efi

// Top level API for goefi

import (
	"encoding/binary"
	"fmt"
	"io"
	"os"

	"github.com/foxboron/go-uefi/efi/attributes"
	"github.com/foxboron/go-uefi/efi/device"
	"github.com/foxboron/go-uefi/efi/signature"
	"github.com/foxboron/go-uefi/efi/util"
	"github.com/pkg/errors"
)

// Keeps track of expected attributes for each variable
var ValidAttributes = map[string]attributes.Attributes{
	"SetupMode": attributes.EFI_VARIABLE_NON_VOLATILE |
		attributes.EFI_VARIABLE_BOOTSERVICE_ACCESS,
	"PK": attributes.EFI_VARIABLE_NON_VOLATILE |
		attributes.EFI_VARIABLE_BOOTSERVICE_ACCESS |
		attributes.EFI_VARIABLE_RUNTIME_ACCESS |
		attributes.EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS,
	"KEK": attributes.EFI_VARIABLE_NON_VOLATILE |
		attributes.EFI_VARIABLE_BOOTSERVICE_ACCESS |
		attributes.EFI_VARIABLE_RUNTIME_ACCESS |
		attributes.EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS,
	"db": attributes.EFI_VARIABLE_NON_VOLATILE |
		attributes.EFI_VARIABLE_BOOTSERVICE_ACCESS |
		attributes.EFI_VARIABLE_RUNTIME_ACCESS |
		attributes.EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS,
	"dbx": attributes.EFI_VARIABLE_NON_VOLATILE |
		attributes.EFI_VARIABLE_BOOTSERVICE_ACCESS |
		attributes.EFI_VARIABLE_RUNTIME_ACCESS |
		attributes.EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS,
}

func GetBootOrder() []string {
	ret := []string{}
	_, data, _ := attributes.ReadEfivars("BootOrder")
	for i := 0; i < data.Len(); i += 2 {
		b := make([]byte, 2)
		data.Read(b)
		val := binary.BigEndian.Uint16([]byte{b[1], b[0]})
		ret = append(ret, fmt.Sprintf("Boot%04x\n", val))
	}
	return ret
}

func GetBootEntry(entry string) (*device.EFILoadOption, error) {
	_, f, _ := attributes.ReadEfivars(entry)
	loadOption, err := device.ParseEFILoadOption(f)
	if err != nil {
		return nil, err
	}
	loadOption.FilePath, err = device.ParseDevicePath(f)
	if err != nil {
		return nil, err
	}
	return loadOption, nil
}

// GetSetupMode returns if setup mode has been enabled on the machine.
func GetSetupMode() bool {
	if _, data, err := attributes.ReadEfivars("SetupMode"); err == nil {
		b, _ := data.ReadByte()
		if b == 1 {
			return true
		}
	}
	return false
}

// GetSecureBoot returns if secure boot has been enabled on the machine.
func GetSecureBoot() bool {
	if _, data, err := attributes.ReadEfivars("SecureBoot"); err == nil {
		b, _ := data.ReadByte()
		if b == 1 {
			return true
		}
	}
	return false
}

func GetPK() (*signature.SignatureDatabase, error) {
	efivar := "PK"
	attributes, data, err := attributes.ReadEfivars(efivar)
	if err != nil {
		if errors.Is(err, io.EOF) || os.IsNotExist(err) {
			return &signature.SignatureDatabase{}, nil
		}
		return &signature.SignatureDatabase{}, err
	}
	if (ValidAttributes[efivar] & attributes) != ValidAttributes[efivar] {
		return nil, fmt.Errorf("invalid bitmask")
	}
	siglist, err := signature.ReadSignatureDatabase(data)
	if err != nil {
		return nil, errors.Wrapf(err, "can't parse Platform Key")
	}
	return &siglist, nil
}

func GetKEK() (*signature.SignatureDatabase, error) {
	efivar := "KEK"
	attr, data, err := attributes.ReadEfivars(efivar)
	if err != nil {
		if errors.Is(err, io.EOF) || os.IsNotExist(err) {
			return &signature.SignatureDatabase{}, nil
		}
		return &signature.SignatureDatabase{}, err
	}
	if (ValidAttributes[efivar] & attr) != ValidAttributes[efivar] {
		return nil, fmt.Errorf("invalid bitmask")
	}
	siglist, err := signature.ReadSignatureDatabase(data)
	if err != nil {
		return nil, errors.Wrapf(err, "can't parse Key Exchange key")
	}
	return &siglist, nil
}

func Getdb() (*signature.SignatureDatabase, error) {
	efivar := "db"
	attr, data, err := attributes.ReadEfivars(efivar)
	if err != nil {
		if errors.Is(err, io.EOF) || os.IsNotExist(err) {
			return &signature.SignatureDatabase{}, nil
		}
		return &signature.SignatureDatabase{}, err
	}
	if (ValidAttributes[efivar] & attr) != ValidAttributes[efivar] {
		return nil, fmt.Errorf("invalid bitmask")
	}
	siglist, err := signature.ReadSignatureDatabase(data)
	if err != nil {
		return nil, errors.Wrapf(err, "can't parse database key")
	}
	return &siglist, nil
}

func Getdbx() (*signature.SignatureDatabase, error) {
	efivar := "dbx"
	attr, data, err := attributes.ReadEfivars(efivar)
	if err != nil {
		if errors.Is(err, io.EOF) || os.IsNotExist(err) {
			return &signature.SignatureDatabase{}, nil
		}
		return &signature.SignatureDatabase{}, err
	}
	if (ValidAttributes[efivar] & attr) != ValidAttributes[efivar] {
		return nil, fmt.Errorf("invalid bitmask")
	}
	siglist, err := signature.ReadSignatureDatabase(data)
	if err != nil {
		return nil, errors.Wrapf(err, "can't parse forbidden database key")
	}
	return &siglist, nil
}

func WriteEFIVariable(variable string, buf []byte) error {
	attrs := ValidAttributes[variable]
	if err := attributes.WriteEfivars(variable, attrs, buf); err != nil {
		return err
	}
	return nil
}

// Return the boot entry which is currently booted.
func GetCurrentlyBootedEntry() (string, error) {
	_, data, err := attributes.ReadEfivarsWithGuid(
		"LoaderEntrySelected",
		*util.StringToGUID("4a67b082-0a4c-41cf-b6c7-440b29bb8c4f"),
	)
	if err != nil {
		return "", err
	}

	name, err := util.ParseUtf16Var(data)
	if err != nil {
		return "", err
	}

	return name, nil
}