Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Dreaded_X
|
1d5a4c61be
|
||
|
Dreaded_X
|
f51746c5df
|
||
|
Dreaded_X
|
ca72d08cc1
|
||
 Release-plz
|
6a7ab1f9d5 | ||
|
Dreaded_X
|
f7e4a2d545
|
||
|
Dreaded_X
|
7142ff0fa3
|
||
|
Release-plz
|
afcca9eb47 | ||
|
Dreaded_X
|
c76b0e6ade
|
||
|
Release-plz
|
8e5e02d29d
|
||
|
Dreaded_X
|
c15f1ae5c4
|
||
|
Dreaded_X
|
c5d39e4e51
|
||
|
Dreaded_X
|
744cf3e395
|
||
|
Dreaded_X
|
a9ae86d08a
|
||
|
Dreaded_X
|
8aff9de90e
|
||
|
Dreaded_X
|
e60738e81d
|
||
|
Dreaded_X
|
9d5c095e7f
|
||
|
Dreaded_X
|
2ffa196014
|
||
|
Dreaded_X
|
babcf1ec23
|
||
|
Dreaded_X
|
c90e95613e
|
@@ -0,0 +1,27 @@
|
||||
name: Audit
|
||||
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- "**/Cargo.toml"
|
||||
- "**/Cargo.lock"
|
||||
schedule:
|
||||
- cron: "0 0 * * *"
|
||||
|
||||
jobs:
|
||||
audit:
|
||||
name: cargo audit
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
issues: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
- name: Install rust toolchain
|
||||
uses: dtolnay/rust-toolchain@nightly
|
||||
- name: Setup rust cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
- name: Audit check
|
||||
uses: rustsec/audit-check@v2.0.0
|
||||
with:
|
||||
token: ${{ secrets.GITEA_TOKEN }}
|
||||
@@ -0,0 +1,44 @@
|
||||
name: CI
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- "main"
|
||||
tags:
|
||||
- "*"
|
||||
pull_request:
|
||||
|
||||
concurrency:
|
||||
group: "${{ github.workflow }}-${{ github.ref }}"
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
prek:
|
||||
name: prek
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
- name: Install rust toolchain
|
||||
uses: dtolnay/rust-toolchain@nightly
|
||||
with:
|
||||
components: rustfmt, clippy
|
||||
- name: Setup rust cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
- uses: j178/prek-action@v2
|
||||
|
||||
cargo-shear:
|
||||
name: cargo shear
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
- name: Install rust toolchain
|
||||
uses: dtolnay/rust-toolchain@nightly
|
||||
- name: Setup rust cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
- name: Install cargo shear
|
||||
uses: taiki-e/install-action@v2
|
||||
with:
|
||||
tool: cargo-shear
|
||||
- name: cargo shear
|
||||
run: cargo shear --deny-warnings
|
||||
@@ -0,0 +1,19 @@
|
||||
name: Committed
|
||||
on:
|
||||
pull_request:
|
||||
|
||||
concurrency:
|
||||
group: "${{ github.workflow }}-${{ github.ref }}"
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
committed:
|
||||
name: committed
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- uses: crate-ci/committed@master
|
||||
with:
|
||||
commits: "origin/${{ gitea.base_ref }}..HEAD"
|
||||
@@ -0,0 +1,62 @@
|
||||
name: Release-plz
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
release-plz:
|
||||
name: Release-plz Release
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: read
|
||||
steps:
|
||||
- &checkout
|
||||
name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
- name: Install rust toolchain
|
||||
uses: dtolnay/rust-toolchain@nightly
|
||||
- name: Setup rust cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
- name: Install release-plz
|
||||
uses: taiki-e/install-action@v2
|
||||
with:
|
||||
tool: release-plz
|
||||
- &git-setup
|
||||
name: Configure git
|
||||
run: |
|
||||
git config user.name "Release-plz"
|
||||
git config user.email "release-plz@noreply.huizinga.dev"
|
||||
git config url.https://${{ gitea.actor }}:${{ secrets.RELEASE_PLZ_TOKEN }}@git.huizinga.dev/.insteadOf https://git.huizinga.dev/
|
||||
- name: release-plz release
|
||||
env:
|
||||
CARGO_REGISTRIES_INFRA_TOKEN: "Bearer ${{ secrets.RELEASE_PLZ_TOKEN }}"
|
||||
run: release-plz release --git-token "${{ secrets.RELEASE_PLZ_TOKEN }}" --forge gitea
|
||||
|
||||
release-plz-pr:
|
||||
name: Release-plz PR
|
||||
runs-on: ubuntu-latest
|
||||
concurrency:
|
||||
group: release-plz-${{ github.ref }}
|
||||
cancel-in-progress: false
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
steps:
|
||||
- *checkout
|
||||
- name: Install rust toolchain
|
||||
uses: dtolnay/rust-toolchain@nightly
|
||||
- name: Setup rust cache
|
||||
uses: Swatinem/rust-cache@v2
|
||||
- name: Install release-plz
|
||||
uses: taiki-e/install-action@v2
|
||||
with:
|
||||
tool: release-plz
|
||||
- *git-setup
|
||||
- name: release-plz release-pr
|
||||
run: release-plz release-pr --git-token "${{ secrets.RELEASE_PLZ_TOKEN }}" --forge gitea
|
||||
@@ -0,0 +1,25 @@
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*"
|
||||
|
||||
jobs:
|
||||
archlinux:
|
||||
name: Arch Linux
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
packages: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
- name: Build package
|
||||
uses: https://git.huizinga.dev/infra/archlinux-package-action@v4
|
||||
with:
|
||||
path: .
|
||||
- name: Upload package
|
||||
run: |
|
||||
curl --user ${{ gitea.actor }}:${{ secrets.REGISTRY_TOKEN }} \
|
||||
--upload-file "$(ls | grep -E 'crete-[0-9]+\.[0-9]+\.[0-9]+-[0-9]+-.*.pkg.tar.zst')" \
|
||||
https://git.huizinga.dev/api/packages/infra/arch/core
|
||||
@@ -31,6 +31,7 @@ repos:
|
||||
rev: "1.0.0"
|
||||
hooks:
|
||||
- id: mdformat
|
||||
exclude: "^CHANGELOG.md$"
|
||||
|
||||
- repo: local
|
||||
hooks:
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
[workspace]
|
||||
pr_name = "chore(release): Release v{{ version }}"
|
||||
|
||||
[[package]]
|
||||
name = "xtask"
|
||||
release = false
|
||||
|
||||
[changelog]
|
||||
commit_parsers = [
|
||||
{ message = "^feat", group = "<!-- 0 -->Features" },
|
||||
{ message = "^revert", group = "<!-- 1 -->Revert" },
|
||||
{ message = "^fix", group = "<!-- 2 -->Bug Fixes" },
|
||||
{ message = "^refactor", group = "<!-- 3 -->Refactor" },
|
||||
{ message = "^test", group = "<!-- 4 -->Testing" },
|
||||
{ message = "^chore\\(release\\)", skip = true },
|
||||
{ message = "^chore\\(deps.*\\)", skip = true },
|
||||
{ message = "^chore|^ci", group = "<!-- 5 -->Miscellaneous Tasks" },
|
||||
]
|
||||
@@ -1 +1,53 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.1.2](https://git.huizinga.dev/infra/crete/compare/v0.1.1...v0.1.2) - 2026-04-17
|
||||
|
||||
### <!-- 0 -->Features
|
||||
|
||||
- Make dns optional
|
||||
- Allow more than two dns entries
|
||||
|
||||
## [0.1.1](https://git.huizinga.dev/infra/crete/compare/v0.1.0...v0.1.1) - 2026-04-13
|
||||
|
||||
### <!-- 2 -->Bug Fixes
|
||||
|
||||
- No default value for advertise routes
|
||||
|
||||
## [0.1.0](https://git.huizinga.dev/infra/crete/releases/tag/v0.1.0) - 2026-04-07
|
||||
|
||||
### <!-- 0 -->Features
|
||||
|
||||
- _(package)_ Added PKGBUILD
|
||||
- Set user agent
|
||||
- _(performance)_ Disable request features to reduce binary size
|
||||
- Generate talos configs
|
||||
- Show error if no clusters are found in repo
|
||||
- Initial rewrite of python render tool
|
||||
|
||||
### <!-- 3 -->Refactor
|
||||
|
||||
- Big internal refactor
|
||||
|
||||
### <!-- 4 -->Testing
|
||||
|
||||
- Disable building tests
|
||||
|
||||
### <!-- 5 -->Miscellaneous Tasks
|
||||
|
||||
- _(actions)_ Publish Arch Linux package
|
||||
- _(license)_ Add GPL license
|
||||
- _(actions)_ Name steps
|
||||
- _(actions)_ Renamed release-plz workflow file
|
||||
- _(actions)_ Use committed to check pr commits
|
||||
- _(actions)_ Cancel in-progress ci runs when pushing to pr
|
||||
- _(docs)_ Added README
|
||||
- _(actions)_ Setup workflows
|
||||
- Publish to gitea registry
|
||||
- _(pre-commit)_ Update pre commit config
|
||||
|
||||
Generated
+110
-6
@@ -214,12 +214,15 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "crete"
|
||||
version = "0.1.0"
|
||||
version = "0.1.2"
|
||||
dependencies = [
|
||||
"byteorder",
|
||||
"clap",
|
||||
"clap_complete",
|
||||
"gix-discover",
|
||||
"minijinja",
|
||||
"netascii",
|
||||
"num_enum",
|
||||
"optional_struct",
|
||||
"reqwest",
|
||||
"schemars",
|
||||
@@ -228,6 +231,7 @@ dependencies = [
|
||||
"serde_json",
|
||||
"serde_yaml",
|
||||
"thiserror",
|
||||
"tokio",
|
||||
"walkdir",
|
||||
]
|
||||
|
||||
@@ -447,7 +451,7 @@ dependencies = [
|
||||
"bstr",
|
||||
"gix-date",
|
||||
"gix-error",
|
||||
"winnow",
|
||||
"winnow 0.7.15",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -567,7 +571,7 @@ dependencies = [
|
||||
"itoa",
|
||||
"smallvec",
|
||||
"thiserror",
|
||||
"winnow",
|
||||
"winnow 0.7.15",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -600,7 +604,7 @@ dependencies = [
|
||||
"gix-validate",
|
||||
"memmap2",
|
||||
"thiserror",
|
||||
"winnow",
|
||||
"winnow 0.7.15",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -1125,6 +1129,34 @@ dependencies = [
|
||||
"tempfile",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "netascii"
|
||||
version = "0.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "205c45083b6725eb4671392c7c399510ad1498dd0275f1a2e68a70a34ebdf1b1"
|
||||
|
||||
[[package]]
|
||||
name = "num_enum"
|
||||
version = "0.7.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5d0bca838442ec211fa11de3a8b0e0e8f3a4522575b5c4c06ed722e005036f26"
|
||||
dependencies = [
|
||||
"num_enum_derive",
|
||||
"rustversion",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "num_enum_derive"
|
||||
version = "0.7.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "680998035259dcfcafe653688bf2aa6d3e2dc05e98be6ab46afb089dc84f1df8"
|
||||
dependencies = [
|
||||
"proc-macro-crate",
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "once_cell"
|
||||
version = "1.21.4"
|
||||
@@ -1277,6 +1309,15 @@ dependencies = [
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "proc-macro-crate"
|
||||
version = "3.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e67ba7e9b2b56446f1d419b1d807906278ffa1a658a8a5d8a39dcb1f5a78614f"
|
||||
dependencies = [
|
||||
"toml_edit",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "proc-macro2"
|
||||
version = "1.0.106"
|
||||
@@ -1628,6 +1669,16 @@ version = "1.3.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
|
||||
|
||||
[[package]]
|
||||
name = "signal-hook-registry"
|
||||
version = "1.4.8"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c4db69cba1110affc0e9f7bcd48bbf87b3f4fc7c61fc9155afd4c469eb3d6c1b"
|
||||
dependencies = [
|
||||
"errno",
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "slab"
|
||||
version = "0.4.12"
|
||||
@@ -1753,18 +1804,32 @@ checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20"
|
||||
|
||||
[[package]]
|
||||
name = "tokio"
|
||||
version = "1.50.0"
|
||||
version = "1.52.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "27ad5e34374e03cfffefc301becb44e9dc3c17584f414349ebe29ed26661822d"
|
||||
checksum = "b67dee974fe86fd92cc45b7a95fdd2f99a36a6d7b0d431a231178d3d670bbcc6"
|
||||
dependencies = [
|
||||
"bytes",
|
||||
"libc",
|
||||
"mio",
|
||||
"parking_lot",
|
||||
"pin-project-lite",
|
||||
"signal-hook-registry",
|
||||
"socket2",
|
||||
"tokio-macros",
|
||||
"windows-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tokio-macros"
|
||||
version = "2.7.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "385a6cb71ab9ab790c5fe8d67f1645e6c450a7ce006a33de03daa956cf70a496"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tokio-native-tls"
|
||||
version = "0.3.1"
|
||||
@@ -1788,6 +1853,36 @@ dependencies = [
|
||||
"tokio",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "toml_datetime"
|
||||
version = "1.1.1+spec-1.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3165f65f62e28e0115a00b2ebdd37eb6f3b641855f9d636d3cd4103767159ad7"
|
||||
dependencies = [
|
||||
"serde_core",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "toml_edit"
|
||||
version = "0.25.11+spec-1.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0b59c4d22ed448339746c59b905d24568fcbb3ab65a500494f7b8c3e97739f2b"
|
||||
dependencies = [
|
||||
"indexmap",
|
||||
"toml_datetime",
|
||||
"toml_parser",
|
||||
"winnow 1.0.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "toml_parser"
|
||||
version = "1.1.2+spec-1.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a2abe9b86193656635d2411dc43050282ca48aa31c2451210f4202550afb7526"
|
||||
dependencies = [
|
||||
"winnow 1.0.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tower"
|
||||
version = "0.5.3"
|
||||
@@ -2115,6 +2210,15 @@ dependencies = [
|
||||
"memchr",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "winnow"
|
||||
version = "1.0.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2ee1708bef14716a11bae175f579062d4554d95be2c6829f518df847b7b3fdd0"
|
||||
dependencies = [
|
||||
"memchr",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "wit-bindgen"
|
||||
version = "0.51.0"
|
||||
|
||||
+6
-1
@@ -1,9 +1,10 @@
|
||||
[package]
|
||||
name = "crete"
|
||||
version = "0.1.0"
|
||||
version = "0.1.2"
|
||||
edition = "2024"
|
||||
default-run = "crete"
|
||||
publish = ["infra"]
|
||||
license = "GPL-3.0-or-later"
|
||||
|
||||
[workspace]
|
||||
members = ["xtask"]
|
||||
@@ -13,10 +14,13 @@ schemars = { version = "1.2.1", features = ["semver1"] }
|
||||
serde_json = "1.0.149"
|
||||
|
||||
[dependencies]
|
||||
byteorder = "1.5.0"
|
||||
clap = { version = "4.6.0", features = ["derive"] }
|
||||
clap_complete = "4.6.0"
|
||||
gix-discover = { version = "0.49.0", features = ["sha1"] }
|
||||
minijinja = { version = "2.18.0", features = ["json", "loader"] }
|
||||
netascii = "0.1.0"
|
||||
num_enum = "0.7.6"
|
||||
optional_struct = "0.5.2"
|
||||
reqwest = { version = "0.13.2", default-features = false, features = [
|
||||
"blocking",
|
||||
@@ -29,6 +33,7 @@ serde = { version = "1.0.228", features = ["derive"] }
|
||||
serde_json = { workspace = true }
|
||||
serde_yaml = "0.9.34"
|
||||
thiserror = "2.0.18"
|
||||
tokio = { version = "1.52.1", features = ["full"] }
|
||||
walkdir = "2.5.0"
|
||||
|
||||
[lib]
|
||||
|
||||
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) 2026 Tim Huizinga
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) 2026 Tim Huizinga
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
@@ -0,0 +1,34 @@
|
||||
# Maintainer: Tim Huizinga <tim@huizinga.dev>
|
||||
pkgname=crete
|
||||
pkgver=dummy
|
||||
pkgrel=1
|
||||
pkgdesc='A tool that takes node and cluster configs and uses it to generate talos configs and render jinja templates'
|
||||
url='https://git.huizinga.dev/infra/crete'
|
||||
license=('GPL-3.0-or-later')
|
||||
makedepends=('cargo-nightly')
|
||||
depends=()
|
||||
arch=('i686' 'x86_64' 'armv6h' 'armv7h')
|
||||
source=('LICENSE')
|
||||
sha256sums=('4bffc7da729013886ae68623c0d6145201b20a495879b589990953b2a27e1fbd')
|
||||
|
||||
pkgver() {
|
||||
cargo info $pkgname | grep -Po '^version: \K[\d\.]+'
|
||||
}
|
||||
|
||||
prepare() {
|
||||
export RUSTUP_TOOLCHAIN=nightly
|
||||
cargo fetch --locked --target host-tuple
|
||||
}
|
||||
|
||||
build() {
|
||||
export RUSTUP_TOOLCHAIN=nightly
|
||||
export CARGO_TARGET_DIR=target
|
||||
cargo build --frozen --release --all-features
|
||||
cargo run --bin $pkgname -- shell-completions > _$pkgname
|
||||
}
|
||||
|
||||
package() {
|
||||
install -Dm0644 -t "$pkgdir/usr/share/licenses/$pkgname/" "LICENSE"
|
||||
install -Dm0755 -t "$pkgdir/usr/bin/" "target/release/$pkgname"
|
||||
install -Dm0644 -t "$pkgdir/usr/share/zsh/site-functions" "_$pkgname"
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
# Crete
|
||||
|
||||
A tool that takes node and cluster configs and uses it to generate talos configs
|
||||
and render jinja templates.
|
||||
|
||||
## Installation
|
||||
|
||||
### Arch
|
||||
|
||||
First import the verification key:
|
||||
|
||||
```bash
|
||||
wget https://git.huizinga.dev/api/packages/infra/arch/repository.key -O /tmp/repository.key
|
||||
sudo pacman-key --add /tmp/repository.key
|
||||
sudo pacman-key --lsign-key $(gpg --show-keys /tmp/repository.key | sed -n 2p)
|
||||
```
|
||||
|
||||
And add the following to `/etc/pacman.conf`:
|
||||
|
||||
```ini
|
||||
[infra]
|
||||
SigLevel = Required
|
||||
Server = https://git.huizinga.dev/api/packages/infra/arch/core/$arch
|
||||
```
|
||||
|
||||
You can then install `crete` by running:
|
||||
|
||||
```bash
|
||||
sudo pacman -Sy crete
|
||||
```
|
||||
|
||||
### Cargo install
|
||||
|
||||
Add the following to `~/.cargo.config.toml`:
|
||||
|
||||
```toml
|
||||
[registries.infra]
|
||||
index = "sparse+https://git.huizinga.dev/api/packages/infra/cargo/"
|
||||
```
|
||||
|
||||
You can then install `crete` by running:
|
||||
|
||||
```bash
|
||||
cargo install --registry infra crete
|
||||
```
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
[changelog]
|
||||
header = """
|
||||
# Changelog
|
||||
"""
|
||||
|
||||
[bump]
|
||||
# TODO: Remove this option once we release v1.0.0
|
||||
breaking_always_bump_major = false
|
||||
|
||||
[git]
|
||||
fail_on_unmatched_commit = true
|
||||
require_conventional = true
|
||||
commit_parsers = [
|
||||
{ message = "^feat", group = "<!-- 0 -->Features" },
|
||||
{ message = "^fix", group = "<!-- 1 -->Bug Fixes" },
|
||||
{ message = "^refactor", group = "<!-- 2 -->Refactor" },
|
||||
{ message = "^test", group = "<!-- 3 -->Testing" },
|
||||
{ message = "^chore\\(release\\): Prepare for", skip = true },
|
||||
{ message = "^chore\\(deps.*\\)", skip = true },
|
||||
{ message = "^chore|^ci", group = "<!-- 4 -->Miscellaneous Tasks" },
|
||||
{ message = "^revert", group = "<!-- 5 -->Revert" },
|
||||
]
|
||||
@@ -140,12 +140,11 @@
|
||||
"array",
|
||||
"null"
|
||||
],
|
||||
"default": null,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"format": "ipv4"
|
||||
},
|
||||
"maxItems": 2,
|
||||
"minItems": 2
|
||||
}
|
||||
},
|
||||
"gateway": {
|
||||
"type": [
|
||||
|
||||
+2
-3
@@ -136,12 +136,11 @@
|
||||
"array",
|
||||
"null"
|
||||
],
|
||||
"default": null,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"format": "ipv4"
|
||||
},
|
||||
"maxItems": 2,
|
||||
"minItems": 2
|
||||
}
|
||||
},
|
||||
"gateway": {
|
||||
"type": [
|
||||
|
||||
+11
-5
@@ -1,8 +1,8 @@
|
||||
use std::net::Ipv4Addr;
|
||||
use std::ops::Deref;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::str::FromStr;
|
||||
|
||||
use minijinja::value::ViaDeserialize;
|
||||
use minijinja::{AutoEscape, Environment, path_loader};
|
||||
use walkdir::WalkDir;
|
||||
|
||||
@@ -16,6 +16,13 @@ pub struct PathEnvironment<'a> {
|
||||
path: PathBuf,
|
||||
}
|
||||
|
||||
fn apply_netmask(
|
||||
ip: ViaDeserialize<Ipv4Addr>,
|
||||
netmask: ViaDeserialize<Ipv4Addr>,
|
||||
) -> Result<String, minijinja::Error> {
|
||||
Ok((*ip & *netmask).to_string())
|
||||
}
|
||||
|
||||
impl<'a> PathEnvironment<'a> {
|
||||
pub fn new(path: &Path) -> Self {
|
||||
let mut env = Environment::new();
|
||||
@@ -27,10 +34,7 @@ impl<'a> PathEnvironment<'a> {
|
||||
env.set_auto_escape_callback(|_| AutoEscape::None);
|
||||
|
||||
// Add filters
|
||||
env.add_filter("to_prefix", |netmask: String| {
|
||||
let netmask = Ipv4Addr::from_str(&netmask).map_err(|err| {
|
||||
minijinja::Error::new(minijinja::ErrorKind::InvalidOperation, err.to_string())
|
||||
})?;
|
||||
env.add_filter("to_prefix", |netmask: ViaDeserialize<Ipv4Addr>| {
|
||||
let mask = netmask.to_bits();
|
||||
let prefix = mask.leading_ones();
|
||||
|
||||
@@ -44,6 +48,8 @@ impl<'a> PathEnvironment<'a> {
|
||||
}
|
||||
});
|
||||
|
||||
env.add_function("apply_netmask", apply_netmask);
|
||||
|
||||
// Helper function for getting the path to kubeconfig files
|
||||
env.add_filter("kubeconfig", move |names: Vec<String>| {
|
||||
names
|
||||
|
||||
@@ -8,6 +8,7 @@ pub mod node;
|
||||
pub mod patch;
|
||||
pub mod schematic;
|
||||
pub mod secret;
|
||||
pub mod tftp;
|
||||
|
||||
pub(crate) static REPO_PATH: OnceLock<PathBuf> = OnceLock::new();
|
||||
|
||||
|
||||
+9
-1
@@ -53,7 +53,8 @@ struct Network {
|
||||
ip: Ipv4Addr,
|
||||
netmask: Ipv4Addr,
|
||||
gateway: Ipv4Addr,
|
||||
dns: [Ipv4Addr; 2],
|
||||
#[serde(default)]
|
||||
dns: Option<Vec<Ipv4Addr>>,
|
||||
#[optional_rename(OptionalTailscale)]
|
||||
#[optional_wrap]
|
||||
tailscale: Tailscale,
|
||||
@@ -128,6 +129,13 @@ impl Node {
|
||||
// Sadly we have to this manually
|
||||
// TODO: Find a better way of doing this
|
||||
let default = OptionalNodeDeserialize {
|
||||
network: Some(OptionalNetwork {
|
||||
tailscale: Some(OptionalTailscale {
|
||||
advertise_routes: Some(false),
|
||||
..Default::default()
|
||||
}),
|
||||
..Default::default()
|
||||
}),
|
||||
patches: Some(OptionalPatches {
|
||||
all: Some(vec![]),
|
||||
control_plane: Some(vec![]),
|
||||
|
||||
+9
-1
@@ -11,7 +11,15 @@ where
|
||||
let path = get_talos_path().join("schematics").join(name);
|
||||
let content = std::fs::read_to_string(path).unwrap().trim().to_owned();
|
||||
|
||||
let client = reqwest::blocking::Client::new();
|
||||
let client = reqwest::blocking::ClientBuilder::new()
|
||||
.user_agent(format!(
|
||||
"{}/{}",
|
||||
std::env!("CARGO_PKG_NAME"),
|
||||
std::env!("CARGO_PKG_VERSION")
|
||||
))
|
||||
.build()
|
||||
.unwrap();
|
||||
|
||||
let res = client
|
||||
.post("https://factory.talos.dev/schematics")
|
||||
.body(content)
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
use std::io;
|
||||
use std::string::FromUtf8Error;
|
||||
|
||||
use thiserror::Error;
|
||||
|
||||
#[derive(Debug, Error)]
|
||||
pub enum Error {
|
||||
#[error("Invalid op code '{0}'")]
|
||||
InvalidOpCode(u16),
|
||||
#[error("Invalid error code '{0}'")]
|
||||
InvalidErrorCode(u16),
|
||||
#[error("Invalid mode '{0}'")]
|
||||
InvalidMode(String),
|
||||
#[error("String contains invalid characters")]
|
||||
InvalidString(#[from] FromUtf8Error),
|
||||
#[error("Unterminated string")]
|
||||
UnterminatedString,
|
||||
#[error("Io error: {0}")]
|
||||
Io(#[from] io::Error),
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
mod error;
|
||||
mod packet;
|
||||
mod server;
|
||||
|
||||
pub use error::Error;
|
||||
pub use packet::Packet;
|
||||
pub use server::{Error as ServerError, serve};
|
||||
@@ -0,0 +1,353 @@
|
||||
use std::io::{BufRead, BufReader, BufWriter, Cursor, Read, Write};
|
||||
use std::net::SocketAddr;
|
||||
|
||||
use byteorder::{NetworkEndian, ReadBytesExt, WriteBytesExt};
|
||||
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
||||
use tokio::net::UdpSocket;
|
||||
|
||||
use crate::tftp::Error;
|
||||
|
||||
// 2 bytes op code + 2 bytes block number + max 512 bytes data
|
||||
pub(crate) const PACKET_SIZE: usize = 2 + 2 + 512;
|
||||
|
||||
fn decode_null_terminated<R>(reader: &mut BufReader<R>) -> Result<String, Error>
|
||||
where
|
||||
R: Read + ?Sized,
|
||||
{
|
||||
let mut text = Vec::new();
|
||||
reader.read_until(0, &mut text)?;
|
||||
|
||||
// Make sure we ended with a null terminator
|
||||
match text.pop() {
|
||||
Some(0) => {}
|
||||
None | Some(_) => return Err(Error::UnterminatedString),
|
||||
}
|
||||
|
||||
Ok(String::from_utf8(text)?)
|
||||
}
|
||||
|
||||
fn encode_null_terminated<W>(writer: &mut BufWriter<W>, text: impl AsRef<str>) -> Result<(), Error>
|
||||
where
|
||||
W: Write + ?Sized,
|
||||
{
|
||||
let text = text.as_ref().as_bytes();
|
||||
writer.write_all(text)?;
|
||||
|
||||
// Add null terminator
|
||||
writer.write_u8(0)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum Mode {
|
||||
NetAscii,
|
||||
Octet,
|
||||
Mail,
|
||||
}
|
||||
|
||||
impl Mode {
|
||||
fn decode<R>(reader: &mut BufReader<R>) -> Result<Self, Error>
|
||||
where
|
||||
R: Read + ?Sized,
|
||||
{
|
||||
let mut mode = decode_null_terminated(reader)?;
|
||||
mode.make_ascii_lowercase();
|
||||
let mode = mode;
|
||||
|
||||
Ok(match mode.as_str() {
|
||||
"netascii" => Self::NetAscii,
|
||||
"octet" => Self::Octet,
|
||||
"mail" => Self::Mail,
|
||||
_ => return Err(Error::InvalidMode(mode)),
|
||||
})
|
||||
}
|
||||
|
||||
fn encode<W>(&self, writer: &mut BufWriter<W>) -> Result<(), Error>
|
||||
where
|
||||
W: Write + ?Sized,
|
||||
{
|
||||
let mode = match &self {
|
||||
Mode::NetAscii => "netascii",
|
||||
Mode::Octet => "octet",
|
||||
Mode::Mail => "mail",
|
||||
};
|
||||
|
||||
encode_null_terminated(writer, mode)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
pub struct Request {
|
||||
filename: String,
|
||||
mode: Mode,
|
||||
}
|
||||
|
||||
impl Request {
|
||||
pub fn filename(&self) -> &str {
|
||||
&self.filename
|
||||
}
|
||||
|
||||
fn decode<R>(reader: &mut BufReader<R>) -> Result<Self, Error>
|
||||
where
|
||||
R: Read + ?Sized,
|
||||
{
|
||||
let filename = decode_null_terminated(reader)?;
|
||||
let mode = Mode::decode(reader)?;
|
||||
|
||||
Ok(Self { filename, mode })
|
||||
}
|
||||
|
||||
fn encode<W>(&self, writer: &mut BufWriter<W>) -> Result<(), Error>
|
||||
where
|
||||
W: Write + ?Sized,
|
||||
{
|
||||
encode_null_terminated(writer, &self.filename)?;
|
||||
self.mode.encode(writer)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn mode(&self) -> Mode {
|
||||
self.mode
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct Data {
|
||||
block: u16,
|
||||
data: Vec<u8>,
|
||||
}
|
||||
|
||||
impl Data {
|
||||
fn decode<R>(reader: &mut BufReader<R>) -> Result<Self, Error>
|
||||
where
|
||||
R: Read + ?Sized,
|
||||
{
|
||||
let block = reader.read_u16::<NetworkEndian>()?;
|
||||
|
||||
let mut data = Vec::new();
|
||||
reader.read_to_end(&mut data)?;
|
||||
|
||||
Ok(Self { data, block })
|
||||
}
|
||||
|
||||
fn encode<W>(&self, writer: &mut BufWriter<W>) -> Result<(), Error>
|
||||
where
|
||||
W: Write + ?Sized,
|
||||
{
|
||||
writer.write_u16::<NetworkEndian>(self.block)?;
|
||||
writer.write_all(&self.data)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct Ack(u16);
|
||||
|
||||
impl Ack {
|
||||
pub fn block(&self) -> u16 {
|
||||
self.0
|
||||
}
|
||||
|
||||
fn decode<R>(reader: &mut BufReader<R>) -> Result<Self, Error>
|
||||
where
|
||||
R: Read + ?Sized,
|
||||
{
|
||||
let number = reader.read_u16::<NetworkEndian>()?;
|
||||
|
||||
Ok(Self(number))
|
||||
}
|
||||
|
||||
fn encode<W>(&self, writer: &mut BufWriter<W>) -> Result<(), Error>
|
||||
where
|
||||
W: Write + ?Sized,
|
||||
{
|
||||
writer.write_u16::<NetworkEndian>(self.0)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, TryFromPrimitive, IntoPrimitive, Clone, Copy)]
|
||||
#[repr(u16)]
|
||||
pub enum ErrorCode {
|
||||
NotDefined,
|
||||
FileNotFound,
|
||||
AccessViolation,
|
||||
DiskFull,
|
||||
Illegal,
|
||||
UnknownTransferId,
|
||||
FileAlreadyExists,
|
||||
NoSuchUser,
|
||||
}
|
||||
|
||||
impl ErrorCode {
|
||||
fn decode<R>(reader: &mut BufReader<R>) -> Result<Self, Error>
|
||||
where
|
||||
R: Read + ?Sized,
|
||||
{
|
||||
let code = reader.read_u16::<NetworkEndian>()?;
|
||||
Self::try_from_primitive(code).map_err(|err| Error::InvalidErrorCode(err.number))
|
||||
}
|
||||
|
||||
fn encode<W>(&self, writer: &mut BufWriter<W>) -> Result<(), Error>
|
||||
where
|
||||
W: Write + ?Sized,
|
||||
{
|
||||
let code: u16 = (*self).into();
|
||||
|
||||
writer.write_u16::<NetworkEndian>(code)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct ErrorMessage {
|
||||
code: ErrorCode,
|
||||
message: String,
|
||||
}
|
||||
|
||||
impl ErrorMessage {
|
||||
fn decode<R>(reader: &mut BufReader<R>) -> Result<Self, Error>
|
||||
where
|
||||
R: Read + ?Sized,
|
||||
{
|
||||
let code = ErrorCode::decode(reader)?;
|
||||
let message = decode_null_terminated(reader)?;
|
||||
|
||||
Ok(Self { code, message })
|
||||
}
|
||||
|
||||
fn encode<W>(&self, writer: &mut BufWriter<W>) -> Result<(), Error>
|
||||
where
|
||||
W: Write + ?Sized,
|
||||
{
|
||||
self.code.encode(writer)?;
|
||||
|
||||
encode_null_terminated(writer, &self.message)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub enum Packet {
|
||||
Read(Request),
|
||||
Write(Request),
|
||||
Data(Data),
|
||||
Ack(Ack),
|
||||
Error(ErrorMessage),
|
||||
}
|
||||
|
||||
impl Packet {
|
||||
pub fn data(block: u16, data: &[u8]) -> Self {
|
||||
Self::Data(Data {
|
||||
block,
|
||||
data: data.into(),
|
||||
})
|
||||
}
|
||||
|
||||
pub fn ack(block: u16) -> Self {
|
||||
Self::Ack(Ack(block))
|
||||
}
|
||||
|
||||
pub fn error(code: ErrorCode, message: impl Into<String>) -> Self {
|
||||
Self::Error(ErrorMessage {
|
||||
code,
|
||||
message: message.into(),
|
||||
})
|
||||
}
|
||||
|
||||
fn decode<R>(reader: &mut BufReader<R>) -> Result<Self, Error>
|
||||
where
|
||||
R: Read + ?Sized,
|
||||
{
|
||||
let op_code = reader.read_u16::<NetworkEndian>()?;
|
||||
|
||||
Ok(match op_code {
|
||||
1 => Self::Read(Request::decode(reader)?),
|
||||
2 => Self::Write(Request::decode(reader)?),
|
||||
3 => Self::Data(Data::decode(reader)?),
|
||||
4 => Self::Ack(Ack::decode(reader)?),
|
||||
5 => Self::Error(ErrorMessage::decode(reader)?),
|
||||
_ => return Err(Error::InvalidOpCode(op_code)),
|
||||
})
|
||||
}
|
||||
|
||||
fn encode<W>(&self, writer: &mut BufWriter<W>) -> Result<(), Error>
|
||||
where
|
||||
W: Write + ?Sized,
|
||||
{
|
||||
match &self {
|
||||
Self::Read(inner) => {
|
||||
writer.write_u16::<NetworkEndian>(1)?;
|
||||
inner.encode(writer)?;
|
||||
}
|
||||
Self::Write(inner) => {
|
||||
writer.write_u16::<NetworkEndian>(2)?;
|
||||
inner.encode(writer)?;
|
||||
}
|
||||
Self::Data(inner) => {
|
||||
writer.write_u16::<NetworkEndian>(3)?;
|
||||
inner.encode(writer)?;
|
||||
}
|
||||
Self::Ack(inner) => {
|
||||
writer.write_u16::<NetworkEndian>(4)?;
|
||||
inner.encode(writer)?;
|
||||
}
|
||||
Self::Error(inner) => {
|
||||
writer.write_u16::<NetworkEndian>(5)?;
|
||||
inner.encode(writer)?;
|
||||
}
|
||||
};
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn recv_from(socket: &UdpSocket) -> Result<(Self, SocketAddr), Error> {
|
||||
let mut buf = Vec::with_capacity(PACKET_SIZE);
|
||||
let (_, src) = socket.recv_buf_from(&mut buf).await?;
|
||||
|
||||
let packet = buf.try_into()?;
|
||||
|
||||
Ok((packet, src))
|
||||
}
|
||||
|
||||
pub async fn send_to(&self, socket: &UdpSocket, src: &SocketAddr) -> Result<(), Error> {
|
||||
let buf: Vec<_> = self.try_into()?;
|
||||
socket.send_to(&buf, src).await?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl TryFrom<&Packet> for Vec<u8> {
|
||||
type Error = Error;
|
||||
|
||||
fn try_from(packet: &Packet) -> Result<Self, Self::Error> {
|
||||
let mut buf = Vec::with_capacity(PACKET_SIZE);
|
||||
let mut writer = BufWriter::new(Cursor::new(&mut buf));
|
||||
packet.encode(&mut writer)?;
|
||||
|
||||
// Normally the writer would get dropped after we return, but since it has a mutable
|
||||
// borrow in buf we have to drop it first.
|
||||
drop(writer);
|
||||
|
||||
Ok(buf)
|
||||
}
|
||||
}
|
||||
|
||||
impl TryFrom<Vec<u8>> for Packet {
|
||||
type Error = Error;
|
||||
|
||||
fn try_from(buf: Vec<u8>) -> Result<Self, <Packet as TryFrom<Vec<u8>>>::Error> {
|
||||
let mut reader = BufReader::new(Cursor::new(buf));
|
||||
|
||||
Packet::decode(&mut reader)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,162 @@
|
||||
use std::io;
|
||||
use std::net::SocketAddr;
|
||||
use std::time::Duration;
|
||||
|
||||
use thiserror::Error;
|
||||
use tokio::net::UdpSocket;
|
||||
|
||||
use crate::tftp::packet::{ErrorCode, Mode};
|
||||
use crate::tftp::{self, Packet};
|
||||
|
||||
#[derive(Debug, Error)]
|
||||
pub enum Error {
|
||||
#[error("{0}")]
|
||||
Tftp(#[from] tftp::Error),
|
||||
#[error("Io error: {0}")]
|
||||
Io(#[from] io::Error),
|
||||
#[error("Unsupported operation: {0:#?}")]
|
||||
UnsupportedOperation(Packet),
|
||||
#[error("File not found: {0}")]
|
||||
FileNotFound(String),
|
||||
#[error("Unsupported mode: {0:?}")]
|
||||
UnsupportedMode(Mode),
|
||||
#[error("Source changed: {0}")]
|
||||
SourceChanged(SocketAddr),
|
||||
#[error("UnexpectedPacket: {0:#?}")]
|
||||
UnexpectedPacket(Packet),
|
||||
#[error("Timeout")]
|
||||
Timeout,
|
||||
}
|
||||
|
||||
pub async fn handle_connection(
|
||||
src: SocketAddr,
|
||||
packet: Packet,
|
||||
callback: impl (Fn(&str) -> Option<Vec<u8>>) + Send + Clone + 'static,
|
||||
) -> Result<(), Error> {
|
||||
let socket = UdpSocket::bind("127.0.0.1:0").await?;
|
||||
println!(
|
||||
"{src}: Connecting from {}",
|
||||
socket.local_addr().expect("Socket is bound")
|
||||
);
|
||||
|
||||
let Packet::Read(request) = packet else {
|
||||
Packet::error(ErrorCode::NotDefined, "Operation not supported")
|
||||
.send_to(&socket, &src)
|
||||
.await?;
|
||||
|
||||
return Err(Error::UnsupportedOperation(packet));
|
||||
};
|
||||
|
||||
let filename = request.filename();
|
||||
println!("{src}: {filename} [{:?}]", request.mode());
|
||||
|
||||
let Some(data) = callback(filename) else {
|
||||
Packet::error(ErrorCode::FileNotFound, "Unknown file")
|
||||
.send_to(&socket, &src)
|
||||
.await?;
|
||||
|
||||
return Err(Error::FileNotFound(filename.into()));
|
||||
};
|
||||
|
||||
let mode = request.mode();
|
||||
let data = match mode {
|
||||
// In case of netascii mode we need to re-encode to escape certain sequences
|
||||
Mode::NetAscii => netascii::Netascii::from_bytes(data).collect(),
|
||||
Mode::Octet => data,
|
||||
_ => {
|
||||
Packet::error(
|
||||
ErrorCode::NotDefined,
|
||||
format!("Mode {mode:?} is not supported"),
|
||||
)
|
||||
.send_to(&socket, &src)
|
||||
.await?;
|
||||
|
||||
return Err(Error::UnsupportedMode(mode));
|
||||
}
|
||||
};
|
||||
|
||||
let mut chunks = data.chunks(512).enumerate();
|
||||
let mut chunk = chunks.next();
|
||||
|
||||
let mut timeout = 0;
|
||||
|
||||
loop {
|
||||
// Send the first byte
|
||||
if let Some((index, chunk)) = chunk {
|
||||
Packet::data((index + 1) as u16, chunk)
|
||||
.send_to(&socket, &src)
|
||||
.await?;
|
||||
}
|
||||
|
||||
tokio::select! {
|
||||
recv = Packet::recv_from(&socket) => {
|
||||
timeout = 0;
|
||||
let (packet, new_src) = recv?;
|
||||
|
||||
// I think this is might technically be possible and fine, but I don't
|
||||
// really know how to test it properly so we don't support it.
|
||||
if new_src != src {
|
||||
Packet::error(ErrorCode::Illegal, "Source changed")
|
||||
.send_to(&socket, &src)
|
||||
.await?;
|
||||
|
||||
return Err(Error::SourceChanged(new_src));
|
||||
}
|
||||
|
||||
match packet {
|
||||
Packet::Ack(ack) => {
|
||||
// If we receive an ack for the current chunk go to the next one
|
||||
if let Some((index, _)) = chunk
|
||||
&& (index + 1) as u16 == ack.block()
|
||||
{
|
||||
chunk = chunks.next();
|
||||
}
|
||||
|
||||
if chunk.is_none() {
|
||||
break;
|
||||
}
|
||||
}
|
||||
_ => {
|
||||
Packet::error(ErrorCode::Illegal, "Unexpected packet")
|
||||
.send_to(&socket, &src)
|
||||
.await?;
|
||||
|
||||
|
||||
return Err(Error::UnexpectedPacket(packet));
|
||||
}
|
||||
}
|
||||
},
|
||||
_ = tokio::time::sleep(Duration::from_secs(1)) => {
|
||||
timeout += 1;
|
||||
|
||||
if timeout == 5 {
|
||||
return Err(Error::Timeout);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
println!("{src}: Transmission complete");
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn serve(
|
||||
callback: impl (Fn(&str) -> Option<Vec<u8>>) + Send + Clone + 'static,
|
||||
) -> Result<(), Error> {
|
||||
let socket = UdpSocket::bind("127.0.0.1:69").await?;
|
||||
|
||||
println!("Server started");
|
||||
loop {
|
||||
let (packet, src) = Packet::recv_from(&socket).await?;
|
||||
|
||||
let callback = callback.clone();
|
||||
tokio::spawn({
|
||||
async move {
|
||||
if let Err(err) = handle_connection(src, packet, callback).await {
|
||||
println!("{src}: {err}")
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user