aboutsummaryrefslogtreecommitdiffhomepage
path: root/dist/init/freebsd/README.md
blob: d2b38e667e202422e8122042a2f9771ff04404a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# Running caddy without root privileges

FreeBSD systems can use the mac_portacl module to allow access to
ports below 1024 by specific users (by default, non-root users are not
able to open ports below 1024).

On a stock FreeBSD system, you need to:

1. Add the following line to `/boot/loader.conf`, which tells the boot
   loader to load the `mac_portacl` kernel module:

    ``` shell
    mac_portacl_load="YES"
    ```

2. Add the following lines to `/etc/sysctl.conf`

    ``` shell
    net.inet.ip.portrange.reservedlow=0
    net.inet.ip.portrange.reservedhigh=0
    security.mac.portacl.port_high=1023
    security.mac.portacl.suser_exempt=1
    security.mac.portacl.rules=uid:80:tcp:80,uid:80:tcp:443
    ```

    The first two lines disable the default restrictions on ports <
    1023, the third makes the `mac_portacl` system responsible for ports
    from 0 (the default) up to 1023, and the fourth ensures that the
    superuser can open *any* port.

    The final/fifth line specifies two rules, separated by a `,`:

      - the first gives the `www` user (uid = 80) access to the `http`
        port (80); and
      - the second gives the `www` user (uid = 80) access to the `https`
        port (443).

    Other/additional rules are possible, e.g. access can be constrained
    by membership in the `www` *group* using the `gid` specifier:

    ```
    security.mac.portacl.rules=gid:80:tcp:80,gid:80:tcp:443
    ```

## See also

- The *MAC Port Access Control List Policy* section of the [Available
  MAC
  Policies](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/mac-policies.html)
  page.
- [Caddy issue #1923](https://github.com/mholt/caddy/issues/1923).

# Logging the caddy process's output:

Caddy's FreeBSD `rc.d` script uses `daemon` to run `caddy`; by default
it sends the process's standard output and error to syslog with the
`caddy` tag, the `local7` facility and the `notice` level.

The stock FreeBSD `/etc/syslog.conf` has a line near the top that
captures nearly anything logged at the `notice` level or higher and
sends it to `/var/log/messages`.  That line will send the caddy
process's output to `/var/log/messages`.

The simplest way to send `caddy` output to a separate file is:

- Arrange to log the messages at a lower level so that they slip past
  that early rule, e.g. add an `/etc/rc.conf` entry like

  ``` shell
  caddy_syslog_level="info"
  ```

- Add a rule that catches them, e.g. by creating a
  `/usr/local/etc/syslog.d/caddy.conf` file that contains:

  ```
  # Capture all messages tagged with "caddy" and send them to /var/log/caddy.log
  !caddy
  *.*      /var/log/caddy.log
  ```

  Heads up, if you specify a file that does not already exist, you'll
  need to create it.

-  Rotate `/var/log/caddy.log` with `newsyslog` by creating a
  `/usr/local/etc/newsyslog.conf/caddy.conf` file that contains:

  ```
  # See newsyslog.conf(5) for details.  Logs written by syslog,
  # no need for a pidfile or signal, the defaults workg.
  # logfilename         [owner:group]  mode count size when  flags [/pid_file] [sig_num]
  /var/log/caddy.log        www:www       664  7     *    @T00  J
  ```

There are many other ways to do it, read the `syslogd.conf` and
`newsyslog.conf` man pages for additional information.