New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fsverity content verification #10007
base: main
Are you sure you want to change the base?
Changes from 3 commits
36e1ad4
9ba5d37
ca67f2c
10e03e6
b3dc6e2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
/* | ||
Copyright The containerd Authors. | ||
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 fsverity | ||
|
||
import ( | ||
"fmt" | ||
"os" | ||
"path/filepath" | ||
"syscall" | ||
"unsafe" | ||
|
||
"github.com/containerd/containerd/v2/pkg/kernelversion" | ||
"golang.org/x/sys/unix" | ||
) | ||
|
||
type fsverityEnableArg struct { | ||
version uint32 | ||
hashAlgorithm uint32 | ||
blockSize uint32 | ||
saltSize uint32 | ||
saltPtr uint64 | ||
sigSize uint32 | ||
reserved1 uint32 | ||
sigPtr uint64 | ||
reserved2 [11]uint64 | ||
} | ||
|
||
const ( | ||
defaultBlockSize int = 4096 | ||
maxDigestSize uint16 = 64 | ||
) | ||
|
||
func IsSupported(rootPath string) (bool, error) { | ||
minKernelVersion := kernelversion.KernelVersion{Kernel: 5, Major: 4} | ||
s, err := kernelversion.GreaterEqualThan(minKernelVersion) | ||
if err != nil { | ||
return s, err | ||
} | ||
|
||
integrityDir := filepath.Join(rootPath, "integrity") | ||
if err = os.MkdirAll(integrityDir, 0755); err != nil { | ||
return false, err | ||
} | ||
|
||
digestPath := filepath.Join(integrityDir, "supported") | ||
digestFile, err := os.Create(digestPath) | ||
if err != nil { | ||
return false, err | ||
} | ||
|
||
digestFile.Close() | ||
defer os.RemoveAll(integrityDir) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. move this line to L57. |
||
|
||
eerr := Enable(digestPath) | ||
if eerr != nil { | ||
return false, eerr | ||
} | ||
|
||
return true, nil | ||
} | ||
|
||
func IsEnabled(path string) (bool, error) { | ||
f, err := os.Open(path) | ||
if err != nil { | ||
return false, err | ||
} | ||
defer f.Close() | ||
|
||
var attr int | ||
|
||
_, _, flagErr := unix.Syscall(syscall.SYS_IOCTL, f.Fd(), uintptr(unix.FS_IOC_GETFLAGS), uintptr(unsafe.Pointer(&attr))) | ||
if flagErr != 0 { | ||
return false, fmt.Errorf("error getting inode flags: %w", flagErr) | ||
} | ||
|
||
if attr&unix.FS_VERITY_FL == unix.FS_VERITY_FL { | ||
return true, nil | ||
} | ||
|
||
return false, nil | ||
} | ||
|
||
func Enable(path string) error { | ||
f, err := os.Open(path) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
var args = &fsverityEnableArg{} | ||
args.version = 1 | ||
args.hashAlgorithm = 1 | ||
|
||
// fsverity block size should be the minimum between the page size | ||
// and the file system block size | ||
// If neither value is retrieved successfully, set fsverity block size to the default value | ||
blockSize := unix.Getpagesize() | ||
|
||
s := unix.Stat_t{} | ||
serr := unix.Stat(path, &s) | ||
if serr == nil && int(s.Blksize) < blockSize { | ||
blockSize = int(s.Blksize) | ||
} | ||
|
||
if blockSize <= 0 { | ||
blockSize = defaultBlockSize | ||
} | ||
|
||
args.blockSize = uint32(blockSize) | ||
|
||
_, _, errno := unix.Syscall(syscall.SYS_IOCTL, f.Fd(), uintptr(unix.FS_IOC_ENABLE_VERITY), uintptr(unsafe.Pointer(args))) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The fsverity module will automatically verify the integrity of the data on every read operation of the enabled file. If fsverity detects corruption, the read operation will return an error. The case where we would need to call I'd be happy to implement this if the malicious corruption of blob data is a case containerd should cover. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, it would be nice to cover malicious corruption. |
||
if errno != 0 { | ||
return fmt.Errorf("enable fsverity failed: %w", errno) | ||
} | ||
|
||
return nil | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
//go:build !linux | ||
|
||
/* | ||
Copyright The containerd Authors. | ||
|
||
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 fsverity | ||
|
||
import "fmt" | ||
|
||
func IsSupported(rootPath string) (bool, error) { | ||
return false, fmt.Errorf("fsverity is only supported on Linux systems") | ||
} | ||
|
||
func IsEnabled(path string) (bool, error) { | ||
return false, fmt.Errorf("fsverity is only supported on Linux systems") | ||
} | ||
|
||
func Enable(_ string) error { | ||
return fmt.Errorf("fsverity is only supported on Linux systems") | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can rename this to
.fsverity-check
byos.MkdirTemp
. So, the node admin will know it's tempdir to verify something.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Thank you for the suggestion.