4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
26 * Copyright (c) 2013 by Delphix. All rights reserved.
30 * Common name validation routines for ZFS. These routines are shared by the
31 * userland code as well as the ioctl() layer to ensure that we don't
32 * inadvertently expose a hole through direct ioctl()s that never gets tested.
33 * In userland, however, we want significantly more information about _why_ the
34 * name is invalid. In the kernel, we only care whether it's valid or not.
35 * Each routine therefore takes a 'namecheck_err_t' which describes exactly why
36 * the name failed to validate.
38 * Each function returns 0 on success, -1 on error.
42 #include <sys/systm.h>
47 #include <sys/param.h>
48 #include <sys/nvpair.h>
49 #include "zfs_namecheck.h"
50 #include "zfs_deleg.h"
55 return ((c >= 'a' && c <= 'z') ||
56 (c >= 'A' && c <= 'Z') ||
57 (c >= '0' && c <= '9') ||
58 c == '-' || c == '_' || c == '.' || c == ':' || c == ' ');
62 * Snapshot names must be made up of alphanumeric characters plus the following
68 zfs_component_namecheck(const char *path, namecheck_err_t *why, char *what)
72 if (strlen(path) >= MAXNAMELEN) {
74 *why = NAME_ERR_TOOLONG;
78 if (path[0] == '\0') {
80 *why = NAME_ERR_EMPTY_COMPONENT;
84 for (loc = path; *loc; loc++) {
85 if (!valid_char(*loc)) {
87 *why = NAME_ERR_INVALCHAR;
98 * Permissions set name must start with the letter '@' followed by the
99 * same character restrictions as snapshot names, except that the name
100 * cannot exceed 64 characters.
103 permset_namecheck(const char *path, namecheck_err_t *why, char *what)
105 if (strlen(path) >= ZFS_PERMSET_MAXLEN) {
107 *why = NAME_ERR_TOOLONG;
111 if (path[0] != '@') {
113 *why = NAME_ERR_NO_AT;
119 return (zfs_component_namecheck(&path[1], why, what));
123 * Dataset names must be of the following form:
125 * [component][/]*[component][@component]
127 * Where each component is made up of alphanumeric characters plus the following
132 * We allow '%' here as we use that character internally to create unique
133 * names for temporary clones (for online recv).
136 dataset_namecheck(const char *path, namecheck_err_t *why, char *what)
138 const char *loc, *end;
142 * Make sure the name is not too long.
144 * ZFS_MAXNAMELEN is the maximum dataset length used in the userland
145 * which is the same as MAXNAMELEN used in the kernel.
146 * If ZFS_MAXNAMELEN value is changed, make sure to cleanup all
147 * places using MAXNAMELEN.
150 if (strlen(path) >= MAXNAMELEN) {
152 *why = NAME_ERR_TOOLONG;
156 /* Explicitly check for a leading slash. */
157 if (path[0] == '/') {
159 *why = NAME_ERR_LEADING_SLASH;
163 if (path[0] == '\0') {
165 *why = NAME_ERR_EMPTY_COMPONENT;
172 /* Find the end of this component */
174 while (*end != '/' && *end != '@' && *end != '\0')
177 if (*end == '\0' && end[-1] == '/') {
178 /* trailing slashes are not allowed */
180 *why = NAME_ERR_TRAILING_SLASH;
184 /* Zero-length components are not allowed */
188 * Make sure this is really a zero-length
189 * component and not a '@@'.
191 if (*end == '@' && found_snapshot) {
192 *why = NAME_ERR_MULTIPLE_AT;
194 *why = NAME_ERR_EMPTY_COMPONENT;
201 /* Validate the contents of this component */
203 if (!valid_char(*loc) && *loc != '%') {
205 *why = NAME_ERR_INVALCHAR;
213 /* If we've reached the end of the string, we're OK */
219 * If we've found an @ symbol, indicate that we're in
220 * the snapshot component, and report a second '@'
221 * character as an error.
223 if (found_snapshot) {
225 *why = NAME_ERR_MULTIPLE_AT;
233 * If there is a '/' in a snapshot name
234 * then report an error
236 if (*end == '/' && found_snapshot) {
238 *why = NAME_ERR_TRAILING_SLASH;
242 /* Update to the next component */
249 * mountpoint names must be of the following form:
251 * /[component][/]*[component][/]
254 mountpoint_namecheck(const char *path, namecheck_err_t *why)
256 const char *start, *end;
259 * Make sure none of the mountpoint component names are too long.
260 * If a component name is too long then the mkdir of the mountpoint
261 * will fail but then the mountpoint property will be set to a value
262 * that can never be mounted. Better to fail before setting the prop.
263 * Extra slashes are OK, they will be tossed by the mountpoint mkdir.
266 if (path == NULL || *path != '/') {
268 *why = NAME_ERR_LEADING_SLASH;
272 /* Skip leading slash */
276 while (*end != '/' && *end != '\0')
279 if (end - start >= MAXNAMELEN) {
281 *why = NAME_ERR_TOOLONG;
286 } while (*end != '\0');
292 * For pool names, we have the same set of valid characters as described in
293 * dataset names, with the additional restriction that the pool name must begin
294 * with a letter. The pool names 'raidz' and 'mirror' are also reserved names
295 * that cannot be used.
298 pool_namecheck(const char *pool, namecheck_err_t *why, char *what)
303 * Make sure the name is not too long.
305 * ZPOOL_MAXNAMELEN is the maximum pool length used in the userland
306 * which is the same as MAXNAMELEN used in the kernel.
307 * If ZPOOL_MAXNAMELEN value is changed, make sure to cleanup all
308 * places using MAXNAMELEN.
310 if (strlen(pool) >= MAXNAMELEN) {
312 *why = NAME_ERR_TOOLONG;
318 if (!valid_char(*c)) {
320 *why = NAME_ERR_INVALCHAR;
328 if (!(*pool >= 'a' && *pool <= 'z') &&
329 !(*pool >= 'A' && *pool <= 'Z')) {
331 *why = NAME_ERR_NOLETTER;
335 if (strcmp(pool, "mirror") == 0 || strcmp(pool, "raidz") == 0) {
337 *why = NAME_ERR_RESERVED;
341 if (pool[0] == 'c' && (pool[1] >= '0' && pool[1] <= '9')) {
343 *why = NAME_ERR_DISKLIKE;