annotate contrib/peer2anonet/README @ 668:d76cc244e016 draft

Added "ping hack" to peer2anonet for users with dymanic IcannNet IP's
author d3v11 <d3v11@d3v11.ano>
date Sun, 09 Oct 2011 17:53:29 -0500
parents 6753fb814c94
children d76deb2af72f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
638
6753fb814c94 fixed some problems in peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 583
diff changeset
1 SYNOPSIS:
6753fb814c94 fixed some problems in peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 583
diff changeset
2 # Generate Keys:
6753fb814c94 fixed some problems in peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 583
diff changeset
3 quicktun.keypair</dev/random
535
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
4
549
5b5b29f8d8c7 peer2anonet: made some patches to script. see README file for details.
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 547
diff changeset
5 # Interactive prompt:
535
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
6 peer2anonet
549
5b5b29f8d8c7 peer2anonet: made some patches to script. see README file for details.
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 547
diff changeset
7
5b5b29f8d8c7 peer2anonet: made some patches to script. see README file for details.
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 547
diff changeset
8 # Accept pipe from file:
5b5b29f8d8c7 peer2anonet: made some patches to script. see README file for details.
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 547
diff changeset
9 peer2anonet < autoconfig.txt
535
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
10
549
5b5b29f8d8c7 peer2anonet: made some patches to script. see README file for details.
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 547
diff changeset
11 # Accept netcat pipe:
5b5b29f8d8c7 peer2anonet: made some patches to script. see README file for details.
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 547
diff changeset
12 nc -l 1337 | peer2anonet
5b5b29f8d8c7 peer2anonet: made some patches to script. see README file for details.
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 547
diff changeset
13
5b5b29f8d8c7 peer2anonet: made some patches to script. see README file for details.
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 547
diff changeset
14 # Send a netcat pipe:
583
f5ec84b7d825 restored old resdb from srn and added new changes for tinydns, my git domain, and peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 556
diff changeset
15 nc 1337 192.168.1.0 < autoconfig.txt
535
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
16
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
17 DESCRIPTION:
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
18 peer2anonet is an autoconfiguration utility to easily establish a
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
19 peering session with BGP on anonet2.
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
20
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
21 LICENSE:
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
22 This program is free software: you can redistribute it and/or modify
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
23 it under the terms of the GNU General Public License as published by
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
24 the Free Software Foundation, either version 3 of the License, or
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
25 (at your option) any later version.
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
26
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
27 This program is distributed in the hope that it will be useful,
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
28 but WITHOUT ANY WARRANTY; without even the implied warranty of
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
29 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
30 GNU General Public License for more details.
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
31
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
32 You should have received a copy of the GNU General Public License
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
33 along with this program. If not, see <http://www.gnu.org/licenses/>.
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
34
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
35 DEPENDS ON:
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
36 quicktun, bird, daemontools(non-deb), bash
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
37
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
38 INSTALL AND UNINSTALL:
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
39 ******************************************************************
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
40 * PEER2ANONET CAN AND WILL OVERWRITE /service AND /services, TO *
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
41 * INCLUDE FILES WITHIN THOSE DIRECTORIES. PLEASE CREATE BACKUPS *
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
42 * BEFORE INSTALLING AND USING PEER2ANONET AT ANY TIME! *
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
43 ******************************************************************
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
44
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
45 To install, `cd' to the extracted peer2anonet folder.
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
46 Issue the following commands as root:
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
47
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
48 make install
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
49
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
50 To uninstall peer2anonet, as root do:
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
51
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
52 make uninstall
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
53
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
54 To compile/install a .deb package, as root do:
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
55
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
56 make install-deb
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
57
537
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
58 USAGE:
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
59 You may execute peer2anonet and answer configuration questions
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
60 via interface or pipe a file containing the new peering
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
61 session's specifications to the executable. peer2anonet has
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
62 some security checks but it is highly recommended you check
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
63 a autoconfig file manually before using to prevent malicious
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
64 attacks. An autoconfig file should be in the following format:
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
65 Plain text file, one block of data per line, no spaces, and
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
66 without including the following '<-- comments'.
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
67
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
68 ================== Not Actual Line on File ============================
540
3e16925cf138 peer2anonet:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 539
diff changeset
69 anon <--your peer's alias
537
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
70 11.22.33.44 <--your peer's remote ip
668
d76cc244e016 Added "ping hack" to peer2anonet for users with dymanic IcannNet IP's
d3v11 <d3v11@d3v11.ano>
parents: 638
diff changeset
71 1.2.3.4 <--your peer's anonet ip
d76cc244e016 Added "ping hack" to peer2anonet for users with dymanic IcannNet IP's
d3v11 <d3v11@d3v11.ano>
parents: 638
diff changeset
72 4321 <--your peer's client port
d76cc244e016 Added "ping hack" to peer2anonet for users with dymanic IcannNet IP's
d3v11 <d3v11@d3v11.ano>
parents: 638
diff changeset
73 1234 <--your peer's asn
537
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
74 3c6e0b8a9c15224a8228b9a98ca1531d <--your peer's public key
547
76d0f12e2125 peer2anonet: made security enhancements for input data
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 545
diff changeset
75 ================== Not Actual Line on File ============================
76d0f12e2125 peer2anonet: made security enhancements for input data
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 545
diff changeset
76
76d0f12e2125 peer2anonet: made security enhancements for input data
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 545
diff changeset
77 At your discretion, you may exclude the public key from the
76d0f12e2125 peer2anonet: made security enhancements for input data
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 545
diff changeset
78 bottom of an autoconfig file and post installation of your new
638
6753fb814c94 fixed some problems in peer2anonet
d3v11 <d3v11@d3v11.ano>
parents: 583
diff changeset
79 peer service, peer2anonet will prompt foor it.
539
7b9a87c560ef peer2anonet:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 538
diff changeset
80
7b9a87c560ef peer2anonet:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 538
diff changeset
81
535
5965e074d13a added peer2anonet: autoconfig tool for easily setting up peering and bgp on anonet using quicktun, bird, and daemontools
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents:
diff changeset
82