… | |
… | |
3 | AnyEvent::Porttracker - Porttracker/PortIQ API client interface. |
3 | AnyEvent::Porttracker - Porttracker/PortIQ API client interface. |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use AnyEvent::Porttracker; |
7 | use AnyEvent::Porttracker; |
|
|
8 | |
|
|
9 | my $api = new AnyEvent::Porttracker |
|
|
10 | host => "10.0.0.1", |
|
|
11 | user => "admin", |
|
|
12 | pass => "31331", |
|
|
13 | tls => 1, |
|
|
14 | ; |
|
|
15 | |
|
|
16 | # Example 1 |
|
|
17 | # a simple request: ping the server |
|
|
18 | |
|
|
19 | $api->req ("ping", sub { |
|
|
20 | my ($api, $ok, $timestamp, $pid) = @_; |
|
|
21 | ... |
|
|
22 | }); |
|
|
23 | |
|
|
24 | # Example 2 |
|
|
25 | # find all realms, start a discovery on all of them |
|
|
26 | # and wait until all discovery processes have finished |
|
|
27 | |
|
|
28 | my $cv = AE::cv; |
|
|
29 | |
|
|
30 | $cv->begin; |
|
|
31 | # find all realms |
|
|
32 | $api->req (realm_info => ["gid", "name"], sub { |
|
|
33 | my ($api, @realms) = @_; |
|
|
34 | |
|
|
35 | # start discovery on all realms |
|
|
36 | for my $realm (@realms) { |
|
|
37 | my ($gid, $name) = @$realm; |
|
|
38 | |
|
|
39 | $cv->begin; |
|
|
40 | $api->req (realm_discover => $realm->[0], sub { |
|
|
41 | warn "discovery for realm '$realm->[1]' finished\n"; |
|
|
42 | $cv->end; |
|
|
43 | }); |
|
|
44 | } |
|
|
45 | |
|
|
46 | $cv->end; |
|
|
47 | }); |
|
|
48 | |
|
|
49 | $cv->recv; |
|
|
50 | |
|
|
51 | # Example 3 |
|
|
52 | # subscribe to realm_poll_stop events and report each occurance |
|
|
53 | |
|
|
54 | $api->req (subscribe => "realm_poll_stop", sub {}); |
|
|
55 | $api->on (realm_poll_stop_event => sub { |
|
|
56 | my ($api, $gid) = @_; |
|
|
57 | warn "this just in: poll for realm <$gid> finished.\n"; |
|
|
58 | }); |
8 | |
59 | |
9 | =head1 DESCRIPTION |
60 | =head1 DESCRIPTION |
10 | |
61 | |
11 | Porttracker (L<http://www.porttracker.com/>) is a product that (among |
62 | Porttracker (L<http://www.porttracker.com/>) is a product that (among |
12 | other things) scans switches and routers in a network and gives a coherent |
63 | other things) scans switches and routers in a network and gives a coherent |
… | |
… | |
24 | run a supported event loop. |
75 | run a supported event loop. |
25 | |
76 | |
26 | To quickly understand how this module works you should read how to |
77 | To quickly understand how this module works you should read how to |
27 | construct a new connection object and then read about the event/callback |
78 | construct a new connection object and then read about the event/callback |
28 | system. |
79 | system. |
|
|
80 | |
|
|
81 | The actual low-level protocol and, more importantly, the existing |
|
|
82 | requests and responses, are documented in the official Porttracker |
|
|
83 | API documentation (a copy of which is included in this module as |
|
|
84 | L<AnyEvent::Porttracker::protocol>. |
29 | |
85 | |
30 | =head1 THE AnyEvent::Porttracker CLASS |
86 | =head1 THE AnyEvent::Porttracker CLASS |
31 | |
87 | |
32 | The AnyEvent::Porttracker class represents a single connection. |
88 | The AnyEvent::Porttracker class represents a single connection. |
33 | |
89 | |
… | |
… | |
88 | =item user => $string, pass => $string |
144 | =item user => $string, pass => $string |
89 | |
145 | |
90 | These are the username and password to use when authentication is required |
146 | These are the username and password to use when authentication is required |
91 | (which it is in almost all cases, so these keys are normally mandatory). |
147 | (which it is in almost all cases, so these keys are normally mandatory). |
92 | |
148 | |
93 | =item tls => ... |
149 | =item tls => $bool |
94 | |
150 | |
95 | #TODO# |
151 | Enables or disables TLS (default: disables). When enabled, then the |
|
|
152 | connection will try to handshake a TLS connection before logging in. If |
|
|
153 | unsuccessful a fatal error will be raised. |
|
|
154 | |
|
|
155 | Since most Porttracker/PortIQ boxes will not have a sensible/verifiable |
|
|
156 | certificate, no attempt at verifying it will be done (which means |
|
|
157 | man-in-the-middle-attacks will be trivial). If you want some form of |
|
|
158 | verification you need to provide your own C<tls_ctx> object with C<< |
|
|
159 | verify => 1, verify_peername => [1, 1, 1] >> or whatever verification mode |
|
|
160 | you wish to use. |
|
|
161 | |
|
|
162 | =item tls_ctx => $tls_ctx |
|
|
163 | |
|
|
164 | The L<AnyEvent::TLS> object to use. See C<tls>, above. |
96 | |
165 | |
97 | =item on_XYZ => $coderef |
166 | =item on_XYZ => $coderef |
98 | |
167 | |
99 | You can specify event callbacks either by subclassing and overriding the |
168 | You can specify event callbacks either by sub-classing and overriding the |
100 | respective methods or by specifying coderefs as key-value pairs when |
169 | respective methods or by specifying code-refs as key-value pairs when |
101 | constructing the object. |
170 | constructing the object. You add or remove event handlers at any time with |
|
|
171 | the C<event> method. |
102 | |
172 | |
103 | =back |
173 | =back |
104 | |
174 | |
105 | =cut |
175 | =cut |
106 | |
176 | |
… | |
… | |
108 | my $class = shift; |
178 | my $class = shift; |
109 | |
179 | |
110 | my $self = bless { |
180 | my $self = bless { |
111 | id => "a", |
181 | id => "a", |
112 | ids => [], |
182 | ids => [], |
113 | queue => [], # ininitially queue everything |
183 | queue => [], # initially queue everything |
114 | @_, |
184 | @_, |
115 | }, $class; |
185 | }, $class; |
116 | |
186 | |
117 | { |
187 | { |
118 | Scalar::Util::weaken (my $self = $self); |
188 | Scalar::Util::weaken (my $self = $self); |
119 | |
189 | |
120 | $self->{hdl} = new AnyEvent::Handle |
190 | $self->{hdl} = new AnyEvent::Handle |
121 | connect => [$self->{host}, $self->{port} || "porttracker=55"], |
191 | connect => [$self->{host}, $self->{port} || "porttracker=55"], |
122 | on_error => sub { |
192 | on_error => sub { |
123 | $self->error (); |
193 | $self->error ($_[2]); |
124 | }, |
194 | }, |
125 | on_connect => sub { |
195 | on_connect => sub { |
126 | if ($self->{tls}) { |
196 | if ($self->{tls}) { |
127 | $self->_req (start_tls => sub { |
197 | $self->_req (start_tls => sub { |
128 | $_[1] |
198 | $_[1] |
… | |
… | |
164 | } |
234 | } |
165 | |
235 | |
166 | sub error { |
236 | sub error { |
167 | my ($self, $msg) = @_; |
237 | my ($self, $msg) = @_; |
168 | |
238 | |
169 | call on_error => $msg; |
239 | call $self, on_error => $msg; |
170 | |
240 | |
171 | () |
241 | () |
172 | } |
242 | } |
173 | |
243 | |
174 | sub _req { |
244 | sub _req { |
… | |
… | |
183 | my $msg = JSON::encode_json \@_; |
253 | my $msg = JSON::encode_json \@_; |
184 | |
254 | |
185 | $self->{hdl}->push_write ($msg); |
255 | $self->{hdl}->push_write ($msg); |
186 | } |
256 | } |
187 | |
257 | |
188 | =item $api->req ($type => @args, $callback->($api, @args)) |
258 | =item $api->req ($type => @args, $callback->($api, @reply)) |
189 | |
259 | |
190 | Sends a generic request of type C<$type> to the server. When the server |
260 | Sends a generic request of type C<$type> to the server. When the server |
191 | responds, the API object and the response arguments are passed to the |
261 | responds, the API object and the response arguments (without the success |
192 | callback, which is the last argument to this method. |
262 | status) are passed to the callback, which is the last argument to this |
|
|
263 | method. |
|
|
264 | |
|
|
265 | If the request fails, then a fatal error will be raised. If you want to |
|
|
266 | handle failures gracefully, you need to use C<< ->req_failok >> instead. |
|
|
267 | |
|
|
268 | The available requests are documented in the Porttracker API |
|
|
269 | documentation (a copy of which is included in this module as |
|
|
270 | L<AnyEvent::Porttracker::protocol>. |
193 | |
271 | |
194 | It is permissible to call this (or any other request function) at any |
272 | It is permissible to call this (or any other request function) at any |
195 | time, even before the connection has been established - the API object |
273 | time, even before the connection has been established - the API object |
196 | always waits until after login before it actually sends the requests, and |
274 | always waits until after login before it actually sends the requests, and |
197 | queues them until then. |
275 | queues them until then. |
… | |
… | |
219 | }); |
297 | }); |
220 | |
298 | |
221 | =cut |
299 | =cut |
222 | |
300 | |
223 | sub req { |
301 | sub req { |
|
|
302 | my $cb = pop; |
|
|
303 | push @_, sub { |
|
|
304 | splice @_, 1, 1 |
|
|
305 | or $_[0]->error ($_[1]); |
|
|
306 | |
|
|
307 | &$cb |
|
|
308 | }; |
|
|
309 | |
224 | $_[0]{queue} |
310 | $_[0]{queue} |
225 | ? push @{ $_[0]{queue} }, [@_] |
311 | ? push @{ $_[0]{queue} }, [@_] |
226 | : &_req |
312 | : &_req |
227 | } |
313 | } |
228 | |
314 | |
|
|
315 | =item $api->req_failok ($type => @args, $callback->($api, $success, @reply)) |
|
|
316 | |
|
|
317 | Just like C<< ->req >>, with two differences: first, a failure will not |
|
|
318 | raise an error, second, the initial status reply which indicates success |
|
|
319 | or failure is not removed before calling the callback. |
|
|
320 | |
|
|
321 | =cut |
|
|
322 | |
|
|
323 | sub req_failok { |
|
|
324 | $_[0]{queue} |
|
|
325 | ? push @{ $_[0]{queue} }, [@_] |
|
|
326 | : &_req |
|
|
327 | } |
|
|
328 | |
|
|
329 | =item $api->on (XYZ => $callback) |
|
|
330 | |
|
|
331 | Overwrites any currently registered handler for C<on_XYZ> or |
|
|
332 | installs a new one. Or, when C<$callback> is undef, unregisters any |
|
|
333 | currently-registered handler. |
|
|
334 | |
|
|
335 | Example: replace/set the handler for C<on_discover_stop_event>. |
|
|
336 | |
|
|
337 | $api->on (discover_stop_event => sub { |
|
|
338 | my ($api, $gid) = @_; |
|
|
339 | ... |
|
|
340 | }); |
|
|
341 | |
|
|
342 | =cut |
|
|
343 | |
|
|
344 | sub on { |
|
|
345 | my $self = shift; |
|
|
346 | |
|
|
347 | while (@_) { |
|
|
348 | my ($event, $cb) = splice @_, 0, 2; |
|
|
349 | $event =~ s/^on_//; |
|
|
350 | |
|
|
351 | $self->{"on_$event"} = $cb; |
|
|
352 | } |
|
|
353 | } |
|
|
354 | |
229 | sub on_start_tls_notify { |
355 | sub on_start_tls_notify { |
230 | my ($self) = @_; |
356 | my ($self) = @_; |
231 | |
357 | |
232 | $self->{hdl}->starttls ("connect"); |
358 | $self->{hdl}->starttls (connect => $self->{tls_ctx}); |
233 | $self->{tls} ||= 1; |
359 | $self->{tls} ||= 1; |
234 | |
360 | |
235 | $self->_login; |
361 | $self->_login; |
236 | } |
362 | } |
237 | |
363 | |
… | |
… | |
329 | |
455 | |
330 | $msg =~ s/\n$//; |
456 | $msg =~ s/\n$//; |
331 | $self->error ("login failed: $msg"); |
457 | $self->error ("login failed: $msg"); |
332 | } |
458 | } |
333 | |
459 | |
|
|
460 | sub on_event_notify { |
|
|
461 | my ($self, $event, @args) = @_; |
|
|
462 | |
|
|
463 | call $self, "on_${event}_event", @args; |
|
|
464 | } |
|
|
465 | |
334 | =back |
466 | =back |
335 | |
467 | |
336 | =head2 EVENTS |
468 | =head1 EVENTS/CALLBACKS |
337 | |
469 | |
338 | AnyEvent::Porttracker conenctions are fully event-driven, and naturally |
470 | AnyEvent::Porttracker connections are fully event-driven, and naturally |
339 | there are a number of events that can occur. All these events have a name |
471 | there are a number of events that can occur. All these events have a name |
340 | starting with C<on_> (example: C<on_login_failure>). |
472 | starting with C<on_> (example: C<on_login_failure>). |
341 | |
473 | |
342 | Programs can catch these events in two ways: either by providing |
474 | Programs can catch these events in two ways: either by providing |
343 | constructor arguments with the event name as key and a coderef as value: |
475 | constructor arguments with the event name as key and a code-ref as value: |
344 | |
476 | |
345 | my $api = new AnyEvent::Porttracker |
477 | my $api = new AnyEvent::Porttracker |
346 | host => ..., |
478 | host => ..., |
347 | user => ..., pass => ..., |
479 | user => ..., pass => ..., |
348 | on_error => sub { |
480 | on_error => sub { |
… | |
… | |
350 | warn $msg; |
482 | warn $msg; |
351 | exit 1; |
483 | exit 1; |
352 | }, |
484 | }, |
353 | ; |
485 | ; |
354 | |
486 | |
355 | Or by subclassing C<AnyEvent::Porttracker> and overriding methods of the |
487 | Or by sub-classing C<AnyEvent::Porttracker> and overriding methods of the |
356 | same name: |
488 | same name: |
357 | |
489 | |
358 | package MyClass; |
490 | package MyClass; |
359 | |
491 | |
360 | use base AnyEvent::Porttracker; |
492 | use base AnyEvent::Porttracker; |
… | |
… | |
408 | |
540 | |
409 | =item on_start_tls_notify $api |
541 | =item on_start_tls_notify $api |
410 | |
542 | |
411 | Called when the server wants to start TLS negotiation. This is used |
543 | Called when the server wants to start TLS negotiation. This is used |
412 | internally and - while it is possible to override it - should not be |
544 | internally and - while it is possible to override it - should not be |
413 | overriden. |
545 | overridden. |
|
|
546 | |
|
|
547 | =item on_event_notify $api, $eventname, @args |
|
|
548 | |
|
|
549 | Called when the server broadcasts an event the API object is subscribed |
|
|
550 | to. The default implementation (which should not be overridden) simply |
|
|
551 | re-issues an "on_eventname_event" event with the @args. |
414 | |
552 | |
415 | =item on_XYZ_notify $api, ... |
553 | =item on_XYZ_notify $api, ... |
416 | |
554 | |
417 | In general, any protocol notification will result in an event of the form |
555 | In general, any protocol notification will result in an event of the form |
418 | C<on_NOTIFICATION_notify>. |
556 | C<on_NOTIFICATION_notify>. |
419 | |
557 | |
|
|
558 | =item on_XYZ_event $api, ... |
|
|
559 | |
|
|
560 | Called when the server broadcasts the named (XYZ) event. |
|
|
561 | |
420 | =back |
562 | =back |
421 | |
563 | |
422 | =head1 SEE ALSO |
564 | =head1 SEE ALSO |
423 | |
565 | |
424 | L<AnyEvent>, L<http://www.porttracker.com/>, L<http://www.infoblox.com/en/products/portiq.html>. |
566 | L<AnyEvent>, L<http://www.porttracker.com/>, L<http://www.infoblox.com/en/products/portiq.html>. |