├── VERSION ├── peerix ├── __init__.py ├── prefix.py ├── __main__.py ├── app.py ├── store.py ├── local.py └── remote.py ├── .envrc ├── requirements.txt ├── overlay.nix ├── shell.nix ├── default.nix ├── .editorconfig ├── setup.py ├── flake.lock ├── flake.nix ├── README.md ├── .gitignore ├── module.nix └── COPYING /VERSION: -------------------------------------------------------------------------------- 1 | 0.0.1 2 | -------------------------------------------------------------------------------- /peerix/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.envrc: -------------------------------------------------------------------------------- 1 | eval "$(lorri direnv)" 2 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | aiohttp 2 | uvloop 3 | hypercorn 4 | starlette 5 | psutil 6 | -------------------------------------------------------------------------------- /overlay.nix: -------------------------------------------------------------------------------- 1 | { self }: 2 | final: prev: { 3 | peerix = self.packages.${prev.system}.peerix; 4 | } 5 | -------------------------------------------------------------------------------- /shell.nix: -------------------------------------------------------------------------------- 1 | (import ( 2 | let 3 | lock = builtins.fromJSON (builtins.readFile ./flake.lock); 4 | in fetchTarball { 5 | url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz"; 6 | sha256 = lock.nodes.flake-compat.locked.narHash; } 7 | ) { 8 | src = ./.; 9 | }).shellNix 10 | -------------------------------------------------------------------------------- /default.nix: -------------------------------------------------------------------------------- 1 | (import ( 2 | let 3 | lock = builtins.fromJSON (builtins.readFile ./flake.lock); 4 | in fetchTarball { 5 | url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz"; 6 | sha256 = lock.nodes.flake-compat.locked.narHash; } 7 | ) { 8 | src = ./.; 9 | }).defaultNix 10 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # Editor configuration, see http://editorconfig.org 2 | root = true 3 | 4 | [*] 5 | end_of_line = lf 6 | insert_final_newline = true 7 | trim_trailing_whitespace = true 8 | charset = utf-8 9 | indent_style = space 10 | indent_size = 2 11 | 12 | [*.py] 13 | indent_size = 4 14 | 15 | [*.md] 16 | max_line_length = off 17 | trim_trailing_whitespace = false 18 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #setup.py: 2 | import os 3 | from setuptools import setup, find_packages 4 | 5 | DIR = os.path.dirname(__file__) 6 | 7 | with open(os.path.join(DIR, "requirements.txt")) as f: 8 | requirements = [l.strip() for l in f.readlines()] 9 | 10 | with open(os.path.join(DIR, "VERSION")) as f: 11 | version = f.read().strip() 12 | 13 | setup( 14 | name="peerix", 15 | packages=find_packages(), 16 | entry_points={ 17 | "console_scripts": [ 18 | 'peerix = peerix.__main__:run' 19 | ] 20 | }, 21 | version=version, 22 | requires=requirements 23 | ) 24 | -------------------------------------------------------------------------------- /peerix/prefix.py: -------------------------------------------------------------------------------- 1 | import typing as t 2 | from peerix.store import NarInfo, Store 3 | 4 | 5 | class PrefixStore(Store): 6 | def __init__(self, prefix: str, backend: Store): 7 | self.backend = backend 8 | self.prefix = prefix 9 | 10 | async def cache_info(self): 11 | return await self.backend.cache_info() 12 | 13 | async def narinfo(self, hsh: str) -> t.Optional[NarInfo]: 14 | info = await self.backend.narinfo(hsh) 15 | if info is None: 16 | return None 17 | return info._replace(url=f"{self.prefix}/{info.url}") 18 | 19 | def nar(self, path: str) -> t.Awaitable[t.AsyncIterable[bytes]]: 20 | if not path.startswith(self.prefix + "/"): 21 | raise FileNotFoundError("Not found.") 22 | 23 | return self.backend.nar(path[len(self.prefix)+1:]) 24 | 25 | -------------------------------------------------------------------------------- /peerix/__main__.py: -------------------------------------------------------------------------------- 1 | import os 2 | import logging 3 | import asyncio 4 | import argparse 5 | 6 | import uvloop 7 | from hypercorn import Config 8 | from hypercorn.asyncio import serve 9 | 10 | from peerix.app import app, setup_stores 11 | 12 | 13 | parser = argparse.ArgumentParser(description="Peerix nix binary cache.") 14 | parser.add_argument("--verbose", action="store_const", const=logging.DEBUG, default=logging.INFO, dest="loglevel") 15 | parser.add_argument("--port", default=12304, type=int) 16 | parser.add_argument("--private-key", required=False) 17 | parser.add_argument("--timeout", type=int, default=50) 18 | 19 | def run(): 20 | args = parser.parse_args() 21 | if args.private_key is not None: 22 | os.environ["NIX_SECRET_KEY_FILE"] = os.path.abspath(os.path.expanduser(args.private_key)) 23 | 24 | logging.basicConfig(level=args.loglevel) 25 | uvloop.install() 26 | 27 | asyncio.run(main(args.port, args.timeout / 1000.0)) 28 | 29 | 30 | async def main(port: int, timeout: float): 31 | config = Config() 32 | config.bind = [f"0.0.0.0:{port}"] 33 | 34 | async with setup_stores(port, timeout): 35 | await serve(app, config) 36 | 37 | 38 | if __name__ == "__main__": 39 | run() 40 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "flake-compat": { 4 | "flake": false, 5 | "locked": { 6 | "lastModified": 1627913399, 7 | "narHash": "sha256-hY8g6H2KFL8ownSiFeMOjwPC8P0ueXpCVEbxgda3pko=", 8 | "owner": "edolstra", 9 | "repo": "flake-compat", 10 | "rev": "12c64ca55c1014cdc1b16ed5a804aa8576601ff2", 11 | "type": "github" 12 | }, 13 | "original": { 14 | "owner": "edolstra", 15 | "repo": "flake-compat", 16 | "type": "github" 17 | } 18 | }, 19 | "flake-utils": { 20 | "locked": { 21 | "lastModified": 1634851050, 22 | "narHash": "sha256-N83GlSGPJJdcqhUxSCS/WwW5pksYf3VP1M13cDRTSVA=", 23 | "owner": "numtide", 24 | "repo": "flake-utils", 25 | "rev": "c91f3de5adaf1de973b797ef7485e441a65b8935", 26 | "type": "github" 27 | }, 28 | "original": { 29 | "owner": "numtide", 30 | "repo": "flake-utils", 31 | "type": "github" 32 | } 33 | }, 34 | "nixpkgs": { 35 | "locked": { 36 | "lastModified": 1636886446, 37 | "narHash": "sha256-4xsVM2H8CG3d/3V+GqDDLDOmb3kdrugbqKVyrg8Q/zc=", 38 | "owner": "NixOS", 39 | "repo": "nixpkgs", 40 | "rev": "5cb226a06c49f7a2d02863d0b5786a310599df6b", 41 | "type": "github" 42 | }, 43 | "original": { 44 | "id": "nixpkgs", 45 | "ref": "nixpkgs-unstable", 46 | "type": "indirect" 47 | } 48 | }, 49 | "root": { 50 | "inputs": { 51 | "flake-compat": "flake-compat", 52 | "flake-utils": "flake-utils", 53 | "nixpkgs": "nixpkgs" 54 | } 55 | } 56 | }, 57 | "root": "root", 58 | "version": 7 59 | } 60 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | description = "Peer2Peer Nix-Binary-Cache"; 3 | 4 | inputs = { 5 | nixpkgs.url = "nixpkgs/nixpkgs-unstable"; 6 | flake-compat = { 7 | url = "github:edolstra/flake-compat"; 8 | flake = false; 9 | }; 10 | flake-utils.url = "github:numtide/flake-utils"; 11 | }; 12 | 13 | outputs = { self, nixpkgs, flake-utils, ... }: { 14 | nixosModules.peerix = import ./module.nix; 15 | overlay = import ./overlay.nix { inherit self; }; 16 | } // flake-utils.lib.eachDefaultSystem (system: 17 | let 18 | pkgs = nixpkgs.legacyPackages.${system}; 19 | python = pkgs.python39; 20 | packages = map (pkg: python.pkgs.${pkg}) (builtins.filter (v: builtins.isString v && (builtins.stringLength v) > 0) (builtins.split "\n" (builtins.readFile ./requirements.txt))); 21 | in { 22 | packages = rec { 23 | peerix-unwrapped = python.pkgs.buildPythonApplication { 24 | pname = "peerix"; 25 | version = builtins.replaceStrings [ " " "\n" ] [ "" "" ] (builtins.readFile ./VERSION); 26 | src = ./.; 27 | 28 | doCheck = false; 29 | 30 | propagatedBuildInputs = with pkgs; [ 31 | nix 32 | nix-serve 33 | ] ++ packages; 34 | }; 35 | 36 | peerix = pkgs.writeShellScriptBin "peerix" '' 37 | PATH=${pkgs.nix}/bin:${pkgs.nix-serve}:$PATH 38 | exec ${peerix-unwrapped}/bin/peerix "$@" 39 | ''; 40 | }; 41 | 42 | defaultPackage = self.packages.${system}.peerix; 43 | 44 | devShell = pkgs.mkShell { 45 | buildInputs = with pkgs; [ 46 | nix-serve 47 | niv 48 | (python.withPackages (ps: packages)) 49 | ]; 50 | }; 51 | 52 | defaultApp = { type = "app"; program = "${self.packages.${system}.peerix}/bin/peerix"; }; 53 | }); 54 | } 55 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Peerix 2 | ====== 3 | 4 | Peerix is a peer-to-peer binary cache for nix derivations. 5 | Every participating node can pull derivations from each other instances' respective nix-stores. 6 | 7 | How does it work? 8 | ----------------- 9 | 10 | Peerix implements a nix binary cache. When the nix package manager queries peerix, peerix 11 | will ask the network if any other peerix instances hold the package, and if some other instance 12 | holds the derivation, it will download the derivation from that instance. 13 | 14 | Installation 15 | ------------ 16 | There is a nix-module located at `module.nix` that configures your nixos-installation 17 | to automatically use peernix. 18 | 19 | These Options exist: 20 | 21 | | Option | Description | 22 | |----------------------------------|----------------------------------------------------------------------------------------------| 23 | | `services.peerix.enable` | Enables Peerix | 24 | | `services.peerix.openFirewall` | Open the neccessary firewall ports. | 25 | | `services.peerix.user` | What user should the peerix service run under. | 26 | | `services.peerix.group` | What group should the peerix service run under. | 27 | | `services.peerix.privateKeyFile` | A path to the file that contains the path to the private key to sign your derivations. | 28 | | `services.peerix.publicKeyFile` | A path to the file that contains the path to the public key so nix can verify the signature. | 29 | | `services.peerix.publicKey` | Directly specifiy a public key for the binary caches. | 30 | 31 | To sign the peerix cache, you can use `nix-store --generate-binary-cache-key` to create keys to verify authenticity of 32 | the packages in each nix-store. 33 | -------------------------------------------------------------------------------- /peerix/app.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import datetime 3 | import contextlib 4 | 5 | from starlette.requests import Request 6 | from starlette.responses import Response, StreamingResponse 7 | from starlette.applications import Starlette 8 | 9 | from peerix.local import local 10 | from peerix.remote import remote 11 | from peerix.prefix import PrefixStore 12 | 13 | 14 | 15 | @contextlib.asynccontextmanager 16 | async def setup_stores(local_port: int, timeout: float): 17 | global l_access, r_access 18 | async with local() as l: 19 | l_access = PrefixStore("local/nar", l) 20 | lp = PrefixStore("local", l) 21 | async with remote(lp, local_port, "0.0.0.0", lp.prefix, timeout) as r: 22 | r_access = PrefixStore("v2/remote", r) 23 | yield 24 | 25 | 26 | app = Starlette() 27 | 28 | 29 | @app.route("/nix-cache-info") 30 | async def cache_info(_: Request) -> Response: 31 | ci = await l_access.cache_info() 32 | ci = ci._replace(priority=20) 33 | return Response(content=ci.dump()) 34 | 35 | 36 | @app.route("/{hash:str}.narinfo") 37 | async def narinfo(req: Request) -> Response: 38 | 39 | if req.client.host != "127.0.0.1": 40 | return Response(content="Permission denied.", status_code=403) 41 | 42 | # We do not cache nar-infos. 43 | # Therefore, dynamically recompute expires at. 44 | ni = await r_access.narinfo(req.path_params["hash"]) 45 | 46 | if ni is None: 47 | return Response(content="Not found", status_code=404) 48 | 49 | return Response(content=ni.dump(), status_code=200, media_type="text/x-nix-narinfo") 50 | 51 | @app.route("/local/{hash:str}.narinfo") 52 | async def access_narinfo(req: Request) -> Response: 53 | ni = await l_access.narinfo(req.path_params["hash"]) 54 | if ni is None: 55 | return Response(content="Not found", status_code=404) 56 | return Response(content=ni.dump(), status_code=200, media_type="text/x-nix-narinfo") 57 | 58 | 59 | @app.route("/local/nar/{path:str}") 60 | async def push_nar(req: Request) -> Response: 61 | try: 62 | return StreamingResponse( 63 | await l_access.nar(f"local/nar/{req.path_params['path']}"), 64 | media_type="text/plain" 65 | ) 66 | except FileNotFoundError: 67 | return Response(content="Gone", status_code=404) 68 | 69 | # Paths must be versioned as nix is caching the NAR urls. 70 | @app.route("/v2/remote/{path:path}") 71 | async def pull_nar(req: Request) -> Response: 72 | try: 73 | return StreamingResponse(await r_access.nar(f"v2/remote/{req.path_params['path']}"), media_type="text/plain") 74 | except FileNotFoundError: 75 | return Response(content="Gone", status_code=404) 76 | -------------------------------------------------------------------------------- /peerix/store.py: -------------------------------------------------------------------------------- 1 | import typing as t 2 | 3 | 4 | class NarInfo(t.NamedTuple): 5 | storePath: str 6 | url: str 7 | compression: t.Literal["none"] 8 | narHash: str 9 | narSize: int 10 | references: t.Sequence[str] 11 | deriver: t.Optional[str] 12 | signatures: t.Sequence[str] 13 | 14 | def dump(self) -> str: 15 | lines = [ 16 | f"StorePath: {self.storePath}", 17 | f"URL: {self.url}", 18 | f"Compression: {self.compression}", 19 | f"NarHash: {self.narHash}", 20 | f"NarSize: {self.narSize}" 21 | ] 22 | if self.references: 23 | lines.append(f"References: {' '.join(self.references)}") 24 | if self.deriver: 25 | lines.append(f"Deriver: {self.deriver}") 26 | for sig in self.signatures: 27 | lines.append(f"Sig: {sig}") 28 | lines.append("") 29 | return "\n".join(lines) 30 | 31 | @classmethod 32 | def parse(cls, data: str) -> "NarInfo": 33 | storePath = "" 34 | url = "" 35 | compression = "none" 36 | narHash = "" 37 | narSize = -1 38 | references = [] 39 | deriver = None 40 | signatures = [] 41 | 42 | for line in data.splitlines(): 43 | k, v = line.split(":", 1) 44 | v = v.strip() 45 | k = k.strip() 46 | 47 | if k == "StorePath": 48 | storePath = v 49 | elif k == "URL": 50 | url = v 51 | elif k == "Compression" and v == "none": 52 | compression = v 53 | elif k == "NarHash": 54 | narHash = v 55 | elif k == "NarSize": 56 | narSize = int(v) 57 | elif k == "References": 58 | references = v.split(" ") 59 | elif k == "Deriver": 60 | deriver = v 61 | elif k == "Sig": 62 | signatures.append(v) 63 | 64 | return NarInfo(storePath, url, compression, narHash, narSize, references, deriver, signatures) 65 | 66 | 67 | 68 | class CacheInfo(t.NamedTuple): 69 | storeDir: str 70 | wantMassQuery: int 71 | priority: int 72 | 73 | def dump(self) -> str: 74 | return "\n".join(( 75 | f"StoreDir: {self.storeDir}", 76 | f"WantMassQuery: {self.wantMassQuery}", 77 | f"Priority: {self.priority}" 78 | )) + "\n" 79 | 80 | 81 | class Store: 82 | 83 | async def cache_info(self) -> CacheInfo: 84 | raise NotImplementedError() 85 | 86 | async def narinfo(self, hsh: str) -> t.Optional[NarInfo]: 87 | raise NotImplementedError() 88 | 89 | def nar(self, url: str) -> t.Awaitable[t.AsyncIterable[bytes]]: 90 | raise NotImplementedError() 91 | 92 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.toptal.com/developers/gitignore/api/python 3 | # Edit at https://www.toptal.com/developers/gitignore?templates=python 4 | 5 | ### Python ### 6 | # Byte-compiled / optimized / DLL files 7 | __pycache__/ 8 | *.py[cod] 9 | *$py.class 10 | 11 | # C extensions 12 | *.so 13 | 14 | # Distribution / packaging 15 | .Python 16 | build/ 17 | develop-eggs/ 18 | dist/ 19 | downloads/ 20 | eggs/ 21 | .eggs/ 22 | lib/ 23 | lib64/ 24 | parts/ 25 | sdist/ 26 | var/ 27 | wheels/ 28 | share/python-wheels/ 29 | *.egg-info/ 30 | .installed.cfg 31 | *.egg 32 | MANIFEST 33 | 34 | # PyInstaller 35 | # Usually these files are written by a python script from a template 36 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 37 | *.manifest 38 | *.spec 39 | 40 | # Installer logs 41 | pip-log.txt 42 | pip-delete-this-directory.txt 43 | 44 | # Unit test / coverage reports 45 | htmlcov/ 46 | .tox/ 47 | .nox/ 48 | .coverage 49 | .coverage.* 50 | .cache 51 | nosetests.xml 52 | coverage.xml 53 | *.cover 54 | *.py,cover 55 | .hypothesis/ 56 | .pytest_cache/ 57 | cover/ 58 | 59 | # Translations 60 | *.mo 61 | *.pot 62 | 63 | # Django stuff: 64 | *.log 65 | local_settings.py 66 | db.sqlite3 67 | db.sqlite3-journal 68 | 69 | # Flask stuff: 70 | instance/ 71 | .webassets-cache 72 | 73 | # Scrapy stuff: 74 | .scrapy 75 | 76 | # Sphinx documentation 77 | docs/_build/ 78 | 79 | # PyBuilder 80 | .pybuilder/ 81 | target/ 82 | 83 | # Jupyter Notebook 84 | .ipynb_checkpoints 85 | 86 | # IPython 87 | profile_default/ 88 | ipython_config.py 89 | 90 | # pyenv 91 | # For a library or package, you might want to ignore these files since the code is 92 | # intended to run in multiple environments; otherwise, check them in: 93 | # .python-version 94 | 95 | # pipenv 96 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 97 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 98 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 99 | # install all needed dependencies. 100 | #Pipfile.lock 101 | 102 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 103 | __pypackages__/ 104 | 105 | # Celery stuff 106 | celerybeat-schedule 107 | celerybeat.pid 108 | 109 | # SageMath parsed files 110 | *.sage.py 111 | 112 | # Environments 113 | .env 114 | .venv 115 | env/ 116 | venv/ 117 | ENV/ 118 | env.bak/ 119 | venv.bak/ 120 | 121 | # Spyder project settings 122 | .spyderproject 123 | .spyproject 124 | 125 | # Rope project settings 126 | .ropeproject 127 | 128 | # mkdocs documentation 129 | /site 130 | 131 | # mypy 132 | .mypy_cache/ 133 | .dmypy.json 134 | dmypy.json 135 | 136 | # Pyre type checker 137 | .pyre/ 138 | 139 | # pytype static type analyzer 140 | .pytype/ 141 | 142 | # Cython debug symbols 143 | cython_debug/ 144 | 145 | # End of https://www.toptal.com/developers/gitignore/api/python 146 | 147 | result 148 | -------------------------------------------------------------------------------- /peerix/local.py: -------------------------------------------------------------------------------- 1 | import typing as t 2 | 3 | import contextlib 4 | import subprocess 5 | import tempfile 6 | import logging 7 | import asyncio 8 | import shutil 9 | import base64 10 | import sys 11 | import os 12 | 13 | import aiohttp 14 | 15 | from peerix.store import NarInfo, CacheInfo, Store 16 | 17 | 18 | nix_serve = shutil.which("nix-serve") 19 | if nix_serve is None: 20 | raise RuntimeError("nix-serve is not installed.") 21 | 22 | nix = shutil.which("nix") 23 | if nix is None: 24 | raise RuntimeError("nix is not installed.") 25 | 26 | assert nix_serve is not None 27 | assert nix is not None 28 | 29 | 30 | logger = logging.getLogger("peerix.local") 31 | 32 | 33 | class LocalStore(Store): 34 | 35 | def __init__(self, session: aiohttp.ClientSession): 36 | self.session = session 37 | self._cache: t.Optional[CacheInfo] = None 38 | 39 | async def cache_info(self) -> CacheInfo: 40 | if self._cache is None: 41 | async with self.session.get("http://_/nix-cache-info") as resp: 42 | storeDir = "" 43 | wantMassQuery = -1 44 | priority = 50 45 | 46 | for line in (await resp.text()).splitlines(): 47 | k, v = line.split(":", 1) 48 | v = v.strip() 49 | k = k.strip() 50 | 51 | if k == "StoreDir": 52 | storeDir = v 53 | elif k == "WantMassQuery": 54 | wantMassQuery = int(v) 55 | elif k == "Priority": 56 | priority = int(v) 57 | 58 | self._cache = CacheInfo(storeDir, wantMassQuery, priority) 59 | 60 | return self._cache 61 | 62 | 63 | async def narinfo(self, hsh: str) -> t.Optional[NarInfo]: 64 | async with self.session.get(f"http://_/{hsh}.narinfo") as resp: 65 | if resp.status == 404: 66 | return None 67 | info = NarInfo.parse(await resp.text()) 68 | return info._replace(url=base64.b64encode(info.storePath.encode("utf-8")).replace(b"/", b"_").decode("ascii")+".nar") 69 | 70 | async def nar(self, sp: str) -> t.Awaitable[t.AsyncIterable[bytes]]: 71 | if sp.endswith(".nar"): 72 | sp = sp[:-4] 73 | path = base64.b64decode(sp.replace("_", "/")).decode("utf-8") 74 | if not path.startswith((await self.cache_info()).storeDir): 75 | raise FileNotFoundError() 76 | 77 | if not os.path.exists(path): 78 | raise FileNotFoundError() 79 | 80 | return self._nar_pull(path) 81 | 82 | async def _nar_pull(self, path: str) -> t.AsyncIterable[bytes]: 83 | logger.info(f"Serving {path}") 84 | process = await asyncio.create_subprocess_exec( 85 | nix, "dump-path", "--", path, 86 | stdout=subprocess.PIPE, 87 | stderr=subprocess.DEVNULL, 88 | stdin=subprocess.DEVNULL, 89 | ) 90 | 91 | assert process.stdout is not None 92 | while not process.stdout.at_eof(): 93 | yield await process.stdout.read(10*1024*1024) 94 | 95 | logger.debug(f"Served {path}") 96 | try: 97 | process.terminate() 98 | except ProcessLookupError: 99 | pass 100 | 101 | 102 | @contextlib.asynccontextmanager 103 | async def local(): 104 | with tempfile.TemporaryDirectory() as tmpdir: 105 | sock = f"{tmpdir}/server.sock" 106 | 107 | logger.info("Launching nix-serve.") 108 | process = await asyncio.create_subprocess_exec( 109 | nix_serve, "--listen", sock, 110 | stdin=subprocess.DEVNULL, 111 | stdout=subprocess.DEVNULL, 112 | stderr=sys.stderr 113 | ) 114 | for _ in range(10): 115 | if os.path.exists(sock): 116 | break 117 | await asyncio.sleep(1) 118 | else: 119 | raise RuntimeError("Failed to start up local store.") 120 | 121 | try: 122 | connector = aiohttp.UnixConnector(sock) 123 | async with aiohttp.ClientSession(connector_owner=True, connector=connector) as session: 124 | yield LocalStore(session) 125 | finally: 126 | try: 127 | process.terminate() 128 | except ProcessLookupError: 129 | pass 130 | 131 | logger.info("nix-serve exited.") 132 | 133 | -------------------------------------------------------------------------------- /module.nix: -------------------------------------------------------------------------------- 1 | { lib, config, pkgs, ... }: 2 | let 3 | cfg = config.services.peerix; 4 | in 5 | { 6 | options = with lib; { 7 | services.peerix = { 8 | enable = lib.mkEnableOption "peerix"; 9 | 10 | openFirewall = lib.mkOption { 11 | type = types.bool; 12 | default = true; 13 | description = '' 14 | Defines whether or not firewall ports should be opened for it. 15 | ''; 16 | }; 17 | 18 | privateKeyFile = lib.mkOption { 19 | type = types.nullOr types.path; 20 | default = null; 21 | description = '' 22 | File containing the private key to sign the derivations with. 23 | ''; 24 | }; 25 | 26 | publicKeyFile = lib.mkOption { 27 | type = types.nullOr types.path; 28 | default = null; 29 | description = '' 30 | File containing the public key to sign the derivations with. 31 | ''; 32 | }; 33 | 34 | publicKey = lib.mkOption { 35 | type = types.nullOr types.str; 36 | default = null; 37 | description = '' 38 | The public key to sign the derivations with. 39 | ''; 40 | }; 41 | 42 | user = lib.mkOption { 43 | type = with types; oneOf [ str int ]; 44 | default = "nobody"; 45 | description = '' 46 | The user the service will use. 47 | ''; 48 | }; 49 | 50 | group = lib.mkOption { 51 | type = with types; oneOf [ str int ]; 52 | default = "nobody"; 53 | description = '' 54 | The user the service will use. 55 | ''; 56 | }; 57 | 58 | globalCacheTTL = lib.mkOption { 59 | type = types.nullOr types.int; 60 | default = null; 61 | description = '' 62 | How long should nix store narinfo files. 63 | 64 | If not defined, the module will not reconfigure the entry. 65 | If it is defined, this will define how many seconds a cache entry will 66 | be stored. 67 | 68 | By default not given, as it affects the UX of the nix installation. 69 | ''; 70 | }; 71 | 72 | package = mkOption { 73 | type = types.package; 74 | default = (import ./default.nix).default or pkgs.peerix; 75 | defaultText = literalExpression "pkgs.peerix"; 76 | description = "The package to use for peerix"; 77 | }; 78 | }; 79 | }; 80 | 81 | config = lib.mkIf (cfg.enable) { 82 | systemd.services.peerix = { 83 | enable = true; 84 | description = "Local p2p nix caching daemon"; 85 | wantedBy = ["multi-user.target"]; 86 | serviceConfig = { 87 | Type = "simple"; 88 | 89 | User = cfg.user; 90 | Group = cfg.group; 91 | 92 | PrivateMounts = true; 93 | PrivateDevices = true; 94 | PrivateTmp = true; 95 | PrivateIPC = true; 96 | PrivateUsers = true; 97 | 98 | SystemCallFilters = [ 99 | "@aio" 100 | "@basic-io" 101 | "@file-system" 102 | "@io-event" 103 | "@process" 104 | "@network-io" 105 | "@timer" 106 | "@signal" 107 | "@alarm" 108 | ]; 109 | SystemCallErrorNumber = "EPERM"; 110 | 111 | ProtectSystem = "full"; 112 | ProtectHome = true; 113 | ProtectHostname = true; 114 | ProtectClock = true; 115 | ProtectKernelTunables = true; 116 | ProtectKernelModules = true; 117 | ProtectKernelLogs = true; 118 | ProtectControlGroups = true; 119 | RestrictNamespaces = ""; 120 | 121 | NoNewPrivileges = true; 122 | ReadOnlyPaths = lib.mkMerge [ 123 | ([ 124 | "/nix/var" 125 | "/nix/store" 126 | ]) 127 | 128 | (lib.mkIf (cfg.privateKeyFile != null) [ 129 | cfg.privateKeyFile 130 | ]) 131 | ]; 132 | ExecPaths = [ 133 | "/nix/store" 134 | ]; 135 | Environment = lib.mkIf (cfg.privateKeyFile != null) [ 136 | "NIX_SECRET_KEY_FILE=${cfg.privateKeyFile}" 137 | ]; 138 | }; 139 | script = '' 140 | exec ${cfg.package}/bin/peerix 141 | ''; 142 | }; 143 | 144 | nix = { 145 | settings = { 146 | substituters = [ 147 | "http://127.0.0.1:12304/" 148 | ]; 149 | trusted-public-keys = [ 150 | (lib.mkIf (cfg.publicKeyFile != null) (builtins.readFile cfg.publicKeyFile)) 151 | (lib.mkIf (cfg.publicKey != null) cfg.publicKey) 152 | ]; 153 | }; 154 | extraOptions = lib.mkIf (cfg.globalCacheTTL != null) '' 155 | narinfo-cache-negative-ttl = ${toString cfg.globalCacheTTL} 156 | narinfo-cache-positive-ttl = ${toString cfg.globalCacheTTL} 157 | ''; 158 | }; 159 | 160 | networking.firewall = lib.mkIf (cfg.openFirewall) { 161 | allowedTCPPorts = [ 12304 ]; 162 | allowedUDPPorts = [ 12304 ]; 163 | }; 164 | }; 165 | } 166 | -------------------------------------------------------------------------------- /peerix/remote.py: -------------------------------------------------------------------------------- 1 | import typing as t 2 | 3 | import socket 4 | import logging 5 | import asyncio 6 | import ipaddress 7 | import contextlib 8 | 9 | import psutil 10 | import aiohttp 11 | 12 | 13 | from peerix.store import NarInfo, Store 14 | 15 | 16 | logger = logging.getLogger("peerix.remote") 17 | 18 | 19 | 20 | def get_brdcasts(): 21 | for interface, iaddrs in psutil.net_if_addrs().items(): 22 | for iaddr in iaddrs: 23 | if iaddr.broadcast is None or iaddr.family != socket.AF_INET: 24 | continue 25 | 26 | ifa = ipaddress.IPv4Interface(f"{iaddr.address}/{iaddr.netmask}") 27 | if not ifa.network.is_private: 28 | continue 29 | 30 | yield str(ifa.network.broadcast_address) 31 | 32 | 33 | def get_myself(): 34 | for interface, iaddrs in psutil.net_if_addrs().items(): 35 | for iaddr in iaddrs: 36 | if iaddr.broadcast is None or iaddr.family != socket.AF_INET: 37 | continue 38 | 39 | yield str(iaddr.address) 40 | 41 | 42 | class DiscoveryProtocol(asyncio.DatagramProtocol, Store): 43 | idx: int 44 | transport: asyncio.DatagramTransport 45 | waiters: t.Dict[int, asyncio.Future] 46 | store: Store 47 | session: aiohttp.ClientSession 48 | local_port: int 49 | prefix: str 50 | timeout: float 51 | 52 | def __init__(self, store: Store, session: aiohttp.ClientSession, local_port: int, prefix: str, timeout: float): 53 | self.idx = 0 54 | self.waiters = {} 55 | self.store = store 56 | self.session = session 57 | self.local_port = local_port 58 | self.prefix = prefix 59 | self.timeout = timeout 60 | 61 | def connection_made(self, transport): 62 | self.transport = transport 63 | 64 | def datagram_received(self, data: bytes, addr: t.Tuple[str, int]) -> None: 65 | if addr[0] in set(get_myself()): 66 | logger.debug(f"Ignoring packet from {addr[0]}") 67 | return 68 | 69 | # 0 => Response to a command of mine. 70 | if data[0] == 1: 71 | idx = int.from_bytes(data[1:5], "big") 72 | if idx not in self.waiters: 73 | return 74 | 75 | self.waiters[idx].set_result((int.from_bytes(data[5:9], "big"), data[9:].decode("utf-8"), addr)) 76 | 77 | # 1 => Request from another server. 78 | elif data[0] == 0: 79 | asyncio.create_task(self.respond(data, addr)) 80 | 81 | def stop(self): 82 | self.transport.close() 83 | 84 | async def cache_info(self): 85 | return await self.store.cache_info() 86 | 87 | async def respond(self, data: bytes, addr: t.Tuple[str, int]) -> None: 88 | hsh = data[5:].decode("utf-8") 89 | logger.info(f"Got request from {addr[0]}:{addr[1]} for {hsh}") 90 | narinfo = await self.store.narinfo(hsh) 91 | if narinfo is None: 92 | logger.debug(f"{hsh} not found") 93 | return 94 | 95 | logger.debug(f"{hsh} was found.") 96 | self.transport.sendto(b"".join([ 97 | b"\x01", 98 | data[1:5], 99 | self.local_port.to_bytes(4, "big"), 100 | self.prefix.encode("utf-8"), 101 | b"/", 102 | hsh.encode("utf-8"), 103 | b".narinfo" 104 | ]), addr) 105 | 106 | async def narinfo(self, hsh: str) -> t.Optional[NarInfo]: 107 | fut = asyncio.get_running_loop().create_future() 108 | self.idx = (idx := self.idx)+1 109 | self.waiters[idx] = fut 110 | fut.add_done_callback(lambda _: self.waiters.pop(idx, None)) 111 | logging.info(f"Requesting {hsh} from direct local network.") 112 | for addr in set(get_brdcasts()): 113 | logging.debug(f"Sending request for {hsh} to {addr}:{self.local_port}") 114 | self.transport.sendto(b"".join([b"\x00", idx.to_bytes(4, "big"), hsh.encode("utf-8")]), (addr, self.local_port)) 115 | 116 | try: 117 | # This must have a short timeout so it does not noticably slow down 118 | # querying of other caches. 119 | port, url, addr = await asyncio.wait_for(fut, self.timeout) 120 | except asyncio.TimeoutError: 121 | logging.debug(f"No response for {hsh}") 122 | return None 123 | 124 | logging.info(f"{addr[0]}:{addr[1]} responded for {hsh} with http://{addr[0]}:{port}/{url}") 125 | 126 | async with self.session.get(f"http://{addr[0]}:{port}/{url}") as resp: 127 | if resp.status != 200: 128 | return 129 | info = NarInfo.parse(await resp.text()) 130 | 131 | return info._replace(url = f"{addr[0]}/{port}/{hsh}/{info.url}") 132 | 133 | async def nar(self, sp: str) -> t.Awaitable[t.AsyncIterable[bytes]]: 134 | try: 135 | return await self._nar_req(sp) 136 | except FileNotFoundError: 137 | addr1, addr2, hsh, _ = sp.split("/", 2) 138 | logging.warn(f"Remote({addr1}:{addr2})-store path is dead: {sp}") 139 | pass 140 | 141 | _, _, hsh, _ = sp.split("/", 3) 142 | narinfo = await self.narinfo(hsh) 143 | if narinfo is None: 144 | logging.warn(f"All sources are gone.") 145 | raise FileNotFoundError() 146 | 147 | return await self._nar_req(narinfo.url) 148 | 149 | async def _nar_req(self, url: str) -> t.Awaitable[t.AsyncIterable[bytes]]: 150 | addr1, addr2, _, p = url.split("/", 3) 151 | resp = await self.session.get(f"http://{addr1}:{addr2}/{p}") 152 | if resp.status == 200: 153 | return self._nar_direct(resp) 154 | else: 155 | raise FileNotFoundError() 156 | 157 | 158 | async def _nar_direct(self, resp: aiohttp.ClientResponse) -> t.AsyncIterable[bytes]: 159 | try: 160 | content = resp.content 161 | while not content.at_eof(): 162 | yield await content.readany() 163 | finally: 164 | resp.close() 165 | await resp.wait_for_close() 166 | 167 | 168 | @contextlib.asynccontextmanager 169 | async def remote(store: Store, local_port: int, local_addr: str="0.0.0.0", prefix: str="local", timeout: float = 0.05): 170 | protocol: DiscoveryProtocol 171 | async with aiohttp.ClientSession() as session: 172 | _, protocol = await asyncio.get_running_loop().create_datagram_endpoint( 173 | lambda: DiscoveryProtocol(store, session, local_port, prefix, timeout), 174 | local_addr=(local_addr, local_port), 175 | family=socket.AF_INET, 176 | allow_broadcast=True 177 | ) 178 | try: 179 | yield protocol 180 | finally: 181 | protocol.stop() 182 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------