zfs_namecheck.c revision fa9e4066f08beec538e775443c5be79dd423fcab
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The contents of this file are subject to the terms of the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Common Development and Distribution License, Version 1.0 only
fa9e4066f08beec538e775443c5be79dd423fcabahrens * (the "License"). You may not use this file except in compliance
fa9e4066f08beec538e775443c5be79dd423fcabahrens * with the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When distributing Covered Code, include this CDDL HEADER in each
fa9e4066f08beec538e775443c5be79dd423fcabahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If applicable, add the following below this CDDL HEADER, with the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * fields enclosed by brackets "[]" replaced with your own identifying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * information: Portions Copyright [yyyy] [name of copyright owner]
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER END
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Copyright 2005 Sun Microsystems, Inc. All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Use is subject to license terms.
fa9e4066f08beec538e775443c5be79dd423fcabahrens#pragma ident "%Z%%M% %I% %E% SMI"
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Common name validation routines for ZFS. These routines are shared by the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * userland code as well as the ioctl() layer to ensure that we don't
fa9e4066f08beec538e775443c5be79dd423fcabahrens * inadvertently expose a hole through direct ioctl()s that never gets tested.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * In userland, however, we want significantly more information about _why_ the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * name is invalid. In the kernel, we only care whether it's valid or not.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Each routine therefore takes a 'namecheck_err_t' which describes exactly why
fa9e4066f08beec538e775443c5be79dd423fcabahrens * the name failed to validate.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Each function returns 0 on success, -1 on error.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Dataset names must be of the following form:
fa9e4066f08beec538e775443c5be79dd423fcabahrens * [component][/]*[component][@component]
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Where each component is made up of alphanumeric characters plus the following
fa9e4066f08beec538e775443c5be79dd423fcabahrens * characters:
fa9e4066f08beec538e775443c5be79dd423fcabahrensdataset_namecheck(const char *path, namecheck_err_t *why, char *what)
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Explicitly check for a leading slash. */
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Find the end of this component */
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* trailing slashes are not allowed */
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Zero-length components are not allowed */
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Validate the contents of this component */
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* If we've reached the end of the string, we're OK */
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If we've found an @ symbol, indicate that we're in
fa9e4066f08beec538e775443c5be79dd423fcabahrens * the snapshot component, and report a second '@'
fa9e4066f08beec538e775443c5be79dd423fcabahrens * character as an error.
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Update to the next component */
fa9e4066f08beec538e775443c5be79dd423fcabahrens * For pool names, we have the same set of valid characters as described in
fa9e4066f08beec538e775443c5be79dd423fcabahrens * dataset names, with the additional restriction that the pool name must begin
fa9e4066f08beec538e775443c5be79dd423fcabahrens * with a letter. The pool names 'raidz' and 'mirror' are also reserved names
fa9e4066f08beec538e775443c5be79dd423fcabahrens * that cannot be used.
fa9e4066f08beec538e775443c5be79dd423fcabahrenspool_namecheck(const char *pool, namecheck_err_t *why, char *what)
fa9e4066f08beec538e775443c5be79dd423fcabahrens const char *c;
fa9e4066f08beec538e775443c5be79dd423fcabahrens while (*c != '\0') {
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (strcmp(pool, "mirror") == 0 || strcmp(pool, "raidz") == 0) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (pool[0] == 'c' && (pool[1] >= '0' && pool[1] <= '9')) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Check if the dataset name is private for internal usage.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * '$' is reserved for internal dataset names. e.g. "$MOS"
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Return 1 if the given name is used internally.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Return 0 if it is not.
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);