seclog: renamed syscall ops interface

Author: ernestl

seclog/audit_linux.go

@@ -33,31 +33,31 @@ const (
 	auditTrustedApp = 1121
 )
 
-// netlinkOps abstracts the syscall operations needed to open,
-// send to, and close a netlink socket. Production code uses [realNetlinkOps];
+// syscallOps abstracts the syscall operations needed to open,
+// send to, and close a netlink socket. Production code uses [realSyscallOps];
 // tests can substitute a recording or stubbing implementation.
-type netlinkOps interface {
+type syscallOps interface {
 	Socket(domain, typ, proto int) (int, error)
 	Sendto(fd int, payload []byte, flags int, to syscall.Sockaddr) error
 	Close(fd int) error
 }
 
-// realNetlinkOps delegates every operation to the corresponding syscall.
-type realNetlinkOps struct{}
+// realSyscallOps delegates every operation to the corresponding syscall.
+type realSyscallOps struct{}
 
-func (realNetlinkOps) Socket(domain, typ, proto int) (int, error) {
+func (realSyscallOps) Socket(domain, typ, proto int) (int, error) {
 	return syscall.Socket(domain, typ, proto)
 }
 
-func (realNetlinkOps) Sendto(fd int, payload []byte, flags int, to syscall.Sockaddr) error {
+func (realSyscallOps) Sendto(fd int, payload []byte, flags int, to syscall.Sockaddr) error {
 	return syscall.Sendto(fd, payload, flags, to)
 }
 
-func (realNetlinkOps) Close(fd int) error {
+func (realSyscallOps) Close(fd int) error {
 	return syscall.Close(fd)
 }
 
-var netlink netlinkOps = realNetlinkOps{}
+var sys syscallOps = realSyscallOps{}
 
 // AuditWriter implements [io.WriteCloser].
 type AuditWriter struct {
@@ -69,7 +69,7 @@ type AuditWriter struct {
 // that sends each written payload as an AUDIT_TRUSTED_APP.
 func OpenAuditWriter() (*AuditWriter, error) {
 	// SOCK_CLOEXEC prevents the fd from leaking to child processes.
-	fd, err := netlink.Socket(syscall.AF_NETLINK, syscall.SOCK_RAW|syscall.SOCK_CLOEXEC, syscall.NETLINK_AUDIT)
+	fd, err := sys.Socket(syscall.AF_NETLINK, syscall.SOCK_RAW|syscall.SOCK_CLOEXEC, syscall.NETLINK_AUDIT)
 	if err != nil {
 		return nil, fmt.Errorf("cannot open audit socket: %v", err)
 	}
@@ -86,15 +86,15 @@ func (aw *AuditWriter) Write(payload []byte) (int, error) {
 		Pid:    0, // kernel
 	}
 	// TODO: request and handle ACK from kernel audit subsystem
-	if err := netlink.Sendto(aw.fd, msg, 0, addr); err != nil {
+	if err := sys.Sendto(aw.fd, msg, 0, addr); err != nil {
 		return 0, fmt.Errorf("cannot send audit message: %v", err)
 	}
 	return len(payload), nil
 }
 
 // Close closes the underlying netlink socket.
 func (aw *AuditWriter) Close() error {
-	return netlink.Close(aw.fd)
+	return sys.Close(aw.fd)
 }
 
 // buildMessage constructs a raw netlink message containing the given payload.

seclog/audit_linux_test.go

@@ -34,8 +34,8 @@ type AuditSuite struct{}
 
 var _ = Suite(&AuditSuite{})
 
-// mockNetlinkOps records calls and returns configurable results.
-type mockNetlinkOps struct {
+// mockSyscallOps records calls and returns configurable results.
+type mockSyscallOps struct {
 	socketFD   int
 	socketErr  error
 	sendtoData []byte
@@ -44,28 +44,28 @@ type mockNetlinkOps struct {
 	closeErr   error
 }
 
-func (m *mockNetlinkOps) Socket(domain, typ, proto int) (int, error) {
+func (m *mockSyscallOps) Socket(domain, typ, proto int) (int, error) {
 	return m.socketFD, m.socketErr
 }
 
-func (m *mockNetlinkOps) Sendto(fd int, payload []byte, flags int, to syscall.Sockaddr) error {
+func (m *mockSyscallOps) Sendto(fd int, payload []byte, flags int, to syscall.Sockaddr) error {
 	m.sendtoData = slices.Clone(payload)
 	return m.sendtoErr
 }
 
-func (m *mockNetlinkOps) Close(fd int) error {
+func (m *mockSyscallOps) Close(fd int) error {
 	m.closedFDs = append(m.closedFDs, fd)
 	return m.closeErr
 }
 
-// Ensure mockNetlinkOps satisfies the interface.
-var _ seclog.NetlinkOps = (*mockNetlinkOps)(nil)
+// Ensure mockSyscallOps satisfies the interface.
+var _ seclog.SyscallOps = (*mockSyscallOps)(nil)
 
 func (s *AuditSuite) TestOpenSuccess(c *C) {
-	mock := &mockNetlinkOps{
+	mock := &mockSyscallOps{
 		socketFD: 42,
 	}
-	restore := seclog.MockNetlinkOps(mock)
+	restore := seclog.MockSyscallOps(mock)
 	defer restore()
 
 	writer, err := seclog.OpenAuditWriter()
@@ -74,21 +74,21 @@ func (s *AuditSuite) TestOpenSuccess(c *C) {
 }
 
 func (s *AuditSuite) TestOpenSocketError(c *C) {
-	mock := &mockNetlinkOps{
+	mock := &mockSyscallOps{
 		socketErr: fmt.Errorf("permission denied"),
 	}
-	restore := seclog.MockNetlinkOps(mock)
+	restore := seclog.MockSyscallOps(mock)
 	defer restore()
 
 	_, err := seclog.OpenAuditWriter()
 	c.Assert(err, ErrorMatches, "cannot open audit socket: permission denied")
 }
 
 func (s *AuditSuite) TestWriteSuccess(c *C) {
-	mock := &mockNetlinkOps{
+	mock := &mockSyscallOps{
 		socketFD: 7,
 	}
-	restore := seclog.MockNetlinkOps(mock)
+	restore := seclog.MockSyscallOps(mock)
 	defer restore()
 
 	writer, err := seclog.OpenAuditWriter()
@@ -102,11 +102,11 @@ func (s *AuditSuite) TestWriteSuccess(c *C) {
 }
 
 func (s *AuditSuite) TestWriteSendtoError(c *C) {
-	mock := &mockNetlinkOps{
+	mock := &mockSyscallOps{
 		socketFD:  7,
 		sendtoErr: fmt.Errorf("no buffer space"),
 	}
-	restore := seclog.MockNetlinkOps(mock)
+	restore := seclog.MockSyscallOps(mock)
 	defer restore()
 
 	writer, err := seclog.OpenAuditWriter()
@@ -117,10 +117,10 @@ func (s *AuditSuite) TestWriteSendtoError(c *C) {
 }
 
 func (s *AuditSuite) TestClose(c *C) {
-	mock := &mockNetlinkOps{
+	mock := &mockSyscallOps{
 		socketFD: 7,
 	}
-	restore := seclog.MockNetlinkOps(mock)
+	restore := seclog.MockSyscallOps(mock)
 	defer restore()
 
 	writer, err := seclog.OpenAuditWriter()

seclog/export_audit_linux_test.go

@@ -23,7 +23,7 @@ import (
 	"github.com/snapcore/snapd/testutil"
 )
 
-type NetlinkOps = netlinkOps
+type SyscallOps = syscallOps
 
 var NlmsgAlign = nlmsgAlign
 
@@ -33,6 +33,6 @@ func AuditWriterBuildMessage(aw *AuditWriter, payload []byte) []byte {
 	return aw.buildMessage(payload)
 }
 
-func MockNetlinkOps(ops netlinkOps) (restore func()) {
-	return testutil.Mock(&netlink, ops)
+func MockSyscallOps(ops syscallOps) (restore func()) {
+	return testutil.Mock(&sys, ops)
 }