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) >= ZFS_MAX_DATASET_NAME_LEN) {
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 if (strlen(path) >= ZFS_MAX_DATASET_NAME_LEN) {
146 *why = NAME_ERR_TOOLONG;
150 /* Explicitly check for a leading slash. */
151 if (path[0] == '/') {
153 *why = NAME_ERR_LEADING_SLASH;
157 if (path[0] == '\0') {
159 *why = NAME_ERR_EMPTY_COMPONENT;
166 /* Find the end of this component */
168 while (*end != '/' && *end != '@' && *end != '\0')
171 if (*end == '\0' && end[-1] == '/') {
172 /* trailing slashes are not allowed */
174 *why = NAME_ERR_TRAILING_SLASH;
178 /* Zero-length components are not allowed */
182 * Make sure this is really a zero-length
183 * component and not a '@@'.
185 if (*end == '@' && found_snapshot) {
186 *why = NAME_ERR_MULTIPLE_AT;
188 *why = NAME_ERR_EMPTY_COMPONENT;
195 /* Validate the contents of this component */
197 if (!valid_char(*loc) && *loc != '%') {
199 *why = NAME_ERR_INVALCHAR;
207 /* If we've reached the end of the string, we're OK */
213 * If we've found an @ symbol, indicate that we're in
214 * the snapshot component, and report a second '@'
215 * character as an error.
217 if (found_snapshot) {
219 *why = NAME_ERR_MULTIPLE_AT;
227 * If there is a '/' in a snapshot name
228 * then report an error
230 if (*end == '/' && found_snapshot) {
232 *why = NAME_ERR_TRAILING_SLASH;
236 /* Update to the next component */
243 * mountpoint names must be of the following form:
245 * /[component][/]*[component][/]
248 mountpoint_namecheck(const char *path, namecheck_err_t *why)
250 const char *start, *end;
253 * Make sure none of the mountpoint component names are too long.
254 * If a component name is too long then the mkdir of the mountpoint
255 * will fail but then the mountpoint property will be set to a value
256 * that can never be mounted. Better to fail before setting the prop.
257 * Extra slashes are OK, they will be tossed by the mountpoint mkdir.
260 if (path == NULL || *path != '/') {
262 *why = NAME_ERR_LEADING_SLASH;
266 /* Skip leading slash */
270 while (*end != '/' && *end != '\0')
273 if (end - start >= ZFS_MAX_DATASET_NAME_LEN) {
275 *why = NAME_ERR_TOOLONG;
280 } while (*end != '\0');
286 * For pool names, we have the same set of valid characters as described in
287 * dataset names, with the additional restriction that the pool name must begin
288 * with a letter. The pool names 'raidz' and 'mirror' are also reserved names
289 * that cannot be used.
292 pool_namecheck(const char *pool, namecheck_err_t *why, char *what)
297 * Make sure the name is not too long.
299 if (strlen(pool) >= ZFS_MAX_DATASET_NAME_LEN) {
301 *why = NAME_ERR_TOOLONG;
307 if (!valid_char(*c)) {
309 *why = NAME_ERR_INVALCHAR;
317 if (!(*pool >= 'a' && *pool <= 'z') &&
318 !(*pool >= 'A' && *pool <= 'Z')) {
320 *why = NAME_ERR_NOLETTER;
324 if (strcmp(pool, "mirror") == 0 || strcmp(pool, "raidz") == 0) {
326 *why = NAME_ERR_RESERVED;
330 if (pool[0] == 'c' && (pool[1] >= '0' && pool[1] <= '9')) {
332 *why = NAME_ERR_DISKLIKE;
339 #if defined(_KERNEL) && defined(HAVE_SPL)
340 EXPORT_SYMBOL(pool_namecheck);
341 EXPORT_SYMBOL(dataset_namecheck);
342 EXPORT_SYMBOL(zfs_component_namecheck);