annotate tests/test-dirent-safer.c @ 11936:a126d5b22410

dirent-safer: new module * modules/dirent-safer: New file. * lib/dirent--.h: Likewise. * lib/dirent-safer.h: Likewise. * lib/opendir-safer.c: Likewise. * m4/dirent-safer.m4: Likewise. * MODULES.html.sh (Enhancements for POSIX:2008): Mention it. * modules/dirent-safer-tests: New test. * tests/test-dirent-safer.c: New file. * lib/fdopendir.c (includes): Ensure fdopendir is also safe. Signed-off-by: Eric Blake <ebb9@byu.net>
author Eric Blake <ebb9@byu.net>
date Tue, 01 Sep 2009 07:41:28 -0600
parents
children e45d9bb2233e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11936
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
1 /* Test that directory streams leave standard fds alone.
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
2 Copyright (C) 2009 Free Software Foundation, Inc.
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
3
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
4 This program is free software: you can redistribute it and/or modify
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
6 the Free Software Foundation; either version 3 of the License, or
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
7 (at your option) any later version.
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
8
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
12 GNU General Public License for more details.
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
13
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
14 You should have received a copy of the GNU General Public License
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
16
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
17 /* Written by Eric Blake <ebb9@byu.net>, 2009. */
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
18
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
19 #include <config.h>
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
20
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
21 #include "dirent--.h"
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
22
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
23 #include <errno.h>
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
24 #include <fcntl.h>
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
25 #include <stdio.h>
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
26 #include <stdlib.h>
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
27 #include <unistd.h>
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
28
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
29 #include "unistd-safer.h"
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
30
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
31 /* This test intentionally closes stderr. So, we arrange to have fd 10
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
32 (outside the range of interesting fd's during the test) set up to
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
33 duplicate the original stderr. */
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
34
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
35 #define BACKUP_STDERR_FILENO 10
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
36 static FILE *myerr;
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
37
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
38 #define ASSERT(expr) \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
39 do \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
40 { \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
41 if (!(expr)) \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
42 { \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
43 fprintf (myerr, "%s:%d: assertion failed\n", __FILE__, __LINE__); \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
44 fflush (myerr); \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
45 abort (); \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
46 } \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
47 } \
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
48 while (0)
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
49
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
50 int
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
51 main ()
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
52 {
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
53 int i;
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
54 DIR *dp;
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
55 /* The dirent-safer module works without the use of fdopendir (which
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
56 would also pull in fchdir and openat); but if those modules were
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
57 also used, we ensure that they are safe. In particular, the
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
58 gnulib version of fdopendir is unable to guarantee that
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
59 dirfd(fdopendir(fd))==fd, but we can at least guarantee that if
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
60 they are not equal, the fd returned by dirfd is safe. */
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
61 #if HAVE_FDOPENDIR || GNULIB_FDOPENDIR
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
62 int dfd;
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
63 #endif
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
64
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
65 /* We close fd 2 later, so save it in fd 10. */
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
66 if (dup2 (STDERR_FILENO, BACKUP_STDERR_FILENO) != BACKUP_STDERR_FILENO
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
67 || (myerr = fdopen (BACKUP_STDERR_FILENO, "w")) == NULL)
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
68 return 2;
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
69
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
70 #if HAVE_FDOPENDIR || GNULIB_FDOPENDIR
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
71 dfd = open (".", O_RDONLY);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
72 ASSERT (STDERR_FILENO < dfd);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
73 #endif
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
74
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
75 /* Four iterations, with progressively more standard descriptors
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
76 closed. */
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
77 for (i = -1; i <= STDERR_FILENO; i++)
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
78 {
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
79 if (0 <= i)
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
80 ASSERT (close (i) == 0);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
81 dp = opendir (".");
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
82 ASSERT (dp);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
83 ASSERT (dirfd (dp) == -1 || STDERR_FILENO < dirfd (dp));
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
84 ASSERT (closedir (dp) == 0);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
85
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
86 #if HAVE_FDOPENDIR || GNULIB_FDOPENDIR
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
87 {
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
88 int fd = dup_safer (dfd);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
89 ASSERT (STDERR_FILENO < fd);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
90 dp = fdopendir (fd);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
91 ASSERT (dp);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
92 ASSERT (dirfd (dp) == -1 || STDERR_FILENO < dirfd (dp));
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
93 ASSERT (closedir (dp) == 0);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
94 errno = 0;
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
95 ASSERT (close (fd) == -1);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
96 ASSERT (errno == EBADF);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
97 }
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
98 #endif
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
99 }
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
100
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
101 #if HAVE_FDOPENDIR || GNULIB_FDOPENDIR
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
102 ASSERT (close (dfd) == 0);
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
103 #endif
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
104
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
105 return 0;
a126d5b22410 dirent-safer: new module
Eric Blake <ebb9@byu.net>
parents:
diff changeset
106 }