rm.c revision 1.46 1 /* $NetBSD: rm.c,v 1.46 2007/06/24 17:59:31 christos Exp $ */
2
3 /*-
4 * Copyright (c) 1990, 1993, 1994, 2003
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32 #include <sys/cdefs.h>
33 #ifndef lint
34 __COPYRIGHT("@(#) Copyright (c) 1990, 1993, 1994\n\
35 The Regents of the University of California. All rights reserved.\n");
36 #endif /* not lint */
37
38 #ifndef lint
39 #if 0
40 static char sccsid[] = "@(#)rm.c 8.8 (Berkeley) 4/27/95";
41 #else
42 __RCSID("$NetBSD: rm.c,v 1.46 2007/06/24 17:59:31 christos Exp $");
43 #endif
44 #endif /* not lint */
45
46 #include <sys/param.h>
47 #include <sys/stat.h>
48 #include <sys/types.h>
49
50 #include <err.h>
51 #include <errno.h>
52 #include <fcntl.h>
53 #include <fts.h>
54 #include <grp.h>
55 #include <locale.h>
56 #include <pwd.h>
57 #include <stdio.h>
58 #include <stdlib.h>
59 #include <string.h>
60 #include <unistd.h>
61
62 int dflag, eval, fflag, iflag, Pflag, stdin_ok, vflag, Wflag;
63
64 int check(char *, char *, struct stat *);
65 void checkdot(char **);
66 void rm_file(char **);
67 int rm_overwrite(char *, struct stat *);
68 void rm_tree(char **);
69 void usage(void);
70 int main(int, char *[]);
71
72 /*
73 * For the sake of the `-f' flag, check whether an error number indicates the
74 * failure of an operation due to an non-existent file, either per se (ENOENT)
75 * or because its filename argument was illegal (ENAMETOOLONG, ENOTDIR).
76 */
77 #define NONEXISTENT(x) \
78 ((x) == ENOENT || (x) == ENAMETOOLONG || (x) == ENOTDIR)
79
80 /*
81 * rm --
82 * This rm is different from historic rm's, but is expected to match
83 * POSIX 1003.2 behavior. The most visible difference is that -f
84 * has two specific effects now, ignore non-existent files and force
85 * file removal.
86 */
87 int
88 main(int argc, char *argv[])
89 {
90 int ch, rflag;
91
92 setprogname(argv[0]);
93 (void)setlocale(LC_ALL, "");
94
95 Pflag = rflag = 0;
96 while ((ch = getopt(argc, argv, "dfiPRrvW")) != -1)
97 switch (ch) {
98 case 'd':
99 dflag = 1;
100 break;
101 case 'f':
102 fflag = 1;
103 iflag = 0;
104 break;
105 case 'i':
106 fflag = 0;
107 iflag = 1;
108 break;
109 case 'P':
110 Pflag = 1;
111 break;
112 case 'R':
113 case 'r': /* Compatibility. */
114 rflag = 1;
115 break;
116 case 'v':
117 vflag = 1;
118 break;
119 case 'W':
120 Wflag = 1;
121 break;
122 case '?':
123 default:
124 usage();
125 }
126 argc -= optind;
127 argv += optind;
128
129 if (argc < 1)
130 usage();
131
132 checkdot(argv);
133
134 if (*argv) {
135 stdin_ok = isatty(STDIN_FILENO);
136
137 if (rflag)
138 rm_tree(argv);
139 else
140 rm_file(argv);
141 }
142
143 exit(eval);
144 /* NOTREACHED */
145 }
146
147 void
148 rm_tree(char **argv)
149 {
150 FTS *fts;
151 FTSENT *p;
152 int flags, needstat, rval;
153
154 /*
155 * Remove a file hierarchy. If forcing removal (-f), or interactive
156 * (-i) or can't ask anyway (stdin_ok), don't stat the file.
157 */
158 needstat = !fflag && !iflag && stdin_ok;
159
160 /*
161 * If the -i option is specified, the user can skip on the pre-order
162 * visit. The fts_number field flags skipped directories.
163 */
164 #define SKIPPED 1
165
166 flags = FTS_PHYSICAL;
167 if (!needstat)
168 flags |= FTS_NOSTAT;
169 if (Wflag)
170 flags |= FTS_WHITEOUT;
171 if (!(fts = fts_open(argv, flags,
172 (int (*)(const FTSENT **, const FTSENT **))NULL)))
173 err(1, NULL);
174 while ((p = fts_read(fts)) != NULL) {
175
176 switch (p->fts_info) {
177 case FTS_DNR:
178 if (!fflag || p->fts_errno != ENOENT) {
179 warnx("%s: %s", p->fts_path,
180 strerror(p->fts_errno));
181 eval = 1;
182 }
183 continue;
184 case FTS_ERR:
185 errx(EXIT_FAILURE, "%s: %s", p->fts_path,
186 strerror(p->fts_errno));
187 /* NOTREACHED */
188 case FTS_NS:
189 /*
190 * FTS_NS: assume that if can't stat the file, it
191 * can't be unlinked.
192 */
193 if (fflag && NONEXISTENT(p->fts_errno))
194 continue;
195 if (needstat) {
196 warnx("%s: %s", p->fts_path,
197 strerror(p->fts_errno));
198 eval = 1;
199 continue;
200 }
201 break;
202 case FTS_D:
203 /* Pre-order: give user chance to skip. */
204 if (!fflag && !check(p->fts_path, p->fts_accpath,
205 p->fts_statp)) {
206 (void)fts_set(fts, p, FTS_SKIP);
207 p->fts_number = SKIPPED;
208 }
209 continue;
210 case FTS_DP:
211 /* Post-order: see if user skipped. */
212 if (p->fts_number == SKIPPED)
213 continue;
214 break;
215 default:
216 if (!fflag &&
217 !check(p->fts_path, p->fts_accpath, p->fts_statp))
218 continue;
219 }
220
221 rval = 0;
222 /*
223 * If we can't read or search the directory, may still be
224 * able to remove it. Don't print out the un{read,search}able
225 * message unless the remove fails.
226 */
227 switch (p->fts_info) {
228 case FTS_DP:
229 case FTS_DNR:
230 rval = rmdir(p->fts_accpath);
231 if (rval != 0 && fflag && errno == ENOENT)
232 continue;
233 break;
234
235 case FTS_W:
236 rval = undelete(p->fts_accpath);
237 if (rval != 0 && fflag && errno == ENOENT)
238 continue;
239 break;
240
241 default:
242 if (Pflag) {
243 if (rm_overwrite(p->fts_accpath, NULL))
244 continue;
245 }
246 rval = unlink(p->fts_accpath);
247 if (rval != 0 && fflag && NONEXISTENT(errno))
248 continue;
249 break;
250 }
251 if (rval != 0) {
252 warn("%s", p->fts_path);
253 eval = 1;
254 } else if (vflag)
255 (void)printf("%s\n", p->fts_path);
256 }
257 if (errno)
258 err(1, "fts_read");
259 fts_close(fts);
260 }
261
262 void
263 rm_file(char **argv)
264 {
265 struct stat sb;
266 int rval;
267 char *f;
268
269 /*
270 * Remove a file. POSIX 1003.2 states that, by default, attempting
271 * to remove a directory is an error, so must always stat the file.
272 */
273 while ((f = *argv++) != NULL) {
274 /* Assume if can't stat the file, can't unlink it. */
275 if (lstat(f, &sb)) {
276 if (Wflag) {
277 sb.st_mode = S_IFWHT|S_IWUSR|S_IRUSR;
278 } else {
279 if (!fflag || !NONEXISTENT(errno)) {
280 warn("%s", f);
281 eval = 1;
282 }
283 continue;
284 }
285 } else if (Wflag) {
286 warnx("%s: %s", f, strerror(EEXIST));
287 eval = 1;
288 continue;
289 }
290
291 if (S_ISDIR(sb.st_mode) && !dflag) {
292 warnx("%s: is a directory", f);
293 eval = 1;
294 continue;
295 }
296 if (!fflag && !S_ISWHT(sb.st_mode) && !check(f, f, &sb))
297 continue;
298 if (S_ISWHT(sb.st_mode))
299 rval = undelete(f);
300 else if (S_ISDIR(sb.st_mode))
301 rval = rmdir(f);
302 else {
303 if (Pflag) {
304 if (rm_overwrite(f, &sb))
305 continue;
306 }
307 rval = unlink(f);
308 }
309 if (rval && (!fflag || !NONEXISTENT(errno))) {
310 warn("%s", f);
311 eval = 1;
312 }
313 if (vflag && rval == 0)
314 (void)printf("%s\n", f);
315 }
316 }
317
318 /*
319 * rm_overwrite --
320 * Overwrite the file 3 times with varying bit patterns.
321 *
322 * This is an expensive way to keep people from recovering files from your
323 * non-snapshotted FFS filesystems using fsdb(8). Really. No more. Only
324 * regular files are deleted, directories (and therefore names) will remain.
325 * Also, this assumes a fixed-block file system (like FFS, or a V7 or a
326 * System V file system). In a logging file system, you'll have to have
327 * kernel support.
328 *
329 * A note on standards: U.S. DoD 5220.22-M "National Industrial Security
330 * Program Operating Manual" ("NISPOM") is often cited as a reference
331 * for clearing and sanitizing magnetic media. In fact, a matrix of
332 * "clearing" and "sanitization" methods for various media was given in
333 * Chapter 8 of the original 1995 version of NISPOM. However, that
334 * matrix was *removed from the document* when Chapter 8 was rewritten
335 * in Change 2 to the document in 2001. Recently, the Defense Security
336 * Service has made a revised clearing and sanitization matrix available
337 * in Microsoft Word format on the DSS web site. The standardization
338 * status of this matrix is unclear. Furthermore, one must be very
339 * careful when referring to this matrix: it is intended for the "clearing"
340 * prior to reuse or "sanitization" prior to disposal of *entire media*,
341 * not individual files and the only non-physically-destructive method of
342 * "sanitization" that is permitted for magnetic disks of any kind is
343 * specifically noted to be prohibited for media that have contained
344 * Top Secret data.
345 *
346 * It is impossible to actually conform to the exact procedure given in
347 * the matrix if one is overwriting a file, not an entire disk, because
348 * the procedure requires examination and comparison of the disk's defect
349 * lists. Any program that claims to securely erase *files* while
350 * conforming to the standard, then, is not correct. We do as much of
351 * what the standard requires as can actually be done when erasing a
352 * file, rather than an entire disk; but that does not make us conformant.
353 *
354 * Furthermore, the presence of track caches, disk and controller write
355 * caches, and so forth make it extremely difficult to ensure that data
356 * have actually been written to the disk, particularly when one tries
357 * to repeatedly overwrite the same sectors in quick succession. We call
358 * fsync(), but controllers with nonvolatile cache, as well as IDE disks
359 * that just plain lie about the stable storage of data, will defeat this.
360 *
361 * Finally, widely respected research suggests that the given procedure
362 * is nowhere near sufficient to prevent the recovery of data using special
363 * forensic equipment and techniques that are well-known. This is
364 * presumably one reason that the matrix requires physical media destruction,
365 * rather than any technique of the sort attempted here, for secret data.
366 *
367 * Caveat Emptor.
368 *
369 * rm_overwrite will return 0 on success.
370 */
371
372 int
373 rm_overwrite(char *file, struct stat *sbp)
374 {
375 struct stat sb;
376 int fd, randint;
377 char randchar;
378
379 fd = -1;
380 if (sbp == NULL) {
381 if (lstat(file, &sb))
382 goto err;
383 sbp = &sb;
384 }
385 if (!S_ISREG(sbp->st_mode))
386 return 0;
387
388 /* flags to try to defeat hidden caching by forcing seeks */
389 if ((fd = open(file, O_RDWR|O_SYNC|O_RSYNC, 0)) == -1)
390 goto err;
391
392 #define RAND_BYTES 1
393 #define THIS_BYTE 0
394
395 #define WRITE_PASS(mode, byte) do { \
396 off_t len; \
397 int wlen, i; \
398 char buf[8 * 1024]; \
399 \
400 if (fsync(fd) || lseek(fd, (off_t)0, SEEK_SET)) \
401 goto err; \
402 \
403 if (mode == THIS_BYTE) \
404 memset(buf, byte, sizeof(buf)); \
405 for (len = sbp->st_size; len > 0; len -= wlen) { \
406 if (mode == RAND_BYTES) { \
407 for (i = 0; i < sizeof(buf); \
408 i+= sizeof(u_int32_t)) \
409 *(int *)(buf + i) = arc4random(); \
410 } \
411 wlen = len < sizeof(buf) ? len : sizeof(buf); \
412 if (write(fd, buf, wlen) != wlen) \
413 goto err; \
414 } \
415 sync(); /* another poke at hidden caches */ \
416 } while (/* CONSTCOND */ 0)
417
418 #define READ_PASS(byte) do { \
419 off_t len; \
420 int rlen; \
421 char pattern[8 * 1024]; \
422 char buf[8 * 1024]; \
423 \
424 if (fsync(fd) || lseek(fd, (off_t)0, SEEK_SET)) \
425 goto err; \
426 \
427 memset(pattern, byte, sizeof(pattern)); \
428 for(len = sbp->st_size; len > 0; len -= rlen) { \
429 rlen = len < sizeof(buf) ? len : sizeof(buf); \
430 if(read(fd, buf, rlen) != rlen) \
431 goto err; \
432 if(memcmp(buf, pattern, rlen)) \
433 goto err; \
434 } \
435 sync(); /* another poke at hidden caches */ \
436 } while (/* CONSTCOND */ 0)
437
438 /*
439 * DSS sanitization matrix "clear" for magnetic disks:
440 * option 'c' "Overwrite all addressable locations with a single
441 * character."
442 */
443 randint = arc4random();
444 randchar = *(char *)&randint;
445 WRITE_PASS(THIS_BYTE, randchar);
446
447 /*
448 * DSS sanitization matrix "sanitize" for magnetic disks:
449 * option 'd', sub 2 "Overwrite all addressable locations with a
450 * character, then its complement. Verify "complement" character
451 * was written successfully to all addressable locations, then
452 * overwrite all addressable locations with random characters; or
453 * verify third overwrite of random characters." The rest of the
454 * text in d-sub-2 specifies requirements for overwriting spared
455 * sectors; we cannot conform to it when erasing only a file, thus
456 * we do not conform to the standard.
457 */
458
459 /* 1. "a character" */
460 WRITE_PASS(THIS_BYTE, 0xff);
461
462 /* 2. "its complement" */
463 WRITE_PASS(THIS_BYTE, 0x00);
464
465 /* 3. "Verify 'complement' character" */
466 READ_PASS(0x00);
467
468 /* 4. "overwrite all addressable locations with random characters" */
469
470 WRITE_PASS(RAND_BYTES, 0x00);
471
472 /*
473 * As the file might be huge, and we note that this revision of
474 * the matrix says "random characters", not "a random character"
475 * as the original did, we do not verify the random-character
476 * write; the "or" in the standard allows this.
477 */
478
479 if (close(fd) == -1) {
480 fd = -1;
481 goto err;
482 }
483
484 return 0;
485
486 err: eval = 1;
487 warn("%s", file);
488 if (fd != -1)
489 close(fd);
490 return 1;
491 }
492
493 int
494 check(char *path, char *name, struct stat *sp)
495 {
496 int ch, first;
497 char modep[15];
498
499 /* Check -i first. */
500 if (iflag)
501 (void)fprintf(stderr, "remove '%s'? ", path);
502 else {
503 /*
504 * If it's not a symbolic link and it's unwritable and we're
505 * talking to a terminal, ask. Symbolic links are excluded
506 * because their permissions are meaningless. Check stdin_ok
507 * first because we may not have stat'ed the file.
508 */
509 if (!stdin_ok || S_ISLNK(sp->st_mode) ||
510 !(access(name, W_OK) && (errno != ETXTBSY)))
511 return (1);
512 strmode(sp->st_mode, modep);
513 if (Pflag) {
514 warnx(
515 "%s: -P was specified but file could not"
516 " be overwritten", path);
517 return 0;
518 }
519 (void)fprintf(stderr, "override %s%s%s:%s for '%s'? ",
520 modep + 1, modep[9] == ' ' ? "" : " ",
521 user_from_uid(sp->st_uid, 0),
522 group_from_gid(sp->st_gid, 0), path);
523 }
524 (void)fflush(stderr);
525
526 first = ch = getchar();
527 while (ch != '\n' && ch != EOF)
528 ch = getchar();
529 return (first == 'y' || first == 'Y');
530 }
531
532 /*
533 * POSIX.2 requires that if "." or ".." are specified as the basename
534 * portion of an operand, a diagnostic message be written to standard
535 * error and nothing more be done with such operands.
536 *
537 * Since POSIX.2 defines basename as the final portion of a path after
538 * trailing slashes have been removed, we'll remove them here.
539 */
540 #define ISDOT(a) ((a)[0] == '.' && (!(a)[1] || ((a)[1] == '.' && !(a)[2])))
541 void
542 checkdot(char **argv)
543 {
544 char *p, **save, **t;
545 int complained;
546
547 complained = 0;
548 for (t = argv; *t;) {
549 /* strip trailing slashes */
550 p = strrchr(*t, '\0');
551 while (--p > *t && *p == '/')
552 *p = '\0';
553
554 /* extract basename */
555 if ((p = strrchr(*t, '/')) != NULL)
556 ++p;
557 else
558 p = *t;
559
560 if (ISDOT(p)) {
561 if (!complained++)
562 warnx("\".\" and \"..\" may not be removed");
563 eval = 1;
564 for (save = t; (t[0] = t[1]) != NULL; ++t)
565 continue;
566 t = save;
567 } else
568 ++t;
569 }
570 }
571
572 void
573 usage(void)
574 {
575
576 (void)fprintf(stderr, "usage: %s [-f|-i] [-dPRrvW] file ...\n",
577 getprogname());
578 exit(1);
579 /* NOTREACHED */
580 }
581