xref: /dflybsd-src/lib/libc/stdlib/realpath.c (revision 66546629446c1c63ff8423d7e5484fc1365c9590)
1 /*
2  * Copyright (c) 2003 Constantin S. Svintsoff <kostik@iclub.nsu.ru>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  * 3. The names of the authors may not be used to endorse or promote
13  *    products derived from this software without specific prior written
14  *    permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * @(#)realpath.c	8.1 (Berkeley) 2/16/94
29  * $FreeBSD: src/lib/libc/stdlib/realpath.c,v 1.20 2003/05/28 08:23:01 fjoe Exp $
30  * $DragonFly: src/lib/libc/stdlib/realpath.c,v 1.4 2005/04/28 13:47:15 joerg Exp $
31  */
32 
33 #include "namespace.h"
34 #include <sys/param.h>
35 #include <sys/stat.h>
36 
37 #include <errno.h>
38 #include <stdlib.h>
39 #include <string.h>
40 #include <unistd.h>
41 #include "un-namespace.h"
42 
43 /*
44  * char *realpath(const char *path, char resolved[PATH_MAX]);
45  *
46  * Find the real name of path, by removing all ".", ".." and symlink
47  * components.  Returns (resolved) on success, or (NULL) on failure,
48  * in which case the path which caused trouble is left in (resolved).
49  */
50 char *
51 realpath(const char *path, char resolved[PATH_MAX])
52 {
53 	struct stat sb;
54 	char *p, *q, *s;
55 	size_t left_len, resolved_len;
56 	unsigned symlinks;
57 	int serrno, slen;
58 	char left[PATH_MAX], next_token[PATH_MAX], my_symlink[PATH_MAX];
59 
60 	serrno = errno;
61 	symlinks = 0;
62 	if (path == NULL) {
63 		errno = EINVAL;
64 		return (NULL);
65 	}
66 	if (path[0] == '\0') {
67 		errno = ENOENT;
68 		return (NULL);
69 	}
70 	else if (path[0] == '/') {
71 		resolved[0] = '/';
72 		resolved[1] = '\0';
73 		if (path[1] == '\0')
74 			return (resolved);
75 		resolved_len = 1;
76 		left_len = strlcpy(left, path + 1, sizeof(left));
77 	} else {
78 		if (getcwd(resolved, PATH_MAX) == NULL) {
79 			strlcpy(resolved, ".", PATH_MAX);
80 			return (NULL);
81 		}
82 		resolved_len = strlen(resolved);
83 		left_len = strlcpy(left, path, sizeof(left));
84 	}
85 	if (left_len >= sizeof(left) || resolved_len >= PATH_MAX) {
86 		errno = ENAMETOOLONG;
87 		return (NULL);
88 	}
89 
90 	/*
91 	 * Iterate over path components in `left'.
92 	 */
93 	while (left_len != 0) {
94 		/*
95 		 * Extract the next path component and adjust `left'
96 		 * and its length.
97 		 */
98 		p = strchr(left, '/');
99 		s = p ? p : left + left_len;
100 		if (s >= left + sizeof(next_token)) {
101 			errno = ENAMETOOLONG;
102 			return (NULL);
103 		}
104 		memcpy(next_token, left, s - left);
105 		next_token[s - left] = '\0';
106 		left_len -= s - left;
107 		if (p != NULL)
108 			memmove(left, s + 1, left_len + 1);
109 		if (resolved[resolved_len - 1] != '/') {
110 			if (resolved_len + 1 >= PATH_MAX) {
111 				errno = ENAMETOOLONG;
112 				return (NULL);
113 			}
114 			resolved[resolved_len++] = '/';
115 			resolved[resolved_len] = '\0';
116 		}
117 		if (next_token[0] == '\0')
118 			continue;
119 		else if (strcmp(next_token, ".") == 0)
120 			continue;
121 		else if (strcmp(next_token, "..") == 0) {
122 			/*
123 			 * Strip the last path component except when we have
124 			 * single "/"
125 			 */
126 			if (resolved_len > 1) {
127 				resolved[resolved_len - 1] = '\0';
128 				q = strrchr(resolved, '/') + 1;
129 				*q = '\0';
130 				resolved_len = q - resolved;
131 			}
132 			continue;
133 		}
134 
135 		/*
136 		 * Append the next path component and lstat() it. If
137 		 * lstat() fails we still can return successfully if
138 		 * there are no more path components left.
139 		 */
140 		resolved_len = strlcat(resolved, next_token, PATH_MAX);
141 		if (resolved_len >= PATH_MAX) {
142 			errno = ENAMETOOLONG;
143 			return (NULL);
144 		}
145 		if (lstat(resolved, &sb) != 0) {
146 			if (errno == ENOENT && p == NULL) {
147 				errno = serrno;
148 				return (resolved);
149 			}
150 			return (NULL);
151 		}
152 		if (S_ISLNK(sb.st_mode)) {
153 			if (symlinks++ > MAXSYMLINKS) {
154 				errno = ELOOP;
155 				return (NULL);
156 			}
157 			slen = readlink(resolved, my_symlink, sizeof(my_symlink) - 1);
158 			if (slen < 0)
159 				return (NULL);
160 			my_symlink[slen] = '\0';
161 			if (my_symlink[0] == '/') {
162 				resolved[1] = 0;
163 				resolved_len = 1;
164 			} else if (resolved_len > 1) {
165 				/* Strip the last path component. */
166 				resolved[resolved_len - 1] = '\0';
167 				q = strrchr(resolved, '/') + 1;
168 				*q = '\0';
169 				resolved_len = q - resolved;
170 			}
171 
172 			/*
173 			 * If there are any path components left, then
174 			 * append them to symlink. The result is placed
175 			 * in `left'.
176 			 */
177 			if (p != NULL) {
178 				if (my_symlink[slen - 1] != '/') {
179 					if (slen + 1 >= (int)sizeof(my_symlink)) {
180 						errno = ENAMETOOLONG;
181 						return (NULL);
182 					}
183 					my_symlink[slen] = '/';
184 					my_symlink[slen + 1] = 0;
185 				}
186 				left_len = strlcat(my_symlink, left, sizeof(left));
187 				if (left_len >= sizeof(left)) {
188 					errno = ENAMETOOLONG;
189 					return (NULL);
190 				}
191 			}
192 			left_len = strlcpy(left, my_symlink, sizeof(left));
193 		}
194 	}
195 
196 	/*
197 	 * Remove trailing slash except when the resolved pathname
198 	 * is a single "/".
199 	 */
200 	if (resolved_len > 1 && resolved[resolved_len - 1] == '/')
201 		resolved[resolved_len - 1] = '\0';
202 	return (resolved);
203 }
204