servive 0.4.0

A stupid simple program to serve files over HTTP
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

# servive - Simple HTTP File Server

A lightweight, secure HTTP file server written in Rust with TLS and basic
authentication support.

## Features

- Serve files over HTTP/HTTPS
- Basic authentication support
- TLS encryption (via rustls)
- Optional directory listing
- Security headers (CSP, XSS protection, etc.)
- Configurable logging levels
- CLI configuration interface

## Installation

### From crates.io

```sh
cargo install servive
```

### From source

```sh
git clone https://github.com/metdxt/servive.git
cd servive
cargo install --path .
```

## Usage

### Basic usage

```sh
servive -p 8080 -d ./public
```

### With authentication

```sh
servive --username admin --password secret
```

### With TLS

```sh
servive --tls --tls-cert cert.pem --tls-key key.pem
```

### Disable directory listing

```sh
servive --no-list-dirs
```

### Enable Content Security Policy

```sh
servive --enable-csp
```

### Enable HSTS (requires TLS)

```sh
servive --tls --enable-hsts
```

### With specific bind address

IPv4:
```sh
servive -b 192.168.1.100
```

IPv6:
```sh
servive -b ::1
```

## Configuration Options

| Option              | Description                                     | Default         |
| ------------------- | ----------------------------------------------- | --------------- |
| `-p`, `--port`      | Port to listen on                               | 8000            |
| `-d`, `--directory` | Directory to serve files from                   | . (current dir) |
| `--username`        | Username for basic auth                         | None            |
| `--password`        | Password for basic auth                         | None            |
| `--log-level`       | Logging level (error, warn, info, debug, trace) | info            |
| `--tls`             | Enable TLS                                      | false           |
| `--tls-cert`        | TLS certificate file path                       | None            |
| `--tls-key`         | TLS private key file path                       | None            |
| `--no-list-dirs`    | Disable directory listing                       | false           |
| `-b`, `--bind`      | Bind address (IPv4 or IPv6)                     | 127.0.0.1       |
| `--show-dotfiles`   | Show dotfiles (hidden by default)               | false           |
| `--enable-csp`      | Enable Content Security Policy headers          | false           |
| `--enable-hsts`     | Enable HTTP Strict Transport Security headers   | false           |
| `--max-file-size`   | Maximum file size in bytes (0 for unlimited)    | unlimited       |

## File Size Limits

If you wish to limit file size served to clients you can:
- Set a custom limit with `--max-file-size BYTES`
- Allow unlimited file sizes with `--max-file-size 0` (this is default)

If limit is set servive will return `403 Forbidden` if requested file is larger than the limit.

## Security Considerations

- Basic authentication credentials are transmitted in plaintext when not using
  TLS
- Always use TLS in production environments
- The server adds security headers by default:
  - X-Content-Type-Options
  - X-Frame-Options
  - X-XSS-Protection
- Content-Security-Policy is optional (enabled with --enable-csp)
- HSTS (HTTP Strict Transport Security) is now opt-in (enabled with --enable-hsts when using TLS)

## Building from Source

1. Clone the repository:

```sh
git clone https://github.com/metdxt/servive.git
cd servive
```

2. Build in release mode:

```sh
cargo build --release
```

The binary will be available at `target/release/servive`

## License

The project is distributed under the MIT license