Compare commits
154 commits
Author | SHA1 | Date | |
---|---|---|---|
10f6aa8455 | |||
af6dcad5df | |||
afb4dd8ff3 | |||
3f41b8958e | |||
7e7646a4eb | |||
40f617a2d6 | |||
65519933be | |||
2c83671c8e | |||
3626237d90 | |||
6a31ae0f9a | |||
04a1be9bcb | |||
49b8d8cc05 | |||
ffe1fbc7a4 | |||
3c4e55d126 | |||
8a1c52cd90 | |||
7b6bdc37c7 | |||
bff7057c45 | |||
9dfd21ce8d | |||
dec6834920 | |||
9d5c3fcc23 | |||
bbee00c9f9 | |||
46bf5dc50d | |||
ba34228cbd | |||
74cb65a658 | |||
973741f7bb | |||
1e578d1a6b | |||
fda3c6bab6 | |||
7b7b55de0d | |||
561bcbba26 | |||
6d0c792f52 | |||
3da5ac2a0c | |||
89192016fd | |||
6a4a2b6445 | |||
bccfc3d1f1 | |||
b6aade0ad3 | |||
83a0b37c4e | |||
61e45713e3 | |||
9ccd290ebc | |||
0c8414f0d0 | |||
50c9677b82 | |||
f8f6737ae6 | |||
9b47a6dbac | |||
cbab7703ef | |||
7b6cc44e17 | |||
30cf1afba8 | |||
c62dd2ff39 | |||
86dcdea7c6 | |||
d28bbd45d7 | |||
3fc17bcd4a | |||
3dec954747 | |||
45a7ab58d7 | |||
ceddb5454d | |||
812f93d2be | |||
b9419a5446 | |||
ffcaeb9d4b | |||
6ec4b1b48c | |||
a1092be60c | |||
2412ad1666 | |||
3657754fd7 | |||
0a9eba9732 | |||
6588bf20a5 | |||
00ea82e12c | |||
6936fa87d4 | |||
b727a3714e | |||
db0df8f0f0 | |||
7738c8b366 | |||
6b847ba34e | |||
95268b5020 | |||
e1dd7c0046 | |||
dba934ab41 | |||
03453a3327 | |||
f74a37ac24 | |||
c7a4e68e8f | |||
62945286fd | |||
6e385d7f87 | |||
5aa2f62c66 | |||
ee2b492851 | |||
1c0bb64572 | |||
f78f735b2c | |||
4ba04706b5 | |||
9e3415f890 | |||
846e07b56c | |||
9c45603ee6 | |||
73f2b90482 | |||
7bd690f650 | |||
9e61ff2c6c | |||
abb1f9a07c | |||
f0f4b16b2d | |||
c88c4d9baf | |||
1ef874b092 | |||
98cb5c6837 | |||
4c0ace604f | |||
c14db40a77 | |||
2844d6b963 | |||
6a41db72fd | |||
93fd6d6bea | |||
cf46f1124a | |||
e1c81bb404 | |||
33f36adf3f | |||
3639511414 | |||
3f465b2031 | |||
1a75c93661 | |||
965bcf3cc8 | |||
cebad8abe4 | |||
7511828552 | |||
0ab2c8c1a3 | |||
87a285bc2e | |||
151993c92a | |||
f0f32472eb | |||
8d9f282092 | |||
72e25a7081 | |||
251771f3c3 | |||
4adfc7efb2 | |||
660b4efa26 | |||
f969e21418 | |||
6714f447de | |||
293f0af30a | |||
e9ca986926 | |||
285ed25eaf | |||
48e0446521 | |||
bd7514ea84 | |||
31892b27fc | |||
ab23597218 | |||
fbf31a4115 | |||
445b22fecd | |||
1ae5d2b49f | |||
0b8b2299da | |||
590093aa5e | |||
ae80119fa8 | |||
7efa41a48c | |||
478dc4dd3a | |||
74b4202e9e | |||
f66fd67159 | |||
d2f89f0938 | |||
f8ad83439c | |||
8dbd524839 | |||
fa6f0f7707 | |||
6f2975dfd7 | |||
1885b481c9 | |||
f0c96012ce | |||
5818e5d4ab | |||
e0350d04de | |||
36243e6137 | |||
614c0d6f8d | |||
e161b4949b | |||
|
8367f381b6 | ||
389cd249d6 | |||
02735ff29d | |||
59ca47cd50 | |||
2287e8da9d | |||
f2667c4d76 | |||
5186bded04 | |||
|
6540041f4b | ||
|
78524042cc |
17 changed files with 2673 additions and 1117 deletions
146
.forgejo/workflows/build+release.yml
Normal file
146
.forgejo/workflows/build+release.yml
Normal file
|
@ -0,0 +1,146 @@
|
|||
name: 'Build and release binary file and packages'
|
||||
author: 'Neshura'
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '[0-9]+.[0-9]+.[0-9]+'
|
||||
- '[0-9]+.[0-9]+.[0-9]+-rc.[0-9]+'
|
||||
jobs:
|
||||
test:
|
||||
runs-on: docker
|
||||
container: forgejo.neshweb.net/ci-docker-images/rust-node:latest
|
||||
steps:
|
||||
-
|
||||
name: Add Clippy
|
||||
run: rustup component add clippy
|
||||
-
|
||||
name: Checking Out Repository Code
|
||||
uses: https://code.forgejo.org/actions/checkout@v3
|
||||
-
|
||||
name: Set Up Cargo Cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/bin/
|
||||
~/.cargo/registry/index/
|
||||
~/.cargo/registry/cache/
|
||||
~/.cargo/git/db/
|
||||
target/
|
||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||
-
|
||||
name: Run Clippy
|
||||
run: cargo clippy
|
||||
-
|
||||
name: Check if Version in Cargo.toml matches Tag
|
||||
run: |
|
||||
VERSION=$(cat Cargo.toml | grep -E "(^|\|)version =" | cut -f2- -d= | tr -d \" | tr -d " ")
|
||||
if test $VERSION != "${{ github.ref_name }}"; then
|
||||
echo "Expected Version is: '${{ github.ref_name }}' actual Version is: '$VERSION'";
|
||||
exit 1
|
||||
else
|
||||
echo "Version is: '$VERSION'";
|
||||
fi
|
||||
|
||||
build:
|
||||
needs: test
|
||||
if: success()
|
||||
runs-on: docker
|
||||
container: forgejo.neshweb.net/ci-docker-images/rust-node:latest
|
||||
steps:
|
||||
-
|
||||
name: Checking Out Repository Code
|
||||
uses: https://code.forgejo.org/actions/checkout@v3
|
||||
-
|
||||
name: Prepare build environment
|
||||
run: mkdir dist
|
||||
-
|
||||
name: Compiling To Linux Target
|
||||
run: |
|
||||
cargo build -r
|
||||
mv target/release/${{ github.event.repository.name }} dist/${{ github.event.repository.name }}-linux-amd64
|
||||
-
|
||||
name: Bundle .deb package
|
||||
run: |
|
||||
cargo deb
|
||||
DEBIAN_REF=$(cat Cargo.toml | grep -E "(^|\|)version =" | cut -f2- -d= | tr -d \" | tr -d " " | tr - \~)
|
||||
echo "DEBIAN_REF=$DEBIAN_REF" >> dist/build.env
|
||||
DEBIAN_REV=-$(cat Cargo.toml | grep -E "(^|\|)revision =" | cut -f2- -d= | tr -d \" | tr -d " ")
|
||||
echo "DEBIAN_REV=$DEBIAN_REV" >> dist/build.env
|
||||
mv target/debian/${{ github.event.repository.name }}_"$DEBIAN_REF""$DEBIAN_REV"_amd64.deb dist/${{ github.event.repository.name }}_"$DEBIAN_REF""$DEBIAN_REV"_amd64.deb
|
||||
-
|
||||
name: Uploading Build Artifact
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: release_blobs
|
||||
path: dist
|
||||
if-no-files-found: error
|
||||
|
||||
upload-generic-package:
|
||||
needs: build
|
||||
if: success()
|
||||
runs-on: docker
|
||||
steps:
|
||||
-
|
||||
name: Downloading All Build Artifacts
|
||||
uses: actions/download-artifact@v3
|
||||
-
|
||||
name: Upload Binary
|
||||
run: |
|
||||
echo 'curl -v --user ${{ secrets.FORGEJO_USERNAME }}:${{ secrets.FORGEJO_TOKEN }} \
|
||||
--upload-file release_blobs/${{ github.event.repository.name }}-linux-amd64 \
|
||||
https://forgejo.neshweb.net/api/packages/${{ secrets.FORGEJO_USERNAME }}/generic/${{ github.event.repository.name }}/${{ github.ref_name }}/${{ github.event.repository.name }}-linux-amd64'
|
||||
curl -v --user ${{ secrets.FORGEJO_USERNAME }}:${{ secrets.FORGEJO_TOKEN }} \
|
||||
--upload-file release_blobs/${{ github.event.repository.name }}-linux-amd64 \
|
||||
https://forgejo.neshweb.net/api/packages/${{ secrets.FORGEJO_USERNAME }}/generic/${{ github.event.repository.name }}/${{ github.ref_name }}/${{ github.event.repository.name }}-linux-amd64
|
||||
|
||||
upload-debian-package:
|
||||
needs: build
|
||||
if: success()
|
||||
runs-on: docker
|
||||
steps:
|
||||
-
|
||||
name: Downloading All Build Artifacts
|
||||
uses: actions/download-artifact@v3
|
||||
-
|
||||
name: Upload Debian Package to staging
|
||||
run: |
|
||||
source release_blobs/build.env
|
||||
echo 'curl -v --user ${{ secrets.FORGEJO_USERNAME }}:${{ secrets.FORGEJO_TOKEN }} \
|
||||
--upload-file release_blobs/${{ github.event.repository.name }}_'"$DEBIAN_REF""$DEBIAN_REV"'_amd64.deb \
|
||||
https://forgejo.neshweb.net/api/packages/${{ secrets.FORGEJO_USERNAME }}/debian/pool/bookworm/staging/upload'
|
||||
curl -v --user ${{ secrets.FORGEJO_USERNAME }}:${{ secrets.FORGEJO_TOKEN }} \
|
||||
--upload-file release_blobs/${{ github.event.repository.name }}_"$DEBIAN_REF""$DEBIAN_REV"_amd64.deb \
|
||||
https://forgejo.neshweb.net/api/packages/${{ secrets.FORGEJO_USERNAME }}/debian/pool/bookworm/staging/upload
|
||||
-
|
||||
name: Upload Debian Package to main
|
||||
if: (! contains(github.ref_name, '-rc'))
|
||||
run: |
|
||||
source release_blobs/build.env
|
||||
echo 'curl -v --user ${{ secrets.FORGEJO_USERNAME }}:${{ secrets.FORGEJO_TOKEN }} \
|
||||
--upload-file release_blobs/${{ github.event.repository.name }}_'"$DEBIAN_REF""$DEBIAN_REV"'_amd64.deb \
|
||||
https://forgejo.neshweb.net/api/packages/${{ secrets.FORGEJO_USERNAME }}/debian/pool/bookworm/main/upload'
|
||||
curl -v --user ${{ secrets.FORGEJO_USERNAME }}:${{ secrets.FORGEJO_TOKEN }} \
|
||||
--upload-file release_blobs/${{ github.event.repository.name }}_"$DEBIAN_REF""$DEBIAN_REV"_amd64.deb \
|
||||
https://forgejo.neshweb.net/api/packages/${{ secrets.FORGEJO_USERNAME }}/debian/pool/bookworm/main/upload
|
||||
|
||||
create-release:
|
||||
needs: build
|
||||
if: success()
|
||||
runs-on: docker
|
||||
steps:
|
||||
-
|
||||
name: Downloading All Build Artifacts
|
||||
uses: actions/download-artifact@v3
|
||||
-
|
||||
name: Filter out env files
|
||||
run: rm release_blobs/build.env
|
||||
-
|
||||
name: Release New Version
|
||||
uses: actions/forgejo-release@v2
|
||||
with:
|
||||
direction: upload
|
||||
url: https://forgejo.neshweb.net
|
||||
release-dir: release_blobs
|
||||
token: ${{ secrets.FORGEJO_TOKEN }}
|
||||
tag: ${{ github.ref_name }}
|
67
.forgejo/workflows/pull-requests.yml
Normal file
67
.forgejo/workflows/pull-requests.yml
Normal file
|
@ -0,0 +1,67 @@
|
|||
name: 'Build binary file and bundle packages'
|
||||
author: 'Neshura'
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: docker
|
||||
container: forgejo.neshweb.net/ci-docker-images/rust-node:latest
|
||||
steps:
|
||||
-
|
||||
name: Add Clippy
|
||||
run: rustup component add clippy
|
||||
-
|
||||
name: Checking Out Repository Code
|
||||
uses: https://code.forgejo.org/actions/checkout@v3
|
||||
-
|
||||
name: Set Up Cargo Cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/bin/
|
||||
~/.cargo/registry/index/
|
||||
~/.cargo/registry/cache/
|
||||
~/.cargo/git/db/
|
||||
target/
|
||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||
-
|
||||
name: Run Clippy
|
||||
run: cargo clippy
|
||||
|
||||
build:
|
||||
needs: test
|
||||
if: success()
|
||||
runs-on: docker
|
||||
container: forgejo.neshweb.net/ci-docker-images/rust-node:latest
|
||||
steps:
|
||||
-
|
||||
name: Checking Out Repository Code
|
||||
uses: https://code.forgejo.org/actions/checkout@v3
|
||||
-
|
||||
name: Prepare build environment
|
||||
run: mkdir dist
|
||||
-
|
||||
name: Compiling To Linux Target
|
||||
run: |
|
||||
cargo build -r
|
||||
mv target/release/${{ github.event.repository.name }} dist/${{ github.event.repository.name }}-linux-amd64
|
||||
-
|
||||
name: Bundle .deb package
|
||||
run: |
|
||||
cargo deb
|
||||
DEBIAN_REF=$(cat Cargo.toml | grep -E "(^|\|)version =" | cut -f2- -d= | tr -d \" | tr -d " " | tr - \~)
|
||||
echo "DEBIAN_REF=$DEBIAN_REF" >> dist/build.env
|
||||
DEBIAN_REV=-$(cat Cargo.toml | grep -E "(^|\|)revision =" | cut -f2- -d= | tr -d \" | tr -d " ")
|
||||
echo "DEBIAN_REV=$DEBIAN_REV" >> dist/build.env
|
||||
mv target/debian/${{ github.event.repository.name }}_"$DEBIAN_REF""$DEBIAN_REV"_amd64.deb dist/${{ github.event.repository.name }}_"$DEBIAN_REF""$DEBIAN_REV"_amd64.deb
|
||||
-
|
||||
name: Uploading Build Artifact
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: release_blobs
|
||||
path: dist
|
||||
if-no-files-found: error
|
34
.forgejo/workflows/test.yml
Normal file
34
.forgejo/workflows/test.yml
Normal file
|
@ -0,0 +1,34 @@
|
|||
name: 'Run Tests on Code'
|
||||
author: 'Neshura'
|
||||
|
||||
on:
|
||||
push:
|
||||
tags-ignore:
|
||||
- '**'
|
||||
branches:
|
||||
- '**'
|
||||
jobs:
|
||||
run-tests:
|
||||
runs-on: docker
|
||||
container: forgejo.neshweb.net/ci-docker-images/rust-node:latest
|
||||
steps:
|
||||
-
|
||||
name: Add Clippy
|
||||
run: rustup component add clippy
|
||||
-
|
||||
name: Checking Out Repository Code
|
||||
uses: https://code.forgejo.org/actions/checkout@v3
|
||||
-
|
||||
name: Set Up Cargo Cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/bin/
|
||||
~/.cargo/registry/index/
|
||||
~/.cargo/registry/cache/
|
||||
~/.cargo/git/db/
|
||||
target/
|
||||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
|
||||
-
|
||||
name: Run Clippy
|
||||
run: cargo clippy
|
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -3,4 +3,6 @@ target/
|
|||
venv/
|
||||
.idea/
|
||||
.vscode/
|
||||
api-key.json
|
||||
|
||||
/interfaces.toml
|
||||
/zones.d
|
|
@ -1,60 +0,0 @@
|
|||
image: 3.10.8-slim-buster
|
||||
|
||||
.deploy:
|
||||
rules:
|
||||
# Regex magic copied from Neshura/page-test, only deploys on x.y.z or higher (x.y) Tags
|
||||
- if: $CI_COMMIT_TAG =~ /^((([\d])+\.){1,2}[\d]+)\s*$/ && $CI_COMMIT_TAG
|
||||
|
||||
stages:
|
||||
- build
|
||||
- release
|
||||
|
||||
## Docker steps
|
||||
|
||||
build:
|
||||
image: rust:bullseye
|
||||
stage: build
|
||||
|
||||
variables:
|
||||
IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_BRANCH
|
||||
CACHING:
|
||||
|
||||
script:
|
||||
- echo "Compiling the code..."
|
||||
- cargo build -r
|
||||
- echo "Compile complete."
|
||||
|
||||
after_script:
|
||||
- echo JOB_ID=$CI_JOB_ID >> job.env
|
||||
- mkdir ./artifacts
|
||||
- cp /builds/Neshura/cloudflare-dns-updater/target/release/cloudflare-dns-updater ./artifacts/
|
||||
- cp /builds/Neshura/cloudflare-dns-updater/config.json ./artifacts/
|
||||
- cp /builds/Neshura/cloudflare-dns-updater/api-key-empty.json ./artifacts/api-key.json
|
||||
|
||||
artifacts:
|
||||
paths:
|
||||
- ./artifacts/
|
||||
reports:
|
||||
dotenv: job.env
|
||||
|
||||
rules:
|
||||
- !reference [.deploy, rules]
|
||||
|
||||
Tag Release:
|
||||
needs:
|
||||
- job: build
|
||||
artifacts: true
|
||||
stage: release
|
||||
image: registry.gitlab.com/gitlab-org/release-cli:latest
|
||||
rules:
|
||||
- !reference [.deploy, rules]
|
||||
script:
|
||||
- echo "running Release Job, attaching Artifact from Job $JOB_ID"
|
||||
release:
|
||||
tag_name: '$CI_COMMIT_TAG'
|
||||
description: '$CI_COMMIT_TAG'
|
||||
assets:
|
||||
links:
|
||||
- name: "cloudflare-dns-updater.zip"
|
||||
url: "https://gitlab.neshweb.net/Neshura/cloudflare-dns-updater/-/jobs/$JOB_ID/artifacts/download"
|
||||
|
674
COPYING
Normal file
674
COPYING
Normal file
|
@ -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) <year> <name of author>
|
||||
|
||||
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) <year> <name of author>
|
||||
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>.
|
831
Cargo.lock
generated
831
Cargo.lock
generated
File diff suppressed because it is too large
Load diff
36
Cargo.toml
36
Cargo.toml
|
@ -1,14 +1,36 @@
|
|||
[package]
|
||||
authors = ["Neshura"]
|
||||
name = "cloudflare-dns-updater"
|
||||
version = "0.1.0"
|
||||
version = "1.1.9"
|
||||
edition = "2021"
|
||||
description = "Application for automatically updating Cloudflare DNS records"
|
||||
license = "GPL-3.0-or-later"
|
||||
|
||||
[package.metadata.deb]
|
||||
extended-description = "Application for automatically updating Cloudflare DNS records"
|
||||
maintainer-scripts = "debian/"
|
||||
revision = "1"
|
||||
depends = ["libc6", "libssl3", "systemd"]
|
||||
assets = [
|
||||
[
|
||||
"target/release/cloudflare-dns-updater",
|
||||
"/usr/local/bin/cloudflare-dns-updater",
|
||||
"755",
|
||||
]
|
||||
]
|
||||
systemd-units = { enable = false }
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
[dependencies]
|
||||
chrono = "0.4.23"
|
||||
reqwest = { version = "0.11.14", features = ["blocking", "json"] }
|
||||
serde = "1.0.152"
|
||||
serde_derive = "1.0.152"
|
||||
serde_json = "1.0.93"
|
||||
strum_macros = "0.24.3"
|
||||
chrono = "^0.4.23"
|
||||
reqwest = { version = "^0.11.14", features = ["blocking", "json"] }
|
||||
serde = "^1.0.152"
|
||||
serde_derive = "^1.0.152"
|
||||
serde_json = "^1.0.93"
|
||||
strum_macros = "^0.25.3"
|
||||
log = "^0.4.20"
|
||||
systemd-journal-logger = "^2.1.1"
|
||||
confy = "^0.5.1"
|
||||
ipnet = "^2.9.0"
|
||||
url = "2.5.0"
|
||||
|
|
93
README.md
93
README.md
|
@ -1,72 +1,51 @@
|
|||
# Cloudflare DNS Updater
|
||||
|
||||
## Create and activating a venv
|
||||
|
||||
Make sure Python 3.10 or higher is installed.
|
||||
Use `cd` to change to the location of this repository.
|
||||
|
||||
Now, run
|
||||
```
|
||||
py -3.10 -m venv venv
|
||||
```
|
||||
Replace the `-3.10` with other Python versions if necessary (ex.: `-3.11`)
|
||||
## Using the application
|
||||
|
||||
Activate the venv using the command
|
||||
```
|
||||
venv/scripts/activate
|
||||
The application necessarily requires a valid Cloudflare API Token.
|
||||
Further the application must be located in the same network as the configured zones.
|
||||
|
||||
The actual configuration happens in three or more files located in `~/.config/cloudflare-dns-updater/`:
|
||||
`config.toml` contains general configuration parameters for the application
|
||||
`interfaces.toml` contains all IPv6 interfaces available/used by the zone config files.
|
||||
`.toml` files in `zones.d` contain settings for individual zones.
|
||||
|
||||
Example:
|
||||
|
||||
*config.toml*
|
||||
```toml
|
||||
cf_api_token = "0123456789abcdef0123456789abcdef01234" # Cloudflare API Token
|
||||
check_interval_seconds = 30 # Defaults to 60 if missing
|
||||
uptime_url = "https://example.org/uptime/id12" # Post Endpoint for a Uptime Monitor
|
||||
```
|
||||
|
||||
## Installing the required packages
|
||||
*interfaces.toml*
|
||||
```toml
|
||||
host_address = "::edcb:a098:7654:3210"
|
||||
|
||||
Make sure the venv is activated.
|
||||
|
||||
Run the following command
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
[interfaces]
|
||||
example-interface = "::0123:4567:890a:bcde" # static part of the IP, the rest will be dynamically generated using the host
|
||||
```
|
||||
|
||||
Alternatively, the packages can be installed manually by using `pip install`.
|
||||
*zones.d/example.org.toml*
|
||||
```toml
|
||||
email = "owner@example.org" # Email of User owning the Zone
|
||||
zone = "example.org" # Zone Name
|
||||
id = "01234567890abcdefghijklmnopqrstu" # Zone ID
|
||||
|
||||
The full list of packages needed:
|
||||
- cloudflare (Version 2.0.0 or greater)
|
||||
- Buildins:
|
||||
- json
|
||||
- configparser
|
||||
- ipaddress
|
||||
- sys
|
||||
|
||||
## Using the script
|
||||
|
||||
Before running the script, make sure there exists a `config.ini` file next to the `cloudflare_script.py`.
|
||||
The config has to have the following structure:
|
||||
```ini
|
||||
[cloudflare]
|
||||
TOKEN=<cloudflare api token>
|
||||
|
||||
[server]
|
||||
HOSTNAME=hostname-of-website.com
|
||||
[[entry]]
|
||||
name = "example.org" # "@" Symbol is not currently supported
|
||||
type = ["AAAA", "A"] # Options are: "A" (IPv4/A Record) and/or "AAAA" (IPv6/AAAA Record)
|
||||
interface = "example-interface" # Only required on type values 6 and 10
|
||||
```
|
||||
|
||||
Run the script using the following arguments:
|
||||
```
|
||||
python cloudflare_script.py <ipversion> <path/to/ip/list>
|
||||
```
|
||||
## Debian Repository
|
||||
|
||||
IP-Version can be 4 or 6.
|
||||
The IP-List has to conform to the following structure and be a json file:
|
||||
```json
|
||||
{
|
||||
"AAAA": [
|
||||
"ipv6 site prefix"
|
||||
],
|
||||
"A": [
|
||||
"ipv4 site prefix"
|
||||
]
|
||||
}
|
||||
```
|
||||
Currently supported:
|
||||
- Debian 12 'Bookworm'
|
||||
|
||||
To only get the currently registered DNS records for a given API key, run
|
||||
```
|
||||
python cloudflare_script.py
|
||||
```
|
||||
THis will print all DNS records for the API key with name, ip, cloudflare id and ip-version
|
||||
Includes systemd system and user unit files
|
||||
|
||||
For more details see [the package registry](https://forgejo.neshweb.net/Neshura/-/packages/debian/cloudflare-dns-updater)
|
|
@ -1,3 +0,0 @@
|
|||
{
|
||||
"api_key": ""
|
||||
}
|
|
@ -1,74 +0,0 @@
|
|||
{
|
||||
"AAAA": [
|
||||
"books",
|
||||
"calibre",
|
||||
"docs.gitlab",
|
||||
"element",
|
||||
"files",
|
||||
"gitlab",
|
||||
"*.gitpages",
|
||||
"gitpages",
|
||||
"hentai",
|
||||
"ipv6",
|
||||
"jellyfin",
|
||||
"komga",
|
||||
"manga",
|
||||
"mastodon",
|
||||
"matrix",
|
||||
"minecraft",
|
||||
"monitoring",
|
||||
"mstreaming",
|
||||
"music",
|
||||
"navidrome",
|
||||
"neshura-server.net",
|
||||
"nextcloud",
|
||||
"nginx",
|
||||
"picard",
|
||||
"porn",
|
||||
"portainer",
|
||||
"readyornot",
|
||||
"registry.gitlab",
|
||||
"temp1",
|
||||
"temp2",
|
||||
"tube",
|
||||
"video",
|
||||
"www",
|
||||
"zomboid"
|
||||
],
|
||||
"A": [
|
||||
"books",
|
||||
"calibre",
|
||||
"docs.gitlab",
|
||||
"element",
|
||||
"files",
|
||||
"gitlab",
|
||||
"*.gitpages",
|
||||
"gitpages",
|
||||
"hentai",
|
||||
"ipv4",
|
||||
"jellyfin",
|
||||
"komga",
|
||||
"manga",
|
||||
"mastodon",
|
||||
"matrix",
|
||||
"minecraft",
|
||||
"monitoring",
|
||||
"mstreaming",
|
||||
"music",
|
||||
"navidrome",
|
||||
"neshura-server.net",
|
||||
"nextcloud",
|
||||
"nginx",
|
||||
"picard",
|
||||
"porn",
|
||||
"portainer",
|
||||
"readyornot",
|
||||
"registry.gitlab",
|
||||
"temp1",
|
||||
"temp2",
|
||||
"tube",
|
||||
"video",
|
||||
"www",
|
||||
"zomboid"
|
||||
]
|
||||
}
|
38
config.json
38
config.json
|
@ -1,38 +0,0 @@
|
|||
{
|
||||
"ipv6_interface": ":da5e:d3ff:feeb:4346",
|
||||
"zones": [
|
||||
{
|
||||
"email": "neshura@proton.me",
|
||||
"name": "neshura.net",
|
||||
"id": "0183f167a051f1e432c0d931478638b5",
|
||||
"dns_entries": [
|
||||
{
|
||||
"name": "*.neshura.net",
|
||||
"type4": true,
|
||||
"type6": true,
|
||||
"interface": ":da5e:d3ff:feeb:4346"
|
||||
},
|
||||
{
|
||||
"name": "neshura.net",
|
||||
"type4": true,
|
||||
"type6": true,
|
||||
"interface": ":da5e:d3ff:feeb:4346"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"email": "neshura@proton.me",
|
||||
"name": "neshura-server.net",
|
||||
"id": "146d4cd6a1777376b423aaedc6824818",
|
||||
"dns_entries": [
|
||||
]
|
||||
},
|
||||
{
|
||||
"email": "neshura@proton.me",
|
||||
"name": "neshweb.net",
|
||||
"id": "75b0d52229357478b734ae0f6d075c15",
|
||||
"dns_entries": [
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
14
debian/cloudflare-dns-updater@.service
vendored
Normal file
14
debian/cloudflare-dns-updater@.service
vendored
Normal file
|
@ -0,0 +1,14 @@
|
|||
[Unit]
|
||||
Description="Application for automatically updating Cloudflare DNS records"
|
||||
After=syslog.target
|
||||
After=network-online.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=%i
|
||||
ExecStart=/usr/local/bin/cloudflare-dns-updater
|
||||
Restart=always
|
||||
RestartSec=3
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
358
src/cloudflare.rs
Normal file
358
src/cloudflare.rs
Normal file
|
@ -0,0 +1,358 @@
|
|||
use std::collections::HashMap;
|
||||
use std::error::Error;
|
||||
use std::net::{Ipv4Addr, Ipv6Addr};
|
||||
use log::{error, warn};
|
||||
use reqwest::header::{HeaderMap, HeaderValue};
|
||||
use reqwest::{Url};
|
||||
use reqwest::blocking::{Response, Client};
|
||||
use serde_derive::{Deserialize, Serialize};
|
||||
use strum_macros::{Display, IntoStaticStr};
|
||||
use systemd_journal_logger::connected_to_journal;
|
||||
use url::ParseError;
|
||||
use crate::config::{AppConfig, ZoneConfig, ZoneEntry};
|
||||
|
||||
const API_BASE: &str = "https://api.cloudflare.com/client/v4";
|
||||
|
||||
#[derive(Serialize, Deserialize, Debug)]
|
||||
struct CloudflareApiResults {
|
||||
result: Vec<CloudflareDnsRecord>,
|
||||
success: bool,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, Debug)]
|
||||
struct CloudflareApiResult {
|
||||
success: bool,
|
||||
}
|
||||
|
||||
pub(crate) struct CloudflareZone {
|
||||
name: String,
|
||||
email: String,
|
||||
key: String,
|
||||
id: String,
|
||||
}
|
||||
|
||||
impl CloudflareZone {
|
||||
pub(crate) fn new(zone: &ZoneConfig, config: &AppConfig) -> Self {
|
||||
let key = config.cloudflare_api_token.clone();
|
||||
Self {
|
||||
name: zone.name.clone(),
|
||||
email: zone.email.clone(),
|
||||
key,
|
||||
id: zone.id.clone(),
|
||||
}
|
||||
}
|
||||
|
||||
fn generate_auth_headers(&self) -> HeaderMap {
|
||||
let mut headers = HeaderMap::new();
|
||||
headers.insert(
|
||||
"X-Auth-Email",
|
||||
HeaderValue::from_str(self.email.as_str()).expect("After CloudflareZone gets created the required Values should exist"),
|
||||
);
|
||||
headers.insert(
|
||||
"X-Auth-Key",
|
||||
HeaderValue::from_str(self.key.as_str()).expect("After CloudflareZone gets created the required Values should exist"),
|
||||
);
|
||||
headers
|
||||
}
|
||||
|
||||
pub(crate) fn get_entries(&self) -> Result<Vec<CloudflareDnsRecord>, ()> {
|
||||
let endpoint = format!("{}/zones/{}/dns_records", API_BASE, self.id);
|
||||
|
||||
match self.get(&endpoint) {
|
||||
Ok(response) => {
|
||||
if response.status().is_success() {
|
||||
let entries = match response.json::<CloudflareApiResults>() {
|
||||
Ok(data) => data,
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to parse API response: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
return Err(())
|
||||
}
|
||||
};
|
||||
|
||||
Ok(entries.result)
|
||||
} else {
|
||||
let err_msg = format!("Unable to fetch Cloudflare Zone Entries for {}: {}",self.name ,response.status());
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to access Cloudflare API: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn update(&self, entry: &ZoneEntry, r#type: &DnsRecordType, id: &String, ipv6: Option<Ipv6Addr>, ipv4: Option<Ipv4Addr>) -> Result<(), ()> {
|
||||
let endpoint = format!("{}/zones/{}/dns_records/{}", API_BASE, self.id, id);
|
||||
|
||||
return match r#type {
|
||||
DnsRecordType::A => {
|
||||
if let Some(ip) = ipv4 {
|
||||
let json_body = self.create_body("A", &entry.name, ip.to_string().as_str());
|
||||
|
||||
match self.put(&endpoint, &json_body) {
|
||||
Ok(response) => {
|
||||
self.validate_response(response)
|
||||
},
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to access Cloudflare API: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
}
|
||||
} else {
|
||||
let err_msg = "Missing IPv4 for Update.";
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
},
|
||||
DnsRecordType::AAAA => {
|
||||
if let Some(ip) = ipv6 {
|
||||
let json_body = self.create_body("AAAA", &entry.name, ip.to_string().as_str());
|
||||
|
||||
match self.put(&endpoint, &json_body) {
|
||||
Ok(response) => {
|
||||
self.validate_response(response)
|
||||
},
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to access Cloudflare API: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
}
|
||||
} else {
|
||||
let err_msg = "Missing IPv6 for Update.";
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
},
|
||||
_ => {
|
||||
let warn_msg = "Config contains unsupported type identifier";
|
||||
match connected_to_journal() {
|
||||
true => warn!("[WARN] {warn_msg}"),
|
||||
false => println!("[WARN] {warn_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn create(&self, entry: &ZoneEntry, r#type: &DnsRecordType, ipv6: Option<Ipv6Addr>, ipv4: Option<Ipv4Addr>) -> Result<(), ()> {
|
||||
let endpoint = format!("{}/zones/{}/dns_records", API_BASE, self.id);
|
||||
|
||||
return match r#type {
|
||||
DnsRecordType::A => {
|
||||
if let Some(ip) = ipv4 {
|
||||
let json_body = self.create_body("A", &entry.name, ip.to_string().as_str());
|
||||
|
||||
match self.post(&endpoint, &json_body) {
|
||||
Ok(response) => {
|
||||
self.validate_response(response)
|
||||
},
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to access Cloudflare API: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
}
|
||||
} else {
|
||||
let err_msg = "Missing IPv4 for Update.";
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
},
|
||||
DnsRecordType::AAAA => {
|
||||
if let Some(ip) = ipv6 {
|
||||
let json_body = self.create_body("AAAA", &entry.name, ip.to_string().as_str());
|
||||
|
||||
match self.post(&endpoint, &json_body) {
|
||||
Ok(response) => {
|
||||
self.validate_response(response)
|
||||
},
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to access Cloudflare API: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
}
|
||||
} else {
|
||||
let err_msg = "Missing IPv6 for Update.";
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
},
|
||||
_ => {
|
||||
let warn_msg = "Config contains unsupported type identifier";
|
||||
match connected_to_journal() {
|
||||
true => warn!("[WARN] {warn_msg}"),
|
||||
false => println!("[WARN] {warn_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn get(&self, url: &str) -> Result<Response, Box<dyn Error>> {
|
||||
let url_parsed = self.parse_url(url)?;
|
||||
|
||||
match Client::new()
|
||||
.get(url_parsed)
|
||||
.headers(self.generate_auth_headers())
|
||||
.send() {
|
||||
Ok(result) => Ok(result),
|
||||
Err(e) => Err(Box::new(e)),
|
||||
}
|
||||
}
|
||||
|
||||
fn post(&self, url: &str, data: &HashMap<String, String>) -> Result<Response, Box<dyn Error>> {
|
||||
let url_parsed = self.parse_url(url)?;
|
||||
|
||||
match Client::new()
|
||||
.post(url_parsed)
|
||||
.headers(self.generate_auth_headers())
|
||||
.json(data)
|
||||
.send() {
|
||||
Ok(result) => Ok(result),
|
||||
Err(e) => Err(Box::new(e)),
|
||||
}
|
||||
}
|
||||
|
||||
fn put(&self, url: &str, data: &HashMap<String, String>) -> Result<Response, Box<dyn Error>> {
|
||||
let url_parsed = self.parse_url(url)?;
|
||||
|
||||
match Client::new()
|
||||
.put(url_parsed)
|
||||
.headers(self.generate_auth_headers())
|
||||
.json(data)
|
||||
.send() {
|
||||
Ok(result) => Ok(result),
|
||||
Err(e) => Err(Box::new(e)),
|
||||
}
|
||||
}
|
||||
|
||||
fn parse_url(&self, input: &str) -> Result<Url, ParseError> {
|
||||
match Url::parse(input) {
|
||||
Ok(url) => Ok(url),
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to parse URL: {}", e);
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(e)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn create_body(&self, r#type: &str, name: &str, ip: &str) -> HashMap<String, String> {
|
||||
let mut body = HashMap::new();
|
||||
body.insert("type".to_owned(), r#type.to_owned());
|
||||
body.insert("name".to_owned(), name.to_owned());
|
||||
body.insert("content".to_owned(), ip.to_owned());
|
||||
body
|
||||
}
|
||||
|
||||
fn validate_response(&self, response: Response) -> Result<(), ()> {
|
||||
if response.status().is_success() {
|
||||
let data = match response.json::<CloudflareApiResult>() {
|
||||
Ok(data) => data,
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to parse API response: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
return Err(())
|
||||
}
|
||||
};
|
||||
|
||||
match data.success {
|
||||
true => Ok(()),
|
||||
false => {
|
||||
let err_msg = format!("Unexpected error while updating DNS record: {:?}", data);
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
}
|
||||
} else {
|
||||
let err_msg = format!("Unable to post/put Cloudflare DNS entry: {}", response.status());
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
Err(())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone, Copy, Display, IntoStaticStr)]
|
||||
#[allow(clippy::upper_case_acronyms)]
|
||||
pub(crate) enum DnsRecordType {
|
||||
A,
|
||||
AAAA,
|
||||
CAA,
|
||||
CERT,
|
||||
CNAME,
|
||||
DNSKEY,
|
||||
DS,
|
||||
HTTPS,
|
||||
LOC,
|
||||
MX,
|
||||
NAPTR,
|
||||
NS,
|
||||
PTR,
|
||||
SMIMEA,
|
||||
SRV,
|
||||
SSHFP,
|
||||
SVCB,
|
||||
TLSA,
|
||||
TXT,
|
||||
URI
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
||||
pub(crate) struct CloudflareDnsRecord {
|
||||
pub(crate) id: String,
|
||||
pub(crate) name: String,
|
||||
pub(crate) r#type: DnsRecordType,
|
||||
pub(crate) content: String
|
||||
}
|
|
@ -1,224 +0,0 @@
|
|||
use reqwest::{blocking::{Response, Client}, Url};
|
||||
use serde_derive::{Deserialize, Serialize};
|
||||
use reqwest::{Error, header::{HeaderMap, HeaderValue}};
|
||||
use std::{string::String, collections::HashMap};
|
||||
use strum_macros::{Display, IntoStaticStr};
|
||||
|
||||
const API_BASE: &str = "https://api.cloudflare.com/client/v4/";
|
||||
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
struct CloudflareDnsZone {
|
||||
result: Vec<CloudflareDnsEntry>,
|
||||
success: bool
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone, Copy)]
|
||||
#[derive(Display, IntoStaticStr)]
|
||||
pub enum CloudflareDnsType {
|
||||
#[strum(serialize = "A")]
|
||||
A = 4,
|
||||
#[strum(serialize = "AAAA")]
|
||||
AAAA = 6,
|
||||
TXT,
|
||||
MX
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
pub struct CloudflareDnsEntry {
|
||||
id: String,
|
||||
pub zone_id: String,
|
||||
pub name: String,
|
||||
pub r#type: CloudflareDnsType,
|
||||
content: String,
|
||||
proxied: bool
|
||||
}
|
||||
|
||||
impl CloudflareDnsEntry {
|
||||
pub fn is_equal(&self, other_entry: &String) -> bool {
|
||||
return if &self.name == other_entry { true } else { false };
|
||||
}
|
||||
|
||||
pub fn is_ip_new(&self, other_entry: &String) -> bool {
|
||||
return if &self.content == other_entry { false } else { true };
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
pub(crate) struct Instance {
|
||||
api_key: String,
|
||||
pub dns_entries: Vec<CloudflareDnsEntry>,
|
||||
dns_email: String
|
||||
}
|
||||
|
||||
impl Instance {
|
||||
pub fn new(key: &String) -> Instance {
|
||||
Instance {
|
||||
api_key: key.clone(),
|
||||
dns_entries: Vec::new(),
|
||||
dns_email: "".to_string()
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads all DNS entires in a Zone as a [`CloudflareDnsEntry`] Vector
|
||||
///
|
||||
/// * `email` : E-Mail Address associated with the Zone, required for [`generate_headers()`]
|
||||
/// * `zone_id` : Zone to be used for the Request
|
||||
/// * `return` : Returns true if a recoverable Error was encountered, true otherwise
|
||||
pub fn load_entries(&mut self, email: &String, zone_id: &String) -> Result<(), Error> {
|
||||
self.dns_email = email.clone();
|
||||
let endpoint = format!("{}zones/{}/dns_records", API_BASE, zone_id);
|
||||
|
||||
match self.get(&endpoint) {
|
||||
Ok(response) => {
|
||||
let entries = match response
|
||||
.json::<CloudflareDnsZone>() {
|
||||
Ok(data) => {data},
|
||||
Err(e) => panic!("{:#?}", e)
|
||||
};
|
||||
|
||||
for entry in entries.result {
|
||||
self.dns_entries.append(&mut vec!(entry));
|
||||
}
|
||||
|
||||
return Ok(())
|
||||
},
|
||||
Err(e) => { return Err(e) }
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
/// Shorthand for Cloudflare API Requests
|
||||
///
|
||||
/// Automatically appends Auth Headers and parses the URL
|
||||
///
|
||||
/// * `url` : URL for the request, will be parsed to [`Url`]
|
||||
fn get(&self, url: &str) -> Result<Response, Error> {
|
||||
let url_parsed = match Url::parse(url) {
|
||||
Ok(url) => {url},
|
||||
Err(e) => panic!("{:#?}", e) // If this call fails the API changed
|
||||
}; // Continuing without a code update is not possible
|
||||
|
||||
let result = match Client::new()
|
||||
.get(url_parsed)
|
||||
.headers(self.generate_headers())
|
||||
.send() {
|
||||
Ok(res) => { Ok(res) },
|
||||
Err(e) => { Err(e) }
|
||||
};
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/// Shorthand for Cloudflare API Requests
|
||||
///
|
||||
/// Automatically appends Auth Headers and parses the URL
|
||||
///
|
||||
/// * `url` : URL for the request, will be parsed to [`Url`]
|
||||
/// * `data` : PUT request body
|
||||
fn put(&self, url: &str, data: &HashMap<&str, &str>) -> Result<Response, Error> {
|
||||
let url_parsed = match Url::parse(url) {
|
||||
Ok(url) => {url},
|
||||
Err(e) => panic!("{:#?}", e)// If this call fails the API changed
|
||||
}; // Continuing without a code update is not possible
|
||||
|
||||
let result = match Client::new()
|
||||
.put(url_parsed)
|
||||
.headers(self.generate_headers())
|
||||
.json(data)
|
||||
.send() {
|
||||
Ok(res) => { Ok(res) },
|
||||
Err(e) => { Err(e) }
|
||||
};
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/// Shorthand for Cloudflare API Requests
|
||||
///
|
||||
/// Automatically appends Auth Headers and parses the URL
|
||||
///
|
||||
/// * `url` : URL for the request, will be parsed to [`Url`]
|
||||
/// * `data` : POST request body
|
||||
fn post(&self, url: &str, data: &HashMap<&str, &str>) -> Result<Response, Error> {
|
||||
let url_parsed = match Url::parse(url) {
|
||||
Ok(url) => {url},
|
||||
Err(e) => panic!("{:#?}", e) // If this call fails the API changed
|
||||
}; // Continuing without a code update is not possible
|
||||
|
||||
let result = match Client::new()
|
||||
.post(url_parsed)
|
||||
.headers(self.generate_headers())
|
||||
.json(data)
|
||||
.send() {
|
||||
Ok(res) => { Ok(res) },
|
||||
Err(e) => { Err(e) }
|
||||
};
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/// Updates the given DNS entry with the given IP
|
||||
///
|
||||
/// * `entry` : DNS entry to update
|
||||
/// * `new_ip` : IP used to Update the DNS entry, can be IPv4 or IPv6
|
||||
/// * `return1` : Returns success of the API call, extracted from the HTTP Response body
|
||||
pub fn update_entry(&self, entry: &CloudflareDnsEntry, new_ip: &String) -> Result<bool, Error> {
|
||||
let endpoint = format!("{}zones/{}/dns_records/{}", API_BASE, entry.zone_id, entry.id);
|
||||
|
||||
let mut json_body = HashMap::new();
|
||||
json_body.insert("type", entry.r#type.clone().into());
|
||||
json_body.insert("name", entry.name.as_ref());
|
||||
json_body.insert("content", new_ip);
|
||||
json_body.insert("ttl", "1");
|
||||
|
||||
match self.put(&endpoint, &json_body) {
|
||||
Ok(response) => {
|
||||
let data = response
|
||||
.json::<serde_json::Value>()
|
||||
.expect("Response should always be valid JSON");
|
||||
|
||||
let success = data["success"]
|
||||
.as_bool()
|
||||
.expect("JSON should always include success bool");
|
||||
return Ok(success);
|
||||
},
|
||||
Err(e) => { return Err(e) },
|
||||
}
|
||||
}
|
||||
|
||||
pub fn create_entry(&self, zone_id: &String, r#type: &str, name: &str, ip: &String) -> Result<bool, Error> {
|
||||
let endpoint = format!("{}zones/{}/dns_records", API_BASE, zone_id);
|
||||
|
||||
let mut json_body = HashMap::new();
|
||||
json_body.insert("type", r#type);
|
||||
json_body.insert("name", name);
|
||||
json_body.insert("content", ip);
|
||||
json_body.insert("ttl", "1");
|
||||
|
||||
match self.post(&endpoint, &json_body) {
|
||||
Ok(response) => {
|
||||
let data = response
|
||||
.json::<serde_json::Value>()
|
||||
.expect("Response should always be valid JSON");
|
||||
|
||||
let success = data["success"]
|
||||
.as_bool()
|
||||
.expect("JSON should always include success bool");
|
||||
|
||||
return Ok(success)
|
||||
},
|
||||
Err(e) => { return Err(e) },
|
||||
}
|
||||
}
|
||||
|
||||
/// Generate Cloudflare API v4 Auth Headers
|
||||
fn generate_headers(&self) -> HeaderMap {
|
||||
let mut headers = HeaderMap::new();
|
||||
headers.insert("X-Auth-Key", HeaderValue::from_str(self.api_key.as_ref()).unwrap());
|
||||
headers.insert("X-Auth-Email", HeaderValue::from_str(self.dns_email.as_ref()).unwrap());
|
||||
headers
|
||||
}
|
||||
|
||||
}
|
185
src/config.rs
Normal file
185
src/config.rs
Normal file
|
@ -0,0 +1,185 @@
|
|||
use std::collections::HashMap;
|
||||
use std::error::Error;
|
||||
use std::fs;
|
||||
use std::net::Ipv6Addr;
|
||||
use ipnet::{IpBitOr, IpSub};
|
||||
use std::str::FromStr;
|
||||
use log::{error, warn};
|
||||
use serde_derive::{Deserialize, Serialize};
|
||||
use systemd_journal_logger::connected_to_journal;
|
||||
use crate::cloudflare::DnsRecordType;
|
||||
use crate::cloudflare::DnsRecordType::{A, AAAA};
|
||||
|
||||
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
|
||||
pub(crate) struct InterfaceConfig {
|
||||
pub(crate) host_address: Ipv6Addr,
|
||||
pub(crate) interfaces: HashMap<String, Ipv6Addr>,
|
||||
}
|
||||
|
||||
impl InterfaceConfig {
|
||||
pub(crate) fn load() -> Result<Self, Box<dyn Error>> {
|
||||
let cfg: Self = match confy::load(env!("CARGO_PKG_NAME"),"interfaces") {
|
||||
Ok(data) => data,
|
||||
Err(e) => {
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {e}"),
|
||||
false => eprintln!("[ERROR] {e}")
|
||||
}
|
||||
return Err(Box::new(e));
|
||||
}
|
||||
};
|
||||
|
||||
Ok(cfg)
|
||||
}
|
||||
|
||||
pub(crate) fn full_v6(&self, interface_name: &String, host_v6: Ipv6Addr) -> Result<Ipv6Addr, ()> {
|
||||
let host_range = Ipv6Addr::from(host_v6.saturating_sub(self.host_address));
|
||||
let interface_address = match self.interfaces.get(interface_name) {
|
||||
Some(address) => *address,
|
||||
None => {
|
||||
let err_msg = format!("Malformed or missing IP in interfaces.toml for interface {}", interface_name);
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
return Err(());
|
||||
}
|
||||
};
|
||||
Ok(host_range.bitor(interface_address))
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for InterfaceConfig {
|
||||
fn default() -> Self {
|
||||
InterfaceConfig {
|
||||
host_address: Ipv6Addr::from_str("::").expect("Malformed literal in code"),
|
||||
interfaces: HashMap::from([(" ".to_owned(), Ipv6Addr::from(0))]),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
///////////////
|
||||
|
||||
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
|
||||
pub(crate) struct ZoneEntry {
|
||||
pub(crate) name: String,
|
||||
pub(crate) r#type: Vec<DnsRecordType>,
|
||||
pub(crate) interface: String,
|
||||
}
|
||||
|
||||
impl Default for ZoneEntry {
|
||||
fn default() -> Self {
|
||||
ZoneEntry {
|
||||
name: " ".to_owned(),
|
||||
r#type: vec![A, AAAA],
|
||||
interface: " ".to_owned(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
|
||||
pub(crate) struct ZoneConfig {
|
||||
pub(crate) email: String,
|
||||
pub(crate) name: String,
|
||||
pub(crate) id: String,
|
||||
#[serde(alias="entry")]
|
||||
pub(crate) entries: Vec<ZoneEntry>
|
||||
}
|
||||
|
||||
impl ZoneConfig {
|
||||
pub(crate) fn load() -> Result<Vec<Self>, Box<dyn Error>> {
|
||||
let path = confy::get_configuration_file_path(env!("CARGO_PKG_NAME"), "interfaces").expect("Something went wrong with confy");
|
||||
let zones_dir = path.parent().expect("Something went wrong with confy").join("zones.d/");
|
||||
|
||||
let zones = fs::read_dir(zones_dir).expect("Directory creation handling does not yet exist");
|
||||
|
||||
|
||||
let mut zone_configs: Vec<Self> = vec![];
|
||||
|
||||
for entry in zones {
|
||||
let entry = entry?;
|
||||
let path = entry.path();
|
||||
if path.is_dir() {
|
||||
let warn_msg = "Subdirectory in zones.d detected, this should not be the case";
|
||||
match connected_to_journal() {
|
||||
true => warn!("[WARN] {warn_msg}"),
|
||||
false => eprintln!("[WARN] {warn_msg}"),
|
||||
}
|
||||
}
|
||||
else if !path.file_name().expect("Directories should have been filtered out by the leading if")
|
||||
.to_str().expect("Conversion to str should not fail for a file name")
|
||||
.starts_with('.') {
|
||||
let zone_config_path = format!("zones.d/{}", path.file_stem()
|
||||
.expect("stem could not be extracted from filename").to_str()
|
||||
.expect("&OsStr could not be converted to &str"));
|
||||
match confy::load(env!("CARGO_PKG_NAME"), zone_config_path.as_str()) {
|
||||
Ok(data) => zone_configs.push(data),
|
||||
Err(e) => {
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {e}"),
|
||||
false => eprintln!("[ERROR] {e}"),
|
||||
}
|
||||
return Err(Box::new(e));
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
Ok(zone_configs)
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for ZoneConfig {
|
||||
fn default() -> Self {
|
||||
ZoneConfig {
|
||||
email: " ".to_owned(),
|
||||
name: " ".to_owned(),
|
||||
id: " ".to_owned(),
|
||||
entries: vec![ZoneEntry::default()],
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
|
||||
pub(crate) struct AppConfig {
|
||||
pub(crate) cloudflare_api_token: String,
|
||||
pub(crate) check_interval_seconds: Option<u16>,
|
||||
pub(crate) uptime_url: Option<String>,
|
||||
}
|
||||
|
||||
impl AppConfig {
|
||||
pub(crate) fn load() -> Result<Self, Box<dyn Error>> {
|
||||
let cfg: Self = match confy::load(env!("CARGO_PKG_NAME"),"config") {
|
||||
Ok(data) => data,
|
||||
Err(e) => {
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {e}"),
|
||||
false => eprintln!("[ERROR] {e}")
|
||||
}
|
||||
return Err(Box::new(e));
|
||||
}
|
||||
};
|
||||
|
||||
if cfg.cloudflare_api_token.is_empty() {
|
||||
let err_msg = "Cloudflare api token not specified. The app cannot work without this";
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}")
|
||||
}
|
||||
panic!("{err_msg}");
|
||||
}
|
||||
|
||||
Ok(cfg)
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for AppConfig {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
cloudflare_api_token: "".to_owned(),
|
||||
check_interval_seconds: None,
|
||||
uptime_url: None
|
||||
}
|
||||
}
|
||||
}
|
||||
|
951
src/main.rs
951
src/main.rs
|
@ -1,365 +1,680 @@
|
|||
use cloudflare::{Instance, CloudflareDnsType};
|
||||
/*use cloudflare_old::{Instance, CloudflareDnsType};*/
|
||||
use reqwest::blocking::get;
|
||||
use serde_derive::{Deserialize, Serialize};
|
||||
use std::{fs, thread::{sleep}};
|
||||
use std::{thread::{sleep}};
|
||||
use std::error::Error;
|
||||
use std::net::{Ipv4Addr, Ipv6Addr};
|
||||
use std::str::FromStr;
|
||||
use chrono::{Utc, Duration};
|
||||
use log::{info, warn, error, LevelFilter};
|
||||
use reqwest::StatusCode;
|
||||
use systemd_journal_logger::{connected_to_journal, JournalLog};
|
||||
use crate::cloudflare::{CloudflareZone, DnsRecordType};
|
||||
use crate::config::{AppConfig, InterfaceConfig, ZoneConfig, ZoneEntry};
|
||||
|
||||
mod config;
|
||||
mod cloudflare;
|
||||
|
||||
fn default_key() -> String {
|
||||
return "".to_string();
|
||||
struct Addresses {
|
||||
ipv4_uri: String,
|
||||
ipv6_uri: String,
|
||||
ipv4: Ipv4Addr,
|
||||
ipv6: Ipv6Addr,
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
struct ChangeTracker {
|
||||
created: u16,
|
||||
updated: u16,
|
||||
unchanged: u16,
|
||||
error: u16
|
||||
}
|
||||
impl Addresses {
|
||||
fn new() -> Result<Self, Box<dyn Error>> {
|
||||
let mut ret = Self {
|
||||
ipv4_uri: "http://ip4only.me/api/".to_owned(),
|
||||
ipv6_uri: "http://ip6only.me/api/".to_owned(),
|
||||
ipv4: Ipv4Addr::new(0, 0, 0, 0),
|
||||
ipv6: Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)
|
||||
};
|
||||
|
||||
impl ChangeTracker {
|
||||
fn new() -> ChangeTracker {
|
||||
ChangeTracker {
|
||||
created: 0,
|
||||
updated: 0,
|
||||
unchanged: 0,
|
||||
error: 0
|
||||
match ret.get_v4() {
|
||||
Ok(ip) => ret.ipv4 = ip,
|
||||
Err(_) => {
|
||||
let err_msg = format!("Unable to fetch IPv4 from '{}' during init. Aborting!", ret.ipv4_uri);
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
panic!("{}", err_msg);
|
||||
}
|
||||
}
|
||||
|
||||
match ret.get_v6() {
|
||||
Ok(ip) => ret.ipv6 = ip,
|
||||
Err(_) => {
|
||||
let err_msg = format!("Unable to fetch IPv6 from '{}' during init. Aborting!", ret.ipv6_uri);
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
panic!("{}", err_msg);
|
||||
}
|
||||
}
|
||||
|
||||
Ok(ret)
|
||||
}
|
||||
|
||||
fn update(&mut self) {
|
||||
match self.get_v4() {
|
||||
Ok(ip) => {
|
||||
if ip != self.ipv4 {
|
||||
if ip == Ipv4Addr::new(0,0,0,0) {
|
||||
let warn_msg = "'0.0.0.0' detected as new IPv4, skipping changes".to_owned();
|
||||
match connected_to_journal() {
|
||||
true => warn!("[WARN] {warn_msg}"),
|
||||
false => println!("[WARN] {warn_msg}"),
|
||||
}
|
||||
}
|
||||
else {
|
||||
let info_msg = format!("IPv4 changed from '{}' to '{}'", self.ipv4, ip);
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
self.ipv4 = ip;
|
||||
}
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
let error_msg = format!("Unable to fetch IPv4 from '{}': {}", self.ipv4_uri, e);
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {error_msg}"),
|
||||
false => eprintln!("[ERROR] {error_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
match self.get_v6() {
|
||||
Ok(ip) => {
|
||||
if ip != self.ipv6 {
|
||||
if ip == Ipv6Addr::new(0,0,0,0,0,0,0,0) {
|
||||
let warn_msg = "'::' detected as new IPv6, skipping changes".to_owned();
|
||||
match connected_to_journal() {
|
||||
true => warn!("[WARN] {warn_msg}"),
|
||||
false => println!("[WARN] {warn_msg}"),
|
||||
}
|
||||
}
|
||||
else {
|
||||
let info_msg = format!("IPv6 changed from '{}' to '{}'", self.ipv6, ip);
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
self.ipv6 = ip;
|
||||
}
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
let error_msg = format!("Unable to fetch IPv6 from '{}': {}", self.ipv6_uri, e);
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {error_msg}"),
|
||||
false => eprintln!("[ERROR] {error_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn print(&self, f: &str) {
|
||||
match f {
|
||||
"" => {
|
||||
self.print("simple");
|
||||
}
|
||||
"simple" => {
|
||||
println!("{} created", self.created);
|
||||
println!("{} updated", self.updated);
|
||||
println!("{} unchanged", self.unchanged);
|
||||
println!("{} errors", self.error);
|
||||
}
|
||||
&_ => {
|
||||
println!("unknown format pattern '{}', defaulting to 'simple'", f);
|
||||
self.print("simple");
|
||||
fn get_v4(&self) -> Result<Ipv4Addr, reqwest::Error> {
|
||||
match get(&self.ipv4_uri) {
|
||||
Ok(res) => {
|
||||
match res.status() {
|
||||
StatusCode::OK => {
|
||||
let ip_string = res.text().expect("Returned data should always contain text").trim_end().split(',').collect::<Vec<&str>>()[1].to_owned();
|
||||
Ok(Ipv4Addr::from_str(ip_string.as_str()).expect("Returned IP should always be parseable"))
|
||||
},
|
||||
_ => {
|
||||
let warn_msg = format!("Unexpected HTTP status {}", res.status());
|
||||
match connected_to_journal() {
|
||||
true => warn!("[WARN] {warn_msg}"),
|
||||
false => println!("[WARN] {warn_msg}"),
|
||||
}
|
||||
Ok(Ipv4Addr::new(0, 0, 0, 0))
|
||||
}
|
||||
}
|
||||
}
|
||||
Err(e) => Err(e),
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
fn get_v6(&self) -> Result<Ipv6Addr, reqwest::Error> {
|
||||
match get(&self.ipv6_uri) {
|
||||
Ok(res) => {
|
||||
match res.status() {
|
||||
StatusCode::OK => {
|
||||
let ip_string: String = res.text().expect("Returned data should always contain text").trim_end().split(',').collect::<Vec<&str>>()[1].to_owned();
|
||||
Ok(Ipv6Addr::from_str(ip_string.as_str()).expect("Returned IP should always be parseable"))
|
||||
},
|
||||
_ => {
|
||||
let warn_msg = format!("Unexpected HTTP status {}", res.status());
|
||||
match connected_to_journal() {
|
||||
true => warn!("[WARN] {warn_msg}"),
|
||||
false => println!("[WARN] {warn_msg}"),
|
||||
}
|
||||
Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0))
|
||||
}
|
||||
}
|
||||
},
|
||||
Err(e) => Err(e),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
struct DnsEntry {
|
||||
name: String,
|
||||
type4: bool,
|
||||
type6: bool,
|
||||
interface: Option<String>,
|
||||
}
|
||||
fn compare_zones(old_zone: &ZoneConfig, new_zone: &ZoneConfig) -> Vec<String> {
|
||||
let mut info_pieces = vec![];
|
||||
if old_zone.id != new_zone.id || old_zone.email != new_zone.email {
|
||||
let msg = "changed id or email".to_owned();
|
||||
info_pieces.push(msg);
|
||||
}
|
||||
|
||||
impl DnsEntry {
|
||||
/// Updates a single DNS Entry
|
||||
///
|
||||
/// * `change4` : IPv4 DNS change tracker, used to print details about the results of the update run after it concludes
|
||||
/// * `change6` : Same as `change4` but for IPv6
|
||||
/// * `ips` : Enum of current IPv4 and IPv6 base, used to check against and update the DNS record
|
||||
/// * `agent` : Cloudflare Auth Agent, provides the needed Authentication headers for the API Calls
|
||||
/// * `zone_id` : Cloudfalre ID of the Zone this DNS entry resides in, needed for the API Calls
|
||||
///
|
||||
/// * `return` : Returns true if the DNS Update failed due to an Error, otherwise returns false
|
||||
fn update(
|
||||
&self,
|
||||
change4: &mut ChangeTracker,
|
||||
change6: &mut ChangeTracker,
|
||||
ips: &Ips,
|
||||
agent: &Instance,
|
||||
zone_id: &String
|
||||
) -> bool {
|
||||
let mut found4 = false;
|
||||
let mut found6 = false;
|
||||
if old_zone.entries != new_zone.entries {
|
||||
let mut added: Vec<&ZoneEntry> = vec![];
|
||||
let mut modified: Vec<&ZoneEntry> = vec![];
|
||||
|
||||
// Loops over every Entry in the List fetched from the Cloudflare API
|
||||
// If the entry is in this List we need to update it, if not it needs to be created
|
||||
for cloudflare_entry in &agent.dns_entries {
|
||||
if cloudflare_entry.is_equal(&self.name) {
|
||||
// Update IPv4 Entry
|
||||
if cloudflare_entry.r#type == CloudflareDnsType::A && self.type4 {
|
||||
found4 = true;
|
||||
|
||||
if cloudflare_entry.is_ip_new(&ips.ipv4) {
|
||||
match agent.update_entry(cloudflare_entry, &ips.ipv4) {
|
||||
Ok(success) => {
|
||||
if success {
|
||||
change4.updated += 1;
|
||||
}
|
||||
else {
|
||||
change4.error += 1;
|
||||
}
|
||||
},
|
||||
Err(_e) => { return true } // if an error is detected any subsequent calls are likely to fail as well
|
||||
};
|
||||
}
|
||||
else {
|
||||
change4.unchanged += 1;
|
||||
new_zone.entries.iter().for_each(|entry| {
|
||||
let matches: Vec<&ZoneEntry> = old_zone.entries.iter().filter(|old_entry| {
|
||||
if old_entry.name == entry.name {
|
||||
if old_entry != &entry {
|
||||
modified.push(entry);
|
||||
}
|
||||
true
|
||||
}
|
||||
// Update IPv6 Entry
|
||||
else if cloudflare_entry.r#type == CloudflareDnsType::AAAA && self.type6 {
|
||||
found6 = true;
|
||||
let ipv6 = ips.ipv6base.clone() + self.interface.as_ref().unwrap();
|
||||
|
||||
if cloudflare_entry.is_ip_new(&ipv6) {
|
||||
match agent.update_entry(cloudflare_entry, &ipv6) {
|
||||
Ok(success) => {
|
||||
if success {
|
||||
change6.updated += 1
|
||||
}
|
||||
else {
|
||||
change6.error += 1
|
||||
}
|
||||
},
|
||||
Err(_e) => { return true } // if an error is detected any subsequent calls are likely to fail as well
|
||||
};
|
||||
}
|
||||
else {
|
||||
change6.unchanged += 1;
|
||||
}
|
||||
else {
|
||||
false
|
||||
}
|
||||
// ignore otherwise
|
||||
else {}
|
||||
}
|
||||
}
|
||||
}).collect();
|
||||
|
||||
if !found4 && self.type4 {
|
||||
match agent.create_entry(zone_id, "A", &self.name, &ips.ipv4) {
|
||||
Ok(success) => {
|
||||
if success {
|
||||
change4.created += 1;
|
||||
}
|
||||
else {
|
||||
change4.error += 1;
|
||||
};
|
||||
},
|
||||
Err(_e) => { return true } // early return since if an error is detected any subsequent calls are likely to fail as well
|
||||
if matches.is_empty() {
|
||||
added.push(entry);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
if !found6 && self.type6 {
|
||||
let ipv6 = ips.ipv6base.clone() + self.interface.as_ref().unwrap();
|
||||
match agent.create_entry(zone_id, "AAAA", &self.name, &ipv6) {
|
||||
Ok(success) => {
|
||||
if success {
|
||||
change6.created += 1;
|
||||
}
|
||||
else {
|
||||
change6.error += 1;
|
||||
};
|
||||
},
|
||||
Err(_e) => { return true } // if an error is detected any subsequent calls are likely to fail as well
|
||||
let deleted: Vec<&ZoneEntry> = old_zone.entries.iter().filter(|old_entry| {
|
||||
!new_zone.entries.contains(old_entry) &&
|
||||
!new_zone.entries.iter().any(|changed_entry| { changed_entry.name == old_entry.name })
|
||||
}).collect();
|
||||
|
||||
if !deleted.is_empty() {
|
||||
let mut deleted_entries_vec = vec![];
|
||||
|
||||
for entry in deleted {
|
||||
deleted_entries_vec.push(entry.name.clone());
|
||||
}
|
||||
|
||||
let deleted_entries = match deleted_entries_vec.len() {
|
||||
1 => deleted_entries_vec[0].clone(),
|
||||
2 => deleted_entries_vec.join(" & "),
|
||||
_ => deleted_entries_vec.join(", "),
|
||||
};
|
||||
let msg = format!("deleted {deleted_entries}");
|
||||
info_pieces.push(msg);
|
||||
}
|
||||
|
||||
return false; // If this point is reached no error has been caught therefore returning false
|
||||
}
|
||||
}
|
||||
if !added.is_empty() {
|
||||
let mut added_entries_vec = vec![];
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
struct DnsZone {
|
||||
email: String,
|
||||
name: String,
|
||||
id: String,
|
||||
dns_entries: Vec<DnsEntry>,
|
||||
}
|
||||
|
||||
impl DnsZone {
|
||||
/// Attempts to Update the DNS Entries of the Zone with a new IP
|
||||
///
|
||||
/// * `change4` : IPv4 DNS change tracker, used to print details about the results of the update run after it concludes
|
||||
/// * `change6` : Same as `change4` but for IPv6
|
||||
/// * `ips` : Enum of current IPv4 and IPv6 base, used to check against and update the DNS record
|
||||
/// * `key` : API Key needed to create the Auth Agent for the API
|
||||
///
|
||||
/// * `return` : Returns true if the DNS Updates failed due to an Error, false otherwise
|
||||
fn update(
|
||||
&self,
|
||||
change4: &mut ChangeTracker,
|
||||
change6: &mut ChangeTracker,
|
||||
ips: &Ips,
|
||||
key: &String
|
||||
) -> bool {
|
||||
let mut agent = Instance::new(key);
|
||||
|
||||
match agent.load_entries(&self.email, &self.id) {
|
||||
Ok(_) => {
|
||||
let mut results = Vec::<bool>::new();
|
||||
|
||||
for entry in &self.dns_entries {
|
||||
let result = entry.update(change4, change6, &ips, &agent, &self.id);
|
||||
results.append(&mut vec!(result));
|
||||
if result {
|
||||
break; // if one update fails all others are likely to fail as well
|
||||
}
|
||||
}
|
||||
|
||||
let result = results.contains(&true);
|
||||
|
||||
return result;
|
||||
},
|
||||
Err(_e) => { return true }, // Early return since an Error likely means subsequent calls will also fail
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
struct DnsConfig {
|
||||
ipv6_interface: String,
|
||||
#[serde(default = "default_key")]
|
||||
api_key: String,
|
||||
zones: Vec<DnsZone>,
|
||||
}
|
||||
|
||||
impl DnsConfig {
|
||||
fn new() -> DnsConfig {
|
||||
DnsConfig {
|
||||
ipv6_interface: "".to_string(),
|
||||
api_key: "".to_string(),
|
||||
zones: Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
fn load(&mut self) {
|
||||
let file_contents = match fs::read_to_string("config.json") {
|
||||
Ok(data) => data,
|
||||
Err(e) => panic!("{:#?}", e),
|
||||
};
|
||||
let config_parse: DnsConfig = match serde_json::from_str(&file_contents) {
|
||||
Ok(data) => data,
|
||||
Err(e) => panic!("{:#?}", e),
|
||||
};
|
||||
|
||||
let key_file_contents = match fs::read_to_string("api-key.json") {
|
||||
Ok(data) => data,
|
||||
Err(e) => panic!("{:#?}", e),
|
||||
};
|
||||
let api_key_parse: serde_json::Value = match serde_json::from_str(&key_file_contents) {
|
||||
Ok(data) => data,
|
||||
Err(e) => panic!("{:#?}", e),
|
||||
};
|
||||
|
||||
*self = config_parse;
|
||||
self.api_key = api_key_parse["api_key"].as_str().unwrap().to_owned();
|
||||
}
|
||||
}
|
||||
|
||||
struct Ips {
|
||||
ipv4: String,
|
||||
ipv6base: String,
|
||||
}
|
||||
|
||||
impl Ips {
|
||||
fn new() -> Ips {
|
||||
Ips {
|
||||
ipv4: "0.0.0.0".to_string(),
|
||||
ipv6base: ":".to_string(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Get the current IPv4 address and IPv6 prefix from Mullvad API
|
||||
///
|
||||
/// Returns true if the get succeeded and false if it failed.
|
||||
/// The IPv6 Prefix is generated by removing the IPv6 Interface from the fetched IPv6 address
|
||||
fn get(&mut self, ipv6_interface: &str) -> bool {
|
||||
let ipv4uri = "https://am.i.mullvad.net/ip";
|
||||
let ipv6uri = "https://ipv6.am.i.mullvad.net/ip";
|
||||
let mut ret;
|
||||
|
||||
match get(ipv4uri) {
|
||||
Ok(data) => {
|
||||
self.ipv4 = data.text().expect("0.0.0.0").trim_end().to_owned();
|
||||
ret = true;
|
||||
},
|
||||
Err(_e) => {
|
||||
println!("Could not fetch IPv4");
|
||||
ret = false;
|
||||
|
||||
return ret; // Early return since a fail on IPv4 means a likely fail on IPv6
|
||||
for entry in added {
|
||||
added_entries_vec.push(entry.name.clone());
|
||||
}
|
||||
|
||||
let added_entries = match added_entries_vec.len() {
|
||||
1 => added_entries_vec[0].clone(),
|
||||
2 => added_entries_vec.join(" & "),
|
||||
_ => added_entries_vec.join(", "),
|
||||
};
|
||||
let msg = format!("added {added_entries}");
|
||||
info_pieces.push(msg);
|
||||
}
|
||||
|
||||
match get(ipv6uri) {
|
||||
Ok(data) => {
|
||||
let ipv6 = match data.text() {
|
||||
Ok(ip) => {ip},
|
||||
Err(_) => {panic!("Expected IP, found none")},
|
||||
};
|
||||
let stripped = match ipv6.trim_end().strip_suffix(ipv6_interface) {
|
||||
Some(string) => string.to_string(),
|
||||
None => ":".to_string(),
|
||||
};
|
||||
self.ipv6base = stripped;
|
||||
ret = true && ret; // Only set ret to true if previous ret is also true
|
||||
}
|
||||
Err(_e) => {
|
||||
println!("Could not fetch IPv6");
|
||||
ret = false;
|
||||
}
|
||||
}
|
||||
if !modified.is_empty() {
|
||||
let mut modified_entries_vec = vec![];
|
||||
|
||||
return ret;
|
||||
for entry in modified {
|
||||
modified_entries_vec.push(entry.name.clone());
|
||||
}
|
||||
|
||||
let modified_entries = match modified_entries_vec.len() {
|
||||
1 => modified_entries_vec[0].clone(),
|
||||
2 => modified_entries_vec.join(" & "),
|
||||
_ => modified_entries_vec.join(", "),
|
||||
};
|
||||
let msg = format!("modified {modified_entries}");
|
||||
info_pieces.push(msg);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Loops over all DNS Entries in the config and calls an update on them
|
||||
fn update_dns() {
|
||||
let mut config = DnsConfig::new();
|
||||
config.load();
|
||||
|
||||
let mut ips = Ips::new();
|
||||
if ips.get(&config.ipv6_interface) {
|
||||
println!("Current IPv4: {}", ips.ipv4);
|
||||
println!("Current IPv6: {}{}", ips.ipv6base, &config.ipv6_interface);
|
||||
|
||||
let mut change4 = ChangeTracker::new();
|
||||
|
||||
let mut change6 = ChangeTracker::new();
|
||||
|
||||
let mut update_results = Vec::<bool>::new();
|
||||
|
||||
// Iterator does not work here
|
||||
for zone in &config.zones {
|
||||
let error = zone.update(&mut change4, &mut change6, &ips, &config.api_key);
|
||||
update_results.append(&mut vec!(error));
|
||||
if error {
|
||||
break; // if one update fails all others are likely to fail as well
|
||||
}
|
||||
}
|
||||
|
||||
if update_results.contains(&true) {
|
||||
println!("DNS Update failed due to Network Error")
|
||||
}
|
||||
else {
|
||||
println!("++++A Records+++");
|
||||
change4.print("simple");
|
||||
println!("++AAAA Records++");
|
||||
change6.print("simple")
|
||||
}
|
||||
|
||||
}
|
||||
info_pieces
|
||||
}
|
||||
|
||||
fn main() {
|
||||
JournalLog::new().expect("Systemd-Logger crate error").install().expect("Systemd-Logger crate error");
|
||||
log::set_max_level(LevelFilter::Info);
|
||||
|
||||
let mut config = AppConfig::load().unwrap();
|
||||
let mut ifaces = InterfaceConfig::load().unwrap();
|
||||
let mut zone_cfgs = ZoneConfig::load().unwrap();
|
||||
|
||||
let mut now = Utc::now() - Duration::seconds(59);
|
||||
let mut current = now;
|
||||
let mut start = now;
|
||||
|
||||
let mut ips = match Addresses::new() {
|
||||
Ok(ips) => ips,
|
||||
Err(e) => panic!("{}", e)
|
||||
};
|
||||
|
||||
let reload_interval = config.check_interval_seconds.unwrap_or_else(|| {
|
||||
let warn_msg = "Reload interval option not set, defaulting to 60";
|
||||
match connected_to_journal() {
|
||||
true => warn!("[WARN] {warn_msg}"),
|
||||
false => println!("[WARN] {warn_msg}"),
|
||||
}
|
||||
60
|
||||
}) as i64;
|
||||
|
||||
loop {
|
||||
now = Utc::now();
|
||||
if now >= current + Duration::seconds(60) {
|
||||
current = now;
|
||||
if now >= start + Duration::seconds(reload_interval) {
|
||||
start = now;
|
||||
|
||||
print!("\x1B[2J\x1B[1;1H");
|
||||
println!("Starting DNS Update at {} {}", now.format("%H:%M:%S"), now.timezone());
|
||||
update_dns();
|
||||
if let Some(uptime_url) = &config.uptime_url {
|
||||
let _ = get(uptime_url);
|
||||
}
|
||||
|
||||
match InterfaceConfig::load() {
|
||||
Ok(new_cfg) => {
|
||||
if ifaces != new_cfg {
|
||||
if ifaces.host_address != new_cfg.host_address {
|
||||
let info_msg = format!("Host address in interfaces.toml changed from '{}' to '{}'", ifaces.host_address, new_cfg.host_address);
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
|
||||
if ifaces.interfaces != new_cfg.interfaces {
|
||||
let mut new: Vec<(&String, &Ipv6Addr)> = vec![];
|
||||
let mut modified: Vec<(&String, &Ipv6Addr)> = vec![];
|
||||
|
||||
new_cfg.interfaces.iter().for_each(|(interface, address)| {
|
||||
if ifaces.interfaces.contains_key(interface) {
|
||||
if ifaces.interfaces.get(interface) != Some(address) {
|
||||
modified.push((interface, address));
|
||||
}
|
||||
}
|
||||
else {
|
||||
let matches: Vec<&Ipv6Addr> = ifaces.interfaces.values().filter(|addr| {
|
||||
addr == &address
|
||||
}).collect();
|
||||
|
||||
if matches.is_empty() {
|
||||
new.push((interface, address));
|
||||
}
|
||||
else {
|
||||
modified.push((interface, address));
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
let deleted: Vec<(&String, &Ipv6Addr)> = ifaces.interfaces.iter().filter(|(interface, address)| {
|
||||
!new_cfg.interfaces.contains_key(*interface) && !modified.iter().any(|(_, new_addr)| { new_addr == address })
|
||||
}).collect();
|
||||
|
||||
for (name, addr) in deleted {
|
||||
let info_msg = format!("Deleted interface '{name}' with address '{addr}'");
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
|
||||
for (name, addr) in new {
|
||||
let info_msg = format!("Added interface '{name}' with address '{addr}'");
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
|
||||
for (name, addr) in modified {
|
||||
let info_msg= if ifaces.interfaces.contains_key(name) {
|
||||
let old_addr = ifaces.interfaces.get(name).expect("contains check on ifaces was successful");
|
||||
format!("Changed interface address of '{name}' from '{old_addr}' to '{addr}'")
|
||||
}
|
||||
else {
|
||||
let old_name = ifaces.interfaces.iter()
|
||||
.find(|(_, old_addr)| { old_addr == &addr })
|
||||
.expect("modified entry should not exist if this fails")
|
||||
.0;
|
||||
format!("Changed interface name for '{addr}' from '{old_name}' to '{name}'")
|
||||
};
|
||||
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
ifaces = new_cfg
|
||||
}
|
||||
},
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to load ínterfaces.toml with error: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
match ZoneConfig::load() {
|
||||
Ok(new_cfgs) => {
|
||||
if zone_cfgs != new_cfgs {
|
||||
if zone_cfgs.len() != new_cfgs.len() {
|
||||
let new_zones: Vec<&ZoneConfig> = new_cfgs.iter().filter(|zone_cfg| {
|
||||
!zone_cfgs.contains(zone_cfg)
|
||||
}).collect();
|
||||
|
||||
let deleted_zones: Vec<&ZoneConfig> = zone_cfgs.iter().filter(|zone_cfg| {
|
||||
!new_cfgs.contains(zone_cfg)
|
||||
}).collect();
|
||||
|
||||
for new_zone in new_zones {
|
||||
let name = new_zone.name.as_str();
|
||||
let entry_count = new_zone.entries.len();
|
||||
let info_msg = format!("Added Zone '{name}' with {entry_count} entries");
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
|
||||
for deleted_zone in deleted_zones {
|
||||
let name = deleted_zone.name.as_str();
|
||||
let entry_count = deleted_zone.entries.len();
|
||||
let info_msg = format!("Deleted Zone '{name}' with {entry_count} entries");
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
let changed_zones: Vec<&ZoneConfig> = new_cfgs.iter().filter(|new_cfg| {
|
||||
zone_cfgs.iter().any(|old_cfg| {
|
||||
old_cfg.name == new_cfg.name && &old_cfg != new_cfg
|
||||
})
|
||||
}).collect();
|
||||
|
||||
let deleted_zones: Vec<&ZoneConfig> = zone_cfgs.iter().filter(|old_cfg| {
|
||||
!new_cfgs.iter().any(|new_cfg| {
|
||||
old_cfg.name == new_cfg.name
|
||||
})
|
||||
}).collect();
|
||||
|
||||
let added_zones: Vec<&ZoneConfig> = new_cfgs.iter().filter(|new_cfg| {
|
||||
!zone_cfgs.iter().any(|old_cfg| {
|
||||
old_cfg.name == new_cfg.name
|
||||
})
|
||||
}).collect();
|
||||
|
||||
if deleted_zones.len() == 1 && added_zones.len() == 1 {
|
||||
let new_zone = added_zones[0];
|
||||
let old_zone = deleted_zones[0];
|
||||
|
||||
let mut info_pieces = vec![];
|
||||
|
||||
{
|
||||
let msg = format!("name from '{}' to '{}'", old_zone.name, new_zone.name);
|
||||
info_pieces.push(msg);
|
||||
}
|
||||
|
||||
let info_pieces = [info_pieces, compare_zones(old_zone, new_zone)].concat();
|
||||
|
||||
println!("{}", info_pieces.join(", "));
|
||||
}
|
||||
else {
|
||||
if !deleted_zones.is_empty() {
|
||||
let mut info_pieces = vec![];
|
||||
for deleted_zone in deleted_zones {
|
||||
info_pieces.push(deleted_zone.name.clone());
|
||||
}
|
||||
let deleted_info = match info_pieces.len() {
|
||||
1 => info_pieces[0].clone(),
|
||||
2 => info_pieces.join(" & "),
|
||||
_ => info_pieces.join(", "),
|
||||
};
|
||||
let info_msg = format!("Deleted {deleted_info}");
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
|
||||
if !added_zones.is_empty() {
|
||||
let mut info_pieces = vec![];
|
||||
for added_zone in added_zones {
|
||||
info_pieces.push(added_zone.name.clone());
|
||||
}
|
||||
let added_info = match info_pieces.len() {
|
||||
1 => info_pieces[0].clone(),
|
||||
2 => info_pieces.join(" & "),
|
||||
_ => info_pieces.join(", "),
|
||||
};
|
||||
let info_msg = format!("Added {added_info}");
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for changed_zone in changed_zones {
|
||||
// try find element where one of these is unchanged
|
||||
let old_zone = zone_cfgs.iter().find(|zone_cfg| {
|
||||
zone_cfg.name == changed_zone.name
|
||||
}).expect("This element should exist because it was added to the changed_zones vector");
|
||||
|
||||
let info_pieces = compare_zones(old_zone, changed_zone);
|
||||
|
||||
let changed_info = match info_pieces.len() {
|
||||
1 => info_pieces[0].clone(),
|
||||
2 => info_pieces.join(" & "),
|
||||
_ => info_pieces.join(", "),
|
||||
};
|
||||
let info_msg_raw = format!("{changed_info} for {}", changed_zone.name);
|
||||
let mut info_msg_chars = info_msg_raw.chars();
|
||||
let info_msg = match info_msg_chars.next() {
|
||||
None => String::new(),
|
||||
Some(first) => first.to_uppercase().collect::<String>() + info_msg_chars.as_str(),
|
||||
};
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
zone_cfgs = new_cfgs
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to load from zones.d with error: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
match AppConfig::load() {
|
||||
Ok(new_cfg) => {
|
||||
if config != new_cfg {
|
||||
if config.cloudflare_api_token != new_cfg.cloudflare_api_token {
|
||||
let info_msg = "API token in config.toml changed";
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
|
||||
if config.check_interval_seconds != new_cfg.check_interval_seconds {
|
||||
let info_msg = match config.check_interval_seconds {
|
||||
Some(old_interval) => {
|
||||
match new_cfg.check_interval_seconds {
|
||||
Some(new_interval) => format!("Check interval in config.toml changed from {old_interval}s to {new_interval}s"),
|
||||
None => format!("Check interval in config.toml changed from {old_interval}s to 60s"),
|
||||
}
|
||||
},
|
||||
None => {
|
||||
match new_cfg.check_interval_seconds {
|
||||
Some(new_interval) => format!("Check interval in config.toml changed from 60s to {new_interval}s"),
|
||||
None => "This is a unicorn error, congratulations.".to_owned(),
|
||||
}
|
||||
}
|
||||
};
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
|
||||
if config.uptime_url != new_cfg.uptime_url {
|
||||
let info_msg = match &config.uptime_url {
|
||||
Some(old_url) => {
|
||||
match &new_cfg.uptime_url {
|
||||
Some(new_url) => format!("Uptime URL in config.toml changed from '{old_url}' to '{new_url}'"),
|
||||
None => "Uptime URL in config.toml was removed".to_owned(),
|
||||
}
|
||||
},
|
||||
None => {
|
||||
match &new_cfg.uptime_url {
|
||||
Some(new_url) => format!("Uptime URL '{new_url}' was added to config.toml"),
|
||||
None => "This is a unicorn error, congratulations.".to_owned(),
|
||||
}
|
||||
}
|
||||
};
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
|
||||
config = new_cfg
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
let err_msg = format!("Unable to load config.toml with error: {e}");
|
||||
match connected_to_journal() {
|
||||
true => error!("[ERROR] {err_msg}"),
|
||||
false => eprintln!("[ERROR] {err_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
ips.update();
|
||||
for zone in &zone_cfgs {
|
||||
let cf_zone = CloudflareZone::new(zone, &config);
|
||||
|
||||
let cf_entries = match cf_zone.get_entries() {
|
||||
Ok(entries) => entries,
|
||||
Err(_) => {
|
||||
continue
|
||||
}
|
||||
};
|
||||
|
||||
for entry in &zone.entries {
|
||||
let ipv6;
|
||||
let ipv4;
|
||||
match entry.r#type[..] {
|
||||
[DnsRecordType::AAAA, DnsRecordType::A] => {
|
||||
ipv6 = match ifaces.full_v6(&entry.interface, ips.ipv6) {
|
||||
Ok(ip) => Some(ip),
|
||||
Err(_) => {
|
||||
continue
|
||||
}
|
||||
};
|
||||
ipv4 = Some(ips.ipv4);
|
||||
},
|
||||
[DnsRecordType::A, DnsRecordType::AAAA] => {
|
||||
ipv6 = match ifaces.full_v6(&entry.interface, ips.ipv6) {
|
||||
Ok(ip) => Some(ip),
|
||||
Err(_) => {
|
||||
continue
|
||||
}
|
||||
};
|
||||
ipv4 = Some(ips.ipv4);
|
||||
},
|
||||
[DnsRecordType::AAAA] => {
|
||||
ipv6 = match ifaces.full_v6(&entry.interface, ips.ipv6) {
|
||||
Ok(ip) => Some(ip),
|
||||
Err(_) => {
|
||||
continue
|
||||
}
|
||||
};
|
||||
ipv4 = None;
|
||||
},
|
||||
[DnsRecordType::A] => {
|
||||
ipv6 = None;
|
||||
ipv4 = Some(ips.ipv4);
|
||||
},
|
||||
_ => {
|
||||
let warn_msg = "Config contains unsupported type identifier";
|
||||
match connected_to_journal() {
|
||||
true => warn!("[WARN] {warn_msg}"),
|
||||
false => println!("[WARN] {warn_msg}"),
|
||||
}
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
for r#type in &entry.r#type {
|
||||
let cf_entry = cf_entries.iter().find(|cf_entry| {
|
||||
cf_entry.name == entry.name && &cf_entry.r#type == r#type
|
||||
});
|
||||
|
||||
if let Some(cf_entry) = cf_entry {
|
||||
match cf_entry.r#type {
|
||||
DnsRecordType::A => {
|
||||
let cf_ip = Ipv4Addr::from_str(cf_entry.content.as_str()).expect("Cloudflare return should always be valid IP");
|
||||
if Some(cf_ip) == ipv4 {
|
||||
continue
|
||||
}
|
||||
},
|
||||
DnsRecordType::AAAA => {
|
||||
let cf_ip = Ipv6Addr::from_str(cf_entry.content.as_str()).expect("Cloudflare return should always be valid IP");
|
||||
if Some(cf_ip) == ipv6 {
|
||||
continue
|
||||
}
|
||||
},
|
||||
_ => {},
|
||||
}
|
||||
|
||||
if cf_zone.update(entry, r#type, &cf_entry.id, ipv6, ipv4).is_ok() {
|
||||
let info_msg = format!("Updated {} DNS Record for entry '{}' in zone '{}'", r#type, entry.name, zone.name);
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
}
|
||||
}
|
||||
}
|
||||
else if cf_zone.create(entry, r#type, ipv6, ipv4).is_ok() {
|
||||
let info_msg = format!("Created {} DNS Record for entry '{}' in zone '{}'", r#type, entry.name, zone.name);
|
||||
match connected_to_journal() {
|
||||
true => info!("[INFO] {info_msg}"),
|
||||
false => println!("[INFO] {info_msg}"),
|
||||
};
|
||||
}
|
||||
}
|
||||
// handle return values
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
sleep(std::time::Duration::from_millis(500));
|
||||
sleep(std::time::Duration::from_millis(200));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue