572c7c221a
* wg-quick: freebsd: allow loopback to work FreeBSD adds a route for point-to-point destination addresses. We don't really want to specify any destination address, but unfortunately we have to. Before we tried to cheat by giving our own address as the destination, but this had the unfortunate effect of preventing loopback from working on our local ip address. We work around this with yet another kludge: we set the destination address to 127.0.0.1. Since 127.0.0.1 is already assigned to an interface, this has the same effect of not specifying a destination address, and therefore we accomplish the intended behavior. Note that the bad behavior is still present in Darwin, where such workaround does not exist. * tools: remove unused check phony declaration * highlighter: when subtracting char, cast to unsigned * chacha20: name enums * tools: fight compiler slightly harder * tools: c_acc doesn't need to be initialized * queueing: more reasonable allocator function convention Usual nits. * systemd: wg-quick should depend on nss-lookup.target Since wg-quick(8) calls wg(8) which does hostname lookups, we should probably only run this after we're allowed to look up hostnames. * compat: backport ALIGN_DOWN * noise: whiten the nanoseconds portion of the timestamp This mitigates unrelated sidechannel attacks that think they can turn WireGuard into a useful time oracle. * hashtables: decouple hashtable allocations from the main device allocation The hashtable allocations are quite large, and cause the device allocation in the net framework to stall sometimes while it tries to find a contiguous region that can fit the device struct. To fix the allocation stalls, decouple the hashtable allocations from the device allocation and allocate the hashtables with kvmalloc's implicit __GFP_NORETRY so that the allocations fall back to vmalloc with little resistance. * chacha20poly1305: permit unaligned strides on certain platforms The map allocations required to fix this are mostly slower than unaligned paths. * noise: store clamped key instead of raw key This causes `wg show` to now show the right thing. Useful for doing comparisons. * compat: ipv6_stub is sometimes null On ancient kernels, ipv6_stub is sometimes null in cases where IPv6 has been disabled with a command line flag or other failures. * Makefile: don't duplicate code in install and modules-install * Makefile: make the depmod path configurable * queueing: net-next has changed signature of skb_probe_transport_header A 5.1 change. This could change again, but for now it allows us to keep this snapshot aligned with our upstream submissions. * netlink: don't remove allowed ips for new peers * peer: only synchronize_rcu_bh and traverse trie once when removing all peers * allowedips: maintain per-peer list of allowedips This is a rather big and important change that makes it much much faster to do operations involving thousands of peers. Batch peer/allowedip addition and clearing is several orders of magnitude faster now. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> |
||
|---|---|---|
| .circleci | ||
| .github | ||
| contrib | ||
| docs | ||
| examples | ||
| kernel | ||
| logo | ||
| pkg | ||
| projects | ||
| reports | ||
| scripts | ||
| sigs | ||
| src/cmd/linuxkit | ||
| test | ||
| tools | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| ADOPTERS.md | ||
| AUTHORS | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| linuxkit.yml | ||
| MAINTAINERS | ||
| Makefile | ||
| NOTICE | ||
| poule.yml | ||
| README.md | ||
LinuxKit
LinuxKit, a toolkit for building custom minimal, immutable Linux distributions.
- Secure defaults without compromising usability
- Everything is replaceable and customisable
- Immutable infrastructure applied to building Linux distributions
- Completely stateless, but persistent storage can be attached
- Easy tooling, with easy iteration
- Built with containers, for running containers
- Designed to create reproducible builds [WIP]
- Designed for building and running clustered applications, including but not limited to container orchestration such as Docker or Kubernetes
- Designed from the experience of building Docker Editions, but redesigned as a general-purpose toolkit
- Designed to be managed by external tooling, such as Infrakit or similar tools
- Includes a set of longer-term collaborative projects in various stages of development to innovate on kernel and userspace changes, particularly around security
LinuxKit currently supports the x86_64, arm64, and s390x architectures on a variety of platforms, both as virtual machines and baremetal (see below for details).
Subprojects
- LinuxKit kubernetes aims to build minimal and immutable Kubernetes images. (previously
projects/kubernetesin this repository). - LinuxKit LCOW LinuxKit images and utilities for Microsoft's Linux Containers on Windows.
- linux A copy of the Linux stable tree with branches LinuxKit kernels.
- virtsock A
golibrary and test utilities forvirtioand Hyper-V sockets. - rtf A regression test framework used for the LinuxKit CI tests (and other projects).
- homebrew Homebrew packages for the
linuxkittool.
Getting Started
Build the linuxkit tool
LinuxKit uses the linuxkit tool for building, pushing and running VM images.
Simple build instructions: use make to build. This will build the tool in bin/. Add this
to your PATH or copy it to somewhere in your PATH eg sudo cp bin/* /usr/local/bin/. Or you can use sudo make install.
If you already have go installed you can use go get -u github.com/linuxkit/linuxkit/src/cmd/linuxkit to install the linuxkit tool.
On MacOS there is a brew tap available. Detailed instructions are at linuxkit/homebrew-linuxkit,
the short summary is
brew tap linuxkit/linuxkit
brew install --HEAD linuxkit
Build requirements from source:
- GNU
make - Docker
- optionally
qemu
Building images
Once you have built the tool, use
linuxkit build linuxkit.yml
to build the example configuration. You can also specify different output formats, eg linuxkit build -format raw-bios linuxkit.yml to
output a raw BIOS bootable disk image, or linuxkit build -format iso-efi linuxkit.yml to output an EFI bootable ISO image. See linuxkit build -help for more information.
Booting and Testing
You can use linuxkit run <name> or linuxkit run <name>.<format> to
execute the image you created with linuxkit build <name>.yml. This
will use a suitable backend for your platform or you can choose one,
for example VMWare. See linuxkit run --help.
Currently supported platforms are:
- Local hypervisors
- HyperKit (macOS)
[x86_64] - Hyper-V (Windows)
[x86_64] - qemu (macOS, Linux, Windows)
[x86_64, arm64, s390x] - VMware (macOS, Windows)
[x86_64]
- HyperKit (macOS)
- Cloud based platforms:
- Amazon Web Services
[x86_64] - Google Cloud
[x86_64] - Microsoft Azure
[x86_64] - OpenStack
[x86_64]
- Amazon Web Services
- Baremetal:
- packet.net
[x86_64, arm64] - Raspberry Pi Model 3b
[arm64]
- packet.net
Running the Tests
The test suite uses rtf To
install this you should use make bin/rtf && make install. You will
also need to install expect on your system as some tests use it.
To run the test suite:
cd test
rtf -v run -x
This will run the tests and put the results in a the _results directory!
Run control is handled using labels and with pattern matching. To run add a label you may use:
rtf -v -l slow run -x
To run tests that match the pattern linuxkit.examples you would use the following command:
rtf -v run -x linuxkit.examples
Building your own customised image
To customise, copy or modify the linuxkit.yml to your own file.yml or use one of the examples and then run linuxkit build file.yml to
generate its specified output. You can run the output with linuxkit run file.
The yaml file specifies a kernel and base init system, a set of containers that are built into the generated image and started at boot time. You can specify the type
of artifact to build eg linuxkit build -format vhd linuxkit.yml.
If you want to build your own packages, see this document.
Yaml Specification
The yaml format specifies the image to be built:
kernelspecifies a kernel Docker image, containing a kernel and a filesystem tarball, eg containing modules. The example kernels are built fromkernel/initis the baseinitprocess Docker image, which is unpacked as the base system, containinginit,containerd,runcand a few tools. Built frompkg/init/onbootare the system containers, executed sequentially in order. They should terminate quickly when done.servicesis the system services, which normally run for the whole time the system is upfilesare additional files to add to the image
For a more detailed overview of the options see yaml documentation
Architecture and security
There is an overview of the architecture covering how the system works.
There is an overview of the security considerations and direction covering the security design of the system.
Roadmap
This project was extensively reworked from the code we are shipping in Docker Editions, and the result is not yet production quality. The plan is to return to production quality during Q3 2017, and rebase the Docker Editions on this open source project during this quarter. We plan to start making stable releases on this timescale.
This is an open project without fixed judgements, open to the community to set the direction. The guiding principles are:
- Security informs design
- Infrastructure as code: immutable, manageable with code
- Sensible, secure, and well-tested defaults
- An open, pluggable platform for diverse use cases
- Easy to use and participate in the project
- Built with containers, for portability and reproducibility
- Run with system containers, for isolation and extensibility
- A base for robust products
Development reports
There are monthly development reports summarising the work carried out each month.
Adopters
We maintain an incomplete list of adopters. Please open a PR if you are using LinuxKit in production or in your project, or both.
FAQ
See FAQ.
Released under the Apache 2.0 license.