jcgruenhage/dyndnsd
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 2 Wiki Activity

chore: fork and rename

Browse source 
I'm forking this, with the following changes:
 - daemon instead of CLI tool run via cron
 - mandatory config file
 - use cloudflare crate instead of home grown API client
 - IPv6 support
 - CNPLv6+ licensed instead of MIT licensed
This commit is contained in:
Jan Christian Grünhage 2021-05-23 15:22:21 +02:00
parent 7cf8502fb9
commit 5f25f85a5e
11 changed files with 1814 additions and 1473 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
.github/workflows/build.yml vendored
View file

@ -1,22 +0,0 @@
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
View file

@ -1,88 +0,0 @@
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 }}.tar.xz
cloudflare-ddns-ubuntu-${{ steps.get_version.outputs.VERSION }}.tar.xz
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

1
.gitignore vendored
View file

@ -1,3 +1,2 @@
/target
**/*.rs.bk
.envrc

50
.vscode/launch.json vendored
View file

@ -1,50 +0,0 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.3.0",
"configurations": [
{
"type": "lldb",
"request": "launch",
"name": "Debug 'cloudflare-ddns'",
"cargo": {
"args": [
"build",
"--bin=cloudflare-ddns",
"--package=cloudflare-ddns"
],
"filter": {
"name": "cloudflare-ddns",
"kind": "bin"
}
},
"args": [
"--key=${env:DDNS_AUTH_KEY}",
"--domain=${env:DOMAIN}",
"--email=${env:EMAIL}",
"--zone=${env:ZONE}"
],
"cwd": "${workspaceFolder}"
},
{
"type": "lldb",
"request": "launch",
"name": "Debug unit tests in 'cloudflare-ddns'",
"cargo": {
"args": [
"test",
"--no-run",
"--bin=cloudflare-ddns",
"--package=cloudflare-ddns"
],
"filter": {
"name": "cloudflare-ddns",
"kind": "bin"
}
},
"args": [],
"cwd": "${workspaceFolder}"
}
]
}

1942
Cargo.lock generated
View file

File diff suppressed because it is too large Load diff

38
Cargo.toml
View file

@ -1,26 +1,24 @@
[package]
name = "cloudflare-ddns"
version = "0.3.0"
authors = ["Rostislav Raykov <z@zbrox.org>"]
name = "cloudflare-ddns-service"
version = "0.4.0"
authors = ["Jan Christian Grünhage <jan.christian@gruenhage.xyz>"]
edition = "2018"
description = "A simple CLI tool to use Cloudflare's free DDNS service"
repository = "https://github.com/zbrox/cloudflare-ddns"
homepage = "https://github.com/zbrox/cloudflare-ddns"
keywords = ["cloudflare", "ddns", "cli"]
description = "A daemon to use Cloudflare as a DDNS provider"
repository = "https://git.jcg.re/jcgruenhage/cloudflare-ddns-service"
homepage = "https://git.jcg.re/jcgruenhage/cloudflare-ddns-service"
keywords = ["cloudflare", "ddns"]
categories = ["command-line-utilities"]
license = "MIT"
documentation = "https://github.com/zbrox/cloudflare-ddns"
license-file = "LICENSE"
documentation = "https://git.jcg.re/jcgruenhage/cloudflare-ddns-service"
readme = "README.md"
[dependencies]
quicli = "0.4.0"
structopt = "0.3.13"
reqwest= { version = "0.10.4", features = ["blocking", "json"] }
serde = "1.0.106"
serde_json = "1.0.51"
toml = "0.5.6"
human-panic = "1.0.3"
serde_derive = "1.0.106"
anyhow = "1.0.28"
env_logger = "0.7.1"
log = "0.4.8"
reqwest= { version = "0.11.3", features = ["blocking", "json"] }
serde = { version = "1.0.126", features = ["derive"] }
anyhow = "1.0.40"
env_logger = "0.8.3"
log = "0.4.14"
directories-next = "2.0.0"
tokio = { version = "1.6.0", features = ["time", "macros", "rt-multi-thread"] }
serde_yaml = "0.8.17"
cloudflare = "0.8.2"

539
LICENSE
View file

@ -1,21 +1,526 @@
MIT License
cloudflare-ddns-service
Copyright (c) 2019 Rostislav Raykov <z@zbrox.org>
Copyright Jan Christian Grünhage <jan.christian@gruenhage.xyz> 2020-2021
Copyright Rostislav Raykov <z@zbrox.org> 2019
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:
COOPERATIVE NON-VIOLENT PUBLIC LICENSE v6
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
Preamble
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.
The Cooperative Non-Violent Public license is a freedom-respecting sharealike
license for both the author of a work as well as those subject to a work.
It aims to protect the basic rights of human beings from exploitation,
the earth from plunder, and the equal treatment of the workers involved in the
creation of the work. It aims to ensure a copyrighted work is forever
available for public use, modification, and redistribution under the same
terms so long as the work is not used for harm. For more information about
the CNPL refer to the official webpage
Official Webpage: https://thufie.lain.haus/NPL.html
Terms and Conditions
THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS
COOPERATIVE NON-VIOLENT PUBLIC LICENSE v5 ("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.
1. DEFINITIONS
a. "Act of War" means 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.
b. "Adaptation" means 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.
c. "Bodily Harm" means 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.
d. "Collection" means a collection of literary or artistic
works, such as encyclopedias and anthologies, or performances,
phonograms or broadcasts, or other works or subject matter other
than works listed in Section 1(i) below, which, by reason of the
selection and arrangement of their contents, constitute
intellectual creations, in which the Work is included in its
entirety in unmodified form along with one or more other
contributions, each constituting separate and independent works
in themselves, which together are assembled into a collective
whole. A work that constitutes a Collection will not be
considered an Adaptation (as defined above) for the purposes of
this License.
e. "Distribute" means 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.
f. "Incarceration" means 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.
g. "Licensor" means the individual, individuals, entity or
entities that offer(s) the Work under the terms of this License.
h. "Original Author" means, 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 (i) 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; (ii) 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, (iii) in the case of
broadcasts, the organization that transmits the broadcast.
i. "Work" means 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.
j. "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.
k. "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.
l. "Reproduce" means 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.
m. "Software" means 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.
n. "Source Code" means the human-readable form of Software
through which the Original Author and/or Distributor originally
created, derived, and/or modified it.
o. "Surveilling" means the use of the Work to either
overtly or covertly observe and record persons and or their
activities.
p. "Network Service" means the use of a piece of Software to
interpret or modify information that is subsequently and directly
served to users over the Internet.
q. "Discriminate" means the 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.
r. "Hate Speech" means communication or any form
of expression which is solely for the purpose of expressing hatred
for some group or advocating a form of Discrimination
(to Discriminate per definition in (q)) between humans.
s. "Coercion" means 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.
2. 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.
3. 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:
a. to Reproduce the Work, to incorporate the Work into one or
more Collections, and to Reproduce the Work as incorporated in
the Collections;
b. 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.";
c. to Distribute and Publicly Perform the Work including as
incorporated in Collections; and,
d. 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. Subject to
Section 8(g), all rights not expressly granted by Licensor are
hereby reserved, including but not limited to the rights set
forth in Section 4(i).
4. RESTRICTIONS
The license granted in Section 3 above is expressly made subject to and
limited by the following restrictions:
a. 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 4(a)
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
required by Section 4(h), 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
required by Section 4(h), as requested.
b. Subject to the exception in Section 4(e), you may not
exercise any of the rights granted to You in Section 3 above in
any manner that is primarily intended for or directed toward
commercial advantage or private monetary compensation. 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.
c. If the Work meets the definition of Software, You may exercise
the rights granted in Section 3 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.
d. If the Work is used as or for a Network Service, You may exercise
the rights granted in Section 3 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.
e. You may exercise the rights granted in Section 3 for
commercial purposes only if:
i. You are a worker-owned business or worker-owned
collective; and
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 4(e.i) and elaborated upon in
4(e.ii), 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.
f. 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.
g. You may exercise the rights granted in Section 3 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, or lower economic status.
h. If You Distribute, or Publicly Perform the Work or any
Adaptations or Collections, You must, unless a request has been
made pursuant to Section 4(a), 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) consistent with Section 3(b), 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"). The credit required by this Section 4(h) 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.
i. For the avoidance of doubt:
i. 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;
ii. 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 Section 4(b) and
otherwise waives the right to collect royalties through
any statutory or compulsory licensing scheme; and,
iii.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
Section 4(b).
j. 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
Section 3(b) 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 Section 3(b) of this License (right to
make Adaptations) but not otherwise.
k. 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.
5. 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.
6. 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.
7. TERMINATION
a. 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. Sections
1, 2, 5, 6, 7, and 8 will survive any termination of this
License.
b. 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.
8. REVISED LICENSE VERSIONS
a. 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.
b. Unless otherwise specified like in Section 8(c) The Licensor
has only granted this current version of This License for The Work.
In this case future revisions do not apply.
c. 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.
d. 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.
9. MISCELLANEOUS
a. 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.
b. 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.
c. 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.
d. 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.
e. 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.
f. 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.
g. 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.
h. 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.

91
README.md
View file

@ -1,39 +1,84 @@
# CloudFlare DDNS update tool
# Cloudflare DDNS service
![](https://github.com/zbrox/cloudflare-ddns/workflows/Build/badge.svg)
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.
This is a simple CLI you can use to continuously update an A DNS record for a domain using CloudFlare's free DDNS service.
## Installation
## Options
Use the package manager [cargo](https://doc.rust-lang.org/cargo/) to install
Cloudflare DDNS service.
```
-t, --token <api-token> The API token 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)
-f, --config <config> Your TOML config file containing all the required options (email, auth_key, zone, domain)
which you can use instead of passing the arguments to the command line
-d, --domain <domain> The domain for which you want to report the current IP address
-z, --zone <zone> The zone in which your domain is (usually that is your base domain name)
```bash
cargo install cloudflare-ddns-service
```
## Usage
### Config
You Can pass a path to a configuration file (`-f` or `--config`) instead of each option as a command line argument. The configuration should be a [TOML](https://github.com/toml-lang/toml) file and hold the same options. Here's a sample:
The services adheres to the XDG spec for locating the config file. In most
cases, that means the config file is located at
`~/.config/cloudflare-ddns-service/config.yaml`.
```TOML
api_token = "secretkey"
domain = "example.example.com"
zone = "example.com"
As you can see from the path, the configuration should be a yaml file. A sample
could look like this:
```yaml
api_token: "secretkey"
zone: "example.com"
domain: "example.example.com"
ipv4: true # defaults to true
ipv6: true # defaults to false
interval: 15 # seconds, defaults to 60
```
## Cloudflare Setup
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.
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.
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.
### Initial DNS setup
### Running
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.
To run the service, just call the binary. You can optionally set the `RUST_LOG`
env var to configure the log level:
### API token
```bash
RUST_LOG=info cloudflare-ddns-service
```
We need to authenticate ourselves in front of the Cloudflare API. To do so we need to an API token to pass along with every request. You can generate an API token to use specifically with this application on Cloudflare in `My profile > API Tokens > Create Token`.
## 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
cloudflare-ddns-service is cooperative non-violent software: you can use,
redistribute, and/or modify it under the terms of the CNPLv6+ as found in the
LICENSE file in the source code root directory or at
<https://git.pixie.town/thufie/CNPL>.
cloudflare-ddns-service comes with ABSOLUTELY NO WARRANTY, to the extent
permitted by applicable law. See `LICENSE` for details.
[CNPLv6+](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 been made to severly refactor the utility (have it running
constantly instead of running it in cron, for supporting IPv6, and for not using
a homegrown Cloudflare API client but the library provided by Cloudflare
themselves). Due to the nature of these changes, I have not sent a PR, as it
makes this basically a separate tool and nearly all code has been rewritten.

18
src/file.rs
View file

@ -1,18 +0,0 @@
use std::fs::File;
use std::io::prelude::*;
use std::path::PathBuf;
use anyhow::Result;
pub fn read_file(path: &PathBuf) -> Result<String> {
let mut file = File::open(path)?;
let mut contents = String::new();
file.read_to_string(&mut contents)?;
Ok(contents)
}
pub fn write_file(path: &PathBuf, ip: &str) -> Result<()> {
let mut file = File::create(path)?;
file.write_all(ip.as_bytes())?;
Ok(())
}

234
src/main.rs
View file

@ -1,117 +1,163 @@
mod file;
mod network;
use file::{read_file, write_file};
use human_panic::setup_panic;
use network::{get_current_ip, get_dns_record_id, get_zone_identifier, update_ddns};
use quicli::prelude::*;
use std::path::PathBuf;
use structopt::StructOpt;
use anyhow::{Context, Result};
use directories_next::ProjectDirs;
use network::{get_current_ipv4, get_current_ipv6, get_record, get_zone, update_record};
use serde::{Deserialize, Serialize};
use serde_yaml::{from_str, to_writer};
use std::{
fs::{create_dir_all, read_to_string, File},
net::{Ipv4Addr, Ipv6Addr},
path::PathBuf,
time::Duration,
};
use tokio::time::interval;
#[derive(Deserialize)]
use cloudflare::{
endpoints::dns::DnsContent,
framework::{
async_api::Client as CfClient, auth::Credentials, Environment, HttpApiClientConfig,
},
};
use reqwest::Client as ReqwClient;
#[derive(Serialize, Deserialize)]
struct Config {
api_token: String,
zone: String,
domain: String,
#[serde(default = "yes")]
ipv4: bool,
#[serde(default = "no")]
ipv6: bool,
#[serde(default = "default_duration")]
interval: u64,
}
#[derive(Debug, StructOpt)]
/// Inform Cloudflare's DDNS service of the current IP address for your domain
struct Cli {
/// Your TOML config file containing all the required options (api_token, zone, domain) which you can use instead of passing the arguments to the command line
#[structopt(long = "config", short = "f")]
config: Option<PathBuf>,
/// The api token you need to generate in your Cloudflare profile
#[structopt(long = "token", short = "t", required_unless = "config")]
api_token: Option<String>,
/// The zone in which your domain is (usually that is your base domain name)
#[structopt(long = "zone", short = "z", required_unless = "config")]
zone: Option<String>,
/// The domain for which you want to report the current IP address
#[structopt(long = "domain", short = "d", required_unless = "config")]
domain: Option<String>,
/// Cache file for previously reported IP address (if skipped the IP will be reported on every execution)
#[structopt(long = "cache", short = "c")]
cache: Option<PathBuf>,
#[derive(Serialize, Deserialize, Default)]
struct Cache {
v4: Option<Ipv4Addr>,
v6: Option<Ipv6Addr>,
}
fn main() -> Result<()> {
setup_panic!();
let args = Cli::from_args();
#[tokio::main]
async fn main() -> Result<()> {
env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();
env_logger::from_env(env_logger::Env::default().default_filter_or("info")).init();
let should_use_cache = args.cache.is_some();
let cached_ip: Option<String> = match args.cache.clone() {
Some(v) => {
if v.exists() {
Some(read_file(&v.clone()).context("Could not read cache file")?)
} else {
Some("0.0.0.0".to_owned())
let dirs = ProjectDirs::from("re", "jcg", "cloudflare-ddns-service")
.context("Couldn't find project directories! Is $HOME set?")?;
let config_string = read_to_string(dirs.config_dir().join("config.yaml"))
.context("couldn't read config file!")?;
let config: Config = from_str(&config_string)?;
let cache_path = dirs.cache_dir().join("cache.yaml");
let mut cache = match read_to_string(&cache_path) {
Ok(cache) => from_str(&cache)?,
Err(_) => {
create_dir_all(dirs.cache_dir())?;
Cache::default()
}
}
None => None,
};
let current_ip = get_current_ip()?;
if cached_ip.is_some() && current_ip == cached_ip.unwrap() {
log::info!("IP is unchanged. Exiting...");
return Ok(());
let mut interval = interval(Duration::new(config.interval, 0));
let mut reqw_client = ReqwClient::new();
let mut cf_client = CfClient::new(
Credentials::UserAuthToken {
token: config.api_token.clone(),
},
HttpApiClientConfig::default(),
Environment::Production,
)?;
let zone = get_zone(config.zone.clone(), &mut cf_client).await?;
loop {
update(
&config,
&mut cache,
&cache_path,
&zone,
&mut reqw_client,
&mut cf_client,
)
.await?;
interval.tick().await;
}
let (api_token, zone, domain) = match args.config {
Some(c) => {
let config_str = read_file(&c)?;
let config: Config = toml::from_str(&config_str)?;
(config.api_token, config.zone, config.domain)
}
None => (
args.api_token.expect("API token is not set"),
args.zone.expect("Zone is not set"),
args.domain.expect("Domain is not set"),
),
};
update(&current_ip, &api_token, &zone, &domain)?;
log::info!(
"Successfully updated the A record for {} to {}",
&domain, &current_ip
);
if should_use_cache {
log::info!(
"Saving current IP {} to cache file {:?}...",
&current_ip,
&args.cache.clone().unwrap()
);
write_file(&args.cache.unwrap(), &current_ip)?;
}
Ok(())
}
fn update(
current_ip: &str,
api_token: &str,
async fn update(
config: &Config,
cache: &mut Cache,
cache_path: &PathBuf,
zone: &str,
domain: &str,
reqw_client: &mut ReqwClient,
cf_client: &mut CfClient,
) -> Result<()> {
let zone_id = get_zone_identifier(&zone, &api_token).context("Error getting the zone identifier")?;
let record_id = get_dns_record_id(&zone_id, &domain, &api_token).context("Error getting the DNS record ID")?;
update_ddns(
&current_ip,
&domain,
&zone_id,
&record_id,
&api_token,
).context("Error updating the DNS record")?;
if config.ipv4 {
let current = get_current_ipv4(reqw_client).await?;
log::debug!("fetched current IP: {}", current.to_string());
match cache.v4 {
Some(old) if old == current => {
log::debug!("ipv4 unchanged, continuing...");
}
_ => {
log::debug!("ipv4 changed, setting record");
let rid = get_record(zone, config.domain.clone(), network::A_RECORD, cf_client)
.await
.context("couldn't find record!")?;
log::debug!("got record ID {}", rid);
update_record(
zone,
&rid,
&config.domain,
DnsContent::A { content: current },
cf_client,
)
.await?;
cache.v4 = Some(current);
write_cache(cache, cache_path)?;
}
}
}
if config.ipv6 {
let current = get_current_ipv6(reqw_client).await?;
log::debug!("fetched current IP: {}", current.to_string());
match cache.v6 {
Some(old) if old == current => {
log::debug!("ipv6 unchanged, continuing...")
}
_ => {
log::debug!("ipv4 changed, setting record");
let rid = get_record(zone, config.domain.clone(), network::AAAA_RECORD, cf_client)
.await
.context("couldn't find record!")?;
log::debug!("got record ID {}", rid);
update_record(
zone,
&rid,
&config.domain,
DnsContent::AAAA { content: current },
cf_client,
)
.await?;
cache.v6 = Some(current);
write_cache(cache, cache_path)?;
}
}
}
Ok(())
}
fn write_cache(cache: &mut Cache, cache_path: &PathBuf) -> Result<()> {
to_writer(File::create(cache_path)?, cache)?;
Ok(())
}
fn yes() -> bool {
true
}
fn no() -> bool {
false
}
fn default_duration() -> u64 {
60
}

260
src/network.rs
View file

@ -1,171 +1,119 @@
use serde_derive::{Deserialize, Serialize};
use anyhow::{anyhow};
use std::net::{Ipv4Addr, Ipv6Addr};
#[derive(Deserialize, Debug)]
struct CloudflareListResponse {
success: bool,
errors: Vec<String>,
result: Option<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, api_token: &str) -> anyhow::Result<String> {
let client = reqwest::blocking::Client::new();
let url = format!("https://api.cloudflare.com/client/v4/zones?name={}", zone);
let response = client
.get(&url)
.header("Authorization", format!("Bearer {}", api_token))
.header("Content-Type", "application/json")
.send()?;
if response.status() != 200 {
return Err(anyhow!("API Error: HTTP {}", response.status()));
}
let body: CloudflareListResponse = response
.json()?;
if !body.success {
let err: String = body
.errors
.iter()
.map(|s| format!("{}\n", s.to_owned()))
.collect();
return Err(anyhow!("API Error: {}", err));
}
let zones = match body.result {
Some(v) => v,
None => {
return Err(anyhow!("No zones returned"))
use anyhow::{Context, Result};
use cloudflare::{
endpoints::{
dns::{
DnsContent, ListDnsRecords, ListDnsRecordsParams, UpdateDnsRecord,
UpdateDnsRecordParams,
},
};
Ok(zones[0].id.clone())
}
pub fn get_dns_record_id(
zone_id: &str,
domain: &str,
api_token: &str,
) -> anyhow::Result<String> {
let client = reqwest::blocking::Client::new();
let url = format!(
"https://api.cloudflare.com/client/v4/zones/{}/dns_records?name={}",
zone_id, domain
);
let response = client
.get(&url)
.header("Authorization", format!("Bearer {}", api_token))
.header("Content-Type", "application/json")
.send()?;
if response.status() != 200 {
return Err(anyhow!("API Error: HTTP {}", response.status()));
}
let body: CloudflareListResponse = response.json()?;
if !body.success {
let err: String = body
.errors
.iter()
.map(|s| format!("{}\n", s.to_owned()))
.collect();
return Err(anyhow!("API Error: {}", err));
}
let records = match body.result {
Some(v) => v,
None => {
return Err(anyhow!("No DNS records returned"))
zone::{ListZones, ListZonesParams},
},
};
framework::async_api::Client as CfClient,
};
use reqwest::Client as ReqwClient;
let id = match records.first() {
Some(v) => v.id.clone(),
None => {
return Err(anyhow!(
"Unexpected API result for DNS record. Check if you passed the right options."
))
}
};
pub const A_RECORD: DnsContent = DnsContent::A {
content: Ipv4Addr::UNSPECIFIED,
};
pub const AAAA_RECORD: DnsContent = DnsContent::AAAA {
content: Ipv6Addr::UNSPECIFIED,
};
Ok(id)
}
pub fn get_current_ip() -> anyhow::Result<String> {
Ok(reqwest::blocking::Client::new()
.get("http://ipv4.icanhazip.com")
.send()?
.text()?
pub async fn get_current_ipv4(client: &mut ReqwClient) -> Result<Ipv4Addr> {
Ok(client
.get("https://ipv4.icanhazip.com")
.send()
.await?
.text()
.await?
.trim()
.into())
.parse()?)
}
pub fn update_ddns(
ip: &str,
domain: &str,
zone_id: &str,
record_id: &str,
api_token: &str,
) -> anyhow::Result<()> {
let client = reqwest::blocking::Client::new();
let url = format!(
"https://api.cloudflare.com/client/v4/zones/{}/dns_records/{}",
zone_id, record_id
);
pub async fn get_current_ipv6(client: &mut ReqwClient) -> Result<Ipv6Addr> {
Ok(client
.get("https://ipv6.icanhazip.com")
.send()
.await?
.text()
.await?
.trim()
.parse()?)
}
let update_data = UpdateIpData {
id: zone_id.to_owned(),
r#type: "A".to_owned(),
name: domain.to_owned(),
content: ip.to_owned(),
};
pub async fn get_zone(domain: String, cf_client: &mut CfClient) -> Result<String> {
Ok(cf_client
.request_handle(&ListZones {
params: ListZonesParams {
name: Some(domain),
status: None,
page: None,
per_page: None,
order: None,
direction: None,
search_match: None,
},
})
.await?
.result[0]
.id
.clone())
}
let response = client
.put(&url)
.header("Authorization", format!("Bearer {}", api_token))
.header("Content-Type", "application/json")
.json(&update_data)
.send()?;
if response.status() != 200 {
return Err(anyhow!("API Error: HTTP {}", response.status()));
}
let body: CloudflareUpdateResponse = response
.json()?;
if !body.success {
let err: String = body
.errors
pub async fn get_record(
zone_identifier: &str,
domain: String,
r#type: DnsContent,
cf_client: &mut CfClient,
) -> Result<String> {
Ok(cf_client
.request_handle(&ListDnsRecords {
zone_identifier,
params: ListDnsRecordsParams {
record_type: None,
name: Some(domain),
page: None,
per_page: None,
order: None,
direction: None,
search_match: None,
},
})
.await
.context("Couldn't fetch record")?
.result
.iter()
.map(|s| format!("{}\n", s.to_owned()))
.collect();
return Err(anyhow!("Unsuccessful update of DNS record: {}", err));
.find(|record| {
if std::mem::discriminant(&record.content) == std::mem::discriminant(&r#type) {
true
} else {
false
}
})
.context("No matching record found")?
.id
.clone())
}
pub async fn update_record(
zone_identifier: &str,
identifier: &str,
name: &str,
content: DnsContent,
cf_client: &mut CfClient,
) -> Result<()> {
cf_client
.request_handle(&UpdateDnsRecord {
zone_identifier,
identifier,
params: UpdateDnsRecordParams {
ttl: None,
proxied: Some(false),
name,
content,
},
})
.await?;
Ok(())
}