zfs_namecheck.c revision b81d61a68b235e0529ebadc18e14d9d1dd52a258
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
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 *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * or http://www.opensolaris.org/os/licensing.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
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 *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER END
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Copyright 2005 Sun Microsystems, Inc. All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Use is subject to license terms.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#pragma ident "%Z%%M% %I% %E% SMI"
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
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 *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Each function returns 0 on success, -1 on error.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#if defined(_KERNEL)
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/systm.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#else
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <string.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling#include <sys/param.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include "zfs_namecheck.h"
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrensstatic int
fa9e4066f08beec538e775443c5be79dd423fcabahrensvalid_char(char c)
fa9e4066f08beec538e775443c5be79dd423fcabahrens{
fa9e4066f08beec538e775443c5be79dd423fcabahrens return ((c >= 'a' && c <= 'z') ||
fa9e4066f08beec538e775443c5be79dd423fcabahrens (c >= 'A' && c <= 'Z') ||
fa9e4066f08beec538e775443c5be79dd423fcabahrens (c >= '0' && c <= '9') ||
fa9e4066f08beec538e775443c5be79dd423fcabahrens c == '-' || c == '_' || c == '.' || c == ':');
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Dataset names must be of the following form:
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * [component][/]*[component][@component]
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Where each component is made up of alphanumeric characters plus the following
fa9e4066f08beec538e775443c5be79dd423fcabahrens * characters:
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * [-_.:]
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrensint
fa9e4066f08beec538e775443c5be79dd423fcabahrensdataset_namecheck(const char *path, namecheck_err_t *why, char *what)
fa9e4066f08beec538e775443c5be79dd423fcabahrens{
fa9e4066f08beec538e775443c5be79dd423fcabahrens const char *loc, *end;
fa9e4066f08beec538e775443c5be79dd423fcabahrens int found_snapshot;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling /*
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * Make sure the name is not too long.
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling *
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * ZFS_MAXNAMELEN is the maximum dataset length used in the userland
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * which is the same as MAXNAMELEN used in the kernel.
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * If ZFS_MAXNAMELEN value is changed, make sure to cleanup all
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * places using MAXNAMELEN.
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling */
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling if (strlen(path) >= MAXNAMELEN) {
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling if (why)
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling *why = NAME_ERR_TOOLONG;
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling return (-1);
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling }
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Explicitly check for a leading slash. */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (path[0] == '/') {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why)
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_LEADING_SLASH;
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (path[0] == '\0') {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why)
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_EMPTY_COMPONENT;
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens loc = path;
fa9e4066f08beec538e775443c5be79dd423fcabahrens found_snapshot = 0;
fa9e4066f08beec538e775443c5be79dd423fcabahrens for (;;) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Find the end of this component */
fa9e4066f08beec538e775443c5be79dd423fcabahrens end = loc;
fa9e4066f08beec538e775443c5be79dd423fcabahrens while (*end != '/' && *end != '@' && *end != '\0')
fa9e4066f08beec538e775443c5be79dd423fcabahrens end++;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (*end == '\0' && end[-1] == '/') {
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* trailing slashes are not allowed */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why)
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_TRAILING_SLASH;
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Zero-length components are not allowed */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (loc == end) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why)
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_EMPTY_COMPONENT;
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Validate the contents of this component */
fa9e4066f08beec538e775443c5be79dd423fcabahrens while (loc != end) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (!valid_char(*loc)) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_INVALCHAR;
fa9e4066f08beec538e775443c5be79dd423fcabahrens *what = *loc;
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens loc++;
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* If we've reached the end of the string, we're OK */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (*end == '\0')
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (*end == '@') {
fa9e4066f08beec538e775443c5be79dd423fcabahrens /*
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 */
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (found_snapshot) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why)
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_MULTIPLE_AT;
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens found_snapshot = 1;
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens /* Update to the next component */
fa9e4066f08beec538e775443c5be79dd423fcabahrens loc = end + 1;
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
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.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrensint
fa9e4066f08beec538e775443c5be79dd423fcabahrenspool_namecheck(const char *pool, namecheck_err_t *why, char *what)
fa9e4066f08beec538e775443c5be79dd423fcabahrens{
fa9e4066f08beec538e775443c5be79dd423fcabahrens const char *c;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling /*
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * Make sure the name is not too long.
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling *
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * ZPOOL_MAXNAMELEN is the maximum pool length used in the userland
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * which is the same as MAXNAMELEN used in the kernel.
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * If ZPOOL_MAXNAMELEN value is changed, make sure to cleanup all
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * places using MAXNAMELEN.
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling */
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling if (strlen(pool) >= MAXNAMELEN) {
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling if (why)
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling *why = NAME_ERR_TOOLONG;
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling return (-1);
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling }
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling
fa9e4066f08beec538e775443c5be79dd423fcabahrens c = pool;
fa9e4066f08beec538e775443c5be79dd423fcabahrens while (*c != '\0') {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (!valid_char(*c)) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_INVALCHAR;
fa9e4066f08beec538e775443c5be79dd423fcabahrens *what = *c;
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens c++;
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (!(*pool >= 'a' && *pool <= 'z') &&
fa9e4066f08beec538e775443c5be79dd423fcabahrens !(*pool >= 'A' && *pool <= 'Z')) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why)
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_NOLETTER;
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (strcmp(pool, "mirror") == 0 || strcmp(pool, "raidz") == 0) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why)
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_RESERVED;
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (pool[0] == 'c' && (pool[1] >= '0' && pool[1] <= '9')) {
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (why)
fa9e4066f08beec538e775443c5be79dd423fcabahrens *why = NAME_ERR_DISKLIKE;
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (-1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens }
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Check if the dataset name is private for internal usage.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * '$' is reserved for internal dataset names. e.g. "$MOS"
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Return 1 if the given name is used internally.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Return 0 if it is not.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrensint
fa9e4066f08beec538e775443c5be79dd423fcabahrensdataset_name_hidden(const char *name)
fa9e4066f08beec538e775443c5be79dd423fcabahrens{
fa9e4066f08beec538e775443c5be79dd423fcabahrens if (strchr(name, '$') != NULL)
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (1);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens return (0);
fa9e4066f08beec538e775443c5be79dd423fcabahrens}