From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
	id S966579AbcDLVYz (ORCPT <rfc822;w@1wt.eu>);
	Tue, 12 Apr 2016 17:24:55 -0400
Received: from h2.hallyn.com ([78.46.35.8]:33310 "EHLO h2.hallyn.com"
	rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP
	id S965635AbcDLVYx (ORCPT <rfc822;linux-kernel@vger.kernel.org>);
	Tue, 12 Apr 2016 17:24:53 -0400
Date: Tue, 12 Apr 2016 16:24:45 -0500
From: "Serge E. Hallyn" <serge@hallyn.com>
To: Kees Cook <keescook@chromium.org>
Cc: James Morris <jmorris@namei.org>, Joe Perches <joe@perches.com>,
        Mimi Zohar <zohar@linux.vnet.ibm.com>,
        Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
        Andrew Morton <akpm@linux-foundation.org>,
        "Serge E. Hallyn" <serge@hallyn.com>, Jonathan Corbet <corbet@lwn.net>,
        Kalle Valo <kvalo@codeaurora.org>,
        Mauro Carvalho Chehab <mchehab@osg.samsung.com>,
        Guenter Roeck <linux@roeck-us.net>, Jiri Slaby <jslaby@suse.com>,
        Paul Moore <pmoore@redhat.com>, Stephen Smalley <sds@tycho.nsa.gov>,
        Casey Schaufler <casey@schaufler-ca.com>,
        Andreas Gruenbacher <agruenba@redhat.com>,
        Rasmus Villemoes <linux@rasmusvillemoes.dk>,
        Ulf Hansson <ulf.hansson@linaro.org>,
        Vitaly Kuznetsov <vkuznets@redhat.com>,
        linux-security-module@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-doc@vger.kernel.org
Subject: Re: [PATCH v4 3/6] string_helpers: add kstrdup_quotable_file
Message-ID: <20160412212445.GC12324@mail.hallyn.com>
References: <1460480085-32263-1-git-send-email-keescook@chromium.org>
 <1460480085-32263-4-git-send-email-keescook@chromium.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1460480085-32263-4-git-send-email-keescook@chromium.org>
User-Agent: Mutt/1.5.21 (2010-09-15)
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Quoting Kees Cook (keescook@chromium.org):
> Allocate a NULL-terminated file path with special characters escaped,
> safe for logging.
> 
> Signed-off-by: Kees Cook <keescook@chromium.org>

Acked-by: Serge Hallyn <serge.hallyn@canonical.com>

> ---
>  include/linux/string_helpers.h |  3 +++
>  lib/string_helpers.c           | 30 ++++++++++++++++++++++++++++++
>  2 files changed, 33 insertions(+)
> 
> diff --git a/include/linux/string_helpers.h b/include/linux/string_helpers.h
> index 684d2695fc36..5ce9538f290e 100644
> --- a/include/linux/string_helpers.h
> +++ b/include/linux/string_helpers.h
> @@ -3,6 +3,8 @@
>  
>  #include <linux/types.h>
>  
> +struct file;
> +
>  /* Descriptions of the types of units to
>   * print in */
>  enum string_size_units {
> @@ -70,5 +72,6 @@ static inline int string_escape_str_any_np(const char *src, char *dst,
>  
>  char *kstrdup_quotable(const char *src, gfp_t gfp);
>  char *kstrdup_quotable_cmdline(struct task_struct *task, gfp_t gfp);
> +char *kstrdup_quotable_file(struct file *file, gfp_t gfp);
>  
>  #endif
> diff --git a/lib/string_helpers.c b/lib/string_helpers.c
> index b16ee85aaf87..ecaac2c0526f 100644
> --- a/lib/string_helpers.c
> +++ b/lib/string_helpers.c
> @@ -10,6 +10,8 @@
>  #include <linux/export.h>
>  #include <linux/ctype.h>
>  #include <linux/errno.h>
> +#include <linux/fs.h>
> +#include <linux/limits.h>
>  #include <linux/mm.h>
>  #include <linux/slab.h>
>  #include <linux/string.h>
> @@ -596,3 +598,31 @@ char *kstrdup_quotable_cmdline(struct task_struct *task, gfp_t gfp)
>  	return quoted;
>  }
>  EXPORT_SYMBOL_GPL(kstrdup_quotable_cmdline);
> +
> +/*
> + * Returns allocated NULL-terminated string containing pathname,
> + * with special characters escaped, able to be safely logged. If
> + * there is an error, the leading character will be "<".
> + */
> +char *kstrdup_quotable_file(struct file *file, gfp_t gfp)
> +{
> +	char *temp, *pathname;
> +
> +	if (!file)
> +		return kstrdup("<unknown>", gfp);
> +
> +	/* We add 11 spaces for ' (deleted)' to be appended */
> +	temp = kmalloc(PATH_MAX + 11, GFP_TEMPORARY);
> +	if (!temp)
> +		return kstrdup("<no_memory>", gfp);
> +
> +	pathname = file_path(file, temp, PATH_MAX + 11);
> +	if (IS_ERR(pathname))
> +		pathname = kstrdup("<too_long>", gfp);
> +	else
> +		pathname = kstrdup_quotable(pathname, gfp);
> +
> +	kfree(temp);
> +	return pathname;
> +}
> +EXPORT_SYMBOL_GPL(kstrdup_quotable_file);
> -- 
> 2.6.3