[mirror_ubuntu-eoan-kernel.git] / security / tomoyo / realpath.c

/*
 * security/tomoyo/realpath.c
 *
 * Copyright (C) 2005-2011  NTT DATA CORPORATION
 */

#include <linux/types.h>
#include <linux/mount.h>
#include <linux/mnt_namespace.h>
#include <linux/fs_struct.h>
#include <linux/magic.h>
#include <linux/slab.h>
#include <net/sock.h>
#include "common.h"
#include "../../fs/internal.h"

/**
 * tomoyo_encode2 - Encode binary string to ascii string.
 *
 * @str:     String in binary format.
 * @str_len: Size of @str in byte.
 *
 * Returns pointer to @str in ascii format on success, NULL otherwise.
 *
 * This function uses kzalloc(), so caller must kfree() if this function
 * didn't return NULL.
 */
char *tomoyo_encode2(const char *str, int str_len)
{
	int i;
	int len = 0;
	const char *p = str;
	char *cp;
	char *cp0;

	if (!p)
		return NULL;
	for (i = 0; i < str_len; i++) {
		const unsigned char c = p[i];

		if (c == '\\')
			len += 2;
		else if (c > ' ' && c < 127)
			len++;
		else
			len += 4;
	}
	len++;
	/* Reserve space for appending "/". */
	cp = kzalloc(len + 10, GFP_NOFS);
	if (!cp)
		return NULL;
	cp0 = cp;
	p = str;
	for (i = 0; i < str_len; i++) {
		const unsigned char c = p[i];

		if (c == '\\') {
			*cp++ = '\\';
			*cp++ = '\\';
		} else if (c > ' ' && c < 127) {
			*cp++ = c;
		} else {
			*cp++ = '\\';
			*cp++ = (c >> 6) + '0';
			*cp++ = ((c >> 3) & 7) + '0';
			*cp++ = (c & 7) + '0';
		}
	}
	return cp0;
}

/**
 * tomoyo_encode - Encode binary string to ascii string.
 *
 * @str: String in binary format.
 *
 * Returns pointer to @str in ascii format on success, NULL otherwise.
 *
 * This function uses kzalloc(), so caller must kfree() if this function
 * didn't return NULL.
 */
char *tomoyo_encode(const char *str)
{
	return str ? tomoyo_encode2(str, strlen(str)) : NULL;
}

/**
 * tomoyo_get_absolute_path - Get the path of a dentry but ignores chroot'ed root.
 *
 * @path:   Pointer to "struct path".
 * @buffer: Pointer to buffer to return value in.
 * @buflen: Sizeof @buffer.
 *
 * Returns the buffer on success, an error code otherwise.
 *
 * If dentry is a directory, trailing '/' is appended.
 */
static char *tomoyo_get_absolute_path(struct path *path, char * const buffer,
				      const int buflen)
{
	char *pos = ERR_PTR(-ENOMEM);
	if (buflen >= 256) {
		/* go to whatever namespace root we are under */
		pos = d_absolute_path(path, buffer, buflen - 1);
		if (!IS_ERR(pos) && *pos == '/' && pos[1]) {
			struct inode *inode = path->dentry->d_inode;
			if (inode && S_ISDIR(inode->i_mode)) {
				buffer[buflen - 2] = '/';
				buffer[buflen - 1] = '\0';
			}
		}
	}
	return pos;
}

/**
 * tomoyo_get_dentry_path - Get the path of a dentry.
 *
 * @dentry: Pointer to "struct dentry".
 * @buffer: Pointer to buffer to return value in.
 * @buflen: Sizeof @buffer.
 *
 * Returns the buffer on success, an error code otherwise.
 *
 * If dentry is a directory, trailing '/' is appended.
 */
static char *tomoyo_get_dentry_path(struct dentry *dentry, char * const buffer,
				    const int buflen)
{
	char *pos = ERR_PTR(-ENOMEM);
	if (buflen >= 256) {
		pos = dentry_path_raw(dentry, buffer, buflen - 1);
		if (!IS_ERR(pos) && *pos == '/' && pos[1]) {
			struct inode *inode = dentry->d_inode;
			if (inode && S_ISDIR(inode->i_mode)) {
				buffer[buflen - 2] = '/';
				buffer[buflen - 1] = '\0';
			}
		}
	}
	return pos;
}

/**
 * tomoyo_get_local_path - Get the path of a dentry.
 *
 * @dentry: Pointer to "struct dentry".
 * @buffer: Pointer to buffer to return value in.
 * @buflen: Sizeof @buffer.
 *
 * Returns the buffer on success, an error code otherwise.
 */
static char *tomoyo_get_local_path(struct dentry *dentry, char * const buffer,
				   const int buflen)
{
	struct super_block *sb = dentry->d_sb;
	char *pos = tomoyo_get_dentry_path(dentry, buffer, buflen);
	if (IS_ERR(pos))
		return pos;
	/* Convert from $PID to self if $PID is current thread. */
	if (sb->s_magic == PROC_SUPER_MAGIC && *pos == '/') {
		char *ep;
		const pid_t pid = (pid_t) simple_strtoul(pos + 1, &ep, 10);
		if (*ep == '/' && pid && pid ==
		    task_tgid_nr_ns(current, sb->s_fs_info)) {
			pos = ep - 5;
			if (pos < buffer)
				goto out;
			memmove(pos, "/self", 5);
		}
		goto prepend_filesystem_name;
	}
	/* Use filesystem name for unnamed devices. */
	if (!MAJOR(sb->s_dev))
		goto prepend_filesystem_name;
	{
		struct inode *inode = sb->s_root->d_inode;
		/*
		 * Use filesystem name if filesystem does not support rename()
		 * operation.
		 */
		if (inode->i_op && !inode->i_op->rename)
			goto prepend_filesystem_name;
	}
	/* Prepend device name. */
	{
		char name[64];
		int name_len;
		const dev_t dev = sb->s_dev;
		name[sizeof(name) - 1] = '\0';
		snprintf(name, sizeof(name) - 1, "dev(%u,%u):", MAJOR(dev),
			 MINOR(dev));
		name_len = strlen(name);
		pos -= name_len;
		if (pos < buffer)
			goto out;
		memmove(pos, name, name_len);
		return pos;
	}
	/* Prepend filesystem name. */
prepend_filesystem_name:
	{
		const char *name = sb->s_type->name;
		const int name_len = strlen(name);
		pos -= name_len + 1;
		if (pos < buffer)
			goto out;
		memmove(pos, name, name_len);
		pos[name_len] = ':';
	}
	return pos;
out:
	return ERR_PTR(-ENOMEM);
}

/**
 * tomoyo_get_socket_name - Get the name of a socket.
 *
 * @path:   Pointer to "struct path".
 * @buffer: Pointer to buffer to return value in.
 * @buflen: Sizeof @buffer.
 *
 * Returns the buffer.
 */
static char *tomoyo_get_socket_name(struct path *path, char * const buffer,
				    const int buflen)
{
	struct inode *inode = path->dentry->d_inode;
	struct socket *sock = inode ? SOCKET_I(inode) : NULL;
	struct sock *sk = sock ? sock->sk : NULL;
	if (sk) {
		snprintf(buffer, buflen, "socket:[family=%u:type=%u:"
			 "protocol=%u]", sk->sk_family, sk->sk_type,
			 sk->sk_protocol);
	} else {
		snprintf(buffer, buflen, "socket:[unknown]");
	}
	return buffer;
}

/**
 * tomoyo_realpath_from_path - Returns realpath(3) of the given pathname but ignores chroot'ed root.
 *
 * @path: Pointer to "struct path".
 *
 * Returns the realpath of the given @path on success, NULL otherwise.
 *
 * If dentry is a directory, trailing '/' is appended.
 * Characters out of 0x20 < c < 0x7F range are converted to
 * \ooo style octal string.
 * Character \ is converted to \\ string.
 *
 * These functions use kzalloc(), so the caller must call kfree()
 * if these functions didn't return NULL.
 */
char *tomoyo_realpath_from_path(struct path *path)
{
	char *buf = NULL;
	char *name = NULL;
	unsigned int buf_len = PAGE_SIZE / 2;
	struct dentry *dentry = path->dentry;
	struct super_block *sb;
	if (!dentry)
		return NULL;
	sb = dentry->d_sb;
	while (1) {
		char *pos;
		struct inode *inode;
		buf_len <<= 1;
		kfree(buf);
		buf = kmalloc(buf_len, GFP_NOFS);
		if (!buf)
			break;
		/* To make sure that pos is '\0' terminated. */
		buf[buf_len - 1] = '\0';
		/* Get better name for socket. */
		if (sb->s_magic == SOCKFS_MAGIC) {
			pos = tomoyo_get_socket_name(path, buf, buf_len - 1);
			goto encode;
		}
		/* For "pipe:[\$]". */
		if (dentry->d_op && dentry->d_op->d_dname) {
			pos = dentry->d_op->d_dname(dentry, buf, buf_len - 1);
			goto encode;
		}
		inode = sb->s_root->d_inode;
		/*
		 * Get local name for filesystems without rename() operation
		 * or dentry without vfsmount.
		 */
		if (!path->mnt || (inode->i_op && !inode->i_op->rename))
			pos = tomoyo_get_local_path(path->dentry, buf,
						    buf_len - 1);
		/* Get absolute name for the rest. */
		else {
			pos = tomoyo_get_absolute_path(path, buf, buf_len - 1);
			/*
			 * Fall back to local name if absolute name is not
			 * available.
			 */
			if (pos == ERR_PTR(-EINVAL))
				pos = tomoyo_get_local_path(path->dentry, buf,
							    buf_len - 1);
		}
encode:
		if (IS_ERR(pos))
			continue;
		name = tomoyo_encode(pos);
		break;
	}
	kfree(buf);
	if (!name)
		tomoyo_warn_oom(__func__);
	return name;
}

/**
 * tomoyo_realpath_nofollow - Get realpath of a pathname.
 *
 * @pathname: The pathname to solve.
 *
 * Returns the realpath of @pathname on success, NULL otherwise.
 */
char *tomoyo_realpath_nofollow(const char *pathname)
{
	struct path path;

	if (pathname && kern_path(pathname, 0, &path) == 0) {
		char *buf = tomoyo_realpath_from_path(&path);
		path_put(&path);
		return buf;
	}
	return NULL;
}
Commit	Line	Data
c73bd6d4 KT	1	/*
	2	* security/tomoyo/realpath.c
	3	*
0f2a55d5	4	* Copyright (C) 2005-2011 NTT DATA CORPORATION
c73bd6d4 KT	5	*/
	6
	7	#include <linux/types.h>
	8	#include <linux/mount.h>
	9	#include <linux/mnt_namespace.h>
5ad4e53b	10	#include <linux/fs_struct.h>
67fa4880	11	#include <linux/magic.h>
5a0e3ad6	12	#include <linux/slab.h>
c8c57e84	13	#include <net/sock.h>
c73bd6d4	14	#include "common.h"
da502956	15	#include "../../fs/internal.h"
c73bd6d4 KT	16
c73bd6d4 KT	17	/**
059d84db	18	* tomoyo_encode2 - Encode binary string to ascii string.
c73bd6d4	19	*
059d84db TH	20	* @str: String in binary format.
059d84db TH	21	* @str_len: Size of @str in byte.
c73bd6d4	22	*
c8c57e84 TH	23	* Returns pointer to @str in ascii format on success, NULL otherwise.
	24	*
	25	* This function uses kzalloc(), so caller must kfree() if this function
	26	* didn't return NULL.
c73bd6d4	27	*/
059d84db	28	char tomoyo_encode2(const char str, int str_len)
c73bd6d4	29	{
059d84db	30	int i;
c8c57e84 TH	31	int len = 0;
	32	const char *p = str;
	33	char *cp;
	34	char *cp0;
c73bd6d4	35
c8c57e84 TH	36	if (!p)
c8c57e84 TH	37	return NULL;
059d84db TH	38	for (i = 0; i < str_len; i++) {
	39	const unsigned char c = p[i];
	40
c8c57e84 TH	41	if (c == '\\')
	42	len += 2;
	43	else if (c > ' ' && c < 127)
	44	len++;
	45	else
	46	len += 4;
	47	}
	48	len++;
	49	/* Reserve space for appending "/". */
	50	cp = kzalloc(len + 10, GFP_NOFS);
	51	if (!cp)
	52	return NULL;
	53	cp0 = cp;
	54	p = str;
059d84db TH	55	for (i = 0; i < str_len; i++) {
059d84db TH	56	const unsigned char c = p[i];
c8c57e84 TH	57
	58	if (c == '\\') {
	59	*cp++ = '\\';
	60	*cp++ = '\\';
	61	} else if (c > ' ' && c < 127) {
	62	*cp++ = c;
	63	} else {
	64	*cp++ = '\\';
	65	*cp++ = (c >> 6) + '0';
	66	*cp++ = ((c >> 3) & 7) + '0';
	67	*cp++ = (c & 7) + '0';
c73bd6d4	68	}
c73bd6d4	69	}
c8c57e84	70	return cp0;
c73bd6d4 KT	71	}
c73bd6d4 KT	72
059d84db TH	73	/**
	74	* tomoyo_encode - Encode binary string to ascii string.
	75	*
	76	* @str: String in binary format.
	77	*
	78	* Returns pointer to @str in ascii format on success, NULL otherwise.
	79	*
	80	* This function uses kzalloc(), so caller must kfree() if this function
	81	* didn't return NULL.
	82	*/
	83	char tomoyo_encode(const char str)
	84	{
	85	return str ? tomoyo_encode2(str, strlen(str)) : NULL;
	86	}
	87
5625f2e3 TH	88	/**
	89	* tomoyo_get_absolute_path - Get the path of a dentry but ignores chroot'ed root.
	90	*
	91	* @path: Pointer to "struct path".
	92	* @buffer: Pointer to buffer to return value in.
	93	* @buflen: Sizeof @buffer.
	94	*
	95	* Returns the buffer on success, an error code otherwise.
	96	*
	97	* If dentry is a directory, trailing '/' is appended.
	98	*/
	99	static char tomoyo_get_absolute_path(struct path path, char * const buffer,
	100	const int buflen)
	101	{
	102	char *pos = ERR_PTR(-ENOMEM);
	103	if (buflen >= 256) {
5625f2e3	104	/* go to whatever namespace root we are under */
02125a82	105	pos = d_absolute_path(path, buffer, buflen - 1);
5625f2e3 TH	106	if (!IS_ERR(pos) && *pos == '/' && pos[1]) {
	107	struct inode *inode = path->dentry->d_inode;
	108	if (inode && S_ISDIR(inode->i_mode)) {
	109	buffer[buflen - 2] = '/';
	110	buffer[buflen - 1] = '\0';
	111	}
	112	}
	113	}
	114	return pos;
	115	}
	116
	117	/**
	118	* tomoyo_get_dentry_path - Get the path of a dentry.
	119	*
	120	* @dentry: Pointer to "struct dentry".
	121	* @buffer: Pointer to buffer to return value in.
	122	* @buflen: Sizeof @buffer.
	123	*
	124	* Returns the buffer on success, an error code otherwise.
	125	*
	126	* If dentry is a directory, trailing '/' is appended.
	127	*/
	128	static char tomoyo_get_dentry_path(struct dentry dentry, char * const buffer,
	129	const int buflen)
	130	{
	131	char *pos = ERR_PTR(-ENOMEM);
	132	if (buflen >= 256) {
	133	pos = dentry_path_raw(dentry, buffer, buflen - 1);
	134	if (!IS_ERR(pos) && *pos == '/' && pos[1]) {
	135	struct inode *inode = dentry->d_inode;
	136	if (inode && S_ISDIR(inode->i_mode)) {
	137	buffer[buflen - 2] = '/';
	138	buffer[buflen - 1] = '\0';
	139	}
	140	}
	141	}
	142	return pos;
	143	}
	144
	145	/**
	146	* tomoyo_get_local_path - Get the path of a dentry.
	147	*
	148	* @dentry: Pointer to "struct dentry".
	149	* @buffer: Pointer to buffer to return value in.
	150	* @buflen: Sizeof @buffer.
	151	*
	152	* Returns the buffer on success, an error code otherwise.
	153	*/
	154	static char tomoyo_get_local_path(struct dentry dentry, char * const buffer,
	155	const int buflen)
	156	{
	157	struct super_block *sb = dentry->d_sb;
	158	char *pos = tomoyo_get_dentry_path(dentry, buffer, buflen);
	159	if (IS_ERR(pos))
	160	return pos;
	161	/* Convert from $PID to self if $PID is current thread. */
	162	if (sb->s_magic == PROC_SUPER_MAGIC && *pos == '/') {
	163	char *ep;
	164	const pid_t pid = (pid_t) simple_strtoul(pos + 1, &ep, 10);
	165	if (*ep == '/' && pid && pid ==
	166	task_tgid_nr_ns(current, sb->s_fs_info)) {
	167	pos = ep - 5;
	168	if (pos < buffer)
	169	goto out;
170	memmove(pos, "/self", 5);
171	}
172	goto prepend_filesystem_name;
173	}
174	/* Use filesystem name for unnamed devices. */
175	if (!MAJOR(sb->s_dev))
176	goto prepend_filesystem_name;
177	{
178	struct inode *inode = sb->s_root->d_inode;
179	/*
180	* Use filesystem name if filesystem does not support rename()
181	* operation.
182	*/
183	if (inode->i_op && !inode->i_op->rename)
184	goto prepend_filesystem_name;
185	}
186	/* Prepend device name. */
187	{
188	char name[64];
189	int name_len;
190	const dev_t dev = sb->s_dev;
191	name[sizeof(name) - 1] = '\0';
192	snprintf(name, sizeof(name) - 1, "dev(%u,%u):", MAJOR(dev),
193	MINOR(dev));
194	name_len = strlen(name);
195	pos -= name_len;
196	if (pos < buffer)
197	goto out;
198	memmove(pos, name, name_len);
199	return pos;
200	}
201	/* Prepend filesystem name. */
202	prepend_filesystem_name:
203	{
204	const char *name = sb->s_type->name;
205	const int name_len = strlen(name);
206	pos -= name_len + 1;
207	if (pos < buffer)
208	goto out;
209	memmove(pos, name, name_len);
210	pos[name_len] = ':';
211	}
212	return pos;
213	out:
214	return ERR_PTR(-ENOMEM);
215	}
216
217	/**
218	* tomoyo_get_socket_name - Get the name of a socket.
219	*
220	* @path: Pointer to "struct path".
221	* @buffer: Pointer to buffer to return value in.
222	* @buflen: Sizeof @buffer.
223	*
224	* Returns the buffer.
225	*/
226	static char tomoyo_get_socket_name(struct path path, char * const buffer,
227	const int buflen)
228	{
229	struct inode *inode = path->dentry->d_inode;
230	struct socket *sock = inode ? SOCKET_I(inode) : NULL;
231	struct sock *sk = sock ? sock->sk : NULL;
232	if (sk) {
233	snprintf(buffer, buflen, "socket:[family=%u:type=%u:"
234	"protocol=%u]", sk->sk_family, sk->sk_type,
235	sk->sk_protocol);
236	} else {
237	snprintf(buffer, buflen, "socket:[unknown]");
238	}
239	return buffer;
240	}
241
c73bd6d4	242	/**
c8c57e84	243	* tomoyo_realpath_from_path - Returns realpath(3) of the given pathname but ignores chroot'ed root.
c73bd6d4	244	*
c8c57e84	245	* @path: Pointer to "struct path".
c73bd6d4	246	*
c8c57e84	247	* Returns the realpath of the given @path on success, NULL otherwise.
c73bd6d4 KT	248	*
	249	* If dentry is a directory, trailing '/' is appended.
	250	* Characters out of 0x20 < c < 0x7F range are converted to
	251	* \ooo style octal string.
	252	* Character \ is converted to \\ string.
c8c57e84 TH	253	*
	254	* These functions use kzalloc(), so the caller must call kfree()
	255	* if these functions didn't return NULL.
c73bd6d4	256	*/
c8c57e84	257	char tomoyo_realpath_from_path(struct path path)
c73bd6d4	258	{
c8c57e84 TH	259	char *buf = NULL;
	260	char *name = NULL;
	261	unsigned int buf_len = PAGE_SIZE / 2;
c73bd6d4	262	struct dentry *dentry = path->dentry;
5625f2e3	263	struct super_block *sb;
c8c57e84 TH	264	if (!dentry)
c8c57e84 TH	265	return NULL;
5625f2e3	266	sb = dentry->d_sb;
c8c57e84	267	while (1) {
c8c57e84	268	char *pos;
5625f2e3	269	struct inode *inode;
c8c57e84 TH	270	buf_len <<= 1;
	271	kfree(buf);
	272	buf = kmalloc(buf_len, GFP_NOFS);
	273	if (!buf)
	274	break;
5625f2e3 TH	275	/* To make sure that pos is '\0' terminated. */
5625f2e3 TH	276	buf[buf_len - 1] = '\0';
c8c57e84	277	/* Get better name for socket. */
5625f2e3 TH	278	if (sb->s_magic == SOCKFS_MAGIC) {
	279	pos = tomoyo_get_socket_name(path, buf, buf_len - 1);
	280	goto encode;
c8c57e84	281	}
5625f2e3	282	/* For "pipe:[\$]". */
c8c57e84 TH	283	if (dentry->d_op && dentry->d_op->d_dname) {
c8c57e84 TH	284	pos = dentry->d_op->d_dname(dentry, buf, buf_len - 1);
5625f2e3	285	goto encode;
c73bd6d4	286	}
5625f2e3 TH	287	inode = sb->s_root->d_inode;
	288	/*
	289	* Get local name for filesystems without rename() operation
	290	* or dentry without vfsmount.
	291	*/
	292	if (!path->mnt \|\| (inode->i_op && !inode->i_op->rename))
	293	pos = tomoyo_get_local_path(path->dentry, buf,
	294	buf_len - 1);
	295	/* Get absolute name for the rest. */
1418a3e5	296	else {
5625f2e3	297	pos = tomoyo_get_absolute_path(path, buf, buf_len - 1);
1418a3e5 TH	298	/*
	299	* Fall back to local name if absolute name is not
	300	* available.
	301	*/
	302	if (pos == ERR_PTR(-EINVAL))
	303	pos = tomoyo_get_local_path(path->dentry, buf,
	304	buf_len - 1);
	305	}
5625f2e3	306	encode:
c8c57e84 TH	307	if (IS_ERR(pos))
	308	continue;
	309	name = tomoyo_encode(pos);
	310	break;
c73bd6d4	311	}
8e2d39a1	312	kfree(buf);
c8c57e84 TH	313	if (!name)
c8c57e84 TH	314	tomoyo_warn_oom(__func__);
c8c57e84	315	return name;
c73bd6d4 KT	316	}
c73bd6d4 KT	317
c73bd6d4 KT	318	/**
	319	* tomoyo_realpath_nofollow - Get realpath of a pathname.
	320	*
	321	* @pathname: The pathname to solve.
	322	*
	323	* Returns the realpath of @pathname on success, NULL otherwise.
	324	*/
	325	char tomoyo_realpath_nofollow(const char pathname)
	326	{
e24977d4	327	struct path path;
c73bd6d4	328
e24977d4 AV	329	if (pathname && kern_path(pathname, 0, &path) == 0) {
	330	char *buf = tomoyo_realpath_from_path(&path);
	331	path_put(&path);
c73bd6d4 KT	332	return buf;
	333	}
	334	return NULL;
	335	}