| 1 | package NetworkInfo::Discovery; | ||
| 2 | |||
| 3 | use strict; | ||
| 4 | use warnings; | ||
| 5 | use vars qw($VERSION); | ||
| 6 | use NetworkInfo::Discovery::Register; | ||
| 7 | |||
| 8 | $VERSION = '0.12'; | ||
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | NetworkInfo::Discovery - Modules for network discovery and mapping | ||
| 13 | |||
| 14 | =head1 DESCRIPTION | ||
| 15 | |||
| 16 | NetworkInfo::Discovery is a set of modules that can be used to discover network | ||
| 17 | topology, interfaces on the network, and information about the links between subnets. | ||
| 18 | This information is brought together into C<NetworkInfo::Discovery::Register> | ||
| 19 | where it can be examined and used to build a unified map of the network. | ||
| 20 | The network map is controlled from a single location. | ||
| 21 | |||
| 22 | Host detection currently runs from a single location, but in the future | ||
| 23 | there will be support for having remote agents that contribute to the | ||
| 24 | central map. | ||
| 25 | |||
| 26 | =head1 MODULE LAYOUT | ||
| 27 | |||
| 28 | NetworkInfo::Discovery consists of several modules that all into three categories: | ||
| 29 | |||
| 30 | =head2 Register | ||
| 31 | |||
| 32 | The Register maintains a full picture of the network. Anything that is discovered | ||
| 33 | should be put into the Register where little details can be used to build the | ||
| 34 | larger picture. | ||
| 35 | |||
| 36 | =head2 Network Objects | ||
| 37 | |||
| 38 | These are the things about your network that you want to discover. Namely, interfaces, | ||
| 39 | subnets, and gateways. See L<NetworkInfo::Discovery::Register> for details about what | ||
| 40 | attributes these have. | ||
| 41 | |||
| 42 | =head2 Detection Modules | ||
| 43 | |||
| 44 | These modules should all be a subclass of C<NetworkInfo::Discovery::Detect>. | ||
| 45 | It is their job to detect interfaces, gateways, and subnets that can then be | ||
| 46 | fed into the register. The following are the existing detection modules: | ||
| 47 | |||
| 48 | =over 4 | ||
| 49 | |||
| 50 | =item Sniff | ||
| 51 | |||
| 52 | is a passive monitor that listens to ethernet traffic on the | ||
| 53 | local sement to build a list of Hosts. | ||
| 54 | |||
| 55 | =item Traceroute | ||
| 56 | |||
| 57 | is used to map interfaces and gateways using traceroute. | ||
| 58 | |||
| 59 | =item Scan | ||
| 60 | |||
| 61 | is used to probe ip addresses or ranges of ip addresses for open tcp or udp ports. | ||
| 62 | |||
| 63 | =back | ||
| 64 | |||
| 65 | =head1 AVAILABILITY | ||
| 66 | |||
| 67 | This module can be found in CPAN at http://www.cpan.org/authors/id/T/TS/TSCANLAN/ | ||
| 68 | or at http://they.gotdns.org:88/~tscanlan/perl/ | ||
| 69 | |||
| 70 | =head1 AUTHOR | ||
| 71 | |||
| 72 | Tom Scanlan <tscanlan@they.gotdns.org> | ||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | L<NetworkInfo::Discovery::Register> | ||
| 77 | |||
| 78 | L<NetworkInfo::Discovery::Detect> | ||
| 79 | |||
| 80 | L<NetworkInfo::Discovery::Sniff> | ||
| 81 | |||
| 82 | L<NetworkInfo::Discovery::Traceroute> | ||
| 83 | |||
| 84 | L<NetworkInfo::Discovery::Scan> | ||
| 85 | |||
| 86 | =head1 BUGS | ||
| 87 | |||
| 88 | Please send any bugs to Tom Scanlan <tscanlan@they.gotdns.org> | ||
| 89 | |||
| 90 | =head1 COPYRIGHT AND LICENCE | ||
| 91 | |||
| 92 | Copyright (c) 2002 Thomas P. Scanlan IV. All rights reserved. | ||
| 93 | This program is free software; you can redistribute it and/or | ||
| 94 | modify it under the same terms as Perl itself. | ||
| 95 | |||
| 96 | =cut | ||
| 97 | |||
| 98 | 1; |