├── LICENSE
├── Makefile
├── README.md
├── clusters.go
├── ipv6-addr2hex.go
├── ipv6-hex2addr.go
├── plot-clusters.py
└── profiles.go
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | default: all
2 | all: profiles clusters ipv6-addr2hex ipv6-hex2addr
3 |
4 | profiles: profiles.go
5 | go build -o profiles ./profiles.go
6 |
7 | clusters: clusters.go
8 | go build -o clusters ./clusters.go
9 |
10 | ipv6-addr2hex: ipv6-addr2hex.go
11 | go build -o ipv6-addr2hex ./ipv6-addr2hex.go
12 |
13 | ipv6-hex2addr: ipv6-hex2addr.go
14 | go build -o ipv6-hex2addr ./ipv6-hex2addr.go
15 |
16 | .PHONY: clean
17 | clean:
18 | -rm -f ./clusters ./profiles ./ipv6-hex2addr ./ipv6-addr2hex
19 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ENTROPY CLUSTERING
2 |
3 | Implementation of the Entropy Clustering algorithm for IPv6 networks, introduced in the ACM IMC'18 conference paper:
4 |
5 | > [Clusters in the Expanse: Understanding and Unbiasing IPv6 Hitlists](https://ipv6hitlist.github.io/), *Oliver Gasser, Quirin Scheitle, Paweł Foremski, Qasim Lone, Maciej Korczyński, Stephen D. Strowes, Luuk Hendriks, Georg Carle*, ACM Internet Measurement Conference 2018, Boston, MA, USA
6 |
7 | See [ipv6hitlist.github.io](https://ipv6hitlist.github.io/) for more details and output examples, as the one below:
8 |
9 | 
10 |
11 | # PREREQUISITES
12 |
13 | Install [Go](https://www.golang.org/) and the required packages:
14 | ```
15 | go get github.com/pforemski/gouda/...
16 | go get github.com/fatih/color
17 | ```
18 |
19 | Also, if you want to plot the results using this code, install Matplotlib, e.g.
20 | ```
21 | sudo apt-get install python-matplotlib
22 | ```
23 |
24 | # USAGE
25 |
26 | 1. Compile.
27 | ```
28 | make
29 | ```
30 | 2. Convert list of IPv6 addresses into a list of entropy profiles:
31 | ```
32 | cat ips.txt | ./profiles > profiles.txt
33 | ```
34 | 3. Find entropy clusters using k-means, e.g. for k=6:
35 | ```
36 | cat profiles.txt | ./clusters -kmeans -k 6 > clusters.txt
37 | ```
38 | 4. Finally, plot the results:
39 | ```
40 | cat clusters.txt | ./plot-clusters.py
41 | ```
42 |
43 | # AUTHOR
44 | Written by Paweł Foremski, [@pforemski](https://twitter.com/pforemski), 2018.
45 |
--------------------------------------------------------------------------------
/clusters.go:
--------------------------------------------------------------------------------
1 | /*
2 | * clusters: find clusters of entropy profiles
3 | *
4 | * Copyright (C) 2018 Pawel Foremski
5 | * Licensed under GNU GPL v3
6 | */
7 |
8 | package main
9 |
10 | import "os"
11 | import "bufio"
12 | import "fmt"
13 | import "flag"
14 | import "strings"
15 | import "strconv"
16 | import "sort"
17 | import "github.com/pforemski/gouda/point"
18 | import "github.com/pforemski/gouda/dbscan"
19 | import "github.com/pforemski/gouda/kmeans"
20 | import "github.com/fatih/color"
21 |
22 | // command line arguments
23 | var (
24 | opt_eps = flag.Float64("eps", 0.1, "DBSCAN eps parameter")
25 | opt_min_points = flag.Int("min-points", 2, "DBSCAN min points parameter")
26 | opt_F = flag.Int("F", 0, "ignore first F hex characters")
27 | opt_L = flag.Int("L", 0, "ignore last L hex characters")
28 | opt_N = flag.Bool("N", false, "show noise (cluster 0)")
29 | opt_C = flag.Bool("C", false, "print entropy values in color")
30 | opt_P = flag.String("P", "", "use given prefix2as mapping file")
31 | opt_S = flag.Bool("S", false, "print means & std deviations")
32 |
33 | opt_kmeans = flag.Bool("kmeans", false, "use k-means clustering instead of DBSCAN")
34 | opt_k = flag.Int("k", 10, "number of k-means clusters to look for")
35 | opt_max_iter = flag.Int("max-iter", 50, "max. number of k-means iterations")
36 | opt_min_change = flag.Float64("min-change", 0.01, "min. change in k-means centers to keep trying")
37 | opt_maxdiff = flag.Bool("maxdiff", false, "use Maxdiff distance for k-means")
38 | )
39 |
40 | // rewrite a slice of strings in color, using color_fslice()
41 | func color_slice(str []string) []string {
42 | vals := make([]float64, len(str))
43 | for i,s := range str { vals[i],_ = strconv.ParseFloat(s, 64) }
44 | return color_fslice(vals, 1.0)
45 | }
46 |
47 | // rewrite a slice of float64s in color, according to their values 0.0-1.0*fact
48 | func color_fslice(vals []float64, fact float64) []string {
49 | ret := make([]string, len(vals))
50 |
51 | for i,val := range vals {
52 | fval := val * fact
53 | switch {
54 | case fval > 0.9: ret[i] = color.RedString("%.3f", val)
55 | case fval > 0.5: ret[i] = color.YellowString("%.3f", val)
56 | case fval > 0.3: ret[i] = color.MagentaString("%.3f", val)
57 | case fval > 0.1: ret[i] = color.CyanString("%.3f", val)
58 | case fval > 0.025: ret[i] = color.BlueString("%.3f", val)
59 | default: ret[i] = color.GreenString("%.3f", val)
60 | }
61 | }
62 |
63 | return ret
64 | }
65 |
66 | // percentage pretty-printer
67 | func pcnt_pp(pcnt float64) string {
68 | str := make([]byte, 0, 100)
69 | for i := 0.0; i < pcnt; i += 0.01 {
70 | str = append(str, '#')
71 | }
72 | return string(str[:]) + fmt.Sprintf(" %.3g%%", pcnt*100.0)
73 | }
74 |
75 | // read a prefix2as file
76 | func read_prefix2as(path string, p2a map[string]string) error {
77 | fh, err := os.Open(path)
78 | if err != nil { return err }
79 |
80 | scanner := bufio.NewScanner(fh)
81 | for scanner.Scan() {
82 | line := scanner.Text()
83 | if line[0] != '2' { continue }
84 | d := strings.Split(line, "\t")
85 | if len(d) != 3 { continue }
86 |
87 | prefix := d[0]
88 | plen,_ := strconv.Atoi(d[1])
89 | plen /= 4
90 | asn := d[2]
91 |
92 | // sanitize asn
93 | if len(asn) > 5 { asn = asn[0:5] }
94 | if i := strings.Index(asn, "_"); i > 0 { asn = asn[0:i] }
95 |
96 | if _,ok := p2a[prefix[0:8]]; !ok { p2a[prefix[0:8]] = asn }
97 | if _,ok := p2a[prefix[0:plen]]; !ok { p2a[prefix[0:plen]] = asn }
98 | }
99 |
100 | return nil
101 | }
102 |
103 | func main() {
104 | // parse args
105 | flag.Parse()
106 |
107 | // use opts
108 | if *opt_C { color.NoColor = false } // force
109 |
110 | p2a := make(map[string]string)
111 | if *opt_P != "" {
112 | err := read_prefix2as(*opt_P, p2a)
113 | if err != nil {
114 | fmt.Fprintln(os.Stderr, "reading prefix2as:", err)
115 | os.Exit(1)
116 | }
117 | }
118 |
119 | // prepare
120 | profiles := make(point.Points, 0)
121 |
122 | // read input
123 | scanner := bufio.NewScanner(os.Stdin)
124 | for scanner.Scan() {
125 | line := scanner.Text()
126 | if len(line) < 2 || line[0] == '#' { continue }
127 |
128 | // parse the profile
129 | d := strings.Split(line, ",")
130 | if len(d) < 3 { continue }
131 | point := &point.Point{}
132 | point.D = d
133 | point.V = make([]float64, len(d)-2-*opt_F-*opt_L)
134 | for i,s := range d[2+*opt_F:len(d)-*opt_L] {
135 | point.V[i],_ = strconv.ParseFloat(s, 64)
136 | }
137 |
138 | // append
139 | profiles = append(profiles, point)
140 | }
141 | if err := scanner.Err(); err != nil {
142 | fmt.Fprintln(os.Stderr, "reading standard input:", err)
143 | os.Exit(1)
144 | }
145 |
146 | if len(profiles) == 0 {
147 | fmt.Fprintln(os.Stderr, "no profiles read from stdin, exiting")
148 | os.Exit(1)
149 | }
150 |
151 | // find clusters
152 | var eps []float64
153 | var clusters []point.Points
154 | if *opt_kmeans == true {
155 | // find k clusters using k-means
156 | if *opt_maxdiff {
157 | clusters = kmeans.SearchDist(profiles, *opt_k, *opt_max_iter, *opt_min_change, point.Maxdiff)
158 | } else {
159 | clusters = kmeans.SearchDist(profiles, *opt_k, *opt_max_iter, *opt_min_change, point.Euclidean)
160 | }
161 |
162 | // sort clusters by number of prefixes
163 | sort.Slice(clusters, func(i,j int) bool {
164 | return len(clusters[i]) > len(clusters[j])
165 | })
166 |
167 | } else {
168 | eps = make([]float64, len(profiles[0].V))
169 | for i := range eps { eps[i] = *opt_eps }
170 | clusters = dbscan.Search(profiles, eps, *opt_min_points)
171 |
172 | // sort clusters by number of prefixes
173 | sort.Slice(clusters, func(i,j int) bool {
174 | if i == 0 { return true }
175 | if j == 0 { return false }
176 | return len(clusters[i]) > len(clusters[j])
177 | })
178 | }
179 |
180 | // print clusters
181 | for cluster,points := range clusters {
182 | // skip noise?
183 | if *opt_kmeans == false {
184 | if cluster == 0 && *opt_N == false { continue }
185 | }
186 |
187 | // sort points in cluster by prefix
188 | sort.Slice(points, func(i,j int) bool {
189 | return points[i].D.([]string)[0] < points[j].D.([]string)[0]
190 | })
191 |
192 | fmt.Printf("=== cluster #%d ===\n", cluster)
193 | for i := range points {
194 | d := points[i].D.([]string)
195 |
196 | // print prefix
197 | prefix := d[0]
198 | if len(prefix) > 8 && prefix[len(prefix)-3] == '/' {
199 | fmt.Printf("%20s ", prefix)
200 | } else {
201 | fmt.Printf("%s ", prefix)
202 | }
203 | d = d[2:]
204 |
205 | // print AS?
206 | if *opt_P != "" {
207 | as,ok := p2a[prefix[0:8]]
208 | if !ok {
209 | for l := len(prefix); l >= 4; l-- {
210 | if as,ok = p2a[prefix[0:l]]; ok { break }
211 | }
212 | }
213 | fmt.Printf("[%5s] ", as)
214 | }
215 |
216 | // print ignored nybbles (first)
217 | if *opt_F > 0 { fmt.Printf("(%s) ", strings.Join(d[0:*opt_F], " ")); d = d[*opt_F:] }
218 |
219 | // print nybbles used for clustering
220 | e := d[0:len(d)-*opt_L]
221 | if *opt_C { e = color_slice(e) }
222 | fmt.Printf("%s", strings.Join(e, " "))
223 |
224 | // print ignored nybbles (last)
225 | if *opt_L > 0 { fmt.Printf(" (%s)", strings.Join(d[len(d)-*opt_L:], " ")) }
226 |
227 | fmt.Printf("\n")
228 | }
229 | fmt.Printf("\n")
230 | }
231 |
232 | // print stats
233 | all := len(profiles)
234 | fmt.Printf("SUMMARY\n")
235 | fmt.Printf("-------\n")
236 | fmt.Printf("Analyzed prefixes: %d\n", all)
237 |
238 | fmt.Printf("Cluster summaries:\n")
239 | sse := 0.0
240 | for i := range clusters {
241 | // skip noise?
242 | if *opt_kmeans == false && i == 0 && *opt_N == false { continue }
243 |
244 | mean := clusters[i].Mean()
245 | sd := clusters[i].Stddev(mean)
246 | median := clusters[i].Median()
247 | pcnt := float64(len(clusters[i])) / float64(all)
248 |
249 | // cluster quality
250 | wss := clusters[i].Errors(mean).Sum()
251 | sse += wss
252 |
253 | fmt.Printf("cluster %2d: ", i)
254 | if *opt_C {
255 | fmt.Printf("%s %s (%.3g)\n", color_fslice(median.V, 1.0), pcnt_pp(pcnt), wss)
256 | if *opt_S {
257 | fmt.Printf(" mean: %s\n", color_fslice(mean.V, 1.0))
258 | fmt.Printf(" stddev: %s\n\n", color_fslice(sd.V, 4.0))
259 | }
260 | } else {
261 | fmt.Printf("%.3f %.3f %.3f\n", median.V, pcnt*100.0, wss)
262 | if *opt_S {
263 | fmt.Printf(" mean: %.3f\n", mean.V)
264 | fmt.Printf(" stddev: %.3f\n\n", sd.V)
265 | }
266 | }
267 | }
268 | fmt.Printf("%.2f\n", sse)
269 |
270 | if *opt_kmeans == false {
271 | noise := len(clusters[0])
272 | incluster := all - noise
273 |
274 | fmt.Printf("DBSCAN parameters: eps=%g, min_points=%d\n", *opt_eps, *opt_min_points)
275 | fmt.Printf("Analyzed prefixes: %d\n", all)
276 | fmt.Printf("Clusters found: %d\n", len(clusters))
277 | fmt.Printf(" prefixes in clusters: %d (%.1f%%)\n",
278 | incluster, float64(incluster) / float64(all) * 100.0)
279 | fmt.Printf(" noise: %d (%.1f%%)\n", noise, float64(noise) / float64(all) * 100.0)
280 | }
281 | }
282 |
--------------------------------------------------------------------------------
/ipv6-addr2hex.go:
--------------------------------------------------------------------------------
1 | /*
2 | * ipv6-addr2hex: convert IPv6 addresses to hex IP format
3 | * Author: Pawel Foremski
4 | */
5 |
6 | package main
7 |
8 | import "os"
9 | import "bufio"
10 | import "fmt"
11 | import "net"
12 | import "flag"
13 | import "strings"
14 |
15 | const d2x = "0123456789abcdef"
16 |
17 | // command line arguments
18 | var (
19 | opt_d = flag.String("d", "\t", "field delimiter")
20 | opt_f = flag.Int("f", 0, "field number")
21 | )
22 |
23 | func main() {
24 | // parse args
25 | flag.Parse()
26 | *opt_f -= 1
27 |
28 | // prepare
29 | var d []string
30 | var ipstr string
31 | s := make([]byte, 32)
32 |
33 | scanner := bufio.NewScanner(os.Stdin)
34 | for scanner.Scan() {
35 | line := scanner.Text()
36 |
37 | // extract field?
38 | if *opt_f >= 0 {
39 | d = strings.Split(line, *opt_d)
40 | if *opt_f >= len(d) {
41 | fmt.Println(line)
42 | continue
43 | }
44 | ipstr = d[*opt_f]
45 | } else {
46 | ipstr = line
47 | }
48 |
49 | // parsable?
50 | ip := net.ParseIP(ipstr)
51 | if ip == nil {
52 | fmt.Println(line)
53 | continue
54 | }
55 |
56 | // adapted from golang's net/ip.go
57 | s = s[:len(ip)*2]
58 | for i,d := range ip {
59 | s[i*2], s[i*2+1] = d2x[d>>4], d2x[d&0xf]
60 | }
61 |
62 | if *opt_f >= 0 {
63 | d[*opt_f] = string(s)
64 | fmt.Println(strings.Join(d, *opt_d))
65 | } else {
66 | fmt.Println(string(s))
67 | }
68 | }
69 | }
70 |
--------------------------------------------------------------------------------
/ipv6-hex2addr.go:
--------------------------------------------------------------------------------
1 | /*
2 | * ipv6-hex2addr: convert IPv6 addresses from hex IP format
3 | * Author: Pawel Foremski
4 | */
5 |
6 | package main
7 |
8 | import "os"
9 | import "bufio"
10 | import "fmt"
11 |
12 | func main() {
13 | scanner := bufio.NewScanner(os.Stdin)
14 | for scanner.Scan() {
15 | l := scanner.Text()
16 | fmt.Printf("%s:%s:%s:%s:%s:%s:%s:%s\n",
17 | l[0:4], l[4:8], l[8:12], l[12:16],
18 | l[16:20], l[20:24], l[24:28], l[28:])
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/plot-clusters.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | #
3 | # plot: plot results of entropy clustering
4 | #
5 | # Copyright (C) 2018 Pawel Foremski
6 | # Licensed under GNU GPL v3
7 | #
8 |
9 | from __future__ import print_function
10 |
11 | import numpy as np
12 | import matplotlib.pyplot as plt
13 | from matplotlib import cm
14 | import matplotlib.gridspec as gridspec
15 | import matplotlib.ticker as plticker
16 | # restore matplotlib 1 style
17 | import matplotlib.style
18 | import matplotlib as mpl
19 | mpl.style.use('classic')
20 |
21 | # read clusters
22 | def read_clusters(args, source):
23 | clusters = []
24 | for line in source:
25 | # strip
26 | line = line.strip()
27 | if len(line) == 0: continue
28 |
29 | # infer -F
30 | if line[0] == '2'and args.s < 0:
31 | try:
32 | j = line[:-1].index(')')
33 | i = line[:j].rindex('(')
34 | args.s = 10 + line[i:j].count(' ')
35 | except:
36 | args.s = 9
37 |
38 | if line[0:7] != "cluster": continue
39 | line = line[13:]
40 |
41 | p = line.index("]")
42 | profile = [float(x) for x in line[:p].split(" ")]
43 | details = [float(x) for x in line[p+2:].split(" ")]
44 | clusters.append({
45 | "P": profile,
46 | "%": details[0],
47 | "E": details[1]
48 | })
49 |
50 | return clusters
51 |
52 | def plot(args, clusters):
53 | # prepare the canvas
54 | plt.figure(figsize=(8,3), dpi=100)
55 | plt.gcf().subplots_adjust(bottom=0.18)
56 | gs = gridspec.GridSpec(1, 4, wspace=0.09)
57 | ax1 = plt.subplot(gs[0, 0])
58 | ax2 = plt.subplot(gs[0, 1:])
59 |
60 | # show colormap (hack!)
61 | foo = ax2.imshow(np.array([np.arange(0, 1.01, 0.01)]), visible=False, aspect='auto')
62 | cb = plt.colorbar(foo, pad=0.02, ticks=np.arange(0, 1.01, 0.2))
63 | cb.set_label("Median entropy")
64 | ax2.clear()
65 |
66 | # tweak ax1
67 | ax1.invert_xaxis()
68 | ax1.xaxis.set_label_text(args.type + " [%]" if args.type else "Prefixes [%]")
69 | ax1.xaxis.set_major_locator(plticker.MultipleLocator(10))
70 | ax1.xaxis.set_minor_locator(plticker.MultipleLocator(5.0))
71 | ax1.xaxis.grid(which='both')
72 |
73 | ax1.set_ylim(len(clusters)+0.5, 0.5)
74 | ax1.yaxis.set_ticks(range(1, len(clusters)+1))
75 | ax1.yaxis.set_label_text("Cluster ID")
76 |
77 | # tweak ax2
78 | ax2.xaxis.set_ticks(range(args.s, args.s+args.l))
79 | if args.l > 8:
80 | labels = []
81 | for x in range(args.l):
82 | if x % 2 == 0:
83 | labels.append("")
84 | else:
85 | labels.append("%d" % (args.s + x))
86 | ax2.xaxis.set_ticklabels(labels)
87 | ax2.xaxis.set_label_text("IPv6 nybble (hex character)")
88 |
89 | ax2.set_ylim(len(clusters)+0.5, 0.5)
90 | ax2.yaxis.set_ticks(range(1, len(clusters)+1))
91 | ax2.yaxis.set_ticklabels([])
92 |
93 | # draw entropy profiles
94 | foo = None
95 | for y,cluster in enumerate(clusters):
96 | for x,ent in enumerate(cluster["P"]):
97 | ax2.barh(y+1, 1.0, 0.8, args.s+x-0.5, align='center', color=cm.jet(ent))
98 |
99 | ax1.barh(y+1, cluster["%"], 0.4, align='center', color='red')
100 |
101 | def main():
102 | import argparse
103 | import sys
104 |
105 | # parse arguments
106 | p = argparse.ArgumentParser()
107 | p.add_argument('--file')
108 | p.add_argument('--save')
109 | p.add_argument('--type')
110 | p.add_argument('-s', type=int, default=-1)
111 | p.add_argument('-l', type=int, default=-1)
112 | args = p.parse_args()
113 |
114 | # read clusters
115 | if args.file:
116 | clusters = read_clusters(args, open(args.file))
117 | else:
118 | clusters = read_clusters(args, sys.stdin)
119 |
120 | # infer location
121 | if args.s < 0: args.s = 9
122 | if args.l < 0: args.l = len(clusters[0]["P"])
123 |
124 | # plot it
125 | plot(args, clusters)
126 |
127 | # show it
128 | if args.save:
129 | plt.savefig(args.save)
130 | print("Saved to", (args.save))
131 | else:
132 | plt.show()
133 |
134 | if __name__ == "__main__": main()
135 |
--------------------------------------------------------------------------------
/profiles.go:
--------------------------------------------------------------------------------
1 | /*
2 | * profiles: compute entropy profiles for hex ipv6 addresses on stdin
3 | *
4 | * Copyright (C) 2018 Pawel Foremski
5 | * Licensed under GNU GPL v3
6 | */
7 |
8 | package main
9 |
10 | import "os"
11 | import "bufio"
12 | import "fmt"
13 | import "flag"
14 | import "sync"
15 | import "math"
16 | import "sort"
17 | import "strings"
18 |
19 | // represents data for a prefix
20 | type Prefixd struct {
21 | counts [32][16]uint64 // hex value counts for all 32 nybbles
22 | input chan string // line input
23 | lines uint64 // lines read so far
24 | wg *sync.WaitGroup // waitgroup
25 | }
26 |
27 | // command line arguments
28 | var (
29 | opt_P = flag.Int("P", 8, "prefix length")
30 | opt_m = flag.Uint64("m", 100, "minimum number of IPv6 addrs required in a prefix")
31 | opt_p = flag.Bool("p", false, "print counts")
32 | opt_f = flag.Int("f", 0, "use CSV column f as prefix")
33 | )
34 |
35 | // processor counts hex values in given prefix
36 | func (pd *Prefixd) processor() {
37 | for line := range pd.input {
38 | pd.lines++
39 | for i, v := range line[*opt_P:32] {
40 | if v >= '0' && v <= '9' {
41 | pd.counts[i][v-'0']++
42 | } else if v >= 'a' && v <= 'f' {
43 | pd.counts[i][v-'a'+10]++
44 | } else if v >= 'A' && v <= 'F' {
45 | pd.counts[i][v-'A'+10]++
46 | }
47 | }
48 | }
49 | pd.wg.Done()
50 | }
51 |
52 | func main() {
53 | // parse args
54 | flag.Parse()
55 |
56 | // prepare
57 | prefixes := make(map[string]*Prefixd)
58 |
59 | // read input and distribute to processors
60 | scanner := bufio.NewScanner(os.Stdin)
61 | for scanner.Scan() {
62 | line := scanner.Text()
63 | if line[0] != '2' { continue }
64 |
65 | // determine prefix - the table key
66 | var prefix string
67 | if *opt_f > 0 {
68 | d := strings.Split(line, ",")
69 | prefix = d[*opt_f-1]
70 | } else {
71 | prefix = line[0:*opt_P]
72 | }
73 |
74 | pd, ok := prefixes[prefix]
75 | if !ok {
76 | pd = &Prefixd{}
77 | prefixes[prefix] = pd
78 |
79 | pd.input = make(chan string, 1000)
80 | pd.wg = new(sync.WaitGroup)
81 | pd.wg.Add(1)
82 | go pd.processor()
83 | }
84 |
85 | pd.input <- line
86 | }
87 | if err := scanner.Err(); err != nil {
88 | fmt.Fprintln(os.Stderr, "reading standard input:", err)
89 | os.Exit(1)
90 | }
91 |
92 | // notify we're done, collect prefixes
93 | keys := make([]string, 0, len(prefixes))
94 | for prefix := range prefixes {
95 | close(prefixes[prefix].input)
96 | keys = append(keys, prefix)
97 | }
98 | sort.Strings(keys)
99 |
100 | // print header
101 | fmt.Printf("#prefix,addresses,")
102 | for i := 0; i < 32 - *opt_P; i++ {
103 | if i > 0 { fmt.Printf(",") }
104 | fmt.Printf("ent%d", *opt_P + i + 1)
105 | }
106 | fmt.Printf("\n")
107 |
108 | // iterate
109 | for _,prefix := range keys {
110 | // sync
111 | pd := prefixes[prefix]
112 | pd.wg.Wait()
113 |
114 | // big enough?
115 | if pd.lines < *opt_m { continue }
116 |
117 | // print counts?
118 | if *opt_p {
119 | fmt.Printf("# === prefix %s ===\n", prefix)
120 | fmt.Printf("# value: ")
121 | for v := '0'; v <= '9'; v++ { fmt.Printf(" '%c' ", v) }
122 | for v := 'a'; v <= 'f'; v++ { fmt.Printf(" '%c' ", v) }
123 | fmt.Printf("\n")
124 | for i := 0; i < 32 - *opt_P; i++ {
125 | fmt.Printf("# char %2d: %5d\n", i+1+*opt_P, pd.counts[i])
126 | }
127 | }
128 |
129 | // print entropy
130 | fmt.Printf("%s,%d,", prefix, pd.lines)
131 | for i := 0; i < 32 - *opt_P; i++ {
132 | var entropy float64
133 |
134 | for v := 0; v < 16; v++ {
135 | if pd.counts[i][v] == 0 { continue }
136 |
137 | freq := float64(pd.counts[i][v]) / float64(pd.lines)
138 | entropy -= freq * math.Log2(freq)
139 | }
140 |
141 | // print normalized
142 | if i > 0 { fmt.Printf(",") }
143 | fmt.Printf("%.3f", entropy / 4.0)
144 | }
145 | fmt.Printf("\n")
146 | }
147 | }
148 |
--------------------------------------------------------------------------------