Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blacktop/seccomp-gen

Docker Secure Computing Profile Generator
https://github.com/blacktop/seccomp-gen

docker generator golang seccomp seccomp-profile

Last synced: about 3 hours ago
JSON representation

Docker Secure Computing Profile Generator

Host: GitHub
URL: https://github.com/blacktop/seccomp-gen
Owner: blacktop
License: mit
Created: 2018-12-02T00:00:29.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2021-10-22T21:31:57.000Z (about 3 years ago)
Last Synced: 2024-06-19T05:43:05.379Z (5 months ago)
Topics: docker, generator, golang, seccomp, seccomp-profile
Language: Go
Size: 52.7 KB
Stars: 45
Watchers: 4
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# seccomp-gen

[![Go](https://github.com/blacktop/seccomp-gen/workflows/Go/badge.svg?branch=master)](https://github.com/blacktop/seccomp-gen/actions) [![Github All Releases](https://img.shields.io/github/downloads/blacktop/seccomp-gen/total.svg)](https://github.com/blacktop/seccomp-gen/releases/latest) [![GitHub release](https://img.shields.io/github/release/blacktop/seccomp-gen.svg)](https://github.com/blacktop/seccomp-gen/releases) [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)

> Docker Secure Computing Profile Generator

---

## Why 🤔

This tool allows you to pipe the output of [strace](https://strace.io) through it and will auto-generate a docker seccomp profile that can be used to only whitelist the syscalls your container needs to run and blacklists everything else.

This adds a LOT of security by drastically limiting your attack surface to only what is needed.

## Syscall Arch Supported _(so far)_

- `SCMP_ARCH_X86`
- `SCMP_ARCH_X32`

## Install

### macOS

```bash
$ brew install blacktop/tap/seccomp-gen
```

### linux/windows

Download from [releases](https://github.com/blacktop/seccomp-gen/releases/latest)

## Getting Started

```bash
$ strace -ff curl github.com 2>&1 | scgen -verbose

• found syscall: execve
• found syscall: brk
• found syscall: access
• found syscall: access
• found syscall: openat
• found syscall: fstat
• found syscall: mmap
...
```

```bash
$ ls -lah

-rw-r--r-- 1 blacktop staff 6.7K Dec 1 21:23 seccomp.json
```

### Inside Docker

Create a new Dockerfile

```dockerfile
FROM /:
RUN apt-get update && apt-get install -y strace
CMD ["strace","-ff","/your-entrypoint.sh"]
```

Build `scgen` image

```bash
$ docker build -t /:scgen .
```

Generate `seccomp` profile from docker logs output

```bash
docker run --rm --security-opt seccomp=unconfined /:scgen 2>&1 | scgen -verbose
```

Use your :new: `seccomp` profile

```bash
docker run --rm --security-opt no-new-privileges --security-opt seccomp=/path/to/seccomp.json /:
```

#### Know Issue :warning:

I have noticed that `strace` misses things, but if you run with the generate seccomp profile docker should tell you the next syscall it needs by erroring out. Then you can add that one manually and repeat the process.

## Credits

- https://blog.jessfraz.com/post/how-to-use-new-docker-seccomp-profiles/
- https://github.com/antitree/syscall2seccomp
- https://github.com/xfernando/go2seccomp

## TODO

- [x] filter strace through linux (32|64bit) [tbl](https://github.com/torvalds/linux/blob/master/arch/x86/entry/syscalls/syscall_64.tbl) files like Jess does
- [ ] add support for consuming sysdig output
- [ ] only add current arch to arches
- [ ] https://github.com/opencontainers/runc/pull/1951
- [ ] https://github.com/moby/moby/issues/38333

## Issues

Find a bug? Want more features? Find something missing in the documentation? Let me know! Please don't hesitate to [file an issue](https://github.com/blacktop/seccomp-gen/issues/new)

## License