Compare commits
No commits in common. "main" and "0.1.8" have entirely different histories.
16 changed files with 1736 additions and 2544 deletions
92
.cliffignore
92
.cliffignore
|
|
@ -1,92 +0,0 @@
|
||||||
7cf8502fb9d0c04bab48a2d7d7e819c98f9aed6e
|
|
||||||
d88bb93cfeb0b2b267736ae21bcff684bebd827c
|
|
||||||
33565185daa5acabd632ddeff5e03049e5a120ba
|
|
||||||
eaee82bf5ecc24cb16c0d99d5ea60389f9e8b231
|
|
||||||
4cf30631b61ec87f9c2b2f2aa4bebc8e1ec11747
|
|
||||||
b3bdf965e78d91927632f4e7942b98d706b8f793
|
|
||||||
0c6eb9a9eb1caec299039595b93712a7a1fc0e95
|
|
||||||
37bd9b1f249dd390a025341b502d486476a8549d
|
|
||||||
ec8b893f6a639addc856a7c37b43ef61878dfde5
|
|
||||||
aefd5344f027487fb80b253695005b4cf695b573
|
|
||||||
2920328093fecd3696a7617c07ab22bcbe5d6bcb
|
|
||||||
0dbfa23ef89ae42116ac0f4cc56fa14d33570d5e
|
|
||||||
143bbb7a335579de1bbc1984522edd246a228249
|
|
||||||
7ceb5c3c502dac5469d0c609efee7ffa00106908
|
|
||||||
ed57b709ecd96a27cb043cd341bb7f34374d56b7
|
|
||||||
6aa2458cb2d6d84f25dab994e6e991fa55acd64b
|
|
||||||
cfd5cb9da90da4994fa585b526e20e6e84005d84
|
|
||||||
601445e9738c3e793e67365ee642fef9e496be40
|
|
||||||
56032b81bc0ff432305a3c2a76fbd099d09f0a7d
|
|
||||||
536b184693c4f910e18a292be101823e00a00537
|
|
||||||
93f896f194ce9961e5278bdbbffa3387bbc3dccf
|
|
||||||
46b9cd79a68c879d275839758f1748efe2ff6bf6
|
|
||||||
4a12f3676f737250ea37e2a40af0e6e283d3d28d
|
|
||||||
933b49f3686f9b94e71d247ed9387db60ce266c4
|
|
||||||
1658a432cf38303214ee3933c560eb8d6d94dc56
|
|
||||||
3803843ba29a3181244d50f6a7741dae14965575
|
|
||||||
44d2279271472f6af14f7ffaea49cf8459aa4d92
|
|
||||||
8cbad9d7f11e4933c385dce121c9693065ac8179
|
|
||||||
8ed08c5fa067dcd94d6c55482d675adde225b4cd
|
|
||||||
b654f4523e0ca318d31b980b69140876e2528dba
|
|
||||||
403ec58e21685973ac3a05e4c1977b0a5fcd4249
|
|
||||||
afaf2918c6144a1776d4e1e89963ade1ac8c2a67
|
|
||||||
48a9832a7a6e586cf949a74ddab1fb45f08dc7a5
|
|
||||||
73c93cfbd2f6ab6a2d2d871415ddf9d2f2972d2d
|
|
||||||
a822d34c5a4b52bd20ac7b49339fceb289157ce3
|
|
||||||
8dd21dbd94216a26b14969744a1a0c5fed9b5e0e
|
|
||||||
53608879b9ad3dd0c9a46783ed39b9a83d9b4839
|
|
||||||
a6102da28643a1ce8dc563609169a78915b6b93e
|
|
||||||
5df01f1aea6350990863d390a0ec09f53c7badba
|
|
||||||
867aad941ee9460393589af59a4871d10d37c223
|
|
||||||
00a8fc1f61b31b84b9c377c1943b10614f24a236
|
|
||||||
e2ec6bbcdc12167dcee896003783dc5c6c4ee21e
|
|
||||||
aecbf89cf2f7ac7ed61c3cae1f952434d1ca4ab7
|
|
||||||
024476cc6f1cf0babd1818c7044214987e165599
|
|
||||||
80bece6f68c65ff2d53a4d54f9d91909c99f41c2
|
|
||||||
f3db0cb55911b9f61b78b18333faedc4475d5e10
|
|
||||||
a3102f45b452e2cabfc2ebda9df7209464fd81e6
|
|
||||||
ef66652a133e72449bd0124d479f1e587dcc32c2
|
|
||||||
1ec5a0bd2c81fec1b5ba2572bd26df6f602e3de5
|
|
||||||
84982d61311ada39ab7138e7f6b8896470cfdd32
|
|
||||||
39cc9223d2af5b833ed0b4a63bd2bc0d1e49c429
|
|
||||||
0a7148d62b492b7e54a918323ed0fbcd3ddbb1bb
|
|
||||||
4ae22d878f8f686f9335b0a038b7ccb01383ffdf
|
|
||||||
16a6b797bcf3f7738c6ffbc4c74336b4d0273264
|
|
||||||
e004a70d0b99ca9c9d84eb7764c4a44fd9357d81
|
|
||||||
651ef9ac56fa86ba186e9594d859eecc93d9674d
|
|
||||||
7157ef2a9bdb6d9026c8a8213232b662b333694d
|
|
||||||
a6ee74ffe4f686b0334fa536c9eab12aebce41ad
|
|
||||||
d0667bb70f20751e5f073eae4ba5040b601279ac
|
|
||||||
52776dcf5bdcafc6192787a6b218298e487de194
|
|
||||||
07155ab53f327dd2f5191a3026ada751c7370071
|
|
||||||
75421d7e85982a9f9497d8c8d4252a73834aca61
|
|
||||||
c8d14936505e8e9a9c99a7884b73acd25d44b126
|
|
||||||
5c19f6e387fb4ac6dc6bf47f8ad185a91ca8819f
|
|
||||||
02660e0f63ecfc7c0834b98c682566dbdfaef554
|
|
||||||
c047a99306810187d2bca622323faca3ea72d729
|
|
||||||
20dbbd595a00f6e7090014c4bd788763ccdfa700
|
|
||||||
b1fc33d2aafadca1f261698cf54151297e48de62
|
|
||||||
ac3fc11bfd3acad03662cd58896da287e6153e64
|
|
||||||
fe2ed45ee70f1bb311b988a6ae3e3195dd248dd2
|
|
||||||
e53a8235813b8649775c3013051efcbfe8dbdfb3
|
|
||||||
37b5cf44143419af3598e41e1a88baf2bb034ef2
|
|
||||||
866cbd33bc1dddcb323a38fa978a439eea8afb07
|
|
||||||
2fc1e0a9283d4efdd27048a76154e4b59e246ead
|
|
||||||
ef18de474d1f272657d3f591944743c275084dcc
|
|
||||||
382a973e1400319df4258656b6b35297bfad9911
|
|
||||||
878b7b4d2ad9d303410f628d857773c844850001
|
|
||||||
bacdea35f6611ab020eb7ff7d6ef0cd84ce37046
|
|
||||||
867f5dfe53358de696a0e7d082a847a7dd0a39fd
|
|
||||||
5b084ef31c609472edf3b74c073f735139631352
|
|
||||||
1e04c69d5e4b1e4951a9db4795160d841adeae80
|
|
||||||
b1f1c63585da2cf2b04f85af1c3ea2ef0c08c060
|
|
||||||
a61da424bff7e0133a50e984dd7dd65fdee997ee
|
|
||||||
6f5890a81b71e4f03eb228b2106ffaf90b4e34af
|
|
||||||
8e938e329912b46c6b6cdcf2b1f55ae7d07a9425
|
|
||||||
5c9ec1029b92e23f14cd41e71feedbf5f192ddf5
|
|
||||||
f01cba4dc5d94d5228332ae5ed5e449bd9ee49e5
|
|
||||||
d080f1b3649e47a233584a314caab502d2103767
|
|
||||||
6c71a583bc5b31a9c5886a0215f42b476b9effed
|
|
||||||
4feaf4a17dc6ada863211463266e698a18bc8d1a
|
|
||||||
0c07781bdc80d961ff375bd6476a8c804a0041cd
|
|
||||||
05def135291a23cad8106134e83748c237aabde7
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
target
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
git cliff --bump > CHANGELOG.md
|
|
||||||
if ! git diff --quiet -- CHANGELOG.md; then
|
|
||||||
git commit --amend --no-edit --quiet CHANGELOG.md
|
|
||||||
fi
|
|
||||||
22
.github/workflows/build.yml
vendored
Normal file
22
.github/workflows/build.yml
vendored
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
on: push
|
||||||
|
|
||||||
|
name: Build
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build_and_test:
|
||||||
|
name: Build cloudflare-ddns
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout latest
|
||||||
|
uses: actions/checkout@master
|
||||||
|
- name: Install nightly toolchain
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: nightly
|
||||||
|
override: true
|
||||||
|
- name: Cargo build
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
toolchain: nightly
|
||||||
|
command: build
|
||||||
|
args: --release
|
||||||
88
.github/workflows/publish_release.yml
vendored
Normal file
88
.github/workflows/publish_release.yml
vendored
Normal file
|
|
@ -0,0 +1,88 @@
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*.*.*'
|
||||||
|
|
||||||
|
name: Publish
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: [ubuntu-latest, macOS-latest]
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@master
|
||||||
|
- name: Install nightly toolchain
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: nightly
|
||||||
|
override: true
|
||||||
|
- name: Cargo build
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
toolchain: nightly
|
||||||
|
command: build
|
||||||
|
args: --release
|
||||||
|
- name: Get the version
|
||||||
|
id: get_version
|
||||||
|
run: echo ::set-output name=VERSION::$(echo $GITHUB_REF | cut -d / -f 3)
|
||||||
|
- name: Archive binary
|
||||||
|
run: tar cfJ cloudflare-ddns-${{ matrix.os }}-${{ steps.get_version.outputs.VERSION }}.tar.xz target/release/cloudflare-ddns
|
||||||
|
- name: Save archived binary as an artifact
|
||||||
|
uses: actions/upload-artifact@v1
|
||||||
|
with:
|
||||||
|
name: binary-${{ matrix.os }}-${{ steps.get_version.outputs.VERSION }}
|
||||||
|
path: cloudflare-ddns-${{ matrix.os }}-${{ steps.get_version.outputs.VERSION }}.tar.xz
|
||||||
|
create_github_release:
|
||||||
|
name: Prepare a GitHub release
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: build
|
||||||
|
steps:
|
||||||
|
- name: Get the version
|
||||||
|
id: get_version
|
||||||
|
run: echo ::set-output name=VERSION::$(echo $GITHUB_REF | cut -d / -f 3)
|
||||||
|
- name: Download macOS binary archive
|
||||||
|
uses: actions/download-artifact@v1
|
||||||
|
with:
|
||||||
|
name: binary-macOS-latest-${{ steps.get_version.outputs.VERSION }}
|
||||||
|
path: cloudflare-ddns-macOS-${{ steps.get_version.outputs.VERSION }}.tar.xz
|
||||||
|
- name: Download Linux binary archive
|
||||||
|
uses: actions/download-artifact@v1
|
||||||
|
with:
|
||||||
|
name: binary-ubuntu-latest-${{ steps.get_version.outputs.VERSION }}
|
||||||
|
path: cloudflare-ddns-ubuntu-${{ steps.get_version.outputs.VERSION }}.tar.xz
|
||||||
|
- name: Create release
|
||||||
|
uses: softprops/action-gh-release@v1
|
||||||
|
with:
|
||||||
|
name: cloudflare-ddns v${{ steps.get_version.outputs.VERSION }}
|
||||||
|
files: |
|
||||||
|
LICENSE
|
||||||
|
cloudflare-ddns-macOS-${{ steps.get_version.outputs.VERSION }}
|
||||||
|
cloudflare-ddns-ubuntu-${{ steps.get_version.outputs.VERSION }}
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
publish_crate:
|
||||||
|
name: Publish cloudflare-ddns to crates.io
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout latest master
|
||||||
|
uses: actions/checkout@master
|
||||||
|
- name: Install nightly toolchain
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: nightly
|
||||||
|
override: true
|
||||||
|
- name: Login to crates.io
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
toolchain: nightly
|
||||||
|
command: login
|
||||||
|
args: ${{ secrets.CRATES_TOKEN }}
|
||||||
|
- name: Publish to crates.io
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
toolchain: nightly
|
||||||
|
command: publish
|
||||||
78
CHANGELOG.md
78
CHANGELOG.md
|
|
@ -1,78 +0,0 @@
|
||||||
# Changelog
|
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
|
||||||
|
|
||||||
## [0.6.0] - 2024-10-14
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
- [**breaking**] Use toml for config and cache files
|
|
||||||
- [**breaking**] Support multiple dns providers and rename the project accordingly
|
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
|
||||||
|
|
||||||
- Add hook for automatic changelog generation
|
|
||||||
- Clean up and bump dependencies
|
|
||||||
- Fix license path in Cargo.toml
|
|
||||||
- Bump version to 0.6.0
|
|
||||||
|
|
||||||
### Refactor
|
|
||||||
|
|
||||||
- Replace cloudflare crate with dns-update
|
|
||||||
|
|
||||||
## [0.5.3] - 2023-01-15
|
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
|
||||||
|
|
||||||
- Replace homegrown public IP lookup with library
|
|
||||||
- Update dependencies
|
|
||||||
- Bump version and update changelog
|
|
||||||
|
|
||||||
## [0.5.2] - 2023-01-14
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
- Switch to cloudflare fork that actually parses API responses
|
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
|
||||||
|
|
||||||
- Improve error handling
|
|
||||||
- Fix clippy lints
|
|
||||||
- Bump version and update changelog
|
|
||||||
|
|
||||||
## [0.5.1] - 2023-01-01
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
- Make container image actually usable
|
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
|
||||||
|
|
||||||
- Improve logging granularity
|
|
||||||
- Bump version and update changelog
|
|
||||||
|
|
||||||
## [0.5.0] - 2023-01-01
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
- Don't use XDG spec, because this is a system service
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
- Add Dockerfile
|
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
|
||||||
|
|
||||||
- Make clippy happy
|
|
||||||
- Update dependencies
|
|
||||||
- Update license
|
|
||||||
- Bump version and update changelog
|
|
||||||
|
|
||||||
## [0.4.0] - 2021-05-23
|
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
|
||||||
|
|
||||||
- Fork and rename
|
|
||||||
|
|
||||||
<!-- generated by git-cliff -->
|
|
||||||
<!-- update with `git cliff --tag <new version> 7cf8502fb9d0c04bab48a2d7d7e819c98f9aed6e.. > CHANGELOG.md` -->
|
|
||||||
2880
Cargo.lock
generated
2880
Cargo.lock
generated
File diff suppressed because it is too large
Load diff
44
Cargo.toml
44
Cargo.toml
|
|
@ -1,29 +1,25 @@
|
||||||
[package]
|
[package]
|
||||||
name = "dyndnsd"
|
name = "cloudflare-ddns"
|
||||||
version = "0.6.0"
|
version = "0.1.8"
|
||||||
authors = ["Jan Christian Grünhage <jan.christian@gruenhage.xyz>"]
|
authors = ["Rostislav Raykov <z@zbrox.org>"]
|
||||||
edition = "2021"
|
edition = "2018"
|
||||||
description = "A daemon for dynamically updating DNS via multiple DNS providers"
|
description = "A simple CLI tool to use Cloudflare's free DDNS service"
|
||||||
repository = "https://git.jcg.re/jcgruenhage/dyndnsd"
|
repository = "https://github.com/zbrox/cloudflare-ddns"
|
||||||
homepage = "https://git.jcg.re/jcgruenhage/dyndnsd"
|
homepage = "https://github.com/zbrox/cloudflare-ddns"
|
||||||
keywords = ["rfc2136", "cloudflare", "ddns"]
|
keywords = ["cloudflare", "ddns", "cli"]
|
||||||
categories = ["command-line-utilities"]
|
categories = ["command-line-utilities"]
|
||||||
license-file = "LICENSE.md"
|
license = "MIT"
|
||||||
documentation = "https://git.jcg.re/jcgruenhage/dyndnsd"
|
documentation = "https://github.com/zbrox/cloudflare-ddns"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
|
|
||||||
[dependencies]
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
anyhow = "1"
|
|
||||||
dns-update = "0.1"
|
|
||||||
env_logger = "0.11"
|
|
||||||
log = "0.4"
|
|
||||||
public-ip = "0.2"
|
|
||||||
serde = { version = "1", features = ["derive"] }
|
|
||||||
tokio = { version = "1", features = ["time", "macros", "rt-multi-thread"] }
|
|
||||||
toml = "0.8.19"
|
|
||||||
|
|
||||||
[patch.crates-io]
|
[dependencies]
|
||||||
dns-update = { git = "https://github.com/jcgruenhage/dns-update.git", branch = "fork"}
|
quicli = "0.4"
|
||||||
public-ip = { git = "https://github.com/jcgruenhage/rust-public-ip.git", branch = "main" }
|
structopt = "0.3.1"
|
||||||
hickory-client = { git = "https://github.com/jcgruenhage/hickory-dns.git", branch = "serde_tsig_algorithm_names" }
|
reqwest="0.9.20"
|
||||||
hickory-proto = { git = "https://github.com/jcgruenhage/hickory-dns.git", branch = "serde_tsig_algorithm_names" }
|
serde = "1.0.101"
|
||||||
|
serde_json = "1.0.40"
|
||||||
|
exitcode = "1.1.2"
|
||||||
|
human-panic = "1.0.1"
|
||||||
|
failure = "0.1.5"
|
||||||
17
Dockerfile
17
Dockerfile
|
|
@ -1,17 +0,0 @@
|
||||||
FROM docker.io/rust:bookworm as builder
|
|
||||||
|
|
||||||
RUN apt-get update && apt-get install libssl-dev pkg-config -qq
|
|
||||||
RUN cargo install cargo-auditable
|
|
||||||
|
|
||||||
COPY . /app
|
|
||||||
WORKDIR /app
|
|
||||||
|
|
||||||
RUN cargo auditable build --release
|
|
||||||
|
|
||||||
FROM docker.io/debian:bookworm-slim
|
|
||||||
|
|
||||||
RUN apt-get update && apt-get install openssl ca-certificates -qq
|
|
||||||
|
|
||||||
COPY --from=builder /app/target/release/dyndnsd /usr/local/bin
|
|
||||||
|
|
||||||
CMD /usr/local/bin/dyndnsd
|
|
||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2019 Rostislav Raykov <z@zbrox.org>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
483
LICENSE.md
483
LICENSE.md
|
|
@ -1,483 +0,0 @@
|
||||||
THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS
|
|
||||||
COOPERATIVE NON-VIOLENT PUBLIC LICENSE (\"LICENSE\"). THE WORK IS
|
|
||||||
PROTECTED BY COPYRIGHT AND ALL OTHER APPLICABLE LAWS. ANY USE OF THE
|
|
||||||
WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS
|
|
||||||
PROHIBITED. BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED IN THIS
|
|
||||||
LICENSE, YOU AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE
|
|
||||||
EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR
|
|
||||||
GRANTS YOU THE RIGHTS CONTAINED HERE IN AS CONSIDERATION FOR ACCEPTING
|
|
||||||
THE TERMS AND CONDITIONS OF THIS LICENSE AND FOR AGREEING TO BE BOUND BY
|
|
||||||
THE TERMS AND CONDITIONS OF THIS LICENSE.
|
|
||||||
|
|
||||||
# Definitions
|
|
||||||
|
|
||||||
An Act of War is any action of one country against any group either with
|
|
||||||
an intention to provoke a conflict or an action that occurs during a
|
|
||||||
declared war or during armed conflict between military forces of any
|
|
||||||
origin. This includes but is not limited to enforcing sanctions or
|
|
||||||
sieges, supplying armed forces, or profiting from the manufacture of
|
|
||||||
tools or weaponry used in military conflict.
|
|
||||||
|
|
||||||
An Adaptation is a work based upon the Work, or upon the Work and other
|
|
||||||
pre-existing works, such as a translation, adaptation, derivative work,
|
|
||||||
arrangement of music or other alterations of a literary or artistic
|
|
||||||
work, or phonogram or performance and includes cinematographic
|
|
||||||
adaptations or any other form in which the Work may be recast,
|
|
||||||
transformed, or adapted including in any form recognizably derived from
|
|
||||||
the original, except that a work that constitutes a Collection will not
|
|
||||||
be considered an Adaptation for the purpose of this License. For the
|
|
||||||
avoidance of doubt, where the Work is a musical work, performance or
|
|
||||||
phonogram, the synchronization of the Work in timed-relation with a
|
|
||||||
moving image (\"synching\") will be considered an Adaptation for the
|
|
||||||
purpose of this License. In addition, where the Work is designed to
|
|
||||||
output a neural network the output of the neural network will be
|
|
||||||
considered an Adaptation for the purpose of this license.
|
|
||||||
|
|
||||||
Bodily Harm is any physical hurt or injury to a person that interferes
|
|
||||||
with the health or comfort of the person and that is more than merely
|
|
||||||
transient or trifling in nature.
|
|
||||||
|
|
||||||
Distribute is to make available to the public the original and copies of
|
|
||||||
the Work or Adaptation, as appropriate, through sale, gift or any other
|
|
||||||
transfer of possession or ownership.
|
|
||||||
|
|
||||||
Incarceration is Confinement in a jail, prison, or any other place where
|
|
||||||
individuals of any kind are held against either their will or (if their
|
|
||||||
will cannot be determined) the will of their legal guardian or
|
|
||||||
guardians. In the case of a conflict between the will of the individual
|
|
||||||
and the will of their legal guardian or guardians, the will of the
|
|
||||||
individual will take precedence.
|
|
||||||
|
|
||||||
Licensor is The individual, individuals, entity, or entities that
|
|
||||||
offer(s) the Work under the terms of this License
|
|
||||||
|
|
||||||
Original Author is in the case of a literary or artistic work, the
|
|
||||||
individual, individuals, entity or entities who created the Work or if
|
|
||||||
no individual or entity can be identified, the publisher; and in
|
|
||||||
addition
|
|
||||||
|
|
||||||
- in the case of a performance the actors, singers, musicians,
|
|
||||||
dancers, and other persons who act, sing, deliver, declaim, play in,
|
|
||||||
interpret or otherwise perform literary or artistic works or
|
|
||||||
expressions of folklore;
|
|
||||||
|
|
||||||
- in the case of a phonogram the producer being the person or legal
|
|
||||||
entity who first fixes the sounds of a performance or other sounds;
|
|
||||||
and,
|
|
||||||
|
|
||||||
- in the case of broadcasts, the organization that transmits the
|
|
||||||
broadcast.
|
|
||||||
|
|
||||||
Work is the literary and/or artistic work offered under the terms of
|
|
||||||
this License including without limitation any production in the
|
|
||||||
literary, scientific and artistic domain, whatever may be the mode or
|
|
||||||
form of its expression including digital form, such as a book, pamphlet
|
|
||||||
and other writing; a lecture, address, sermon or other work of the same
|
|
||||||
nature; a dramatic or dramatico-musical work; a choreographic work or
|
|
||||||
entertainment in dumb show; a musical composition with or without words;
|
|
||||||
a cinematographic work to which are assimilated works expressed by a
|
|
||||||
process analogous to cinematography; a work of drawing, painting,
|
|
||||||
architecture, sculpture, engraving or lithography; a photographic work
|
|
||||||
to which are assimilated works expressed by a process analogous to
|
|
||||||
photography; a work of applied art; an illustration, map, plan, sketch
|
|
||||||
or three-dimensional work relative to geography, topography,
|
|
||||||
architecture or science; a performance; a broadcast; a phonogram; a
|
|
||||||
compilation of data to the extent it is protected as a copyrightable
|
|
||||||
work; or a work performed by a variety or circus performer to the extent
|
|
||||||
it is not otherwise considered a literary or artistic work.
|
|
||||||
|
|
||||||
You means an individual or entity exercising rights under this License
|
|
||||||
who has not previously violated the terms of this License with respect
|
|
||||||
to the Work, or who has received express permission from the Licensor to
|
|
||||||
exercise rights under this License despite a previous violation.
|
|
||||||
|
|
||||||
Publicly Perform means to perform public recitations of the Work and to
|
|
||||||
communicate to the public those public recitations, by any means or
|
|
||||||
process, including by wire or wireless means or public digital
|
|
||||||
performances; to make available to the public Works in such a way that
|
|
||||||
members of the public may access these Works from a place and at a place
|
|
||||||
individually chosen by them; to perform the Work to the public by any
|
|
||||||
means or process and the communication to the public of the performances
|
|
||||||
of the Work, including by public digital performance; to broadcast and
|
|
||||||
rebroadcast the Work by any means including signs, sounds or images.
|
|
||||||
|
|
||||||
Reproduce is to make copies of the Work by any means including without
|
|
||||||
limitation by sound or visual recordings and the right of fixation and
|
|
||||||
reproducing fixations of the Work, including storage of a protected
|
|
||||||
performance or phonogram in digital form or other electronic medium.
|
|
||||||
|
|
||||||
Software is any digital Work which, through use of a third-party piece
|
|
||||||
of Software or through the direct usage of itself on a computer system,
|
|
||||||
the memory of the computer is modified dynamically or semi-dynamically.
|
|
||||||
\"Software\", secondly, processes or interprets information.
|
|
||||||
|
|
||||||
Source Code is Any digital Work which, through use of a third-party
|
|
||||||
piece of Software or through the direct usage of itself on a computer
|
|
||||||
system, the memory of the computer is modified dynamically or
|
|
||||||
semi-dynamically. \"Software\", secondly, processes or interprets
|
|
||||||
information.
|
|
||||||
|
|
||||||
Surveilling is the use of the Work to either overtly or covertly observe
|
|
||||||
and record persons and or their activities.
|
|
||||||
|
|
||||||
A Network Service is the use of a piece of Software to interpret or
|
|
||||||
modify information that is subsequently and directly served to users
|
|
||||||
over the Internet.
|
|
||||||
|
|
||||||
To Discriminate is use of a work to differentiate between humans in a
|
|
||||||
such a way which prioritizes some above others on the basis of percieved
|
|
||||||
membership within certain groups.
|
|
||||||
|
|
||||||
Hate Speech is Communication or any form of expression which is solely
|
|
||||||
for the purpose of expressing hatred for some group or advocating a form
|
|
||||||
of Discrimination between humans.
|
|
||||||
|
|
||||||
Coercion is leveraging of the threat of force or use of force to
|
|
||||||
intimidate a person in order to gain compliance, or to offer large
|
|
||||||
incentives which aim to entice a person to act against their will.
|
|
||||||
|
|
||||||
# Fair Dealing Rights
|
|
||||||
|
|
||||||
Nothing in this License is intended to reduce, limit, or restrict any
|
|
||||||
uses free from copyright or rights arising from limitations or
|
|
||||||
exceptions that are provided for in connection with the copyright
|
|
||||||
protection under copyright law or other applicable laws.
|
|
||||||
|
|
||||||
# License Grant
|
|
||||||
|
|
||||||
Subject to the terms and conditions of this License, Licensor hereby
|
|
||||||
grants You a worldwide, royalty-free, non-exclusive, perpetual (for the
|
|
||||||
duration of the applicable copyright) license to exercise the rights in
|
|
||||||
the Work as stated below:
|
|
||||||
|
|
||||||
To Reproduce the Work, to incorporate the Work into one or more
|
|
||||||
Collections, and to Reproduce the Work as incorporated in the
|
|
||||||
Collections
|
|
||||||
|
|
||||||
To create and Reproduce Adaptations provided that any such Adaptation,
|
|
||||||
including any translation in any medium, takes reasonable steps to
|
|
||||||
clearly label, demarcate or otherwise identify that changes were made to
|
|
||||||
the original Work. For example, a translation could be marked \"The
|
|
||||||
original work was translated from English to Spanish,\" or a
|
|
||||||
modification could indicate \"The original work has been modified.\"
|
|
||||||
|
|
||||||
To Distribute and Publicly Perform the Work including as incorporated in
|
|
||||||
Collections.
|
|
||||||
|
|
||||||
To Distribute and Publicly Perform Adaptations. The above rights may be
|
|
||||||
exercised in all media and formats whether now known or hereafter
|
|
||||||
devised. The above rights include the right to make such modifications
|
|
||||||
as are technically necessary to exercise the rights in other media and
|
|
||||||
formats. This License constitutes the entire agreement between the
|
|
||||||
parties with respect to the Work licensed here. There are no
|
|
||||||
understandings, agreements or representations with respect to the Work
|
|
||||||
not specified here. Licensor shall not be bound by any additional
|
|
||||||
provisions that may appear in any communication from You. This License
|
|
||||||
may not be modified without the mutual written agreement of the Licensor
|
|
||||||
and You. All rights not expressly granted by Licensor are hereby
|
|
||||||
reserved, including but not limited to the rights set forth in
|
|
||||||
Non-waivable Compulsory License Schemes, Waivable Compulsory License
|
|
||||||
Schemes, and Voluntary License Schemes in the restrictions.
|
|
||||||
|
|
||||||
# Restrictions
|
|
||||||
|
|
||||||
The license granted in the license grant above is expressly made subject
|
|
||||||
to and limited by the following restrictions:
|
|
||||||
|
|
||||||
You may Distribute or Publicly Perform the Work only under the terms of
|
|
||||||
this License. You must include a copy of, or the Uniform Resource
|
|
||||||
Identifier (URI) for, this License with every copy of the Work You
|
|
||||||
Distribute or Publicly Perform. You may not offer or impose any terms on
|
|
||||||
the Work that restrict the terms of this License or the ability of the
|
|
||||||
recipient of the Work to exercise the rights granted to that recipient
|
|
||||||
under the terms of the License. You may not sublicense the Work. You
|
|
||||||
must keep intact all notices that refer to this License and to the
|
|
||||||
disclaimer of warranties with every copy of the Work You Distribute or
|
|
||||||
Publicly Perform. When You Distribute or Publicly Perform the Work, You
|
|
||||||
may not impose any effective technological measures on the Work that
|
|
||||||
restrict the ability of a recipient of the Work from You to exercise the
|
|
||||||
rights granted to that recipient under the terms of the License. This
|
|
||||||
Section applies to the Work as incorporated in a Collection, but this
|
|
||||||
does not require the Collection apart from the Work itself to be made
|
|
||||||
subject to the terms of this License. If You create a Collection, upon
|
|
||||||
notice from any Licensor You must, to the extent practicable, remove
|
|
||||||
from the Collection any credit as requested. If You create an
|
|
||||||
Adaptation, upon notice from any Licensor You must, to the extent
|
|
||||||
practicable, remove from the Adaptation any credit as requested.
|
|
||||||
|
|
||||||
## Commercial Restrictions
|
|
||||||
|
|
||||||
You may not exercise any of the rights granted to You in the above
|
|
||||||
section in any manner that is primarily intended for or directed toward
|
|
||||||
commercial advantage or private monetary compensation unless you meet
|
|
||||||
the following requirements.
|
|
||||||
|
|
||||||
i. You are a worker-owned business or worker-owned collective.
|
|
||||||
|
|
||||||
ii. after tax, all financial gain, surplus, profits and benefits
|
|
||||||
produced by the business or collective are distributed among the
|
|
||||||
worker-owners unless a set amount is to be allocated towards
|
|
||||||
community projects as decided by a previously-established consensus
|
|
||||||
agreement between the worker-owners where all worker-owners agreed.
|
|
||||||
|
|
||||||
iii. You are not using such rights on behalf of a business other than
|
|
||||||
those specified in (i) or (ii) above, nor are using such rights as
|
|
||||||
a proxy on behalf of a business with the intent to circumvent the
|
|
||||||
aforementioned restrictions on such a business.
|
|
||||||
|
|
||||||
The exchange of the Work for other copyrighted works by means of digital
|
|
||||||
file-sharing or otherwise shall not be considered to be intended for or
|
|
||||||
directed toward commercial advantage or private monetary compensation,
|
|
||||||
provided there is no payment of any monetary compensation in connection
|
|
||||||
with the exchange of copyrighted works.
|
|
||||||
|
|
||||||
If the Work meets the definition of Software, You may exercise the
|
|
||||||
rights granted in the license grant only if You provide a copy of the
|
|
||||||
corresponding Source Code from which the Work was derived in digital
|
|
||||||
form, or You provide a URI for the corresponding Source Code of the
|
|
||||||
Work, to any recipients upon request.
|
|
||||||
|
|
||||||
If the Work is used as or for a Network Service, You may exercise the
|
|
||||||
rights granted in the license grant only if You provide a copy of the
|
|
||||||
corresponding Source Code from which the Work was derived in digital
|
|
||||||
form, or You provide a URI for the corresponding Source Code to the
|
|
||||||
Work, to any recipients of the data served or modified by the Web
|
|
||||||
Service.
|
|
||||||
|
|
||||||
Any use by a business that is privately owned and managed, and that
|
|
||||||
seeks to generate profit from the labor of employees paid by salary or
|
|
||||||
other wages, is not permitted under this license.
|
|
||||||
|
|
||||||
##
|
|
||||||
|
|
||||||
You may exercise the rights granted in the license grant for any
|
|
||||||
purposes only if:
|
|
||||||
|
|
||||||
i. You do not use the Work for the purpose of inflicting Bodily Harm on
|
|
||||||
human beings (subject to criminal prosecution or otherwise) outside
|
|
||||||
of providing medical aid or undergoing a voluntary procedure under
|
|
||||||
no form of Coercion.
|
|
||||||
|
|
||||||
ii. You do not use the Work for the purpose of Surveilling or tracking
|
|
||||||
individuals for financial gain.
|
|
||||||
|
|
||||||
iii. You do not use the Work in an Act of War.
|
|
||||||
|
|
||||||
iv. You do not use the Work for the purpose of supporting or profiting
|
|
||||||
from an Act of War.
|
|
||||||
|
|
||||||
v. You do not use the Work for the purpose of Incarceration.
|
|
||||||
|
|
||||||
vi. You do not use the Work for the purpose of extracting, processing,
|
|
||||||
or refining, oil, gas, or coal. Or to in any other way to
|
|
||||||
deliberately pollute the environment as a byproduct of manufacturing
|
|
||||||
or irresponsible disposal of hazardous materials.
|
|
||||||
|
|
||||||
vii. You do not use the Work for the purpose of expediting,
|
|
||||||
coordinating, or facilitating paid work undertaken by individuals
|
|
||||||
under the age of 12 years.
|
|
||||||
|
|
||||||
viii. You do not use the Work to either Discriminate or spread Hate
|
|
||||||
Speech on the basis of sex, sexual orientation, gender identity,
|
|
||||||
race, age, disability, color, national origin, religion, caste, or
|
|
||||||
lower economic status.
|
|
||||||
|
|
||||||
##
|
|
||||||
|
|
||||||
If You Distribute, or Publicly Perform the Work or any Adaptations or
|
|
||||||
Collections, You must, unless a request has been made by any Licensor to
|
|
||||||
remove credit from a Collection or Adaptation, keep intact all copyright
|
|
||||||
notices for the Work and provide, reasonable to the medium or means You
|
|
||||||
are utilizing:
|
|
||||||
|
|
||||||
i. the name of the Original Author (or pseudonym, if applicable) if
|
|
||||||
supplied, and/or if the Original Author and/or Licensor designate
|
|
||||||
another party or parties (e.g., a sponsor institute, publishing
|
|
||||||
entity, journal) for attribution (\"Attribution Parties\") in
|
|
||||||
Licensor\'s copyright notice, terms of service or by other
|
|
||||||
reasonable means, the name of such party or parties;
|
|
||||||
|
|
||||||
ii. the title of the Work if supplied;
|
|
||||||
|
|
||||||
iii. to the extent reasonably practicable, the URI, if any, that
|
|
||||||
Licensor to be associated with the Work, unless such URI does not
|
|
||||||
refer to the copyright notice or licensing information for the
|
|
||||||
Work; and,
|
|
||||||
|
|
||||||
iv. in the case of an Adaptation, a credit identifying the use of the
|
|
||||||
Work in the Adaptation (e.g., \"French translation of the Work by
|
|
||||||
Original Author,\" or \"Screenplay based on original Work by
|
|
||||||
Original Author\").
|
|
||||||
|
|
||||||
If any Licensor has sent notice to request removing credit, You must, to
|
|
||||||
the extent practicable, remove any credit as requested. The credit
|
|
||||||
required by this Section may be implemented in any reasonable manner;
|
|
||||||
provided, however, that in the case of an Adaptation or Collection, at a
|
|
||||||
minimum such credit will appear, if a credit for all contributing
|
|
||||||
authors of the Adaptation or Collection appears, then as part of these
|
|
||||||
credits and in a manner at least as prominent as the credits for the
|
|
||||||
other contributing authors. For the avoidance of doubt, You may only use
|
|
||||||
the credit required by this Section for the purpose of attribution in
|
|
||||||
the manner set out above and, by exercising Your rights under this
|
|
||||||
License, You may not implicitly or explicitly assert or imply any
|
|
||||||
connection with, sponsorship or endorsement by the Original Author,
|
|
||||||
Licensor and/or Attribution Parties, as appropriate, of You or Your use
|
|
||||||
of the Work, without the separate, express prior written permission of
|
|
||||||
the Original Author, Licensor and/or Attribution Parties.
|
|
||||||
|
|
||||||
Non-waivable Compulsory License Schemes. In those jurisdictions in which
|
|
||||||
the right to collect royalties through any statutory or compulsory
|
|
||||||
licensing scheme cannot be waived, the Licensor reserves the exclusive
|
|
||||||
right to collect such royalties for any exercise by You of the rights
|
|
||||||
granted under this License
|
|
||||||
|
|
||||||
Waivable Compulsory License Schemes. In those jurisdictions in which the
|
|
||||||
right to collect royalties through any statutory or compulsory licensing
|
|
||||||
scheme can be waived, the Licensor reserves the exclusive right to
|
|
||||||
collect such royalties for any exercise by You of the rights granted
|
|
||||||
under this License if Your exercise of such rights is for a purpose or
|
|
||||||
use which is otherwise than noncommercial as permitted under Commercial
|
|
||||||
Restrictions and otherwise waives the right to collect royalties through
|
|
||||||
any statutory or compulsory licensing scheme.
|
|
||||||
|
|
||||||
Voluntary License Schemes. The Licensor reserves the right to collect
|
|
||||||
royalties, whether individually or, in the event that the Licensor is a
|
|
||||||
member of a collecting society that administers voluntary licensing
|
|
||||||
schemes, via that society, from any exercise by You of the rights
|
|
||||||
granted under this License that is for a purpose or use which is
|
|
||||||
otherwise than noncommercial as permitted under the license grant.
|
|
||||||
|
|
||||||
Except as otherwise agreed in writing by the Licensor or as may be
|
|
||||||
otherwise permitted by applicable law, if You Reproduce, Distribute or
|
|
||||||
Publicly Perform the Work either by itself or as part of any Adaptations
|
|
||||||
or Collections, You must not distort, mutilate, modify or take other
|
|
||||||
derogatory action in relation to the Work which would be prejudicial to
|
|
||||||
the Original Author\'s honor or reputation. Licensor agrees that in
|
|
||||||
those jurisdictions (e.g. Japan), in which any exercise of the right
|
|
||||||
granted in the license grant of this License (the right to make
|
|
||||||
Adaptations) would be deemed to be a distortion, mutilation,
|
|
||||||
modification or other derogatory action prejudicial to the Original
|
|
||||||
Author\'s honor and reputation, the Licensor will waive or not assert,
|
|
||||||
as appropriate, this Section, to the fullest extent permitted by the
|
|
||||||
applicable national law, to enable You to reasonably exercise Your right
|
|
||||||
under the license grant of this License (right to make Adaptations) but
|
|
||||||
not otherwise.
|
|
||||||
|
|
||||||
Do not make any legal claim against anyone accusing the Work, with or
|
|
||||||
without changes, alone or with other works, of infringing any patent
|
|
||||||
claim.
|
|
||||||
|
|
||||||
# Representations Warranties and Disclaimer
|
|
||||||
|
|
||||||
UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR
|
|
||||||
OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY
|
|
||||||
KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE,
|
|
||||||
INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF
|
|
||||||
LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS,
|
|
||||||
WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE
|
|
||||||
EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
|
|
||||||
|
|
||||||
# Limitation on Liability
|
|
||||||
|
|
||||||
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL
|
|
||||||
LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL,
|
|
||||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF
|
|
||||||
THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED
|
|
||||||
OF THE POSSIBILITY OF SUCH DAMAGES.
|
|
||||||
|
|
||||||
# Termination
|
|
||||||
|
|
||||||
This License and the rights granted hereunder will terminate
|
|
||||||
automatically upon any breach by You of the terms of this License.
|
|
||||||
Individuals or entities who have received Adaptations or Collections
|
|
||||||
from You under this License, however, will not have their licenses
|
|
||||||
terminated provided such individuals or entities remain in full
|
|
||||||
compliance with those licenses. The Sections on definitions, fair
|
|
||||||
dealing rights, representations, warranties, and disclaimer, limitation
|
|
||||||
on liability, termination, and revised license versions will survive any
|
|
||||||
termination of this License.
|
|
||||||
|
|
||||||
Subject to the above terms and conditions, the license granted here is
|
|
||||||
perpetual (for the duration of the applicable copyright in the Work).
|
|
||||||
Notwithstanding the above, Licensor reserves the right to release the
|
|
||||||
Work under different license terms or to stop distributing the Work at
|
|
||||||
any time; provided, however that any such election will not serve to
|
|
||||||
withdraw this License (or any other license that has been, or is
|
|
||||||
required to be, granted under the terms of this License), and this
|
|
||||||
License will continue in full force and effect unless terminated as
|
|
||||||
stated above.
|
|
||||||
|
|
||||||
# Revised License Versions
|
|
||||||
|
|
||||||
This License may receive future revisions in the original spirit of the
|
|
||||||
license intended to strengthen This License. Each version of This
|
|
||||||
License has an incrementing version number.
|
|
||||||
|
|
||||||
Unless otherwise specified like in the below subsection The Licensor has
|
|
||||||
only granted this current version of This License for The Work. In this
|
|
||||||
case future revisions do not apply.
|
|
||||||
|
|
||||||
The Licensor may specify that the latest available revision of This
|
|
||||||
License be used for The Work by either explicitly writing so or by
|
|
||||||
suffixing the License URI with a \"+\" symbol.
|
|
||||||
|
|
||||||
The Licensor may specify that The Work is also available under the terms
|
|
||||||
of This License\'s current revision as well as specific future
|
|
||||||
revisions. The Licensor may do this by writing it explicitly or
|
|
||||||
suffixing the License URI with any additional version numbers each
|
|
||||||
separated by a comma.
|
|
||||||
|
|
||||||
# Miscellaneous
|
|
||||||
|
|
||||||
Each time You Distribute or Publicly Perform the Work or a Collection,
|
|
||||||
the Licensor offers to the recipient a license to the Work on the same
|
|
||||||
terms and conditions as the license granted to You under this License.
|
|
||||||
|
|
||||||
Each time You Distribute or Publicly Perform an Adaptation, Licensor
|
|
||||||
offers to the recipient a license to the original Work on the same terms
|
|
||||||
and conditions as the license granted to You under this License.
|
|
||||||
|
|
||||||
If the Work is classified as Software, each time You Distribute or
|
|
||||||
Publicly Perform an Adaptation, Licensor offers to the recipient a copy
|
|
||||||
and/or URI of the corresponding Source Code on the same terms and
|
|
||||||
conditions as the license granted to You under this License.
|
|
||||||
|
|
||||||
If the Work is used as a Network Service, each time You Distribute or
|
|
||||||
Publicly Perform an Adaptation, or serve data derived from the Software,
|
|
||||||
the Licensor offers to any recipients of the data a copy and/or URI of
|
|
||||||
the corresponding Source Code on the same terms and conditions as the
|
|
||||||
license granted to You under this License.
|
|
||||||
|
|
||||||
If any provision of this License is invalid or unenforceable under
|
|
||||||
applicable law, it shall not affect the validity or enforceability of
|
|
||||||
the remainder of the terms of this License, and without further action
|
|
||||||
by the parties to this agreement, such provision shall be reformed to
|
|
||||||
the minimum extent necessary to make such provision valid and
|
|
||||||
enforceable.
|
|
||||||
|
|
||||||
No term or provision of this License shall be deemed waived and no
|
|
||||||
breach consented to unless such waiver or consent shall be in writing
|
|
||||||
and signed by the party to be charged with such waiver or consent.
|
|
||||||
|
|
||||||
This License constitutes the entire agreement between the parties with
|
|
||||||
respect to the Work licensed here. There are no understandings,
|
|
||||||
agreements or representations with respect to the Work not specified
|
|
||||||
here. Licensor shall not be bound by any additional provisions that may
|
|
||||||
appear in any communication from You. This License may not be modified
|
|
||||||
without the mutual written agreement of the Licensor and You.
|
|
||||||
|
|
||||||
The rights granted under, and the subject matter referenced, in this
|
|
||||||
License were drafted utilizing the terminology of the Berne Convention
|
|
||||||
for the Protection of Literary and Artistic Works (as amended on
|
|
||||||
September 28, 1979), the Rome Convention of 1961, the WIPO Copyright
|
|
||||||
Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and
|
|
||||||
the Universal Copyright Convention (as revised on July 24, 1971). These
|
|
||||||
rights and subject matter take effect in the relevant jurisdiction in
|
|
||||||
which the License terms are sought to be enforced according to the
|
|
||||||
corresponding provisions of the implementation of those treaty
|
|
||||||
provisions in the applicable national law. If the standard suite of
|
|
||||||
rights granted under applicable copyright law includes additional rights
|
|
||||||
not granted under this License, such additional rights are deemed to be
|
|
||||||
included in the License; this License is not intended to restrict the
|
|
||||||
license of any rights under applicable law.
|
|
||||||
98
README.md
98
README.md
|
|
@ -1,93 +1,27 @@
|
||||||
# dyndnsd
|
# CloudFlare DDNS update tool
|
||||||
|
|
||||||
This is a simple daemon that runs in the background and checks for your public
|
|
||||||
IP regularily. If it changes, the service sets the corresponding DNS record. The
|
|
||||||
service supports both IPv4 and IPv6 addresses.
|
|
||||||
|
|
||||||
## Installation
|
This is a simple CLI you can use to continuously update an A DNS record for a domain using CloudFlare's free DDNS service.
|
||||||
|
|
||||||
Use the package manager [cargo](https://doc.rust-lang.org/cargo/) to install
|
## Options
|
||||||
dyndnsd.
|
|
||||||
|
|
||||||
```bash
|
```
|
||||||
cargo install dyndnsd
|
-k, --key <auth-key> The auth key you need to generate in your Cloudflare profile
|
||||||
|
-c, --cache <cache> Cache file for previously reported IP address (if skipped the IP will be reported on every execution)
|
||||||
|
-d, --domain <domain> The domain for which you want to report the current IP address
|
||||||
|
-e, --email <email> Your Cloudflare login email
|
||||||
|
-z, --zone <zone> The zone in which your domain is (usually that is your base domain name)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Cloudflare Setup
|
||||||
### Config
|
|
||||||
|
|
||||||
`dyndnsd` expects to find a config file at `/etc/dyndnsd/config.toml`.
|
You need to do some preparatory work in Cloudflare. Firstly this assumes you're using Cloudflare already to manage the DNS records for your domain.
|
||||||
|
|
||||||
As you can see from the path, the configuration should be a toml file. A sample
|
### Initial DNS setup
|
||||||
could look like this:
|
|
||||||
|
|
||||||
```toml
|
You need to add a type `A` DNS record for your domain. The `Name` field you should fill in with the name of the subdomain. If you don't want to use a subdomain just type `@` then the base domain will be used. Then change the `Proxy status` field to be not `Proxied` but `DNS only`. This will allow you to input `0.0.0.0` in the `IPv4 Address` field. Then click the save button. You might need to wait sometime before the DNS record propagates.
|
||||||
zone = "example.com"
|
|
||||||
domain = "example.example.com"
|
|
||||||
ipv4 = true # defaults to true
|
|
||||||
ipv6 = true # defaults to false
|
|
||||||
interval = 15 # seconds, defaults to 60
|
|
||||||
|
|
||||||
# You can use cloudflare
|
### API key
|
||||||
[dns_provider_config.cloudflare]
|
|
||||||
secret = "secretkey"
|
|
||||||
|
|
||||||
# Or you can use RFC 2136 with TSIG
|
We need to authenticate ourselves in front of the Cloudflare API. To do so we need to an auth key to pass along as a password together with our login email. You can find the global API key in `My profile > API Tokens`.
|
||||||
[dns_provider_config.rfc2136]
|
|
||||||
addr = "udp://1.2.3.4:53"
|
|
||||||
key_name = "test"
|
|
||||||
key = "test"
|
|
||||||
algorithm = "hmac-sha256"
|
|
||||||
```
|
|
||||||
|
|
||||||
As you can see, we have a token here. This token needs to have access to at
|
|
||||||
least:
|
|
||||||
- reading you account zones (for getting the zone ID from the zone name)
|
|
||||||
- reading and writing to the DNS zone (for first fetching the records and then
|
|
||||||
modifying them.
|
|
||||||
|
|
||||||
Aside of the token, you also have to prepare some DNS records before running
|
|
||||||
this: If you enabled IPv4 support, there needs to be a DNS `A` record for the
|
|
||||||
configured domain already, and if you enabled IPv6 support, you need a DNS
|
|
||||||
`AAAA` record set on the configured domain. The service will not create new
|
|
||||||
records, it just modifies existing records.
|
|
||||||
|
|
||||||
### Running
|
|
||||||
|
|
||||||
To run the service, just call the binary. You can optionally set the `RUST_LOG`
|
|
||||||
env var to configure the log level:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
RUST_LOG=info dyndnsd
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
||||||
|
|
||||||
Please make sure to update tests as appropriate.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
dyndnsd is cooperative non-violent software: you can use,
|
|
||||||
redistribute, and/or modify it under the terms of the CNPLv7+ as found in the
|
|
||||||
`LICENSE.md` file in the source code root directory or at
|
|
||||||
<https://git.pixie.town/thufie/npl-builder>.
|
|
||||||
|
|
||||||
dyndnsd comes with ABSOLUTELY NO WARRANTY, to the extent
|
|
||||||
permitted by applicable law. See `LICENSE.md` for details.
|
|
||||||
|
|
||||||
[CNPLv7+](https://thufie.lain.haus/NPL.html)
|
|
||||||
|
|
||||||
## Attribution
|
|
||||||
|
|
||||||
This work is derived from
|
|
||||||
[cloudflare-ddns](https://github.com/zbrox/cloudflare-ddns), a commandline
|
|
||||||
utility fullfilling the same purpose. It's written by Rostislav Raykov
|
|
||||||
<z@zbrox.org> and available under the MIT license at the link above.
|
|
||||||
|
|
||||||
This fork has made major changes to the project, to the extent where most of
|
|
||||||
the code has been rewritten and the tool is quite different:
|
|
||||||
- Runs as a service instead of in a cron job
|
|
||||||
- Supports IPv6
|
|
||||||
- Homegrown Cloudflare API client has been replaced with a library which
|
|
||||||
supports multiple providers
|
|
||||||
74
cliff.toml
74
cliff.toml
|
|
@ -1,74 +0,0 @@
|
||||||
# configuration file for git-cliff (0.1.0)
|
|
||||||
|
|
||||||
[changelog]
|
|
||||||
# changelog header
|
|
||||||
header = """
|
|
||||||
# Changelog\n
|
|
||||||
All notable changes to this project will be documented in this file.\n
|
|
||||||
"""
|
|
||||||
# template for the changelog body
|
|
||||||
# https://tera.netlify.app/docs/#introduction
|
|
||||||
body = """
|
|
||||||
{% if version %}\
|
|
||||||
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
|
||||||
{% else %}\
|
|
||||||
## [unreleased]
|
|
||||||
{% endif %}\
|
|
||||||
{% for group, commits in commits | group_by(attribute="group") %}
|
|
||||||
### {{ group | upper_first }}
|
|
||||||
{% for commit in commits %}
|
|
||||||
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
|
|
||||||
{% endfor %}
|
|
||||||
{% endfor %}\n
|
|
||||||
"""
|
|
||||||
# remove the leading and trailing whitespace from the template
|
|
||||||
trim = true
|
|
||||||
# changelog footer
|
|
||||||
footer = """
|
|
||||||
<!-- generated by git-cliff -->
|
|
||||||
<!-- update with `git cliff --tag <new version> 7cf8502fb9d0c04bab48a2d7d7e819c98f9aed6e.. > CHANGELOG.md` -->
|
|
||||||
"""
|
|
||||||
|
|
||||||
[git]
|
|
||||||
# parse the commits based on https://www.conventionalcommits.org
|
|
||||||
conventional_commits = true
|
|
||||||
# filter out the commits that are not conventional
|
|
||||||
filter_unconventional = true
|
|
||||||
# process each line of a commit as an individual commit
|
|
||||||
split_commits = false
|
|
||||||
# regex for preprocessing the commit messages
|
|
||||||
commit_preprocessors = [
|
|
||||||
# { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers
|
|
||||||
]
|
|
||||||
# regex for parsing and grouping commits
|
|
||||||
commit_parsers = [
|
|
||||||
{ message = "^feat", group = "Features"},
|
|
||||||
{ message = "^fix", group = "Bug Fixes"},
|
|
||||||
{ message = "^doc", group = "Documentation"},
|
|
||||||
{ message = "^perf", group = "Performance"},
|
|
||||||
{ message = "^refactor", group = "Refactor"},
|
|
||||||
{ message = "^style", group = "Styling"},
|
|
||||||
{ message = "^test", group = "Testing"},
|
|
||||||
{ message = "^chore\\(release\\): prepare for", skip = true},
|
|
||||||
{ message = "^chore", group = "Miscellaneous Tasks"},
|
|
||||||
{ body = ".*security", group = "Security"},
|
|
||||||
]
|
|
||||||
# protect breaking changes from being skipped due to matching a skipping commit_parser
|
|
||||||
protect_breaking_commits = false
|
|
||||||
# filter out the commits that are not matched by commit parsers
|
|
||||||
filter_commits = false
|
|
||||||
# glob pattern for matching git tags
|
|
||||||
tag_pattern = "v[0-9]*"
|
|
||||||
# regex for skipping tags
|
|
||||||
skip_tags = "v0.1.0-beta.1"
|
|
||||||
# regex for ignoring tags
|
|
||||||
ignore_tags = ""
|
|
||||||
# sort the tags topologically
|
|
||||||
topo_order = false
|
|
||||||
# sort the commits inside sections by oldest/newest order
|
|
||||||
sort_commits = "oldest"
|
|
||||||
# limit the number of commits included in the changelog.
|
|
||||||
# limit_commits = 42
|
|
||||||
|
|
||||||
[bump]
|
|
||||||
breaking_always_bump_major = false
|
|
||||||
19
src/file.rs
Normal file
19
src/file.rs
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
use failure::Error;
|
||||||
|
use std::fs::File;
|
||||||
|
use std::io::prelude::*;
|
||||||
|
use std::path::PathBuf;
|
||||||
|
|
||||||
|
pub fn read_cache_file(path: &PathBuf) -> Result<String, Error> {
|
||||||
|
let mut file = File::open(&path)?;
|
||||||
|
let mut s = String::new();
|
||||||
|
file.read_to_string(&mut s)?;
|
||||||
|
|
||||||
|
Ok(s.clone())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn write_cache_file(path: &PathBuf, ip: &str) -> Result<(), Error> {
|
||||||
|
let mut file = File::create(&path)?;
|
||||||
|
file.write_all(ip.as_bytes())?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
226
src/main.rs
226
src/main.rs
|
|
@ -1,177 +1,85 @@
|
||||||
// Copyright (C) 2021-2024 Jan Christian Grünhage <jan.christian@gruenhage.xyz>
|
mod file;
|
||||||
//
|
mod network;
|
||||||
// This file is part of dyndnsd.
|
|
||||||
//
|
|
||||||
// dyndnsd is non-violent software: you can use, redistribute, and/or modify it
|
|
||||||
// under the terms of the CNPLv7+ as found in the LICENSE.md file in the source code root directory
|
|
||||||
// or at <https://git.pixie.town/thufie/npl-builder>.
|
|
||||||
//
|
|
||||||
// dyndnsd comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable
|
|
||||||
// law. See the LICENSE.md for details.
|
|
||||||
|
|
||||||
use anyhow::{bail, Context, Result};
|
use file::{read_cache_file, write_cache_file};
|
||||||
use dns_update::{DnsRecord, DnsUpdater, DnsUpdaterConfig};
|
use human_panic::setup_panic;
|
||||||
use serde::{Deserialize, Serialize};
|
use network::{get_current_ip, get_dns_record_id, get_zone_identifier, update_ddns};
|
||||||
use tokio::time::interval;
|
use quicli::prelude::*;
|
||||||
use toml::{from_str, to_string};
|
use std::path::PathBuf;
|
||||||
|
use structopt::StructOpt;
|
||||||
|
|
||||||
use std::{
|
#[derive(Debug, StructOpt)]
|
||||||
fs::{create_dir_all, read_to_string, File},
|
/// Inform Cloudflare's DDNS service of the current IP address for your domain
|
||||||
io::Write,
|
struct Cli {
|
||||||
net::{Ipv4Addr, Ipv6Addr},
|
/// Your Cloudflare login email
|
||||||
path::PathBuf,
|
#[structopt(long = "email", short = "e")]
|
||||||
time::Duration,
|
email: String,
|
||||||
};
|
|
||||||
|
|
||||||
#[derive(Serialize, Deserialize)]
|
/// The auth key you need to generate in your Cloudflare profile
|
||||||
struct Config {
|
#[structopt(long = "key", short = "k")]
|
||||||
dns_provider_config: DnsUpdaterConfig,
|
auth_key: String,
|
||||||
|
|
||||||
|
/// The zone in which your domain is (usually that is your base domain name)
|
||||||
|
#[structopt(long = "zone", short = "z")]
|
||||||
zone: String,
|
zone: String,
|
||||||
|
|
||||||
|
/// The domain for which you want to report the current IP address
|
||||||
|
#[structopt(long = "domain", short = "d")]
|
||||||
domain: String,
|
domain: String,
|
||||||
#[serde(default = "yes")]
|
|
||||||
ipv4: bool,
|
/// Cache file for previously reported IP address (if skipped the IP will be reported on every execution)
|
||||||
#[serde(default = "no")]
|
#[structopt(long = "cache", short = "c")]
|
||||||
ipv6: bool,
|
cache: Option<PathBuf>,
|
||||||
#[serde(default = "default_duration")]
|
|
||||||
interval: u64,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Serialize, Deserialize, Default)]
|
fn main() -> CliResult {
|
||||||
struct Cache {
|
setup_panic!();
|
||||||
v4: Option<Ipv4Addr>,
|
|
||||||
v6: Option<Ipv6Addr>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tokio::main]
|
let args = Cli::from_args();
|
||||||
async fn main() -> Result<()> {
|
let should_use_cache = args.cache.is_some();
|
||||||
env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();
|
|
||||||
|
|
||||||
let config_string =
|
let cached_ip: Option<String> = match args.cache.clone() {
|
||||||
read_to_string("/etc/dyndnsd/config.toml").context("couldn't read config file!")?;
|
Some(v) => {
|
||||||
let config: Config = from_str(&config_string).context("Failed to parse config file")?;
|
if v.exists() {
|
||||||
let cache_dir = PathBuf::from("/var/cache/dyndnsd");
|
Some(read_cache_file(&v.clone())?)
|
||||||
let cache_path = cache_dir.join("cache.toml");
|
} else {
|
||||||
let mut cache = match read_to_string(&cache_path).map(|str| from_str(&str)) {
|
Some("0.0.0.0".to_owned())
|
||||||
Ok(Ok(cache)) => cache,
|
}
|
||||||
_ => {
|
|
||||||
create_dir_all(cache_dir)?;
|
|
||||||
Cache::default()
|
|
||||||
}
|
}
|
||||||
|
None => None,
|
||||||
};
|
};
|
||||||
|
|
||||||
let mut interval = interval(Duration::new(config.interval, 0));
|
let current_ip = get_current_ip()?;
|
||||||
let mut dns_updater: DnsUpdater = config
|
if cached_ip.is_some() && current_ip == cached_ip.unwrap() {
|
||||||
.dns_provider_config
|
println!("IP is unchanged. Exiting...");
|
||||||
.clone()
|
return Ok(());
|
||||||
.try_into()
|
|
||||||
.context("Failed to initiate DNS updater")?;
|
|
||||||
loop {
|
|
||||||
if let Err(error) = update(&config, &mut cache, &cache_path, &mut dns_updater).await {
|
|
||||||
log::error!("Failed to update record: {}", error);
|
|
||||||
}
|
|
||||||
interval.tick().await;
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
async fn update(
|
if should_use_cache {
|
||||||
config: &Config,
|
println!(
|
||||||
cache: &mut Cache,
|
"Saving current IP {} to cache file {:?}...",
|
||||||
cache_path: &PathBuf,
|
¤t_ip,
|
||||||
dns_updater: &mut DnsUpdater,
|
&args.cache.clone().unwrap()
|
||||||
) -> Result<()> {
|
);
|
||||||
let mut records = Vec::new();
|
write_cache_file(&args.cache.unwrap(), ¤t_ip)?;
|
||||||
let mut update_required = false;
|
|
||||||
|
|
||||||
if config.ipv4 {
|
|
||||||
let current = public_ip::addr_v4()
|
|
||||||
.await
|
|
||||||
.context("Failed to query current IPv4 address")?;
|
|
||||||
log::debug!("fetched current IP: {}", current.to_string());
|
|
||||||
records.push((
|
|
||||||
&config.domain,
|
|
||||||
DnsRecord::A { content: current },
|
|
||||||
300,
|
|
||||||
&config.zone,
|
|
||||||
));
|
|
||||||
match cache.v4 {
|
|
||||||
Some(old) if old == current => {
|
|
||||||
log::debug!("ipv4 unchanged, continuing...");
|
|
||||||
}
|
|
||||||
_ => {
|
|
||||||
log::info!("ipv4 changed, setting record");
|
|
||||||
update_required = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if config.ipv6 {
|
|
||||||
let current = public_ip::addr_v6()
|
|
||||||
.await
|
|
||||||
.context("Failed to query current IPv4 address")?;
|
|
||||||
log::debug!("fetched current IP: {}", current.to_string());
|
|
||||||
records.push((
|
|
||||||
&config.domain,
|
|
||||||
DnsRecord::AAAA { content: current },
|
|
||||||
300,
|
|
||||||
&config.zone,
|
|
||||||
));
|
|
||||||
match cache.v6 {
|
|
||||||
Some(old) if old == current => {
|
|
||||||
log::debug!("ipv6 unchanged, continuing...")
|
|
||||||
}
|
|
||||||
_ => {
|
|
||||||
log::info!("ipv6 changed, setting record");
|
|
||||||
update_required = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if update_required {
|
let zone_id = get_zone_identifier(&args.zone, &args.email, &args.auth_key)?;
|
||||||
dns_updater.delete(&config.domain, &config.zone).await?;
|
let record_id = get_dns_record_id(&zone_id, &args.domain, &args.email, &args.auth_key)?;
|
||||||
for record in records {
|
|
||||||
let cloned_record = match record.1 {
|
update_ddns(
|
||||||
DnsRecord::A { content } => DnsRecord::A { content },
|
¤t_ip,
|
||||||
DnsRecord::AAAA { content } => DnsRecord::AAAA { content },
|
&args.domain,
|
||||||
_ => bail!("This code should be unreachable"),
|
&zone_id,
|
||||||
};
|
&record_id,
|
||||||
dns_updater
|
&args.email,
|
||||||
.create(record.0, record.1, record.2, record.3)
|
&args.auth_key,
|
||||||
.await?;
|
)?;
|
||||||
match cloned_record {
|
|
||||||
DnsRecord::A { content } => {
|
println!(
|
||||||
cache.v4 = Some(content);
|
"Successfully updated the A record for {} to {}",
|
||||||
write_cache(cache, cache_path)
|
&args.domain, ¤t_ip
|
||||||
.context("Failed to write current IPv4 address to cache")?;
|
);
|
||||||
}
|
|
||||||
DnsRecord::AAAA { content } => {
|
|
||||||
cache.v6 = Some(content);
|
|
||||||
write_cache(cache, cache_path)
|
|
||||||
.context("Failed to write current IPv4 address to cache")?;
|
|
||||||
}
|
|
||||||
_ => {}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn write_cache(cache: &mut Cache, cache_path: &PathBuf) -> Result<()> {
|
|
||||||
let cache_str = to_string(cache).context("Failed to serialize cache file")?;
|
|
||||||
let mut cache_file =
|
|
||||||
File::create(cache_path).context("Failed to open cache file for writing")?;
|
|
||||||
cache_file
|
|
||||||
.write_all(cache_str.as_bytes())
|
|
||||||
.context("Failed to serialize cache into file")?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn yes() -> bool {
|
|
||||||
true
|
|
||||||
}
|
|
||||||
|
|
||||||
fn no() -> bool {
|
|
||||||
false
|
|
||||||
}
|
|
||||||
|
|
||||||
fn default_duration() -> u64 {
|
|
||||||
60
|
|
||||||
}
|
|
||||||
|
|
|
||||||
132
src/network.rs
Normal file
132
src/network.rs
Normal file
|
|
@ -0,0 +1,132 @@
|
||||||
|
use failure::{format_err, Error};
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
#[derive(Deserialize, Debug)]
|
||||||
|
struct CloudflareListResponse {
|
||||||
|
success: bool,
|
||||||
|
errors: Vec<String>,
|
||||||
|
result: Vec<ObjectWithId>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Deserialize, Debug)]
|
||||||
|
struct CloudflareUpdateResponse {
|
||||||
|
success: bool,
|
||||||
|
errors: Vec<String>,
|
||||||
|
result: ObjectWithId,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Deserialize, Debug, PartialEq)]
|
||||||
|
struct ObjectWithId {
|
||||||
|
id: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Debug)]
|
||||||
|
struct UpdateIpData {
|
||||||
|
id: String,
|
||||||
|
r#type: String,
|
||||||
|
name: String,
|
||||||
|
content: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn get_zone_identifier(zone: &str, email: &str, key: &str) -> Result<String, Error> {
|
||||||
|
let client = reqwest::Client::new();
|
||||||
|
let url = format!("https://api.cloudflare.com/client/v4/zones?name={}", zone);
|
||||||
|
let response: CloudflareListResponse = client
|
||||||
|
.get(&url)
|
||||||
|
.header("X-Auth-Email", email)
|
||||||
|
.header("X-Auth-Key", key)
|
||||||
|
.header("Content-Type", "application/json")
|
||||||
|
.send()?
|
||||||
|
.json()?;
|
||||||
|
if !response.success {
|
||||||
|
let err: String = response
|
||||||
|
.errors
|
||||||
|
.iter()
|
||||||
|
.map(|s| format!("{}\n", s.to_owned()))
|
||||||
|
.collect();
|
||||||
|
return Err(format_err!("API Error: {}", err));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(response.result[0].id.clone())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn get_dns_record_id(
|
||||||
|
zone_id: &str,
|
||||||
|
domain: &str,
|
||||||
|
email: &str,
|
||||||
|
key: &str,
|
||||||
|
) -> Result<String, Error> {
|
||||||
|
let client = reqwest::Client::new();
|
||||||
|
let url = format!(
|
||||||
|
"https://api.cloudflare.com/client/v4/zones/{}/dns_records?name={}",
|
||||||
|
zone_id, domain
|
||||||
|
);
|
||||||
|
let response: CloudflareListResponse = client
|
||||||
|
.get(&url)
|
||||||
|
.header("X-Auth-Email", email)
|
||||||
|
.header("X-Auth-Key", key)
|
||||||
|
.header("Content-Type", "application/json")
|
||||||
|
.send()?
|
||||||
|
.json()?;
|
||||||
|
if !response.success {
|
||||||
|
let err: String = response
|
||||||
|
.errors
|
||||||
|
.iter()
|
||||||
|
.map(|s| format!("{}\n", s.to_owned()))
|
||||||
|
.collect();
|
||||||
|
return Err(format_err!("API Error: {}", err));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(response.result[0].id.clone())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn get_current_ip() -> Result<String, Error> {
|
||||||
|
Ok(reqwest::Client::new()
|
||||||
|
.get("http://ipv4.icanhazip.com")
|
||||||
|
.send()?
|
||||||
|
.text()?
|
||||||
|
.trim()
|
||||||
|
.into())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn update_ddns(
|
||||||
|
ip: &str,
|
||||||
|
domain: &str,
|
||||||
|
zone_id: &str,
|
||||||
|
record_id: &str,
|
||||||
|
email: &str,
|
||||||
|
key: &str,
|
||||||
|
) -> Result<(), Error> {
|
||||||
|
let client = reqwest::Client::new();
|
||||||
|
let url = format!(
|
||||||
|
"https://api.cloudflare.com/client/v4/zones/{}/dns_records/{}",
|
||||||
|
zone_id, record_id
|
||||||
|
);
|
||||||
|
|
||||||
|
let update_data = UpdateIpData {
|
||||||
|
id: zone_id.to_owned(),
|
||||||
|
r#type: "A".to_owned(),
|
||||||
|
name: domain.to_owned(),
|
||||||
|
content: ip.to_owned(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let response: CloudflareUpdateResponse = client
|
||||||
|
.put(&url)
|
||||||
|
.header("X-Auth-Email", email)
|
||||||
|
.header("X-Auth-Key", key)
|
||||||
|
.header("Content-Type", "application/json")
|
||||||
|
.json(&update_data)
|
||||||
|
.send()?
|
||||||
|
.json()?;
|
||||||
|
|
||||||
|
if !response.success {
|
||||||
|
let err: String = response
|
||||||
|
.errors
|
||||||
|
.iter()
|
||||||
|
.map(|s| format!("{}\n", s.to_owned()))
|
||||||
|
.collect();
|
||||||
|
return Err(format_err!("Unsuccessful update of DNS record: {}", err));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue