Initializing commit
This commit is contained in:
undef-i
commit
62a543fe1a
|
|
@ -0,0 +1,145 @@
|
||||||
|
name: Rust
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
env:
|
||||||
|
CARGO_TERM_COLOR: always
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
# necessary for windows
|
||||||
|
shell: bash
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Cargo cache
|
||||||
|
uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.cargo/registry
|
||||||
|
./target
|
||||||
|
key: test-cargo-registry
|
||||||
|
- name: List
|
||||||
|
run: find ./
|
||||||
|
- name: Run tests
|
||||||
|
run: cargo test --verbose
|
||||||
|
|
||||||
|
build:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/')
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- TARGET: x86_64-unknown-linux-gnu # tested in a debian container on a mac
|
||||||
|
OS: ubuntu-latest
|
||||||
|
- TARGET: x86_64-unknown-linux-musl # test in an alpine container on a mac
|
||||||
|
OS: ubuntu-latest
|
||||||
|
- TARGET: aarch64-unknown-linux-gnu # tested on aws t4g.nano
|
||||||
|
OS: ubuntu-latest
|
||||||
|
#- TARGET: aarch64-unknown-linux-musl # tested on aws t4g.nano in alpine container
|
||||||
|
# OS: ubuntu-latest
|
||||||
|
- TARGET: armv7-unknown-linux-gnueabihf # raspberry pi 2-3-4, not tested
|
||||||
|
OS: ubuntu-latest
|
||||||
|
#- TARGET: armv7-unknown-linux-musleabihf # raspberry pi 2-3-4, not tested
|
||||||
|
# OS: ubuntu-latest
|
||||||
|
- TARGET: arm-unknown-linux-gnueabihf # raspberry pi 0-1, not tested
|
||||||
|
OS: ubuntu-latest
|
||||||
|
#- TARGET: arm-unknown-linux-musleabihf # raspberry pi 0-1, not tested
|
||||||
|
# OS: ubuntu-latest
|
||||||
|
- TARGET: x86_64-apple-darwin # tested on a mac, is not properly signed so there are security warnings
|
||||||
|
OS: macos-latest
|
||||||
|
#- TARGET: x86_64-pc-windows-msvc # tested on a windows machine
|
||||||
|
# OS: windows-latest
|
||||||
|
needs: test
|
||||||
|
runs-on: ${{ matrix.OS }}
|
||||||
|
env:
|
||||||
|
NAME: bird-looking-glass-proxy
|
||||||
|
TARGET: ${{ matrix.TARGET }}
|
||||||
|
OS: ${{ matrix.OS }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Cargo cache
|
||||||
|
uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.cargo/registry
|
||||||
|
./target
|
||||||
|
key: build-cargo-registry-${{matrix.TARGET}}
|
||||||
|
- name: List
|
||||||
|
run: find ./
|
||||||
|
- name: Install and configure dependencies
|
||||||
|
run: |
|
||||||
|
# dependencies are only needed on ubuntu as that's the only place where
|
||||||
|
# we make cross-compilation
|
||||||
|
if [[ $OS =~ ^ubuntu.*$ ]]; then
|
||||||
|
sudo apt-get install -qq crossbuild-essential-arm64 crossbuild-essential-armhf musl-tools
|
||||||
|
fi
|
||||||
|
# some additional configuration for cross-compilation on linux
|
||||||
|
cat >>~/.cargo/config <<EOF
|
||||||
|
[target.aarch64-unknown-linux-gnu]
|
||||||
|
linker = "aarch64-linux-gnu-gcc"
|
||||||
|
[target.aarch64-unknown-linux-musl]
|
||||||
|
linker = "aarch64-linux-gnu-gcc"
|
||||||
|
[target.armv7-unknown-linux-gnueabihf]
|
||||||
|
linker = "arm-linux-gnueabihf-gcc"
|
||||||
|
[target.armv7-unknown-linux-musleabihf]
|
||||||
|
linker = "arm-linux-gnueabihf-gcc"
|
||||||
|
[target.arm-unknown-linux-gnueabihf]
|
||||||
|
linker = "arm-linux-gnueabihf-gcc"
|
||||||
|
[target.arm-unknown-linux-musleabihf]
|
||||||
|
linker = "arm-linux-gnueabihf-gcc"
|
||||||
|
EOF
|
||||||
|
- name: Install rust target
|
||||||
|
run: rustup target add $TARGET
|
||||||
|
- name: Run build
|
||||||
|
run: cargo build --release --verbose --target $TARGET
|
||||||
|
- name: List target
|
||||||
|
run: find ./target
|
||||||
|
- name: Compress
|
||||||
|
run: |
|
||||||
|
mkdir -p ./artifacts
|
||||||
|
# windows is the only OS using a different convention for executable file name
|
||||||
|
if [[ $OS =~ ^windows.*$ ]]; then
|
||||||
|
EXEC=$NAME.exe
|
||||||
|
else
|
||||||
|
EXEC=$NAME
|
||||||
|
fi
|
||||||
|
if [[ $GITHUB_REF_TYPE =~ ^tag$ ]]; then
|
||||||
|
TAG=$GITHUB_REF_NAME
|
||||||
|
else
|
||||||
|
TAG=$GITHUB_SHA
|
||||||
|
fi
|
||||||
|
mv ./target/$TARGET/release/$EXEC ./$EXEC
|
||||||
|
tar -czf ./artifacts/$NAME-$TARGET-$TAG.tar.gz $EXEC
|
||||||
|
- name: Archive artifact
|
||||||
|
uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: result
|
||||||
|
path: |
|
||||||
|
./artifacts
|
||||||
|
# deploys to github releases on tag
|
||||||
|
deploy:
|
||||||
|
if: startsWith(github.ref, 'refs/tags/')
|
||||||
|
needs: build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Download artifacts
|
||||||
|
uses: actions/download-artifact@v2
|
||||||
|
with:
|
||||||
|
name: result
|
||||||
|
path: ./artifacts
|
||||||
|
- name: List
|
||||||
|
run: find ./artifacts
|
||||||
|
- name: Release
|
||||||
|
uses: softprops/action-gh-release@v1
|
||||||
|
with:
|
||||||
|
files: ./artifacts/*.tar.gz
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
/target
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
# Default ignored files
|
||||||
|
/shelf/
|
||||||
|
/workspace.xml
|
||||||
|
# Editor-based HTTP Client requests
|
||||||
|
/httpRequests/
|
||||||
|
# Datasource local storage ignored files
|
||||||
|
/dataSources/
|
||||||
|
/dataSources.local.xml
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<module type="CPP_MODULE" version="4">
|
||||||
|
<component name="NewModuleRootManager">
|
||||||
|
<content url="file://$MODULE_DIR$">
|
||||||
|
<sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
|
||||||
|
<excludeFolder url="file://$MODULE_DIR$/target" />
|
||||||
|
</content>
|
||||||
|
<orderEntry type="inheritedJdk" />
|
||||||
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
</component>
|
||||||
|
</module>
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="ProjectModuleManager">
|
||||||
|
<modules>
|
||||||
|
<module fileurl="file://$PROJECT_DIR$/.idea/bird-looking-glass.iml" filepath="$PROJECT_DIR$/.idea/bird-looking-glass.iml" />
|
||||||
|
</modules>
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="VcsDirectoryMappings">
|
||||||
|
<mapping directory="" vcs="Git" />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
|
|
@ -0,0 +1,45 @@
|
||||||
|
{
|
||||||
|
// 使用 IntelliSense 了解相关属性。
|
||||||
|
// 悬停以查看现有属性的描述。
|
||||||
|
// 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"type": "lldb",
|
||||||
|
"request": "launch",
|
||||||
|
"name": "Debug executable 'bird-looking-glass'",
|
||||||
|
"cargo": {
|
||||||
|
"args": [
|
||||||
|
"build",
|
||||||
|
"--bin=bird-looking-glass",
|
||||||
|
"--package=bird-looking-glass"
|
||||||
|
],
|
||||||
|
"filter": {
|
||||||
|
"name": "bird-looking-glass",
|
||||||
|
"kind": "bin"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"args": [],
|
||||||
|
"cwd": "${workspaceFolder}"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "lldb",
|
||||||
|
"request": "launch",
|
||||||
|
"name": "Debug unit tests in executable 'bird-looking-glass'",
|
||||||
|
"cargo": {
|
||||||
|
"args": [
|
||||||
|
"test",
|
||||||
|
"--no-run",
|
||||||
|
"--bin=bird-looking-glass",
|
||||||
|
"--package=bird-looking-glass"
|
||||||
|
],
|
||||||
|
"filter": {
|
||||||
|
"name": "bird-looking-glass",
|
||||||
|
"kind": "bin"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"args": [],
|
||||||
|
"cwd": "${workspaceFolder}"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,19 @@
|
||||||
|
[package]
|
||||||
|
name = "bird-looking-glass-proxy"
|
||||||
|
version = "0.0.1"
|
||||||
|
edition = "2021"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
actix-web = "3"
|
||||||
|
toml = "0.4.5"
|
||||||
|
serde_derive = "1.0.152"
|
||||||
|
serde = "1.0.152"
|
||||||
|
futures = "0.3.26"
|
||||||
|
lazy_static = "1.4.0"
|
||||||
|
sys-info = "0.9"
|
||||||
|
rust-shell = "0.2.0"
|
||||||
|
birdc = "0.2.0"
|
||||||
|
tokio = { version = "1", features = ["full"] }
|
||||||
|
clap = "3.0.0"
|
||||||
|
[profile.release]
|
||||||
|
lto = true
|
||||||
|
|
@ -0,0 +1,373 @@
|
||||||
|
Mozilla Public License Version 2.0
|
||||||
|
==================================
|
||||||
|
|
||||||
|
1. Definitions
|
||||||
|
--------------
|
||||||
|
|
||||||
|
1.1. "Contributor"
|
||||||
|
means each individual or legal entity that creates, contributes to
|
||||||
|
the creation of, or owns Covered Software.
|
||||||
|
|
||||||
|
1.2. "Contributor Version"
|
||||||
|
means the combination of the Contributions of others (if any) used
|
||||||
|
by a Contributor and that particular Contributor's Contribution.
|
||||||
|
|
||||||
|
1.3. "Contribution"
|
||||||
|
means Covered Software of a particular Contributor.
|
||||||
|
|
||||||
|
1.4. "Covered Software"
|
||||||
|
means Source Code Form to which the initial Contributor has attached
|
||||||
|
the notice in Exhibit A, the Executable Form of such Source Code
|
||||||
|
Form, and Modifications of such Source Code Form, in each case
|
||||||
|
including portions thereof.
|
||||||
|
|
||||||
|
1.5. "Incompatible With Secondary Licenses"
|
||||||
|
means
|
||||||
|
|
||||||
|
(a) that the initial Contributor has attached the notice described
|
||||||
|
in Exhibit B to the Covered Software; or
|
||||||
|
|
||||||
|
(b) that the Covered Software was made available under the terms of
|
||||||
|
version 1.1 or earlier of the License, but not also under the
|
||||||
|
terms of a Secondary License.
|
||||||
|
|
||||||
|
1.6. "Executable Form"
|
||||||
|
means any form of the work other than Source Code Form.
|
||||||
|
|
||||||
|
1.7. "Larger Work"
|
||||||
|
means a work that combines Covered Software with other material, in
|
||||||
|
a separate file or files, that is not Covered Software.
|
||||||
|
|
||||||
|
1.8. "License"
|
||||||
|
means this document.
|
||||||
|
|
||||||
|
1.9. "Licensable"
|
||||||
|
means having the right to grant, to the maximum extent possible,
|
||||||
|
whether at the time of the initial grant or subsequently, any and
|
||||||
|
all of the rights conveyed by this License.
|
||||||
|
|
||||||
|
1.10. "Modifications"
|
||||||
|
means any of the following:
|
||||||
|
|
||||||
|
(a) any file in Source Code Form that results from an addition to,
|
||||||
|
deletion from, or modification of the contents of Covered
|
||||||
|
Software; or
|
||||||
|
|
||||||
|
(b) any new file in Source Code Form that contains any Covered
|
||||||
|
Software.
|
||||||
|
|
||||||
|
1.11. "Patent Claims" of a Contributor
|
||||||
|
means any patent claim(s), including without limitation, method,
|
||||||
|
process, and apparatus claims, in any patent Licensable by such
|
||||||
|
Contributor that would be infringed, but for the grant of the
|
||||||
|
License, by the making, using, selling, offering for sale, having
|
||||||
|
made, import, or transfer of either its Contributions or its
|
||||||
|
Contributor Version.
|
||||||
|
|
||||||
|
1.12. "Secondary License"
|
||||||
|
means either the GNU General Public License, Version 2.0, the GNU
|
||||||
|
Lesser General Public License, Version 2.1, the GNU Affero General
|
||||||
|
Public License, Version 3.0, or any later versions of those
|
||||||
|
licenses.
|
||||||
|
|
||||||
|
1.13. "Source Code Form"
|
||||||
|
means the form of the work preferred for making modifications.
|
||||||
|
|
||||||
|
1.14. "You" (or "Your")
|
||||||
|
means an individual or a legal entity exercising rights under this
|
||||||
|
License. For legal entities, "You" includes any entity that
|
||||||
|
controls, is controlled by, or is under common control with You. For
|
||||||
|
purposes of this definition, "control" means (a) the power, direct
|
||||||
|
or indirect, to cause the direction or management of such entity,
|
||||||
|
whether by contract or otherwise, or (b) ownership of more than
|
||||||
|
fifty percent (50%) of the outstanding shares or beneficial
|
||||||
|
ownership of such entity.
|
||||||
|
|
||||||
|
2. License Grants and Conditions
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
2.1. Grants
|
||||||
|
|
||||||
|
Each Contributor hereby grants You a world-wide, royalty-free,
|
||||||
|
non-exclusive license:
|
||||||
|
|
||||||
|
(a) under intellectual property rights (other than patent or trademark)
|
||||||
|
Licensable by such Contributor to use, reproduce, make available,
|
||||||
|
modify, display, perform, distribute, and otherwise exploit its
|
||||||
|
Contributions, either on an unmodified basis, with Modifications, or
|
||||||
|
as part of a Larger Work; and
|
||||||
|
|
||||||
|
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
||||||
|
for sale, have made, import, and otherwise transfer either its
|
||||||
|
Contributions or its Contributor Version.
|
||||||
|
|
||||||
|
2.2. Effective Date
|
||||||
|
|
||||||
|
The licenses granted in Section 2.1 with respect to any Contribution
|
||||||
|
become effective for each Contribution on the date the Contributor first
|
||||||
|
distributes such Contribution.
|
||||||
|
|
||||||
|
2.3. Limitations on Grant Scope
|
||||||
|
|
||||||
|
The licenses granted in this Section 2 are the only rights granted under
|
||||||
|
this License. No additional rights or licenses will be implied from the
|
||||||
|
distribution or licensing of Covered Software under this License.
|
||||||
|
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
||||||
|
Contributor:
|
||||||
|
|
||||||
|
(a) for any code that a Contributor has removed from Covered Software;
|
||||||
|
or
|
||||||
|
|
||||||
|
(b) for infringements caused by: (i) Your and any other third party's
|
||||||
|
modifications of Covered Software, or (ii) the combination of its
|
||||||
|
Contributions with other software (except as part of its Contributor
|
||||||
|
Version); or
|
||||||
|
|
||||||
|
(c) under Patent Claims infringed by Covered Software in the absence of
|
||||||
|
its Contributions.
|
||||||
|
|
||||||
|
This License does not grant any rights in the trademarks, service marks,
|
||||||
|
or logos of any Contributor (except as may be necessary to comply with
|
||||||
|
the notice requirements in Section 3.4).
|
||||||
|
|
||||||
|
2.4. Subsequent Licenses
|
||||||
|
|
||||||
|
No Contributor makes additional grants as a result of Your choice to
|
||||||
|
distribute the Covered Software under a subsequent version of this
|
||||||
|
License (see Section 10.2) or under the terms of a Secondary License (if
|
||||||
|
permitted under the terms of Section 3.3).
|
||||||
|
|
||||||
|
2.5. Representation
|
||||||
|
|
||||||
|
Each Contributor represents that the Contributor believes its
|
||||||
|
Contributions are its original creation(s) or it has sufficient rights
|
||||||
|
to grant the rights to its Contributions conveyed by this License.
|
||||||
|
|
||||||
|
2.6. Fair Use
|
||||||
|
|
||||||
|
This License is not intended to limit any rights You have under
|
||||||
|
applicable copyright doctrines of fair use, fair dealing, or other
|
||||||
|
equivalents.
|
||||||
|
|
||||||
|
2.7. Conditions
|
||||||
|
|
||||||
|
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
||||||
|
in Section 2.1.
|
||||||
|
|
||||||
|
3. Responsibilities
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
3.1. Distribution of Source Form
|
||||||
|
|
||||||
|
All distribution of Covered Software in Source Code Form, including any
|
||||||
|
Modifications that You create or to which You contribute, must be under
|
||||||
|
the terms of this License. You must inform recipients that the Source
|
||||||
|
Code Form of the Covered Software is governed by the terms of this
|
||||||
|
License, and how they can obtain a copy of this License. You may not
|
||||||
|
attempt to alter or restrict the recipients' rights in the Source Code
|
||||||
|
Form.
|
||||||
|
|
||||||
|
3.2. Distribution of Executable Form
|
||||||
|
|
||||||
|
If You distribute Covered Software in Executable Form then:
|
||||||
|
|
||||||
|
(a) such Covered Software must also be made available in Source Code
|
||||||
|
Form, as described in Section 3.1, and You must inform recipients of
|
||||||
|
the Executable Form how they can obtain a copy of such Source Code
|
||||||
|
Form by reasonable means in a timely manner, at a charge no more
|
||||||
|
than the cost of distribution to the recipient; and
|
||||||
|
|
||||||
|
(b) You may distribute such Executable Form under the terms of this
|
||||||
|
License, or sublicense it under different terms, provided that the
|
||||||
|
license for the Executable Form does not attempt to limit or alter
|
||||||
|
the recipients' rights in the Source Code Form under this License.
|
||||||
|
|
||||||
|
3.3. Distribution of a Larger Work
|
||||||
|
|
||||||
|
You may create and distribute a Larger Work under terms of Your choice,
|
||||||
|
provided that You also comply with the requirements of this License for
|
||||||
|
the Covered Software. If the Larger Work is a combination of Covered
|
||||||
|
Software with a work governed by one or more Secondary Licenses, and the
|
||||||
|
Covered Software is not Incompatible With Secondary Licenses, this
|
||||||
|
License permits You to additionally distribute such Covered Software
|
||||||
|
under the terms of such Secondary License(s), so that the recipient of
|
||||||
|
the Larger Work may, at their option, further distribute the Covered
|
||||||
|
Software under the terms of either this License or such Secondary
|
||||||
|
License(s).
|
||||||
|
|
||||||
|
3.4. Notices
|
||||||
|
|
||||||
|
You may not remove or alter the substance of any license notices
|
||||||
|
(including copyright notices, patent notices, disclaimers of warranty,
|
||||||
|
or limitations of liability) contained within the Source Code Form of
|
||||||
|
the Covered Software, except that You may alter any license notices to
|
||||||
|
the extent required to remedy known factual inaccuracies.
|
||||||
|
|
||||||
|
3.5. Application of Additional Terms
|
||||||
|
|
||||||
|
You may choose to offer, and to charge a fee for, warranty, support,
|
||||||
|
indemnity or liability obligations to one or more recipients of Covered
|
||||||
|
Software. However, You may do so only on Your own behalf, and not on
|
||||||
|
behalf of any Contributor. You must make it absolutely clear that any
|
||||||
|
such warranty, support, indemnity, or liability obligation is offered by
|
||||||
|
You alone, and You hereby agree to indemnify every Contributor for any
|
||||||
|
liability incurred by such Contributor as a result of warranty, support,
|
||||||
|
indemnity or liability terms You offer. You may include additional
|
||||||
|
disclaimers of warranty and limitations of liability specific to any
|
||||||
|
jurisdiction.
|
||||||
|
|
||||||
|
4. Inability to Comply Due to Statute or Regulation
|
||||||
|
---------------------------------------------------
|
||||||
|
|
||||||
|
If it is impossible for You to comply with any of the terms of this
|
||||||
|
License with respect to some or all of the Covered Software due to
|
||||||
|
statute, judicial order, or regulation then You must: (a) comply with
|
||||||
|
the terms of this License to the maximum extent possible; and (b)
|
||||||
|
describe the limitations and the code they affect. Such description must
|
||||||
|
be placed in a text file included with all distributions of the Covered
|
||||||
|
Software under this License. Except to the extent prohibited by statute
|
||||||
|
or regulation, such description must be sufficiently detailed for a
|
||||||
|
recipient of ordinary skill to be able to understand it.
|
||||||
|
|
||||||
|
5. Termination
|
||||||
|
--------------
|
||||||
|
|
||||||
|
5.1. The rights granted under this License will terminate automatically
|
||||||
|
if You fail to comply with any of its terms. However, if You become
|
||||||
|
compliant, then the rights granted under this License from a particular
|
||||||
|
Contributor are reinstated (a) provisionally, unless and until such
|
||||||
|
Contributor explicitly and finally terminates Your grants, and (b) on an
|
||||||
|
ongoing basis, if such Contributor fails to notify You of the
|
||||||
|
non-compliance by some reasonable means prior to 60 days after You have
|
||||||
|
come back into compliance. Moreover, Your grants from a particular
|
||||||
|
Contributor are reinstated on an ongoing basis if such Contributor
|
||||||
|
notifies You of the non-compliance by some reasonable means, this is the
|
||||||
|
first time You have received notice of non-compliance with this License
|
||||||
|
from such Contributor, and You become compliant prior to 30 days after
|
||||||
|
Your receipt of the notice.
|
||||||
|
|
||||||
|
5.2. If You initiate litigation against any entity by asserting a patent
|
||||||
|
infringement claim (excluding declaratory judgment actions,
|
||||||
|
counter-claims, and cross-claims) alleging that a Contributor Version
|
||||||
|
directly or indirectly infringes any patent, then the rights granted to
|
||||||
|
You by any and all Contributors for the Covered Software under Section
|
||||||
|
2.1 of this License shall terminate.
|
||||||
|
|
||||||
|
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
||||||
|
end user license agreements (excluding distributors and resellers) which
|
||||||
|
have been validly granted by You or Your distributors under this License
|
||||||
|
prior to termination shall survive termination.
|
||||||
|
|
||||||
|
************************************************************************
|
||||||
|
* *
|
||||||
|
* 6. Disclaimer of Warranty *
|
||||||
|
* ------------------------- *
|
||||||
|
* *
|
||||||
|
* Covered Software is provided under this License on an "as is" *
|
||||||
|
* basis, without warranty of any kind, either expressed, implied, or *
|
||||||
|
* statutory, including, without limitation, warranties that the *
|
||||||
|
* Covered Software is free of defects, merchantable, fit for a *
|
||||||
|
* particular purpose or non-infringing. The entire risk as to the *
|
||||||
|
* quality and performance of the Covered Software is with You. *
|
||||||
|
* Should any Covered Software prove defective in any respect, You *
|
||||||
|
* (not any Contributor) assume the cost of any necessary servicing, *
|
||||||
|
* repair, or correction. This disclaimer of warranty constitutes an *
|
||||||
|
* essential part of this License. No use of any Covered Software is *
|
||||||
|
* authorized under this License except under this disclaimer. *
|
||||||
|
* *
|
||||||
|
************************************************************************
|
||||||
|
|
||||||
|
************************************************************************
|
||||||
|
* *
|
||||||
|
* 7. Limitation of Liability *
|
||||||
|
* -------------------------- *
|
||||||
|
* *
|
||||||
|
* Under no circumstances and under no legal theory, whether tort *
|
||||||
|
* (including negligence), contract, or otherwise, shall any *
|
||||||
|
* Contributor, or anyone who distributes Covered Software as *
|
||||||
|
* permitted above, be liable to You for any direct, indirect, *
|
||||||
|
* special, incidental, or consequential damages of any character *
|
||||||
|
* including, without limitation, damages for lost profits, loss of *
|
||||||
|
* goodwill, work stoppage, computer failure or malfunction, or any *
|
||||||
|
* and all other commercial damages or losses, even if such party *
|
||||||
|
* shall have been informed of the possibility of such damages. This *
|
||||||
|
* limitation of liability shall not apply to liability for death or *
|
||||||
|
* personal injury resulting from such party's negligence to the *
|
||||||
|
* extent applicable law prohibits such limitation. Some *
|
||||||
|
* jurisdictions do not allow the exclusion or limitation of *
|
||||||
|
* incidental or consequential damages, so this exclusion and *
|
||||||
|
* limitation may not apply to You. *
|
||||||
|
* *
|
||||||
|
************************************************************************
|
||||||
|
|
||||||
|
8. Litigation
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Any litigation relating to this License may be brought only in the
|
||||||
|
courts of a jurisdiction where the defendant maintains its principal
|
||||||
|
place of business and such litigation shall be governed by laws of that
|
||||||
|
jurisdiction, without reference to its conflict-of-law provisions.
|
||||||
|
Nothing in this Section shall prevent a party's ability to bring
|
||||||
|
cross-claims or counter-claims.
|
||||||
|
|
||||||
|
9. Miscellaneous
|
||||||
|
----------------
|
||||||
|
|
||||||
|
This License represents the complete agreement concerning the subject
|
||||||
|
matter hereof. If any provision of this License is held to be
|
||||||
|
unenforceable, such provision shall be reformed only to the extent
|
||||||
|
necessary to make it enforceable. Any law or regulation which provides
|
||||||
|
that the language of a contract shall be construed against the drafter
|
||||||
|
shall not be used to construe this License against a Contributor.
|
||||||
|
|
||||||
|
10. Versions of the License
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
10.1. New Versions
|
||||||
|
|
||||||
|
Mozilla Foundation is the license steward. Except as provided in Section
|
||||||
|
10.3, no one other than the license steward has the right to modify or
|
||||||
|
publish new versions of this License. Each version will be given a
|
||||||
|
distinguishing version number.
|
||||||
|
|
||||||
|
10.2. Effect of New Versions
|
||||||
|
|
||||||
|
You may distribute the Covered Software under the terms of the version
|
||||||
|
of the License under which You originally received the Covered Software,
|
||||||
|
or under the terms of any subsequent version published by the license
|
||||||
|
steward.
|
||||||
|
|
||||||
|
10.3. Modified Versions
|
||||||
|
|
||||||
|
If you create software not governed by this License, and you want to
|
||||||
|
create a new license for such software, you may create and use a
|
||||||
|
modified version of this License if you rename the license and remove
|
||||||
|
any references to the name of the license steward (except to note that
|
||||||
|
such modified license differs from this License).
|
||||||
|
|
||||||
|
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
||||||
|
Licenses
|
||||||
|
|
||||||
|
If You choose to distribute Source Code Form that is Incompatible With
|
||||||
|
Secondary Licenses under the terms of this version of the License, the
|
||||||
|
notice described in Exhibit B of this License must be attached.
|
||||||
|
|
||||||
|
Exhibit A - Source Code Form License Notice
|
||||||
|
-------------------------------------------
|
||||||
|
|
||||||
|
This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
If it is not possible or desirable to put the notice in a particular
|
||||||
|
file, then You may include the notice in a location (such as a LICENSE
|
||||||
|
file in a relevant directory) where a recipient would be likely to look
|
||||||
|
for such a notice.
|
||||||
|
|
||||||
|
You may add additional accurate notices of copyright ownership.
|
||||||
|
|
||||||
|
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
||||||
|
---------------------------------------------------------
|
||||||
|
|
||||||
|
This Source Code Form is "Incompatible With Secondary Licenses", as
|
||||||
|
defined by the Mozilla Public License, v. 2.0.
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
# bird-looking-glass
|
||||||
|
```
|
||||||
|
USAGE:
|
||||||
|
bird-looking-glass-proxy [OPTIONS]
|
||||||
|
|
||||||
|
OPTIONS:
|
||||||
|
-c, --config <FILE> Set the config file
|
||||||
|
-e, --example Export sample config file
|
||||||
|
-h, --help Print help information
|
||||||
|
```
|
||||||
|
## Quick Start
|
||||||
|
0. Make sure that Bird and Traceroute are installed and available.
|
||||||
|
1. Obtain the binary executable by either downloading it from the release or compiling the project with Cargo.
|
||||||
|
2. Use the command bird-looking-glass-proxy --example > config.toml to create a template configuration file and modify it to your needs.
|
||||||
|
3. Run the executable.
|
||||||
|
|
||||||
|
### Tips
|
||||||
|
The default configuration file is located at `./config.toml`, but you can customize the file location using the `-c` or `--config` parameter.
|
||||||
|
|
||||||
|
## Known issues.
|
||||||
|
* Versions built with the *-unknown-linux-gnu toolchain may not function correctly on systems with GLIBC versions below 2.35. To resolve this, use a statically linked version built with the *-unknown-linux-musl toolchain.
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
bind_ip = "0.0.0.0"
|
||||||
|
bind_port = 5000
|
||||||
|
|
||||||
|
# Used to restrict access to bird-looking-glass-proxy based on source IP address.
|
||||||
|
# Empty list = any IP is allowed to run queries.
|
||||||
|
access_list = ["127.0.0.1"]
|
||||||
|
|
||||||
|
# Used to restrict access to bird-looking-glass-proxy based on a shared secret (must also be configured in lg.cfg)
|
||||||
|
# Empty string or unset = no shared secret is required to run queries.
|
||||||
|
shared_secret="ThisTokenIsNotSecret"
|
||||||
|
|
||||||
|
# Used as source address when running traceroute
|
||||||
|
ipv4_source="198.51.100.42"
|
||||||
|
ipv6_source="2001:db8:42::1"
|
||||||
|
|
||||||
|
bird_socket="/var/run/bird/bird.ctl"
|
||||||
|
bird6_socket="/var/run/bird/bird6.ctl"
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
use crate::GLOBAL_CONFIG;
|
||||||
|
use actix_web::body::MessageBody;
|
||||||
|
use actix_web::dev::{Service, ServiceRequest, ServiceResponse, Transform};
|
||||||
|
use actix_web::{error, Error};
|
||||||
|
use futures::future::{ok, Ready};
|
||||||
|
use futures::Future;
|
||||||
|
use std::cell::RefCell;
|
||||||
|
use std::pin::Pin;
|
||||||
|
use std::rc::Rc;
|
||||||
|
use std::task::{Context, Poll};
|
||||||
|
pub struct Auth;
|
||||||
|
|
||||||
|
impl<S, B> Transform<S> for Auth
|
||||||
|
where
|
||||||
|
S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
|
||||||
|
S::Future: 'static,
|
||||||
|
B: MessageBody + 'static,
|
||||||
|
{
|
||||||
|
type Request = ServiceRequest;
|
||||||
|
type Response = ServiceResponse<B>;
|
||||||
|
type Error = Error;
|
||||||
|
type Transform = AuthMiddleware<S>;
|
||||||
|
type InitError = ();
|
||||||
|
type Future = Ready<Result<Self::Transform, Self::InitError>>;
|
||||||
|
|
||||||
|
fn new_transform(&self, service: S) -> Self::Future {
|
||||||
|
ok(AuthMiddleware {
|
||||||
|
service: Rc::new(RefCell::new(service)),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct AuthMiddleware<S> {
|
||||||
|
service: Rc<RefCell<S>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<S, B> Service for AuthMiddleware<S>
|
||||||
|
where
|
||||||
|
S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
|
||||||
|
S::Future: 'static,
|
||||||
|
B: MessageBody + 'static,
|
||||||
|
{
|
||||||
|
type Request = ServiceRequest;
|
||||||
|
type Response = ServiceResponse<B>;
|
||||||
|
type Error = Error;
|
||||||
|
type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>;
|
||||||
|
fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
|
||||||
|
self.service.poll_ready(cx)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn call(&mut self, req: ServiceRequest) -> Self::Future {
|
||||||
|
let mut svc = self.service.clone();
|
||||||
|
Box::pin(async move {
|
||||||
|
let addr = req.peer_addr().unwrap();
|
||||||
|
let access_list = &GLOBAL_CONFIG.access_list;
|
||||||
|
if access_list.contains(&addr.ip().to_string()) || access_list.is_empty() {
|
||||||
|
Ok(svc.call(req).await?)
|
||||||
|
} else {
|
||||||
|
Err(error::ErrorUnauthorized(
|
||||||
|
"Your remote address is not valid!",
|
||||||
|
))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
use serde_derive::Deserialize;
|
||||||
|
extern crate toml;
|
||||||
|
|
||||||
|
use std::fs;
|
||||||
|
|
||||||
|
#[derive(Deserialize)]
|
||||||
|
pub struct Config {
|
||||||
|
pub bind_ip: String,
|
||||||
|
pub bind_port: u16,
|
||||||
|
pub access_list: Vec<String>,
|
||||||
|
pub shared_secret: String,
|
||||||
|
pub ipv4_source: String,
|
||||||
|
pub ipv6_source: String,
|
||||||
|
pub bird_socket: String,
|
||||||
|
pub bird6_socket: String,
|
||||||
|
}
|
||||||
|
impl Config {
|
||||||
|
pub fn new(file_path: &str) -> Self {
|
||||||
|
return match toml::from_str(&match fs::read_to_string(file_path) {
|
||||||
|
Ok(f) => f,
|
||||||
|
Err(e) => panic!("Unable to Find the Config: {}", e),
|
||||||
|
}) {
|
||||||
|
Ok(f) => f,
|
||||||
|
Err(e) => panic!("Unable to Read the Config: {}", e),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,42 @@
|
||||||
|
mod auth;
|
||||||
|
mod config;
|
||||||
|
mod route;
|
||||||
|
use actix_web::{web, App, HttpServer};
|
||||||
|
use clap;
|
||||||
|
use lazy_static::lazy_static;
|
||||||
|
|
||||||
|
lazy_static! {
|
||||||
|
pub static ref GLOBAL_CONFIG: config::Config = {
|
||||||
|
let matches = clap::App::new("bird-looking-glass-proxy")
|
||||||
|
.bin_name("bird-looking-glass-proxy")
|
||||||
|
.arg_from_usage("-c, --config=[FILE] 'Set the config file'")
|
||||||
|
.arg_from_usage("-e, --example 'Export sample config file'")
|
||||||
|
.get_matches();
|
||||||
|
if matches.is_present("example") {
|
||||||
|
println!("bind_ip = \"0.0.0.0\"\nbind_port = 5000\n\n# Used to restrict access to bird-looking-glass-proxy based on source IP address.\n# Empty list = any IP is allowed to run queries.\naccess_list = [\"127.0.0.1\"]\n\n# Used to restrict access to bird-looking-glass-proxy based on a shared secret (must also be configured in lg.cfg)\n# Empty string or unset = no shared secret is required to run queries.\nshared_secret=\"ThisTokenIsNotSecret\"\n\n# Used as source address when running traceroute\nipv4_source=\"198.51.100.42\"\nipv6_source=\"2001:db8:42::1\"\n\nbird_socket=\"/var/run/bird/bird.ctl\"\nbird6_socket=\"/var/run/bird/bird6.ctl\"");
|
||||||
|
std::process::exit(0);
|
||||||
|
}
|
||||||
|
config::Config::new(matches.value_of("config").unwrap_or("config.toml"))
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
#[actix_web::main]
|
||||||
|
async fn main() -> std::io::Result<()> {
|
||||||
|
HttpServer::new(|| {
|
||||||
|
App::new()
|
||||||
|
.wrap(auth::Auth)
|
||||||
|
.route(
|
||||||
|
"/traceroute6",
|
||||||
|
web::get().to(route::traceroute::traceroute6),
|
||||||
|
)
|
||||||
|
.route("/traceroute", web::get().to(route::traceroute::traceroute4))
|
||||||
|
.route("/bird6", web::get().to(route::bird::bird6))
|
||||||
|
.route("/bird", web::get().to(route::bird::bird4))
|
||||||
|
})
|
||||||
|
.bind(format!(
|
||||||
|
"{}:{}",
|
||||||
|
GLOBAL_CONFIG.bind_ip, GLOBAL_CONFIG.bind_port
|
||||||
|
))?
|
||||||
|
.run()
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
pub mod traceroute;
|
||||||
|
pub mod bird;
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
use birdc::*;
|
||||||
|
use actix_web::{web, HttpRequest, HttpResponse, Responder};
|
||||||
|
use serde_derive::Deserialize;
|
||||||
|
use crate::GLOBAL_CONFIG;
|
||||||
|
use futures::executor::block_on;
|
||||||
|
|
||||||
|
#[derive(Deserialize, Debug)]
|
||||||
|
pub struct Param {
|
||||||
|
q: String,
|
||||||
|
}
|
||||||
|
#[tokio::main]
|
||||||
|
pub async fn bird(_param: web::Query<Param>, _req: HttpRequest, mode: i8) -> Result<String> {
|
||||||
|
let client = Client::for_unix_socket(match mode{
|
||||||
|
6 => GLOBAL_CONFIG.bird6_socket.as_str(),
|
||||||
|
_ => GLOBAL_CONFIG.bird_socket.as_str(),
|
||||||
|
});
|
||||||
|
let mut connection = block_on(client.connect())?;
|
||||||
|
let messages = block_on(connection.send_request(&_param.q))?;
|
||||||
|
for message in &messages {
|
||||||
|
println!("received message: {:?}", message);
|
||||||
|
}
|
||||||
|
return Ok(messages.iter().map(|message |format!("{:?}",message)).collect::<String>());
|
||||||
|
|
||||||
|
}
|
||||||
|
pub async fn bird4(_param: web::Query<Param>, _req: HttpRequest) -> impl Responder {
|
||||||
|
match bird(_param, _req, 4) {
|
||||||
|
Ok(response) => HttpResponse::Ok().body(response),
|
||||||
|
Err(_) => HttpResponse::Ok().body("Error".to_string()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn bird6(_param: web::Query<Param>, _req: HttpRequest) -> impl Responder {
|
||||||
|
match bird(_param, _req, 6) {
|
||||||
|
Ok(response) => HttpResponse::Ok().body(response),
|
||||||
|
Err(_) => HttpResponse::Ok().body("Error".to_string()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,68 @@
|
||||||
|
use actix_web::{web, HttpResponse, Responder};
|
||||||
|
use rust_shell::{cmd, ShellError};
|
||||||
|
use serde_derive::Deserialize;
|
||||||
|
use sys_info::os_type;
|
||||||
|
#[derive(Deserialize)]
|
||||||
|
pub struct Param {
|
||||||
|
q: String,
|
||||||
|
ipv4_source: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn traceroute(param: web::Query<Param>, mode: i8) -> impl Responder {
|
||||||
|
let mut traceroute: Vec<&str> = Vec::new();
|
||||||
|
match Some(os_type().unwrap().to_ascii_lowercase().as_str()) {
|
||||||
|
Some(platform) if platform.contains("bsd")=> {
|
||||||
|
match mode {
|
||||||
|
6 => {
|
||||||
|
traceroute.append(&mut vec!["traceroute6"]);
|
||||||
|
}
|
||||||
|
_ => {
|
||||||
|
traceroute.append(&mut vec!["traceroute"]);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
traceroute.append(&mut vec![
|
||||||
|
match platform {
|
||||||
|
"openbsd" => "-A",
|
||||||
|
_ => "-a",
|
||||||
|
},
|
||||||
|
"-q1",
|
||||||
|
"-w1",
|
||||||
|
"-m15",
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
_ => {
|
||||||
|
match mode {
|
||||||
|
6 => {
|
||||||
|
traceroute.append(&mut vec!["traceroute6", "-6"]);
|
||||||
|
}
|
||||||
|
_ => {
|
||||||
|
traceroute.append(&mut vec!["traceroute", "-4"]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
traceroute.append(&mut vec!["-A", "-q1", "-N32", "-w1", "-m15"])
|
||||||
|
}
|
||||||
|
};
|
||||||
|
match param.ipv4_source.as_deref() {
|
||||||
|
Some(ref source) => traceroute.append(&mut vec!["-s", source]),
|
||||||
|
None => {}
|
||||||
|
};
|
||||||
|
HttpResponse::Ok().body(
|
||||||
|
match cmd!(&format!("{} {}", traceroute.join(" "), ¶m.q)).stdout_utf8() {
|
||||||
|
Ok(stdout) => stdout,
|
||||||
|
Err(e) => match e {
|
||||||
|
ShellError::Status(string, exitstatus) => format!("{}: {}", exitstatus, string),
|
||||||
|
ShellError::IoError(_) => "IoError".to_string(),
|
||||||
|
ShellError::VarError(_) => "VarError".to_string(),
|
||||||
|
ShellError::NoSuchProcess => "NoSuchProcess".to_string(),
|
||||||
|
ShellError::Errno(string, errno) => format!("{}: {}", errno, string),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
}
|
||||||
|
pub async fn traceroute4(_param: web::Query<Param>) -> impl Responder {
|
||||||
|
traceroute(_param, 4)
|
||||||
|
}
|
||||||
|
pub async fn traceroute6(_param: web::Query<Param>) -> impl Responder {
|
||||||
|
traceroute(_param, 6)
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue