annotate contrib/peer2anonet/README @ 538:3247a742e3f8 draft

peer2anonet: Sun Jul 10 07:25:42 CDT 2011 - d3v1150m471c * security checks, whitespace removed after some data
author d3v1150m471c <d3v11@d3v1150m471c.ano>
date Sun, 10 Jul 2011 07:26:48 -0500
parents 8e8a01a680b4
children 7b9a87c560ef
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
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
1 ____ _
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
2 _ __ ___ ___ _ _|___ \ __ _ _ __ ___ _ __ ___| |_
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
3 | '_ \ / _ \/ _ \ '__|__) / _` | '_ \ / _ \| '_ \ / _ \ __|
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 | |_) | __/ __/ | / __/ (_| | | | | (_) | | | | __/ |_
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
5 | .__/ \___|\___|_| |_____\__,_|_| |_|\___/|_| |_|\___|\__|
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 |_|
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
7
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
8 SYNOPSIS:
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
9 peer2anonet
537
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
10 -OR-
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
11 peer2anonet < autoconfig
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
12
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
13
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
14 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
15 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
16 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
17
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 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
19 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
20 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
21 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
22 (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
23
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 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
25 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
26 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
27 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
28
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 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
30 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
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 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
33 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
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 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
36 ******************************************************************
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 * 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
38 * 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
39 * 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
40 ******************************************************************
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
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 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
43 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
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 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
46
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 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
48
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 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
50
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 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
52
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 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
54
537
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
55 USAGE:
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
56 You may execute peer2anonet and answer configuration questions
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
57 via interface or pipe a file containing the new peering
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
58 session's specifications to the executable. peer2anonet has
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
59 some security checks but it is highly recommended you check
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
60 a autoconfig file manually before using to prevent malicious
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
61 attacks. An autoconfig file should be in the following format:
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
62 Plain text file, one block of data per line, no spaces, and
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
63 without including the following '<-- comments'.
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
64
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
65 ================== Not Actual Line on File ============================
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
66 anon <--your peer's alias
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
67 1.2.3.0 <--your new anonet network address
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
68 1.2.3.1 <--your new anonet router address
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
69 1.2.3.2 <--your new anonet ip
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
70 1001 <--your new anonet client port
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
71 1230 <--you new asn
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
72 11.22.33.44 <--your peer's remote ip
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
73 3.5.7.9 <--your peer's anonet ip
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
74 3571 <--your peer's client port
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
75 3570 <--your peer's asn
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
76 3c6e0b8a9c15224a8228b9a98ca1531d <--your peer's public key
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
77 ================== Not Actual Line on File ============================
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
78
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
79
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
80 CHANGES:
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
81 Sat Jul 9 06:48:58 CDT 2011 - d3v1150m471c
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 * quicktun's "EXPORT DEBUG=1" removed on peering script.
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
83 * some variables removed, info now passed directly to files.
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
84 * peering.in removed. info passed directly to peering and
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
85 then given executable status. Corresponding makefile
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
86 was also removed.
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
87 * Public key question corrected.
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
88 * daemontools non-deb specified in README.
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
89 * trimmed off unnecessary tests.
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
90 * bash added to dependencies
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
91 * file tests with mkdir changed to `mkdir -p`... .
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
92 * peering file removed, passes directly to run file now.
537
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
93
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
94 Sun Jul 10 05:47:22 CDT 2011 - d3v1150m471c
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
95 * makefile changed to Makefile
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
96 * parse quicktun.keypair</dev/random directly to seckey variable.
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
97 * removed y/n questions with file tests and automatic
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
98 configuration.
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
99 * README file updated
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
100 * ported for autoconfig file pipes
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
101 * some security checks created
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
102
538
3247a742e3f8 peer2anonet:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 537
diff changeset
103 Sun Jul 10 07:25:42 CDT 2011 - d3v1150m471c
3247a742e3f8 peer2anonet:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 537
diff changeset
104 * security checks, whitespace removed after some data
537
8e8a01a680b4 peer2anonet changes made:
d3v1150m471c <d3v11@d3v1150m471c.ano>
parents: 535
diff changeset
105
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
106