Metadata-Version: 2.4
Name: openbsd
Version: 0.1.0
Summary: OpenBSD Library
Home-page: 
Download-URL: https://github.com/yuce/pyopenbsd
Author: Yuce Tekol
Author-email: yucetekol@gmail.com
License: BSD
Keywords: OpenBSD
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: POSIX :: BSD :: OpenBSD
Classifier: License :: OSI Approved :: BSD License
Description-Content-Type: text/markdown
Requires-Dist: cffi>=1.12.3
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

# 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

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

Try removing `rpath` permission.

### unveil

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

Try opening `/bin/ksh`.


Use `openbsd.unveil()` to stop limiting access to directories.

## License

(c) 2019 Yuce Tekol

[BSD](LICENSE)
