xref: /freebsd/lib/libc/stdlib/realpath.c (revision 884a2a699669ec61e2366e3e358342dbc94be24a)
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 
29 #if defined(LIBC_SCCS) && !defined(lint)
30 static char sccsid[] = "@(#)realpath.c	8.1 (Berkeley) 2/16/94";
31 #endif /* LIBC_SCCS and not lint */
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34 
35 #include "namespace.h"
36 #include <sys/param.h>
37 #include <sys/stat.h>
38 
39 #include <errno.h>
40 #include <stdlib.h>
41 #include <string.h>
42 #include <unistd.h>
43 #include "un-namespace.h"
44 
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 * __restrict path, char * __restrict resolved)
52 {
53 	struct stat sb;
54 	char *p, *q, *s;
55 	size_t left_len, resolved_len;
56 	unsigned symlinks;
57 	int m, serrno, slen;
58 	char left[PATH_MAX], next_token[PATH_MAX], symlink[PATH_MAX];
59 
60 	if (path == NULL) {
61 		errno = EINVAL;
62 		return (NULL);
63 	}
64 	if (path[0] == '\0') {
65 		errno = ENOENT;
66 		return (NULL);
67 	}
68 	serrno = errno;
69 	if (resolved == NULL) {
70 		resolved = malloc(PATH_MAX);
71 		if (resolved == NULL)
72 			return (NULL);
73 		m = 1;
74 	} else
75 		m = 0;
76 	symlinks = 0;
77 	if (path[0] == '/') {
78 		resolved[0] = '/';
79 		resolved[1] = '\0';
80 		if (path[1] == '\0')
81 			return (resolved);
82 		resolved_len = 1;
83 		left_len = strlcpy(left, path + 1, sizeof(left));
84 	} else {
85 		if (getcwd(resolved, PATH_MAX) == NULL) {
86 			if (m)
87 				free(resolved);
88 			else {
89 				resolved[0] = '.';
90 				resolved[1] = '\0';
91 			}
92 			return (NULL);
93 		}
94 		resolved_len = strlen(resolved);
95 		left_len = strlcpy(left, path, sizeof(left));
96 	}
97 	if (left_len >= sizeof(left) || resolved_len >= PATH_MAX) {
98 		if (m)
99 			free(resolved);
100 		errno = ENAMETOOLONG;
101 		return (NULL);
102 	}
103 
104 	/*
105 	 * Iterate over path components in `left'.
106 	 */
107 	while (left_len != 0) {
108 		/*
109 		 * Extract the next path component and adjust `left'
110 		 * and its length.
111 		 */
112 		p = strchr(left, '/');
113 		s = p ? p : left + left_len;
114 		if (s - left >= sizeof(next_token)) {
115 			if (m)
116 				free(resolved);
117 			errno = ENAMETOOLONG;
118 			return (NULL);
119 		}
120 		memcpy(next_token, left, s - left);
121 		next_token[s - left] = '\0';
122 		left_len -= s - left;
123 		if (p != NULL)
124 			memmove(left, s + 1, left_len + 1);
125 		if (resolved[resolved_len - 1] != '/') {
126 			if (resolved_len + 1 >= PATH_MAX) {
127 				if (m)
128 					free(resolved);
129 				errno = ENAMETOOLONG;
130 				return (NULL);
131 			}
132 			resolved[resolved_len++] = '/';
133 			resolved[resolved_len] = '\0';
134 		}
135 		if (next_token[0] == '\0')
136 			continue;
137 		else if (strcmp(next_token, ".") == 0)
138 			continue;
139 		else if (strcmp(next_token, "..") == 0) {
140 			/*
141 			 * Strip the last path component except when we have
142 			 * single "/"
143 			 */
144 			if (resolved_len > 1) {
145 				resolved[resolved_len - 1] = '\0';
146 				q = strrchr(resolved, '/') + 1;
147 				*q = '\0';
148 				resolved_len = q - resolved;
149 			}
150 			continue;
151 		}
152 
153 		/*
154 		 * Append the next path component and lstat() it. If
155 		 * lstat() fails we still can return successfully if
156 		 * there are no more path components left.
157 		 */
158 		resolved_len = strlcat(resolved, next_token, PATH_MAX);
159 		if (resolved_len >= PATH_MAX) {
160 			if (m)
161 				free(resolved);
162 			errno = ENAMETOOLONG;
163 			return (NULL);
164 		}
165 		if (lstat(resolved, &sb) != 0) {
166 			if (errno == ENOENT && p == NULL) {
167 				errno = serrno;
168 				return (resolved);
169 			}
170 			if (m)
171 				free(resolved);
172 			return (NULL);
173 		}
174 		if (S_ISLNK(sb.st_mode)) {
175 			if (symlinks++ > MAXSYMLINKS) {
176 				if (m)
177 					free(resolved);
178 				errno = ELOOP;
179 				return (NULL);
180 			}
181 			slen = readlink(resolved, symlink, sizeof(symlink) - 1);
182 			if (slen < 0) {
183 				if (m)
184 					free(resolved);
185 				return (NULL);
186 			}
187 			symlink[slen] = '\0';
188 			if (symlink[0] == '/') {
189 				resolved[1] = 0;
190 				resolved_len = 1;
191 			} else if (resolved_len > 1) {
192 				/* Strip the last path component. */
193 				resolved[resolved_len - 1] = '\0';
194 				q = strrchr(resolved, '/') + 1;
195 				*q = '\0';
196 				resolved_len = q - resolved;
197 			}
198 
199 			/*
200 			 * If there are any path components left, then
201 			 * append them to symlink. The result is placed
202 			 * in `left'.
203 			 */
204 			if (p != NULL) {
205 				if (symlink[slen - 1] != '/') {
206 					if (slen + 1 >= sizeof(symlink)) {
207 						if (m)
208 							free(resolved);
209 						errno = ENAMETOOLONG;
210 						return (NULL);
211 					}
212 					symlink[slen] = '/';
213 					symlink[slen + 1] = 0;
214 				}
215 				left_len = strlcat(symlink, left, sizeof(left));
216 				if (left_len >= sizeof(left)) {
217 					if (m)
218 						free(resolved);
219 					errno = ENAMETOOLONG;
220 					return (NULL);
221 				}
222 			}
223 			left_len = strlcpy(left, symlink, sizeof(left));
224 		}
225 	}
226 
227 	/*
228 	 * Remove trailing slash except when the resolved pathname
229 	 * is a single "/".
230 	 */
231 	if (resolved_len > 1 && resolved[resolved_len - 1] == '/')
232 		resolved[resolved_len - 1] = '\0';
233 	return (resolved);
234 }
235