about summary refs log tree commit diff stats
path: root/README.md
blob: 66333259a468bf99e939f7f9b2ee1c6baf0177d9 (plain) (blame)
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
# openbsd

Python bindings for some OpenBSD-specific APIs. Currently the following are supported:

* `pledge`
* `unveil`

## Change Log

### v0.1.0 (2019-05-03)

    * Initial release.

## Installation

Openbsd is on PyPI. You can install it using pip:

    pip install openbsd

### Prerequisites

* OpenBSD 6.4 or better
* Python 3.6 or better OR Python 2.7

## Usage

Import `openbsd` first:
```python
import openbsd
```

### pledge

See: https://man.openbsd.org/pledge.2

```python
openbsd.pledge("stdio rpath")
print(open("/etc/resolv.conf"))
```

Try removing the`rpath permission.

### unveil

See: https://man.openbsd.org/unveil.2

```python
openbsd.unveil("/etc", "r")
print(open("/etc/resolv.conf"))
```

Try opening `/bin/ksh`.

Use `openbsd.unveil()` to lock down restrictions.


## Similar Projects

* [PyPledge](https://gitlab.com/i80and/pypledge): Python binding for the OpenBSD pledge(2) system call. Uses ctypes.

## License

(c) 2019 Yuce Tekol

[BSD](LICENSE)