aboutsummaryrefslogtreecommitdiff
path: root/tests/sys/fs/fusefs/mknod.cc
blob: 53087b75d987209d885af2261b48ac2e2cac7c6a (plain) (blame)
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
234
235
236
237
238
239
240
241
242
243
/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2019 The FreeBSD Foundation
 *
 * This software was developed by BFF Storage Systems, LLC under sponsorship
 * from the FreeBSD Foundation.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */

extern "C" {
#include <fcntl.h>
#include <sys/socket.h>
#include <sys/un.h>
}

#include "mockfs.hh"
#include "utils.hh"

using namespace testing;

#ifndef VNOVAL
#define VNOVAL (-1)	/* Defined in sys/vnode.h */
#endif

const char FULLPATH[] = "mountpoint/some_file.txt";
const char RELPATH[] = "some_file.txt";

class Mknod: public FuseTest {

mode_t m_oldmask;
const static mode_t c_umask = 022;

public:

virtual void SetUp() {
	m_oldmask = umask(c_umask);
	if (geteuid() != 0) {
		GTEST_SKIP() << "Only root may use most mknod(2) variations";
	}
	FuseTest::SetUp();
}

virtual void TearDown() {
	FuseTest::TearDown();
	(void)umask(m_oldmask);
}

/* Test an OK creation of a file with the given mode and device number */
void expect_mknod(mode_t mode, dev_t dev) {
	uint64_t ino = 42;

	EXPECT_LOOKUP(FUSE_ROOT_ID, RELPATH)
	.WillOnce(Invoke(ReturnErrno(ENOENT)));

	EXPECT_CALL(*m_mock, process(
		ResultOf([=](auto in) {
			const char *name = (const char*)in.body.bytes +
				sizeof(fuse_mknod_in);
			return (in.header.opcode == FUSE_MKNOD &&
				in.body.mknod.mode == mode &&
				in.body.mknod.rdev == (uint32_t)dev &&
				in.body.mknod.umask == c_umask &&
				(0 == strcmp(RELPATH, name)));
		}, Eq(true)),
		_)
	).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto& out) {
		SET_OUT_HEADER_LEN(out, entry);
		out.body.entry.attr.mode = mode;
		out.body.entry.nodeid = ino;
		out.body.entry.entry_valid = UINT64_MAX;
		out.body.entry.attr_valid = UINT64_MAX;
		out.body.entry.attr.rdev = dev;
	})));
}

};

class Mknod_7_11: public FuseTest {
public:
virtual void SetUp() {
	m_kernel_minor_version = 11;
	if (geteuid() != 0) {
		GTEST_SKIP() << "Only root may use most mknod(2) variations";
	}
	FuseTest::SetUp();
}

void expect_lookup(const char *relpath, uint64_t ino, uint64_t size)
{
	FuseTest::expect_lookup_7_8(relpath, ino, S_IFREG | 0644, size, 1);
}

/* Test an OK creation of a file with the given mode and device number */
void expect_mknod(mode_t mode, dev_t dev) {
	uint64_t ino = 42;

	EXPECT_LOOKUP(FUSE_ROOT_ID, RELPATH)
	.WillOnce(Invoke(ReturnErrno(ENOENT)));

	EXPECT_CALL(*m_mock, process(
		ResultOf([=](auto in) {
			const char *name = (const char*)in.body.bytes +
				FUSE_COMPAT_MKNOD_IN_SIZE;
			return (in.header.opcode == FUSE_MKNOD &&
				in.body.mknod.mode == mode &&
				in.body.mknod.rdev == (uint32_t)dev &&
				(0 == strcmp(RELPATH, name)));
		}, Eq(true)),
		_)
	).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto& out) {
		SET_OUT_HEADER_LEN(out, entry);
		out.body.entry.attr.mode = mode;
		out.body.entry.nodeid = ino;
		out.body.entry.entry_valid = UINT64_MAX;
		out.body.entry.attr_valid = UINT64_MAX;
		out.body.entry.attr.rdev = dev;
	})));
}

};

/* 
 * mknod(2) should be able to create block devices on a FUSE filesystem.  Even
 * though FreeBSD doesn't use block devices, this is useful when copying media
 * from or preparing media for other operating systems.
 */
TEST_F(Mknod, blk)
{
	mode_t mode = S_IFBLK | 0755;
	dev_t rdev = 0xfe00; /* /dev/vda's device number on Linux */
	expect_mknod(mode, rdev);
	EXPECT_EQ(0, mknod(FULLPATH, mode, rdev)) << strerror(errno);
}

TEST_F(Mknod, chr)
{
	mode_t mode = S_IFCHR | 0755;
	dev_t rdev = 54;			/* /dev/fuse's device number */
	expect_mknod(mode, rdev);
	EXPECT_EQ(0, mknod(FULLPATH, mode, rdev)) << strerror(errno);
}

/* 
 * The daemon is responsible for checking file permissions (unless the
 * default_permissions mount option was used)
 */
TEST_F(Mknod, eperm)
{
	mode_t mode = S_IFIFO | 0755;

	EXPECT_LOOKUP(FUSE_ROOT_ID, RELPATH)
	.WillOnce(Invoke(ReturnErrno(ENOENT)));

	EXPECT_CALL(*m_mock, process(
		ResultOf([=](auto in) {
			const char *name = (const char*)in.body.bytes +
				sizeof(fuse_mknod_in);
			return (in.header.opcode == FUSE_MKNOD &&
				in.body.mknod.mode == mode &&
				(0 == strcmp(RELPATH, name)));
		}, Eq(true)),
		_)
	).WillOnce(Invoke(ReturnErrno(EPERM)));
	EXPECT_NE(0, mkfifo(FULLPATH, mode));
	EXPECT_EQ(EPERM, errno);
}

TEST_F(Mknod, fifo)
{
	mode_t mode = S_IFIFO | 0755;
	dev_t rdev = VNOVAL;		/* Fifos don't have device numbers */
	expect_mknod(mode, rdev);
	EXPECT_EQ(0, mkfifo(FULLPATH, mode)) << strerror(errno);
}

/*
 * Create a unix-domain socket.
 *
 * This test case doesn't actually need root privileges.
 */
TEST_F(Mknod, socket)
{
	mode_t mode = S_IFSOCK | 0755;
	struct sockaddr_un sa;
	int fd;
	dev_t rdev = -1;	/* Really it's a don't care */

	expect_mknod(mode, rdev);

	fd = socket(AF_UNIX, SOCK_STREAM, 0);
	ASSERT_LE(0, fd) << strerror(errno);
	sa.sun_family = AF_UNIX;
	strlcpy(sa.sun_path, FULLPATH, sizeof(sa.sun_path));
	sa.sun_len = sizeof(FULLPATH);
	ASSERT_EQ(0, bind(fd, (struct sockaddr*)&sa, sizeof(sa)))
		<< strerror(errno);

	leak(fd);
}

/* 
 * fusefs(5) lacks VOP_WHITEOUT support.  No bugzilla entry, because that's a
 * feature, not a bug
 */
TEST_F(Mknod, DISABLED_whiteout)
{
	mode_t mode = S_IFWHT | 0755;
	dev_t rdev = VNOVAL;	/* whiteouts don't have device numbers */
	expect_mknod(mode, rdev);
	EXPECT_EQ(0, mknod(FULLPATH, mode, 0)) << strerror(errno);
}

/* A server built at protocol version 7.11 or earlier can still use mknod */
TEST_F(Mknod_7_11, fifo)
{
	mode_t mode = S_IFIFO | 0755;
	dev_t rdev = VNOVAL;
	expect_mknod(mode, rdev);
	EXPECT_EQ(0, mkfifo(FULLPATH, mode)) << strerror(errno);
}