This program is not yet ready nor secure, do not use it in this version. It is Copyrighted, see LICENCE.txt

该程序还没有准备好，也不安全，在这个版本中不使用它. 它是有版权的，读文件 LICENCE.txt

This program creates an secure connection between computers (like VPN).

• for now best between 2 computers, in future to mesh any number of computers in large network
• access e.g. your home laptop from work, or connect servers in LAN easily
• you get own virtual IPv6 to which you own the private key so no one can impersonate you or steal your address
• compatible with all programs that just support IPv6
• authenticated end-to-end
• encrypted end-to-end
• only one of the computers needs to have public Internet IP address (in future none will need)

Works on: Debian 9 (Stretch) on amd64 is recommended, also other Linuxes, Windows 7, 8, 10, Mac OS X

• see doc/support-matrix.txt.

To run from sources, just use menu ./menu and select install, then build, then run - for supported systems, or keep reading.

To use this program from Command Line (as regular user, or as root) simply:

• on 1st computer run command: ./tunserver.elf the program will start and will print you on screen what is the virtual IP address that is assigned to it by our program.

• on 2nd computer run command: ./tunserver.elf --peer YOURIP:9042-VIRTUALIP1 where YOURIP must be the "normal" IP address of 1st computer as seen from 2nd computer, e.g. the Internet address of it, and VIRTUALIP1 is the virtual IP that was displayed on 1st computer.

That is all! Now your computers are connected together, try ping6 VIRTUALIP1 from 2nd computer, all connections (browser, ftp, ssh etc) should work too.

To build this program from source we recommend:

• for Windows, in Microsoft Visual Studio - see doc/msvc-instructions.md
• for Windows, in Cygwin/Mingw compiler - see doc/cygwin-instructions.md
• for Mac Os X, in Clang compiler - see doc/build-osx-native.md
• for Linux, in GCC (or Clang) compiler - see doc/build-linux.md
• other Unix systems might work - see doc/build-other-unix.md
• Browse directory with more documentation: doc/
• advanced users: to recreate yourself the official binary for Windows/Linux using Gitian deterministic-builds, see doc/build-gitian.md

Backup: your private keys that give ownership of your virtual IP address by default are in ~/.config/antinet/ (or just the galaxy42/wallet there).

This program will allow to do much more in future (full public mesh, scoring, donations/payments) but this are plans for advanced testers (see below).

For more details, including correct naming and glossary, and advanced technical topics for developers and "hackers", see also: doc/hacking.md.

• Summary: multi-threading tools, tests, network model, utils; RPC commands, and GUI, fixes.
• Warnings:
  • Macosx Gitian process is not working in this release (fix in next one).
  • Do not use Bitcoin support, nor GUI, it's just an experiment.
• Draft of Bitcoin RPC interaction (do NOT use for anything other then testnet!!).
  • RPC commands for Bitcoin: get_status pay set_account.
  • GUI: RPC connect timeout changes, more errors supported.
  • GUI: text for Bitcoin status/ballance; Audio sound.
• GUI.
• Basic GUI works, but is for testing from source code (is not connected to build system).
• Connecting to RPC (not encrypted yet!).
• Adding peers.
• work started on address book
• started work on showing coin address ballance from RPC (might not work now!)
• Creating netmodel.
• Multi-thread netmodel.
• Multi-thread isolated crypto tests.
• Creating utils to test network speed.
• Sender program, with remote RPC.
• Tokens
• Started simple example of checking ballance (via RPC) of bitcoind.
• Deps
• Updated external libraries.
• Fixes
• Possible race in RPC, in 13f3eaf0d73f3e48db3892bf11d4956f67a4cd1f
• Fix building in build/ or in top-dir, with proper copy of some files, see 6e3a3a75ac758eb1886b0c026d67ecd16064d75f
• Working --set-prefix (to build oldnet)
• Bench / netmodel
• starting on medium level tests (python, gnuplot)
• starting high-level big test
• many tests added (only-crypto, and various wire-tun-crypto tests)
• Porting
• Started BSD/FreeBSD port (tuntap stump)
• Jenkins: build Macosx and GUI.
• Code
• Affinity mini lib.
• Fixed some C++ warnings.
• Last release of 2017 year.
• In memory of our small friend who kept us company (bitcoin, antinet); Lila (2010-2017).
• We wish everyone a Marry Christmas, and happy end of 2017 year.

Older release notes are in Changelog.md.

You can download the binary releases from: https://github.com/yedino/galaxy42-release/ https://github.com/yedino/galaxy42-release/tree/master/tests-insecure search there for the version that you want to use.

Security: write down a checksum of the downloaded file if you care about security for verification in future, also check if other people confirm same checksum of binary files, and you can also confirm yourself that it matches given source code (see below - "Security of binary install").

• Using pre-built binary on Windows: you need to have TUN/TAP Driver installed first, e.g. get one from the OpenVPN project.

• Get the installer .exe, run it.

• Results:

  • Program is in: Program files/galaxy42/tunserver.elf.exe
  • Program will be installed as service and will run on boot.

• You can start program manually e.g. to specify command-line options:

  • Disable the system service of Galaxy42 - e.g. by going to Task Manager, finding Services tab, finding there "Galaxy" service, and clicking to Stop/Disable it.
  • Run the installed .exe program manually. It will work and you can specify --peer option ... as well as see own virtual IPv6 there. It MUST be run as ADMINISTRATOR (click Menu Start, find cmd, right-click and choose option 'Run as administrator')

• HANDLE ERRORS:

  • If problem finding the tuntap in registry: We can not find the virtual tuntap network card. Did you installed the OpenVPN driver for it? Is it not disabled? Consult README.md for more infomation.
  • If problem setting unicast address etc - then show suggestinon like We can not configure the virtual card - are you running this program with Administrator privileges (e.g. from run-as-administrator command line? or with System privilages as Service?) Consult README.md for more infomation.

• Using pre-built binary on Linux:

• Get the installer .tar.gz and unpack it.

• Start the program using the .sh script there for static version of program.

• Using pre-built binary on Mac OS X:

• Currently not supporting this (untill we resolve bug#J278).

• we drop root UID if run via sudo (see SudoCap below)
• we use Capability and drop when possible, if using setcap (see SudoCap below)

Planned:

• code review - NOT yet
• seccomp filter - NOT yet
• separate process for network, with no filesystem access - NOT yet

The source code is NOT yet reviewed, expect it to have bugs and exploits. For now we recommend to use it only in isolated VM or better yet on a separated test computer.

When you build program from source, check the file [SECURITY.txt] for list of dependencies that you MUST monitor for security updates!

We offer binary builds on web page:

https://github.com/yedino/galaxy42-release/ in future address will be also: https://download.yedino.com/

The files there will be GPG signed, see below "Root of trust".

Write down a checksum of the downloaded file if you care about security for verification in future: you can check if the files are GPG-signed by us (they always should be), and look around if other trusted people repeated our Gitian builds and can testify they have same resulting checksum.

In addition you can "trust no one" and repeat the Gitian build now or in future and you will get identical checksum of resulting binary files.

If you repeat the Gitian build in far future (when there were updates to relevant parts of the OS that we use inside Gitian), then you must somehow provide identical version of the packages, otherwise it could change the checksum.

Not implemented yet.

You can confirm that source code is indeed created by the developers - git tags are signed, and after them (e.g. on some work in progress branch) all following git commits (including git merges) are also signed.

• Root of trust: all work here will be authorized by main key, that is currently by key: AB58 9383 1B9A EE6C EE17 6DA0 B4B4 5712 5445 3AF5 (Tigusoft Admin admin@tigusoft.pl). How ever, you should of course first check with some other channels if that is the fingerprint of owner of this project.

• First, import the GPG keys. They are here in dir doc/pubkey/. How ever make sure the commit with keys is itself signed (e.g. git tag) by root of trust. You can import the keys there, though we are responsible ONLY for security of keys listed in gitallsign/ and only for purposes stated there (tag vs commit).

• You can simply use a tagged version and done - just check the GPG signature on the git tag (git tag, git tag -v v0........), they should be usually signed directly by the root of trust.

Or else, for not-tagged versions:

• The files in gitallsign/ contain lists which GPG key is allowed to be which git Author, and can he sign commits or tags. (In future this will be automatically checked with our script, for now you must do it by hand).
• Of course check who in fact created this files (git log / git blame) and is it signed by the root of trust.
• Check if at least the latest git tag is signed (and is it signed by person that is allowed to sign-tags in this project, and does the GPG key actually match the commit author as seen in git log).
• Each commit (including merge commits) since version you are checking, back to the latest tag, should be also signed (also you should check, is it signed by person allowed to sign-commits this times, and does everything match ditto).

Script that can help speed up this process is being written, e.g. one good version of it is: sha512 3ed9cf88d3d78ced3a7326a05bc954695cb36b5802abca309745196bfe498e679a2f91c1df3e4ffcef852e3a203406959d565f5e78a8364d0438e99a6e9a7ad0 of file antinet/tools/git_pretty_signature.py in project Antinet. (New versions will be better, though review the code before runnig it anyway).

Running benchmarks: Use ./menu See [[src-tools/netutils/README-bench.txt]] for details.

• Galaxy42 - the main network routing.
• Antinet - the research project including Galaxy42, simulations for it, tokens for it, and everything else.
• Yedino - the bigger entity that manages creation of this projects and controlls most of copyrights and official issues.

Program can be given higher privileges on start in various ways, on Linux.

• recommended way is to just start program and it will work thanks to setcap flags on the binary
  • flags are set by our make (if you installed our scripts like cap-tool from ./install, this it the default)
  • this will not work if curren mountpoint has mount flags like nosuid (then remount it, e.g. for Mint ecryptfs: mount -i ... -o remount,suid)
• or else, if you do not have setcap, then just run the program via sudo - it will start as root
  • it will drop root very soon, back to the user who started sudo
  • it will also use the home of user who started the sudo (by default, see --home-env below to set any home dir)

Other combinations (of this conditions, exporting env HOME, etc) are not supported currently.

Config file actually used can be this path plus "/antinet/", e.g. "/home/alice/.config/antinet/".

* * *
* * *
* * *

Advanced topics - for developers and for future.

---> Users, developers, read also the HOWTO section it contains friendly FAQ how to use/develop/hack this :) <---

Galaxy42 - Small experimental network in category of Meshnet, VPN, IP-hash.

Title: Galaxy42
Status: Experimental, pre-alpha, NOT reviewed, NOT secure.

Do not use this network for any purpose at all (yet!) it contains
bugs, probably including vulns. Could be ok to try it in a VM.
Intended ONLY for developers (for now).

Finall version will be aimed to all users on Windows, Linux, Mac and
other systems.


NETWORK TYPE:

* Meshnet - it will be possible to set up the net with minimal config
(and later zeroconf), no nodes are centralized.

* VPN - it will provide end-to-end encryption and authentication,
and IP access even to places with no own traditional Internet-accessible IP.

* IP-Hash - the IP address is hash (e.g. of public key) and therefore
it can be assigned in some decentralized way (e.g. created and owned by user,
as hash of his own public-key to which only he has private-key).

This network is similar in principle to Cjdns network.


GOALS:

We aim with it to test possible solutions to some challenges discovered in Cjdns:

1) Not optimal speed in even 1-to-1 connection over Gigabit link (e.g. on Linux).
2) Not close to optimal global speed, probably because of routing creating not so good routes.
3) Not stable connections.

Optionally, for the main Antinet project we plan to test:

4) Possible integrated micro "payments" between nodes, especially "paying" just with
own resources (I route for you - if you route for me) to allow node owner to demand
cooperation from other participants of the network if they want to get his help.

### HOWTO

Q: How to use Galaxy42?
A: [use] See top of this README for instructions - or just run the program and follow instructions on screen.

Q: How to commit my work using Git?
A: {git.model} First see {devel}.
Create a branch, work there using `git commit -s` to sign each commit. Make a pull request.
Project technical maintainer will the git merge -s your code.
Do NOT rebase our code on top of work - or if you do so then you need to:
sign again all commit using e.g. `git reset --hard` and `git cherry-pick` and `git commit --ammend -s`.
See if all commits are signed using e.g. `git log --show-signature`.
We will merge your commit using e.g. `git merge -S --verify-signatures`.
As result, each and every commit (and merge commits) will be GPG signed.
In addition, tags (that we created with `git tag -s`) will be signed too, by proper developer.

Q: How to develop Galaxy42?
A: [devel] Read most of questions here first, including [devel.demo], [devel.contact].

Q: What is the licence?
A: See the LICENCE-by-Antinet.txt file and other such files.

Q: How to develop Galaxy42?
A: [devel] See LICENCE information first. Read most of questions here first, including [devel.demo], [devel.contact].

Q: How to contact developers?
A: [devel.contact] (Disclaimer: this is NOT a contact for legal matters - all such messages will be ignored; Wait for reply at least 12 hours;
On IRC user names are not protected, and do not trust no one. We will never ask you to give us any passwords or run some untrusted not signed code!)
Contact us on IRC server icann.irc.meshnet.pl on channel #meshnet or #antinet (that for now is also about Galaxy42).

Q: How to see a demo how program works?
A: [devel.demo] First build the program, and then choose one of methods:

1. Run program as ./tunserver.elf --devel --demo foo to run test foo. Existing tests include test "foo",
test "bar", and other real tests.
[TODO] You can see list of the possible tests by running it with "help" demo,
so as:
./tunserver.elf --devel --demo help

2. In directory ./config crete a file config/demo.conf. In this file write a single line like `demo=bar`;
Then run the program with `make run` or with `./tunserver.elf --devel`
It should run a demo "bar" and write bar on screen (read the debug messages).
If you change that text in file to `demo=foo` then it runs test Foo.
If something does not work then see debug to figure it out.
You can now write other demo name in the config file and run tests again.
Set demo to "list" or "help" to see list of possible demo options [TODO].

3. If you just run program with `--devel` it will run the hardcoded demo,
as set in code in variable `g_demoname_default`.
If you start working on a new branch you could set it there to other value
to run your test - see [devel.newthing]

Q: How to develop something new?
A: [devel.newthing] (First read [devel]) and then create git branch named like "wip_galaxy_SOMENAME"
where SOMENAME is a nice name summarizing on what you do work.
Then create also a demo for it (see how other demos are done, see function run_mode_developer,
see demo `developer_tests::wip_galaxy_route_doublestar` that can be used in simulation of few nodes etc)

Q: How to debug a crash, memory leak, etc, how to run in valgrind/gdb
A: [debug.nocap] You can use gdb and valgrind, but if you have a problem there that the CAP privilages level
block your debug tool from working (as is the case with some hardened platforms) then if you can run
a test, or a demo [devel.demo] that does not require net CAP privilages etc,
then use the binary file that is not trying to get CAP rights,
the file `nocap-*` binary, e.g.: `nocap-tunserver.elf`
e.g.: `valgrind  ./nocap-tunserver.elf --devel`
e.g.: `valgrind  ./nocap-tunserver.elf --devel  --demo foo`


### FAQ

This FAQ contains some common problems and their solutions.
Problems that are solved will be moved to

Q: Build failed with: error like `cpp_int.hpp` or `right operand of shift expression` or `limb_type`
e.g.:
`
In file included from /usr/include/boost/config.hpp:61:0,
from /usr/include/boost/cstdint.hpp:36,
from /usr/include/boost/multiprecision/cpp_int.hpp:11,
from gcc6.cpp:1:
/usr/include/boost/multiprecision/cpp_int.hpp:193:4: error: right operand of shift expression ‘(1u << 63u)’ is >= than the precision of the left operand [-fpermissive]
BOOST_STATIC_CONSTANT(limb_type, sign_bit_mask = 1u << (limb_bits - 1));
`
A: Your system seems to include a broken version of lib boost (see bug https://svn.boost.org/trac/boost/ticket/12181),
if system update doesn't fix it then you can for now work around by
building with option: `USE_BOOST_MULTIPRECISION_DEFAULT=0 ./do`
(or set it in ccmake . and then build).

Q: Using gitian has error regarding Xenial `/usr/share/debootstrap/scripts/xenial`, e.g.:
`
E: No such script: /usr/share/debootstrap/scripts/xenial
Error occured, will exit (to create Xenial image (do you have the Xenial template?))
`
A: Older systems (e.g. Debian Jessie) do not include the template script file of Xenial.
Now our Gitian script should automatically work around this problem.
Some other solutions (if needed) would be to:
sudo cp -i galaxy42/contrib/gitian-debootstrap/scripts/xenial   /usr/share/debootstrap/scripts/
or install other version of system's debootstrap (e.g. backports).


Q: Errors like `profiling:invalid arc tag` or `profiling:invalid number of counters`
A: Do an `make clean` and try again. They can show up when you run more then once a build with coveralls/coverage active.
That option is intended for use by automated tools only, and they start in clearn environment.
You can also try: `find . -name "*.gcda" -print0 | xargs -0 rm`.
See: http://stackoverflow.com/questions/22519530/dozens-of-profilinginvalid-arc-tag-when-running-code-coverage-in-xcode-5