]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - share/man/man5/periodic.conf.5
wpa: Import wpa_supplicant/hostapd commit f91680c15
[FreeBSD/FreeBSD.git] / share / man / man5 / periodic.conf.5
1 .\"-
2 .\" Copyright (c) 2000 Brian Somers <brian@Awfulhak.org>
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD$
27 .\"
28 .Dd November 7, 2020
29 .Dt PERIODIC.CONF 5
30 .Os
31 .Sh NAME
32 .Nm periodic.conf
33 .Nd periodic job configuration information
34 .Sh DESCRIPTION
35 The file
36 .Nm
37 contains a description of how daily, weekly and monthly system maintenance
38 jobs should run.
39 It resides in the
40 .Pa /etc/defaults
41 directory and parts may be overridden by a file of the same name in
42 .Pa /etc ,
43 which itself may be overridden by the
44 .Pa /etc/periodic.conf.local
45 file.
46 .Pp
47 The
48 .Nm
49 file
50 is actually sourced as a shell script from each of the periodic scripts
51 and is intended to simply provide default configuration variables.
52 .Pp
53 The following variables are used by
54 .Xr periodic 8
55 itself:
56 .Bl -tag -offset 4n -width 2n
57 .It Va local_periodic
58 .Pq Vt str
59 List of directories to search for periodic scripts.
60 This list is always prefixed with
61 .Pa /etc/periodic ,
62 and is only used when an argument to
63 .Xr periodic 8
64 is not an absolute directory name.
65 .It Ao Ar dir Ac Ns Va _output
66 .Pq Vt path No or Vt list
67 What to do with the output of the scripts executed from
68 the directory
69 .Ar dir .
70 If this variable is set to an absolute path name, output is logged to
71 that file, otherwise it is taken as one or more space separated email
72 addresses and mailed to those users.
73 If this variable is not set or is empty, output is sent to standard output.
74 .Pp
75 For an unattended machine, suitable values for
76 .Va daily_output ,
77 .Va weekly_output ,
78 and
79 .Va monthly_output
80 might be
81 .Dq Li /var/log/daily.log ,
82 .Dq Li /var/log/weekly.log ,
83 and
84 .Dq Li /var/log/monthly.log
85 respectively, as
86 .Xr newsyslog 8
87 will rotate these files (if they exists) at the appropriate times.
88 .It Ao Ar dir Ac Ns Va _show_success
89 .It Ao Ar dir Ac Ns Va _show_info
90 .It Ao Ar dir Ac Ns Va _show_badconfig
91 .Pq Vt bool
92 These variables control whether
93 .Xr periodic 8
94 will mask the output of the executed scripts based on their return code
95 (where
96 .Ar dir
97 is the base directory name in which each script resides).
98 If the return code of a script is
99 .Sq 0
100 and
101 .Ao Ar dir Ac Ns Va _show_success
102 is set to
103 .Dq Li NO ,
104 .Xr periodic 8
105 will mask the script's output.
106 If the return code of a script is
107 .Sq 1
108 and
109 .Ao Ar dir Ac Ns Va _show_info
110 is set to
111 .Dq Li NO ,
112 .Xr periodic 8
113 will mask the script's output.
114 If the return code of a script is
115 .Sq 2
116 and
117 .Ao Ar dir Ac Ns Va _show_badconfig
118 is set to
119 .Dq Li NO ,
120 .Xr periodic 8
121 will mask the script's output.
122 If these variables are set to neither
123 .Dq Li YES
124 nor
125 .Dq Li NO ,
126 they default to
127 .Dq Li YES ,
128 .Dq Li YES
129 and
130 .Dq Li NO
131 respectively.
132 .Pp
133 Refer to the
134 .Xr periodic 8
135 manual page for how script return codes are interpreted.
136 .It Va anticongestion_sleeptime
137 .Pq Vt int
138 The maximum number of seconds to randomly sleep in order to smooth bursty loads
139 on a shared resource, such as a download mirror.
140 .El
141 .Pp
142 The following variables are used by the standard scripts that reside in
143 .Pa /etc/periodic/daily :
144 .Bl -tag -offset 4n -width 2n
145 .It Va daily_clean_disks_enable
146 .Pq Vt bool
147 Set to
148 .Dq Li YES
149 if you want to remove all files matching
150 .Va daily_clean_disks_files
151 daily.
152 .It Va daily_clean_disks_files
153 .Pq Vt str
154 Set to a list of file names to match.
155 Wild cards are permitted.
156 .It Va daily_clean_disks_days
157 .Pq Vt num
158 When
159 .Va daily_clean_disks_enable
160 is set to
161 .Dq Li YES ,
162 this must also be set to the number of days old that a file's access
163 and modification times must be before it is deleted.
164 .It Va daily_clean_disks_verbose
165 .Pq Vt bool
166 Set to
167 .Dq Li YES
168 if you want the removed files to be reported in your daily output.
169 .It Va daily_clean_tmps_enable
170 .Pq Vt bool
171 Set to
172 .Dq Li YES
173 if you want to clear temporary directories daily.
174 .It Va daily_clean_tmps_dirs
175 .Pq Vt str
176 Set to the list of directories to clear if
177 .Va daily_clean_tmps_enable
178 is set to
179 .Dq Li YES .
180 .It Va daily_clean_tmps_days
181 .Pq Vt num
182 When
183 .Va daily_clean_tmps_enable
184 is set, this must also be set to the number of days old that a file's access
185 and modification times must be before it is deleted.
186 .It Va daily_clean_tmps_ignore
187 .Pq Vt str
188 Set to the list of files that should not be deleted when
189 .Va daily_clean_tmps_enable
190 is set to
191 .Dq Li YES .
192 Wild card characters are permitted.
193 .It Va daily_clean_tmps_verbose
194 .Pq Vt bool
195 Set to
196 .Dq Li YES
197 if you want the removed files to be reported in your daily output.
198 .It Va daily_clean_preserve_enable
199 .Pq Vt bool
200 Set to
201 .Dq Li YES
202 if you wish to remove old files from
203 .Pa /var/preserve .
204 .It Va daily_clean_preserve_days
205 .Pq Vt num
206 Set to the number of days that files must not have been modified before
207 they are deleted.
208 .It Va daily_clean_preserve_verbose
209 .Pq Vt bool
210 Set to
211 .Dq Li YES
212 if you want the removed files to be reported in your daily output.
213 .It Va daily_clean_msgs_enable
214 .Pq Vt bool
215 Set to
216 .Dq Li YES
217 if you wish old system messages to be purged.
218 .It Va daily_clean_msgs_days
219 .Pq Vt num
220 Set to the number of days that files must not have been modified before
221 they are deleted.
222 If this variable is left blank, the
223 .Xr msgs 1
224 default is used.
225 .It Va daily_clean_rwho_enable
226 .Pq Vt bool
227 Set to
228 .Dq Li YES
229 if you wish old files in
230 .Pa /var/who
231 to be purged.
232 .It Va daily_clean_rwho_days
233 .Pq Vt num
234 Set to the number of days that files must not have been modified before
235 they are deleted.
236 .It Va daily_clean_rwho_verbose
237 .Pq Vt bool
238 Set to
239 .Dq Li YES
240 if you want the removed files to be reported in your daily output.
241 .It Va daily_clean_hoststat_enable
242 .Pq Vt bool
243 Set to
244 .Dq Li YES
245 to run
246 .Nm sendmail Fl bH
247 to automatically purge stale entries from
248 .Xr sendmail 8 Ns 's
249 host status cache.
250 Files will be deleted using the same criteria as
251 .Xr sendmail 8
252 would normally use when determining whether to believe the cached information,
253 as configured in
254 .Pa /etc/mail/sendmail.cf .
255 .It Va daily_backup_efi_enable
256 .Pq Vt bool
257 Set to
258 .Dq Li YES
259 to create backup of EFI System Partition (ESP).
260 .It Va daily_backup_gmirror_enable
261 .Pq Vt bool
262 Set to
263 .Dq Li YES
264 to create backup of gmirror information (i.e., output of
265 .Nm gmirror Cm list ) ,
266 see
267 .Xr gmirror 8 .
268 .It Va daily_backup_gmirror_verbose
269 .Pq Vt bool
270 Set to
271 .Dq Li YES
272 to report a diff between the new backup and the existing backup
273 in the daily output.
274 .It Va daily_backup_gpart_enable
275 .Pq Vt bool
276 Set to
277 .Dq Li YES
278 to create backups of partition tables, and bootcode partition contents.
279 .It Va daily_backup_gpart_verbose
280 .Pq Vt bool
281 Set to
282 .Dq Li YES
283 to be verbose if existing backups for kern.geom.conftxt or the partition tables differ
284 from the new backups.
285 .It Va daily_backup_passwd_enable
286 .Pq Vt bool
287 Set to
288 .Dq Li YES
289 if you want the
290 .Pa /etc/master.passwd
291 and
292 .Pa /etc/group
293 files backed up and reported on.
294 Reporting consists of checking both files for modifications and running
295 .Xr chkgrp 8
296 on the
297 .Pa group
298 file.
299 .It Va daily_backup_aliases_enable
300 .Pq Vt bool
301 Set to
302 .Dq Li YES
303 if you want the
304 .Pa /etc/mail/aliases
305 file backed up and modifications to be displayed in your daily output.
306 .It Va daily_backup_zfs_enable
307 .Pq Vt bool
308 Set to
309 .Dq Li YES
310 to create backup of the output generated from the
311 .Xr zfs-list 8
312 and
313 .Xr zpool-list 8
314 utilities.
315 .It Va daily_backup_zfs_list_flags
316 .Pq Vt str
317 Set to the arguments for the
318 .Xr zfs-list 8
319 utility.
320 The default is standard behavior.
321 .It Va daily_backup_zpool_list_flags
322 .Pq Vt str
323 Set to the arguments for the
324 .Xr zpool-list 8
325 utility.
326 The default is
327 .Fl v .
328 .It Va daily_backup_zfs_props_enable
329 .Pq Vt bool
330 Set to
331 .Dq Li YES
332 to create backup of the output generated from the
333 .Xr zfs-get 8
334 and
335 .Xr zpool-get 8
336 utilities.
337 .It Va daily_backup_zfs_get_flags
338 .Pq Vt str
339 Set to the arguments for the
340 .Xr zfs-get 8
341 utility.
342 The default is
343 .Cm all .
344 .It Va daily_backup_zpool_get_flags
345 .Pq Vt str
346 Set to the arguments for the
347 .Xr zpool-get 8
348 utility.
349 The default is
350 .Cm all .
351 .It Va daily_backup_zfs_verbose
352 .Pq Vt bool
353 Set to
354 .Dq Li YES
355 to report a diff between the new backup and the existing backup
356 in the daily output.
357 .It Va daily_calendar_enable
358 .Pq Vt bool
359 Set to
360 .Dq Li YES
361 if you want to run
362 .Nm calendar Fl a
363 daily.
364 .It Va daily_accounting_enable
365 .Pq Vt bool
366 Set to
367 .Dq Li YES
368 if you want to rotate your daily accounting files.
369 No rotations are necessary unless
370 .Va accounting_enable
371 is enabled in
372 .Xr rc.conf 5 .
373 .It Va daily_accounting_compress
374 .Pq Vt bool
375 Set to
376 .Dq Li YES
377 if you want your daily accounting files to be compressed using
378 .Xr gzip 1 .
379 .It Va daily_accounting_save
380 .Pq Vt num
381 When
382 .Va daily_accounting_enable
383 is set, this may also be set to the number of daily accounting files that are
384 to be saved.
385 The default is
386 .Dq Li 3 .
387 .It Va daily_accounting_flags
388 .Pq Vt str
389 Set to the arguments to pass to the
390 .Xr sa 8
391 utility (in addition to
392 .Fl s )
393 when
394 .Va daily_accounting_enable
395 is set to
396 .Dq Li YES .
397 The default is
398 .Fl q .
399 .It Va daily_news_expire_enable
400 .Pq Vt bool
401 Set to
402 .Dq Li YES
403 if you want to run
404 .Pa /etc/news.expire .
405 .It Va daily_status_disks_enable
406 .Pq Vt bool
407 Set to
408 .Dq Li YES
409 if you want to run
410 .Xr df 1
411 (with the arguments supplied in
412 .Va daily_status_disks_df_flags )
413 and
414 .Nm dump Fl W .
415 .It Va daily_status_disks_df_flags
416 .Pq Vt str
417 Set to the arguments for the
418 .Xr df 1
419 utility when
420 .Va daily_status_disks_enable
421 is set to
422 .Dq Li YES .
423 The default is
424 .Fl l Fl h .
425 .It Va daily_status_zfs_enable
426 .Pq Vt bool
427 Set to
428 .Dq Li YES
429 if you want to run
430 .Nm zpool Cm status
431 on your
432 .Xr zfs 8
433 pools.
434 .It Va daily_status_zfs_zpool_list_enable
435 .Pq Vt bool
436 Set to
437 .Dq Li YES
438 if you want to run
439 .Nm zpool Cm list
440 on your
441 .Xr zfs 8
442 pools.
443 Requires
444 .Va daily_status_zfs_enable
445 to be set to
446 .Li YES .
447 .It Va daily_status_gmirror_enable
448 .Pq Vt bool
449 Set to
450 .Dq Li YES
451 if you want to run
452 .Nm gmirror Cm status
453 on your
454 .Xr gmirror 8
455 devices.
456 .It Va daily_status_graid3_enable
457 .Pq Vt bool
458 Set to
459 .Dq Li YES
460 if you want to run
461 .Nm graid3 Cm status
462 on your
463 .Xr graid3 8
464 devices.
465 .It Va daily_status_gstripe_enable
466 .Pq Vt bool
467 Set to
468 .Dq Li YES
469 if you want to run
470 .Nm gstripe Cm status
471 on your
472 .Xr gstripe 8
473 devices.
474 .It Va daily_status_gconcat_enable
475 .Pq Vt bool
476 Set to
477 .Dq Li YES
478 if you want to run
479 .Nm gconcat Cm status
480 on your
481 .Xr gconcat 8
482 devices.
483 .It Va daily_status_mfi_enable
484 .Pq Vt bool
485 Set to
486 .Dq Li YES
487 if you want to run
488 .Nm mfiutil Cm status
489 on your
490 .Xr mfi 4
491 devices.
492 .It Va daily_status_network_enable
493 .Pq Vt bool
494 Set to
495 .Dq Li YES
496 if you want to run
497 .Nm netstat Fl i .
498 .It Va daily_status_network_netstat_flags
499 .Pq Vt str
500 Set to additional arguments for the
501 .Xr netstat 1
502 utility when
503 .Va daily_status_network_enable
504 is set to
505 .Dq Li YES .
506 The default is
507 .Fl d W .
508 .It Va daily_status_network_usedns
509 .Pq Vt bool
510 Set to
511 .Dq Li YES
512 if you want to run
513 .Xr netstat 1
514 without the
515 .Fl n
516 option (to do DNS lookups).
517 .It Va daily_status_uptime_enable
518 .Pq Vt bool
519 Set to
520 .Dq Li YES
521 if you want to run
522 .Xr uptime 1
523 (or
524 .Xr ruptime 1
525 if
526 .Va rwhod_enable
527 is set to
528 .Dq Li YES
529 in
530 .Pa /etc/rc.conf ) .
531 .It Va daily_status_mailq_enable
532 .Pq Vt bool
533 Set to
534 .Dq Li YES
535 if you want to run
536 .Xr mailq 1 .
537 .It Va daily_status_mailq_shorten
538 .Pq Vt bool
539 Set to
540 .Dq Li YES
541 if you want to shorten the
542 .Xr mailq 1
543 output when
544 .Va daily_status_mailq_enable
545 is set to
546 .Dq Li YES .
547 .It Va daily_status_include_submit_mailq
548 .Pq Vt bool
549 Set to
550 .Dq Li YES
551 if you also want to run
552 .Xr mailq 1
553 on the submit mail queue when
554 .Va daily_status_mailq_enable
555 is set to
556 .Dq Li YES .
557 This may not work with MTAs other than
558 .Xr sendmail 8 .
559 .It Va daily_status_security_enable
560 .Pq Vt bool
561 Set to
562 .Dq Li YES
563 if you want to run the security check.
564 The security check is another set of
565 .Xr periodic 8
566 scripts.
567 The system defaults are in
568 .Pa /etc/periodic/security .
569 Local scripts should be placed in
570 .Pa /usr/local/etc/periodic/security .
571 See the
572 .Xr periodic 8
573 manual page for more information.
574 .It Va daily_status_security_inline
575 .Pq Vt bool
576 Set to
577 .Dq Li YES
578 if you want the security check output inline.
579 The default is to either mail or log the output according to the value of
580 .Va daily_status_security_output .
581 .It Va daily_status_security_output
582 .Pq Vt str
583 Where to send the output of the security check if
584 .Va daily_status_security_inline
585 is set to
586 .Dq Li NO .
587 This variable behaves in the same way as the
588 .Va *_output
589 variables above, namely it can be set either to one or more email addresses
590 or to an absolute file name.
591 .It Va daily_status_mail_rejects_enable
592 .Pq Vt bool
593 Set to
594 .Dq Li YES
595 if you want to summarise mail rejections logged to
596 .Pa /var/log/maillog
597 for the previous day.
598 .It Va daily_status_mail_rejects_logs
599 .Pq Vt num
600 Set to the number of maillog files that should be checked
601 for yesterday's mail rejects.
602 .It Va daily_status_ntpd_enable
603 .Pq Vt bool
604 Set to
605 .Dq Li YES
606 if you want to enable NTP status check.
607 .It Va daily_status_world_kernel
608 .Pq Vt bool
609 Set to
610 .Dq Li YES
611 to check the running userland and kernel are in sync.
612 .It Va daily_queuerun_enable
613 .Pq Vt bool
614 Set to
615 .Dq Li YES
616 if you want to manually run the mail queue at least once a day.
617 .It Va daily_submit_queuerun
618 .Pq Vt bool
619 Set to
620 .Dq Li YES
621 if you also want to manually run the submit mail queue at least once a day
622 when
623 .Va daily_queuerun_enable
624 is set to
625 .Dq Li YES .
626 .It Va daily_scrub_zfs_enable
627 .Pq Vt bool
628 Set to
629 .Dq Li YES
630 if you want to run a zfs scrub periodically.
631 .It Va daily_scrub_zfs_pools
632 .Pq Vt str
633 A space separated list of names of zfs pools to scrub.
634 If the list is empty or not set, all zfs pools are scrubbed.
635 .It Va daily_scrub_zfs_default_threshold
636 .Pq Vt int
637 Number of days between a scrub if no pool-specific threshold is set.
638 If not set, the default value is 35, corresponding to 5 weeks.
639 .It Va daily_scrub_zfs_ Ns Ao Ar poolname Ac Ns Va _threshold
640 .Pq Vt int
641 The same as
642 .Va daily_scrub_zfs_default_threshold
643 but specific to the pool
644 .Ao Ar poolname Ac Ns .
645 .It Va daily_local
646 .Pq Vt str
647 Set to a list of extra scripts that should be run after all other
648 daily scripts.
649 All scripts must be absolute path names.
650 .El
651 .Pp
652 The following variables are used by the standard scripts that reside in
653 .Pa /etc/periodic/weekly :
654 .Bl -tag -offset 4n -width 2n
655 .It Va weekly_locate_enable
656 .Pq Vt bool
657 Set to
658 .Dq Li YES
659 if you want to run
660 .Pa /usr/libexec/locate.updatedb .
661 This script is run using
662 .Nm nice Fl 5
663 as user
664 .Dq Li nobody ,
665 and generates the table used by the
666 .Xr locate 1
667 command.
668 .It Va weekly_whatis_enable
669 .Pq Vt bool
670 Set to
671 .Dq Li YES
672 if you want to run
673 .Pa /usr/libexec/makewhatis.local .
674 This script regenerates the database used by the
675 .Xr apropos 1
676 command.
677 .It Va weekly_noid_enable
678 .Pq Vt bool
679 Set to
680 .Dq Li YES
681 if you want to locate orphaned files on the system.
682 An orphaned file is one with an invalid owner or group.
683 .It Va weekly_noid_dirs
684 .Pq Vt str
685 A list of directories under which orphaned files are searched for.
686 This would usually be set to
687 .Pa / .
688 .It Va weekly_status_security_enable
689 .Pq Vt bool
690 Weekly counterpart of
691 .Va daily_status_security_enable .
692 .It Va weekly_status_security_inline
693 .Pq Vt bool
694 Weekly counterpart of
695 .Va daily_status_security_inline .
696 .It Va weekly_status_security_output
697 .Pq Vt str
698 Weekly counterpart of
699 .Va daily_status_security_output .
700 .It Va weekly_status_pkg_enable
701 .Pq Vt bool
702 Set to
703 .Dq Li YES
704 if you want to use
705 .Xr pkg-version 8
706 to list installed packages which are out of date.
707 .It Va pkg_version
708 .Pq Vt str
709 When
710 .Va weekly_status_pkg_enable
711 is set to
712 .Dq Li YES ,
713 this variable specifies the program that is used to determine the out of
714 date packages.
715 If unset, the
716 .Xr pkg-version 8
717 program is used.
718 As an example, this variable might be set to
719 .Dq Li portversion
720 if the
721 .Pa ports/sysutils/portupgrade
722 port has been installed.
723 .It Va pkg_version_index
724 .Pq Vt str
725 This variable specifies the
726 .Pa INDEX
727 file from
728 .Pa /usr/ports
729 that should be used by
730 .Xr pkg-version 8 .
731 Because the dependency tree may be substantially different between versions of
732 .Fx ,
733 there may be more than one
734 .Pa INDEX
735 file in
736 .Pa /usr/ports .
737 .Pp
738 Note, if the
739 .Va pkg_version
740 variable is set to
741 .Dq Li portversion ,
742 it will also be necessary to arrange that the correct
743 .Pa INDEX
744 file is specified
745 using environment variables and that
746 .Va pkg_version_index
747 is cleared in
748 .Pa /etc/periodic.conf
749 .Pq Dq Li pkg_version_index= .
750 .It Va weekly_local
751 .Pq Vt str
752 Set to a list of extra scripts that should be run after all other
753 weekly scripts.
754 All scripts must be absolute path names.
755 .El
756 .Pp
757 The following variables are used by the standard scripts that reside in
758 .Pa /etc/periodic/monthly :
759 .Bl -tag -offset 4n -width 2n
760 .It Va monthly_accounting_enable
761 .Pq Vt bool
762 Set to
763 .Dq Li YES
764 if you want to do login accounting using the
765 .Xr ac 8
766 command.
767 .It Va monthly_status_security_enable
768 .Pq Vt bool
769 Monthly counterpart of
770 .Va daily_status_security_enable .
771 .It Va monthly_status_security_inline
772 .Pq Vt bool
773 Monthly counterpart of
774 .Va daily_status_security_inline .
775 .It Va monthly_status_security_output
776 .Pq Vt str
777 Monthly counterpart of
778 .Va daily_status_security_output .
779 .It Va monthly_local
780 .Pq Vt str
781 Set to a list of extra scripts that should be run after all other
782 monthly scripts.
783 All scripts must be absolute path names.
784 .El
785 .Pp
786 The following variables are used by the standard scripts that reside in
787 .Pa /etc/periodic/security .
788 Those scripts are usually run from daily
789 .Pq Va daily_status_security_enable ,
790 weekly
791 .Pq Va weekly_status_security_enable ,
792 and monthly
793 .Pq Va monthly_status_security_enable
794 periodic hooks.
795 The
796 .Va ..._period
797 of each script can be configured as
798 .Dq daily ,
799 .Dq weekly ,
800 .Dq monthly
801 or
802 .Dq NO .
803 Note that when periodic security scripts are run from
804 .Xr crontab 5 ,
805 they will be always run unless their
806 .Va ..._enable
807 or
808 .Va ..._period
809 variable is set to
810 .Dq NO .
811 .Bl -tag -offset 4n -width 2n
812 .It Va security_status_diff_flags
813 .Pq Vt str
814 Set to the arguments to pass to the
815 .Xr diff 1
816 utility when generating differences.
817 The default is
818 .Fl b u .
819 .It Va security_status_chksetuid_enable
820 .Pq Vt bool
821 Set to
822 .Dq Li YES
823 to compare the modes and modification times of setuid executables with
824 the previous day's values.
825 .It Va security_status_chksetuid_period
826 .Pq Vt str
827 Set to either
828 .Dq Li daily ,
829 .Dq Li weekly ,
830 .Dq Li monthly
831 or
832 .Dq Li NO .
833 .It Va security_status_chkportsum_enable
834 .Pq Vt bool
835 Set to
836 .Dq Li YES
837 to verify checksums of all installed packages against the known checksums in
838 .Pa /var/db/pkg .
839 .It Va security_status_chkportsum_period
840 .Pq Vt str
841 Set to either
842 .Dq Li daily ,
843 .Dq Li weekly ,
844 .Dq Li monthly
845 or
846 .Dq Li NO .
847 .It Va security_status_neggrpperm_enable
848 .Pq Vt bool
849 Set to
850 .Dq Li YES
851 to check for files where the group of a file has less permissions than
852 the world at large.
853 When users are in more than 14 supplemental groups these negative
854 permissions may not be enforced via NFS shares.
855 .It Va security_status_neggrpperm_period
856 .Pq Vt str
857 Set to either
858 .Dq Li daily ,
859 .Dq Li weekly ,
860 .Dq Li monthly
861 or
862 .Dq Li NO .
863 .It Va security_status_chkmounts_enable
864 .Pq Vt bool
865 Set to
866 .Dq Li YES
867 to check for changes mounted file systems to the previous day's values.
868 .It Va security_status_chkmounts_period
869 .Pq Vt str
870 Set to either
871 .Dq Li daily ,
872 .Dq Li weekly ,
873 .Dq Li monthly
874 or
875 .Dq Li NO .
876 .It Va security_status_noamd
877 .Pq Vt bool
878 Set to
879 .Dq Li YES
880 if you want to ignore
881 .Xr amd 8
882 mounts when comparing against yesterday's file system mounts in the
883 .Va security_status_chkmounts_enable
884 check.
885 .It Va security_status_chkuid0_enable
886 .Pq Vt bool
887 Set to
888 .Dq Li YES
889 to check
890 .Pa /etc/master.passwd
891 for accounts with UID 0.
892 .It Va security_status_chkuid0_period
893 .Pq Vt str
894 Set to either
895 .Dq Li daily ,
896 .Dq Li weekly ,
897 .Dq Li monthly
898 or
899 .Dq Li NO .
900 .It Va security_status_passwdless_enable
901 .Pq Vt bool
902 Set to
903 .Dq Li YES
904 to check
905 .Pa /etc/master.passwd
906 for accounts with empty passwords.
907 .It Va security_status_passwdless_period
908 .Pq Vt str
909 Set to either
910 .Dq Li daily ,
911 .Dq Li weekly ,
912 .Dq Li monthly
913 or
914 .Dq Li NO .
915 .It Va security_status_logincheck_enable
916 .Pq Vt bool
917 Set to
918 .Dq Li YES
919 to check
920 .Pa /etc/login.conf
921 ownership, see
922 .Xr login.conf 5
923 for more information.
924 .It Va security_status_logincheck_period
925 .Pq Vt str
926 Set to either
927 .Dq Li daily ,
928 .Dq Li weekly ,
929 .Dq Li monthly
930 or
931 .Dq Li NO .
932 .It Va security_status_ipfwdenied_enable
933 .Pq Vt bool
934 Set to
935 .Dq Li YES
936 to show log entries for packets denied by
937 .Xr ipfw 8
938 since yesterday's check.
939 .It Va security_status_ipfwdenied_period
940 .Pq Vt str
941 Set to either
942 .Dq Li daily ,
943 .Dq Li weekly ,
944 .Dq Li monthly
945 or
946 .Dq Li NO .
947 .It Va security_status_ipfdenied_enable
948 .Pq Vt bool
949 Set to
950 .Dq Li YES
951 to show log entries for packets denied by
952 .Xr ipf 8
953 since yesterday's check.
954 .It Va security_status_ipfdenied_period
955 .Pq Vt str
956 Set to either
957 .Dq Li daily ,
958 .Dq Li weekly ,
959 .Dq Li monthly
960 or
961 .Dq Li NO .
962 .It Va security_status_pfdenied_enable
963 .Pq Vt bool
964 Set to
965 .Dq Li YES
966 to show log entries for packets denied by
967 .Xr pf 4
968 since yesterday's check.
969 .It Va security_status_pfdenied_period
970 .Pq Vt str
971 Set to either
972 .Dq Li daily ,
973 .Dq Li weekly ,
974 .Dq Li monthly
975 or
976 .Dq Li NO .
977 .It Va security_status_ipfwlimit_enable
978 .Pq Vt bool
979 Set to
980 .Dq Li YES
981 to display
982 .Xr ipfw 8
983 rules that have reached their verbosity limit.
984 .It Va security_status_ipfwlimit_period
985 .Pq Vt str
986 Set to either
987 .Dq Li daily ,
988 .Dq Li weekly ,
989 .Dq Li monthly
990 or
991 .Dq Li NO .
992 .It Va security_status_kernelmsg_enable
993 .Pq Vt bool
994 Set to
995 .Dq Li YES
996 to show new
997 .Xr dmesg 8
998 entries since yesterday's check.
999 .It Va security_status_kernelmsg_period
1000 .Pq Vt str
1001 Set to either
1002 .Dq Li daily ,
1003 .Dq Li weekly ,
1004 .Dq Li monthly
1005 or
1006 .Dq Li NO .
1007 .It Va security_status_loginfail_enable
1008 .Pq Vt bool
1009 Set to
1010 .Dq Li YES
1011 to display failed logins from
1012 .Pa /var/log/messages
1013 in the previous day.
1014 .It Va security_status_loginfail_period
1015 .Pq Vt str
1016 Set to either
1017 .Dq Li daily ,
1018 .Dq Li weekly ,
1019 .Dq Li monthly
1020 or
1021 .Dq Li NO .
1022 .It Va security_status_tcpwrap_enable
1023 .Pq Vt bool
1024 Set to
1025 .Dq Li YES
1026 to display connections denied by tcpwrappers (see
1027 .Xr hosts_access 5 )
1028 from
1029 .Pa /var/log/messages
1030 during the previous day.
1031 .It Va security_status_tcpwrap_period
1032 .Pq Vt str
1033 Set to either
1034 .Dq Li daily ,
1035 .Dq Li weekly ,
1036 .Dq Li monthly
1037 or
1038 .Dq Li NO .
1039 .El
1040 .Sh FILES
1041 .Bl -tag -width ".Pa /etc/defaults/periodic.conf"
1042 .It Pa /etc/defaults/periodic.conf
1043 The default configuration file.
1044 This file contains all default variables and values.
1045 .It Pa /etc/periodic.conf
1046 The usual system specific variable override file.
1047 .It Pa /etc/periodic.conf.local
1048 An additional override file, useful when
1049 .Pa /etc/periodic.conf
1050 is shared or distributed.
1051 .El
1052 .Sh SEE ALSO
1053 .Xr apropos 1 ,
1054 .Xr calendar 1 ,
1055 .Xr df 1 ,
1056 .Xr diff 1 ,
1057 .Xr gzip 1 ,
1058 .Xr locate 1 ,
1059 .Xr man 1 ,
1060 .Xr msgs 1 ,
1061 .Xr netstat 1 ,
1062 .Xr nice 1 ,
1063 .Xr login.conf 5 ,
1064 .Xr rc.conf 5 ,
1065 .Xr ac 8 ,
1066 .Xr chkgrp 8 ,
1067 .Xr dump 8 ,
1068 .Xr newsyslog 8 ,
1069 .Xr periodic 8 ,
1070 .Xr pkg-version 8 ,
1071 .Xr sendmail 8
1072 .Sh HISTORY
1073 The
1074 .Nm
1075 file appeared in
1076 .Fx 4.1 .
1077 .Sh AUTHORS
1078 .An Brian Somers Aq Mt brian@Awfulhak.org