135/netdisco
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

API implementation (#712)

Browse Source 
* initial v0 creator

* working json api for generic reports

* add require login

* move report swagger into plugin, and set new default layout of noop

* require proper role and also use new util func

* start to tidy authn

* some work on cleaning up web authn

* clean up the authN checks

* fix bug

* fix the auth for api

* fixes to json handling

* set swagger sort order

* enable most reports for api endpoints

* fix doc

* add paramters to reports

* add missed report

* allow api_parameters in reports config

* reorganise api

* add vlan search

* add port search

* make sure to enable layout processing

* add device search

* add v1 to api paths

* add Node Search

* support api_responses

* add device object search; fix spurious ports field in device result class

* handle some plugins just returning undef if search fails

* errors from api seamlessley

* fix error in date range default

* more sensible default for prefix

* change order of endpoints in swagger-ui

* all db row classes can now TO_JSON

* add device_port api endpoint

* add device ports endpoint

* do not expand docs

* add swagger ui json tree formatter

* add all relations from Device table

* add port relations

* add nodes retrieve on device or vlan

* rename to GetAPIKey

* update config for previous commit
This commit is contained in:
Oliver Gorwits
2020-04-15 21:15:52 +01:00
committed by GitHub
parent a8a77a2df1
commit dff26abc5c
78 changed files with 815 additions and 257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

176
lib/App/Netdisco/Web/API/Objects.pm Normal file
View File

@@ -0,0 +1,176 @@
package App::Netdisco::Web::API::Objects;
use Dancer ':syntax';
use Dancer::Plugin::DBIC;
use Dancer::Plugin::Swagger;
use Dancer::Plugin::Auth::Extensible;
use Try::Tiny;
swagger_path {
tags => ['Objects'],
description => 'Returns a row from the device table',
parameters => [
ip => {
description => 'Canonical IP of the Device. Use Search methods to find this.',
required => 1,
in => 'path',
},
],
responses => { default => {} },
}, get '/api/v1/object/device/:ip' => require_role api => sub {
my $device = try { schema('netdisco')->resultset('Device')
->find( params->{ip} ) } or send_error('Bad Device', 404);
return to_json $device->TO_JSON;
};
foreach my $rel (qw/device_ips vlans ports modules port_vlans wireless_ports ssids powered_ports/) {
swagger_path {
tags => ['Objects'],
description => "Returns $rel rows for a given device",
parameters => [
ip => {
description => 'Canonical IP of the Device. Use Search methods to find this.',
required => 1,
in => 'path',
},
],
responses => { default => {} },
}, get "/api/v1/object/device/:ip/$rel" => require_role api => sub {
my $rows = try { schema('netdisco')->resultset('Device')
->find( params->{ip} )->$rel } or send_error('Bad Device', 404);
return to_json [ map {$_->TO_JSON} $rows->all ];
};
}
swagger_path {
tags => ['Objects'],
description => 'Returns a row from the device_port table',
path => '/api/v1/object/device/{ip}/port/{port}',
parameters => [
ip => {
description => 'Canonical IP of the Device. Use Search methods to find this.',
required => 1,
in => 'path',
},
port => {
description => 'Name of the port. Use the ".../device/{ip}/ports" method to find these.',
required => 1,
in => 'path',
},
],
responses => { default => {} },
}, get qr{/api/v1/object/device/(?<ip>[^/]+)/port/(?<port>[^/]+)$} => require_role api => sub {
my $params = captures;
my $port = try { schema('netdisco')->resultset('DevicePort')
->find( $$params{port}, $$params{ip} ) }
or send_error('Bad Device or Port', 404);
return to_json $port->TO_JSON;
};
foreach my $rel (qw/nodes active_nodes nodes_with_age active_nodes_with_age vlans logs/) {
swagger_path {
tags => ['Objects'],
description => "Returns $rel rows for a given port",
path => "/api/v1/object/device/{ip}/port/{port}/$rel",
parameters => [
ip => {
description => 'Canonical IP of the Device. Use Search methods to find this.',
required => 1,
in => 'path',
},
port => {
description => 'Name of the port. Use the ".../device/{ip}/ports" method to find these.',
required => 1,
in => 'path',
},
],
responses => { default => {} },
}, get qq{/api/v1/object/device/(?<ip>[^/]+)/port/(?<port>[^/]+)/$rel} => require_role api => sub {
my $params = captures;
my $rows = try { schema('netdisco')->resultset('DevicePort')
->find( $$params{port}, $$params{ip} )->$rel }
or send_error('Bad Device or Port', 404);
return to_json [ map {$_->TO_JSON} $rows->all ];
};
}
foreach my $rel (qw/power properties ssid wireless agg_master neighbor last_node/) {
swagger_path {
tags => ['Objects'],
description => "Returns the related $rel table entry for a given port",
path => "/api/v1/object/device/{ip}/port/{port}/$rel",
parameters => [
ip => {
description => 'Canonical IP of the Device. Use Search methods to find this.',
required => 1,
in => 'path',
},
port => {
description => 'Name of the port. Use the ".../device/{ip}/ports" method to find these.',
required => 1,
in => 'path',
},
],
responses => { default => {} },
}, get qq{/api/v1/object/device/(?<ip>[^/]+)/port/(?<port>[^/]+)/$rel} => require_role api => sub {
my $params = captures;
my $row = try { schema('netdisco')->resultset('DevicePort')
->find( $$params{port}, $$params{ip} )->$rel }
or send_error('Bad Device or Port', 404);
return to_json $row->TO_JSON;
};
}
swagger_path {
tags => ['Objects'],
description => "Returns the nodes found on a given Device",
parameters => [
ip => {
description => 'Canonical IP of the Device. Use Search methods to find this.',
required => 1,
in => 'path',
},
active_only => {
description => 'Restrict results to active Nodes only',
type => 'boolean',
default => 'true',
in => 'query',
},
],
responses => { default => {} },
}, get '/api/v1/object/device/:ip/nodes' => require_role api => sub {
my $active = (params->{active_only} and ('true' eq params->{active_only})) ? 1 : 0;
my $rows = try { schema('netdisco')->resultset('Node')
->search({ switch => params->{ip}, ($active ? (-bool => 'active') : ()) }) }
or send_error('Bad Device', 404);
return to_json [ map {$_->TO_JSON} $rows->all ];
};
swagger_path {
tags => ['Objects'],
description => "Returns the nodes found in a given VLAN",
parameters => [
vlan => {
description => 'VLAN number',
type => 'integer',
required => 1,
in => 'path',
},
active_only => {
description => 'Restrict results to active Nodes only',
type => 'boolean',
default => 'true',
in => 'query',
},
],
responses => { default => {} },
}, get '/api/v1/object/vlan/:vlan/nodes' => require_role api => sub {
my $active = (params->{active_only} and ('true' eq params->{active_only})) ? 1 : 0;
my $rows = try { schema('netdisco')->resultset('Node')
->search({ vlan => params->{vlan}, ($active ? (-bool => 'active') : ()) }) }
or send_error('Bad VLAN', 404);
return to_json [ map {$_->TO_JSON} $rows->all ];
};
true;

4
lib/App/Netdisco/Web/AdminTask.pm
View File

@@ -66,12 +66,12 @@ get '/admin/*' => require_role admin => sub {
var(nav => 'admin');
template 'admintask', {
task => setting('_admin_tasks')->{ $tag },
};
}, { layout => 'main' };
}
else {
var('notfound' => true);
status 'not_found';
template 'index';
template 'index', {}, { layout => 'main' };
}
};

3
lib/App/Netdisco/Web/Auth/Provider/DBIC.pm
View File

@@ -94,7 +94,8 @@ sub get_user_roles {
my $role_column = $settings->{role_column} || 'role';
return [ try {
$user->$roles->get_column( $role_column )->all;
$user->$roles->search({}, { bind => [setting('api_token_lifetime')] })
->get_column( $role_column )->all;
} ];
}

171
lib/App/Netdisco/Web/AuthN.pm
View File

@@ -5,99 +5,95 @@ use Dancer::Plugin::DBIC;
use Dancer::Plugin::Auth::Extensible;
use Dancer::Plugin::Swagger;
use App::Netdisco::Util::Web 'request_is_api';
use MIME::Base64;
sub request_is_api {
return (setting('api_token_lifetime')
and request->header('Authorization')
and request->accept =~ m/(?:json|javascript)/);
}
# ensure that regardless of where the user is redirected, we have a link
# back to the page they requested.
hook 'before' => sub {
params->{return_url} ||= ((request->path ne uri_for('/')->path)
? request->uri : uri_for(setting('web_home'))->path);
};
# Dancer will create a session if it sees its own cookie. For the API and also
# various auto login options we need to bootstrap the session instead. If no
# auth data passed, then the hook simply returns, no session is set, and the
# user is redirected to login page.
hook 'before' => sub {
# return if request is for endpoints not requiring a session
return if (
request->path eq uri_for('/login')->path
or request->path eq uri_for('/logout')->path
or request->path eq uri_for('/swagger.json')->path
or index(request->path, uri_for('/swagger-ui')->path) == 0
);
# from the internals of Dancer::Plugin::Auth::Extensible
my $provider = Dancer::Plugin::Auth::Extensible::auth_provider('users');
if (! session('logged_in_user')
and request->path ne uri_for('/login')->path
and request->path ne uri_for('/logout')->path
and request->path ne uri_for('/swagger.json')->path
and index(request->path, uri_for('/swagger-ui')->path) != 0) {
# API calls must conform strictly to path and header requirements
if (request_is_api) {
# Dancer will issue a cookie to the client which could be returned and
# cause API calls to succeed without passing token. Kill the session.
session->destroy;
if (setting('trust_x_remote_user')
and scalar request->header('X-REMOTE_USER')
and length scalar request->header('X-REMOTE_USER')) {
my $token = request->header('Authorization');
my $user = $provider->validate_api_token($token)
or return;
(my $user = scalar request->header('X-REMOTE_USER')) =~ s/@[^@]*$//;
return if setting('validate_remote_user')
and not $provider->get_user_details($user);
session(logged_in_user => $user);
session(logged_in_user_realm => 'users');
}
elsif (setting('trust_remote_user')
and defined $ENV{REMOTE_USER}
and length $ENV{REMOTE_USER}) {
(my $user = $ENV{REMOTE_USER}) =~ s/@[^@]*$//;
return if setting('validate_remote_user')
and not $provider->get_user_details($user);
session(logged_in_user => $user);
session(logged_in_user_realm => 'users');
}
elsif (setting('no_auth')) {
session(logged_in_user => 'guest');
session(logged_in_user_realm => 'users');
}
elsif (request_is_api()
and index(request->path, uri_for('/api')->path) == 0) {
my $token = request->header('Authorization');
my $user = $provider->validate_api_token($token)
or return;
session(logged_in_user => $user);
session(logged_in_user_realm => 'users');
}
else {
# user has no AuthN - force to handler for '/'
request->path_info('/');
}
session(logged_in_user => $user);
session(logged_in_user_realm => 'users');
return;
}
};
# user redirected here (POST -> GET) when login fails
get qr{^/(?:login(?:/denied)?)?} => sub {
if (request_is_api()) {
status('unauthorized');
return to_json {
error => 'not authorized',
return_url => param('return_url'),
};
# after checking API, we can short circuit if Dancer reads its cookie OK
return if session('logged_in_user');
if (setting('trust_x_remote_user')
and scalar request->header('X-REMOTE_USER')
and length scalar request->header('X-REMOTE_USER')) {
(my $user = scalar request->header('X-REMOTE_USER')) =~ s/@[^@]*$//;
return if setting('validate_remote_user')
and not $provider->get_user_details($user);
session(logged_in_user => $user);
session(logged_in_user_realm => 'users');
}
elsif (setting('trust_remote_user')
and defined $ENV{REMOTE_USER}
and length $ENV{REMOTE_USER}) {
(my $user = $ENV{REMOTE_USER}) =~ s/@[^@]*$//;
return if setting('validate_remote_user')
and not $provider->get_user_details($user);
session(logged_in_user => $user);
session(logged_in_user_realm => 'users');
}
elsif (setting('no_auth')) {
session(logged_in_user => 'guest');
session(logged_in_user_realm => 'users');
}
else {
template 'index', { return_url => param('return_url') };
# user has no AuthN - force to handler for '/'
request->path_info('/');
}
};
# override default login_handler so we can log access in the database
swagger_path {
description => 'Obtain an API Key using HTTP BasicAuth',
tags => ['Global'],
description => 'Obtain an API Key',
tags => ['General'],
parameters => [],
responses => {
default => {
examples => {
'application/json' => { api_key => 'cc9d5c02d8898e5728b7d7a0339c0785' } } },
responses => { default => { examples => {
'application/json' => { api_key => 'cc9d5c02d8898e5728b7d7a0339c0785' } } },
},
},
post '/login' => sub {
my $mode = (request_is_api() ? 'API' : 'WebUI');
my $api = ((request->accept =~ m/(?:json|javascript)/) ? true : false);
# get authN data from request (HTTP BasicAuth or Form params)
# get authN data from BasicAuth header used by API, put into params
my $authheader = request->header('Authorization');
if (defined $authheader and $authheader =~ /^Basic (.*)$/i) {
my ($u, $p) = split(m/:/, (MIME::Base64::decode($1) || ":"));
@@ -119,12 +115,13 @@ post '/login' => sub {
schema('netdisco')->resultset('UserLog')->create({
username => session('logged_in_user'),
userip => request->remote_address,
event => "Login ($mode)",
event => (sprintf 'Login (%s)', ($api ? 'API' : 'WebUI')),
details => param('return_url'),
});
$user->update({ last_on => \'now()' });
if ($mode eq 'API') {
if ($api) {
header('Content-Type' => 'application/json');
$user->update({
token_from => time,
token => \'md5(random()::text)',
@@ -135,16 +132,18 @@ post '/login' => sub {
redirect param('return_url');
}
else {
# invalidate session cookie
session->destroy;
schema('netdisco')->resultset('UserLog')->create({
username => param('username'),
userip => request->remote_address,
event => "Login Failure ($mode)",
event => (sprintf 'Login Failure (%s)', ($api ? 'API' : 'WebUI')),
details => param('return_url'),
});
if ($mode eq 'API') {
if ($api) {
header('Content-Type' => 'application/json');
status('unauthorized');
return to_json { error => 'authentication failed' };
}
@@ -164,12 +163,12 @@ Dancer::Plugin::Swagger->instance->doc->{paths}->{'/login'}
# we override the default login_handler, so logout has to be handled as well
swagger_path {
description => 'Destroy user API Key and session cookie',
tags => ['Global'],
tags => ['General'],
parameters => [],
responses => { default => { examples => { 'application/json' => {} } } },
},
get '/logout' => sub {
my $mode = (request_is_api() ? 'API' : 'WebUI');
my $api = ((request->accept =~ m/(?:json|javascript)/) ? true : false);
# clear out API token
my $user = schema('netdisco')->resultset('User')
@@ -183,15 +182,35 @@ get '/logout' => sub {
schema('netdisco')->resultset('UserLog')->create({
username => session('logged_in_user'),
userip => request->remote_address,
event => "Logout ($mode)",
event => (sprintf 'Logout (%s)', ($api ? 'API' : 'WebUI')),
details => '',
});
if ($mode eq 'API') {
if ($api) {
header('Content-Type' => 'application/json');
return to_json {};
}
redirect uri_for(setting('web_home'))->path;
};
# user redirected here (POST -> GET) when login fails
get qr{^/(?:login(?:/denied)?)?} => sub {
my $api = ((request->accept =~ m/(?:json|javascript)/) ? true : false);
if ($api) {
header('Content-Type' => 'application/json');
status('unauthorized');
return to_json {
error => 'not authorized',
return_url => param('return_url'),
};
}
else {
template 'index', {
return_url => param('return_url')
}, { layout => 'main' };
}
};
true;

2
lib/App/Netdisco/Web/Device.pm
View File

@@ -85,7 +85,7 @@ get '/device' => require_login sub {
lgroup_list => [ schema('netdisco')->resultset('Device')->get_distinct_col('location') ],
hgroup_list => setting('host_group_displaynames'),
device => params->{'tab'},
};
}, { layout => 'main' };
};
true;

9
lib/App/Netdisco/Web/GenericReport.pm
View File

@@ -21,6 +21,9 @@ foreach my $report (@{setting('reports')}) {
category => ($report->{category} || 'My Reports'),
($report->{hidden} ? (hidden => true) : ()),
provides_csv => true,
api_endpoint => true,
bind_params => $report->{bind_params},
api_parameters => $report->{api_parameters},
});
get "/ajax/content/report/$r" => require_login sub {
@@ -76,16 +79,14 @@ foreach my $report (@{setting('reports')}) {
is_custom_report => true,
column_options => \%column_config,
headings => [map {$column_config{$_}->{displayname}} @column_order],
columns => [@column_order] },
{ layout => undef };
columns => [@column_order] };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/generic_report_csv.tt',
{ results => \@results,
headings => [map {$column_config{$_}->{displayname}} @column_order],
columns => [@column_order] },
{ layout => undef };
columns => [@column_order] };
}
};
}

4
lib/App/Netdisco/Web/Password.pm
View File

@@ -19,7 +19,7 @@ sub _make_password {
sub _bail {
var('passchange_failed' => 1);
return template 'password.tt';
return template 'password.tt', {}, { layout => 'main' };
}
any ['get', 'post'] => '/password' => require_login sub {
@@ -45,7 +45,7 @@ any ['get', 'post'] => '/password' => require_login sub {
var('passchange_ok' => 1);
}
template 'password.tt';
template 'password.tt', {}, { layout => 'main' };
};
true;

30
lib/App/Netdisco/Web/Plugin.pm
View File

@@ -2,6 +2,8 @@ package App::Netdisco::Web::Plugin;
use Dancer ':syntax';
use Dancer::Plugin;
use Dancer::Plugin::Swagger;
use Dancer::Plugin::Auth::Extensible;
use Path::Class 'dir';
@@ -150,6 +152,19 @@ sub _register_tab {
register 'register_search_tab' => sub {
my ($self, $config) = plugin_args(@_);
_register_tab('search', $config);
if ($config->{api_endpoint}) {
my $tag = $config->{tag};
swagger_path {
tags => ['Search'],
description => $config->{label} .' Search',
parameters => $config->{api_parameters},
responses =>
($config->{api_responses} || { default => {} }),
}, get "/api/v1/search/$tag" => require_role api => sub {
forward "/ajax/content/search/$tag";
};
}
};
register 'register_device_tab' => sub {
@@ -178,6 +193,21 @@ register 'register_report' => sub {
if ($config->{tag} eq $tag) {
setting('_reports')->{$tag} = $config;
if ($config->{api_endpoint}) {
(my $category_path = lc $config->{category}) =~ s/ /-/g;
swagger_path {
tags => ['Reports'],
description => $config->{label} .' Report',
parameters =>
($config->{api_parameters} ||
($config->{bind_params} ? [map { $_ => {} } @{ $config->{bind_params} }] : [])),
responses =>
($config->{api_responses} || { default => {} }),
}, get "/api/v1/report/$category_path/$tag" => require_role api => sub {
forward "/ajax/content/report/$tag";
};
}
foreach my $rconfig (@{setting('reports')}) {
if ($rconfig->{tag} eq $tag) {
setting('_reports')->{$tag}->{'rconfig'} = $rconfig;

2
lib/App/Netdisco/Web/Plugin/Inventory.pm
View File

@@ -29,7 +29,7 @@ get '/inventory' => require_login sub {
template 'inventory', {
platforms => [ $platforms->hri->all ],
releases => [ @release_list ],
};
}, { layout => 'main' };
};
true;

7
lib/App/Netdisco/Web/Plugin/Report/ApChannelDist.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'apchanneldist',
label => 'Access Point Channel Distribution',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -28,13 +29,11 @@ get '/ajax/content/report/apchanneldist' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/apchanneldist.tt', { results => $json },
{ layout => undef };
template 'ajax/report/apchanneldist.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/apchanneldist_csv.tt', { results => \@results },
{ layout => undef };
template 'ajax/report/apchanneldist_csv.tt', { results => \@results };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/ApClients.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'apclients',
label => 'Access Point Client Count',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -37,14 +38,12 @@ get '/ajax/content/report/apclients' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/apclients.tt', { results => $json },
{ layout => undef };
template 'ajax/report/apclients.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/apclients_csv.tt',
{ results => \@results },
{ layout => undef };
{ results => \@results };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/ApRadioChannelPower.pm
View File

@@ -12,6 +12,7 @@ register_report(
tag => 'apradiochannelpower',
label => 'Access Point Radios Channel and Power',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -38,8 +39,7 @@ get '/ajax/content/report/apradiochannelpower/data' => require_login sub {
get '/ajax/content/report/apradiochannelpower' => require_login sub {
if ( request->is_ajax ) {
template 'ajax/report/apradiochannelpower.tt', {},
{ layout => undef };
template 'ajax/report/apradiochannelpower.tt';
}
else {
my @results
@@ -50,8 +50,7 @@ get '/ajax/content/report/apradiochannelpower' => require_login sub {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/apradiochannelpower_csv.tt',
{ results => \@results, },
{ layout => undef };
{ results => \@results, };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/DeviceAddrNoDNS.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'deviceaddrnodns',
label => 'Addresses without DNS Entries',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -28,14 +29,12 @@ get '/ajax/content/report/deviceaddrnodns' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json (\@results);
template 'ajax/report/deviceaddrnodns.tt', { results => $json },
{ layout => undef };
template 'ajax/report/deviceaddrnodns.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/deviceaddrnodns_csv.tt',
{ results => \@results, },
{ layout => undef };
{ results => \@results, };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/DeviceByLocation.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'devicebylocation',
label => 'By Location',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -24,14 +25,12 @@ get '/ajax/content/report/devicebylocation' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/devicebylocation.tt', { results => $json },
{ layout => undef };
template 'ajax/report/devicebylocation.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/devicebylocation_csv.tt',
{ results => \@results },
{ layout => undef };
{ results => \@results };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/DeviceDnsMismatch.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'devicednsmismatch',
label => 'Device Name / DNS Mismatches',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -27,14 +28,12 @@ get '/ajax/content/report/devicednsmismatch' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/devicednsmismatch.tt', { results => $json },
{ layout => undef };
template 'ajax/report/devicednsmismatch.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/devicednsmismatch_csv.tt',
{ results => \@results },
{ layout => undef };
{ results => \@results };
}
};

6
lib/App/Netdisco/Web/Plugin/Report/DevicePoeStatus.pm
View File

@@ -12,6 +12,7 @@ register_report(
tag => 'devicepoestatus',
label => 'Power over Ethernet (PoE) Status',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -39,7 +40,7 @@ get '/ajax/content/report/devicepoestatus/data' => require_login sub {
get '/ajax/content/report/devicepoestatus' => require_login sub {
if ( request->is_ajax ) {
template 'ajax/report/devicepoestatus.tt', {}, { layout => undef };
template 'ajax/report/devicepoestatus.tt';
}
else {
my @results
@@ -50,8 +51,7 @@ get '/ajax/content/report/devicepoestatus' => require_login sub {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/devicepoestatus_csv.tt',
{ results => \@results, },
{ layout => undef };
{ results => \@results, };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/DuplexMismatch.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'duplexmismatch',
label => 'Duplex Mismatches Between Devices',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -22,14 +23,12 @@ get '/ajax/content/report/duplexmismatch' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/duplexmismatch.tt', { results => $json, },
{ layout => undef };
template 'ajax/report/duplexmismatch.tt', { results => $json, };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/duplexmismatch_csv.tt',
{ results => \@results, },
{ layout => undef };
{ results => \@results, };
}
};

8
lib/App/Netdisco/Web/Plugin/Report/HalfDuplex.pm
View File

@@ -11,11 +11,11 @@ register_report(
tag => 'halfduplex',
label => 'Ports in Half Duplex Mode',
provides_csv => 1,
api_endpoint => 1,
}
);
get '/ajax/content/report/halfduplex' => require_login sub {
my $format = param('format');
my @results
= schema('netdisco')->resultset('DevicePort')
->columns( [qw/ ip port name duplex /] )->search(
@@ -30,14 +30,12 @@ get '/ajax/content/report/halfduplex' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/halfduplex.tt', { results => $json },
{ layout => undef };
template 'ajax/report/halfduplex.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/halfduplex_csv.tt',
{ results => \@results },
{ layout => undef };
{ results => \@results };
}
};

38
lib/App/Netdisco/Web/Plugin/Report/IpInventory.pm
View File

@@ -6,12 +6,39 @@ use Dancer::Plugin::Auth::Extensible;
use App::Netdisco::Web::Plugin;
use NetAddr::IP::Lite ':lower';
use POSIX qw/strftime/;
register_report(
{ category => 'IP',
tag => 'ipinventory',
label => 'IP Inventory',
provides_csv => 1,
api_endpoint => 1,
api_parameters => [
subnet => {
description => 'IP Prefix to search',
required => 1,
},
daterange => {
description => 'Date range to search',
default => ('1970-01-01 to '. strftime('%Y-%m-%d', gmtime)),
},
age_invert => {
description => 'Results should NOT be within daterange',
type => 'boolean',
default => 'false',
},
limit => {
description => 'Maximum number of historical records',
enum => [qw/32 64 128 256 512 1024 2048 4096 8192/],
default => '256',
},
never => {
description => 'Include in the report IPs never seen',
type => 'boolean',
default => 'false',
},
],
}
);
@@ -25,7 +52,10 @@ get '/ajax/content/report/ipinventory' => require_login sub {
if (! $subnet) or ($subnet->addr eq '0.0.0.0');
my $agenot = param('age_invert') || '0';
my ( $start, $end ) = param('daterange') =~ /(\d+-\d+-\d+)/gmx;
my $daterange = param('daterange')
|| ('1970-01-01 to '. strftime('%Y-%m-%d', gmtime));
my ( $start, $end ) = $daterange =~ /(\d+-\d+-\d+)/gmx;
my $limit = param('limit') || 256;
my $never = param('never') || '0';
@@ -155,13 +185,11 @@ get '/ajax/content/report/ipinventory' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/ipinventory.tt', { results => $json },
{ layout => undef };
template 'ajax/report/ipinventory.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/ipinventory_csv.tt', { results => \@results, },
{ layout => undef };
template 'ajax/report/ipinventory_csv.tt', { results => \@results, };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/NodeMultiIPs.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'nodemultiips',
label => 'Nodes with multiple active IP addresses',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -37,14 +38,12 @@ get '/ajax/content/report/nodemultiips' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/nodemultiips.tt', { results => $json },
{ layout => undef };
template 'ajax/report/nodemultiips.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/nodemultiips_csv.tt',
{ results => \@results },
{ layout => undef };
{ results => \@results };
}
};

30
lib/App/Netdisco/Web/Plugin/Report/NodesDiscovered.pm
View File

@@ -12,6 +12,30 @@ register_report(
tag => 'nodesdiscovered',
label => 'Nodes discovered through LLDP/CDP',
provides_csv => 1,
api_endpoint => 1,
api_parameters => [
remote_id => {
description => 'Host Name reported',
},
remote_type => {
description => 'Platform reported',
},
aps => {
description => 'Include Wireless APs in the report',
type => 'boolean',
default => 'false',
},
phones => {
description => 'Include IP Phones in the report',
type => 'boolean',
default => 'false',
},
matchall => {
description => 'Match all parameters (true) or any (false)',
type => 'boolean',
default => 'false',
},
],
}
);
@@ -40,14 +64,12 @@ get '/ajax/content/report/nodesdiscovered' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/nodesdiscovered.tt', { results => $json },
{ layout => undef };
template 'ajax/report/nodesdiscovered.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/nodesdiscovered_csv.tt',
{ results => \@results },
{ layout => undef };
{ results => \@results };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/PortAdminDown.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'portadmindown',
label => 'Ports administratively disabled',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -31,14 +32,12 @@ get '/ajax/content/report/portadmindown' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json (\@results);
template 'ajax/report/portadmindown.tt', { results => $json },
{ layout => undef };
template 'ajax/report/portadmindown.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/portadmindown_csv.tt',
{ results => \@results, },
{ layout => undef };
{ results => \@results, };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/PortBlocking.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'portblocking',
label => 'Ports that are blocking',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -31,14 +32,12 @@ get '/ajax/content/report/portblocking' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json (\@results);
template 'ajax/report/portblocking.tt', { results => $json },
{ layout => undef };
template 'ajax/report/portblocking.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/portblocking_csv.tt',
{ results => \@results, },
{ layout => undef };
{ results => \@results, };
}
};

13
lib/App/Netdisco/Web/Plugin/Report/PortMultiNodes.pm
View File

@@ -11,6 +11,13 @@ register_report(
tag => 'portmultinodes',
label => 'Ports with multiple nodes attached',
provides_csv => 1,
api_endpoint => 1,
api_parameters => [
vlan => {
description => 'Filter by VLAN',
type => 'integer',
},
],
}
);
@@ -39,14 +46,12 @@ get '/ajax/content/report/portmultinodes' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json (\@results);
template 'ajax/report/portmultinodes.tt', { results => $json },
{ layout => undef };
template 'ajax/report/portmultinodes.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/portmultinodes_csv.tt',
{ results => \@results, },
{ layout => undef };
{ results => \@results, };
}
};

12
lib/App/Netdisco/Web/Plugin/Report/PortSsid.pm
View File

@@ -11,6 +11,12 @@ register_report(
tag => 'portssid',
label => 'Port SSID Inventory',
provides_csv => 1,
api_endpoint => 1,
api_parameters => [
ssid => {
description => 'Get details for this SSID',
},
],
}
);
@@ -65,14 +71,12 @@ get '/ajax/content/report/portssid' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/portssid.tt',
{ results => $json, opt => $ssid },
{ layout => undef };
{ results => $json, opt => $ssid };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/portssid_csv.tt',
{ results => \@results, opt => $ssid },
{ layout => undef };
{ results => \@results, opt => $ssid };
}
};

19
lib/App/Netdisco/Web/Plugin/Report/PortUtilization.pm
View File

@@ -11,6 +11,19 @@ register_report(
tag => 'portutilization',
label => 'Port Utilization',
provides_csv => 1,
api_endpoint => 1,
api_parameters => [
age_num => {
description => 'Mark as Free if down for (quantity)',
enum => [1 .. 31],
default => '3',
},
age_unit => {
description => 'Mark as Free if down for (period)',
enum => [qw/days weeks months years/],
default => 'months',
},
],
}
);
@@ -24,13 +37,11 @@ get '/ajax/content/report/portutilization' => require_login sub {
if (request->is_ajax) {
my $json = to_json (\@results);
template 'ajax/report/portutilization.tt', { results => $json },
{ layout => undef };
template 'ajax/report/portutilization.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/portutilization_csv.tt', { results => \@results, },
{ layout => undef };
template 'ajax/report/portutilization_csv.tt', { results => \@results, };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/PortVLANMismatch.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'portvlanmismatch',
label => 'Port VLAN Mismatches',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -20,13 +21,11 @@ get '/ajax/content/report/portvlanmismatch' => require_login sub {
if (request->is_ajax) {
my $json = to_json (\@results);
template 'ajax/report/portvlanmismatch.tt', { results => $json },
{ layout => undef };
template 'ajax/report/portvlanmismatch.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/portvlanmismatch_csv.tt', { results => \@results, },
{ layout => undef };
template 'ajax/report/portvlanmismatch_csv.tt', { results => \@results, };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/SsidInventory.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'ssidinventory',
label => 'SSID Inventory',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -22,13 +23,11 @@ get '/ajax/content/report/ssidinventory' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/report/portssid.tt', { results => $json },
{ layout => undef };
template 'ajax/report/portssid.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/portssid_csv.tt', { results => \@results },
{ layout => undef };
template 'ajax/report/portssid_csv.tt', { results => \@results };
}
};

29
lib/App/Netdisco/Web/Plugin/Report/SubnetUtilization.pm
View File

@@ -5,19 +5,38 @@ use Dancer::Plugin::DBIC;
use Dancer::Plugin::Auth::Extensible;
use App::Netdisco::Web::Plugin;
use POSIX qw/strftime/;
register_report({
category => 'IP',
tag => 'subnets',
label => 'Subnet Utilization',
provides_csv => 1,
provides_csv => 1,
api_endpoint => 1,
api_parameters => [
subnet => {
description => 'IP Prefix to search',
default => '0.0.0.0/32',
},
daterange => {
description => 'Date range to search',
default => ('1970-01-01 to '. strftime('%Y-%m-%d', gmtime)),
},
age_invert => {
description => 'Results should NOT be within daterange',
type => 'boolean',
default => 'false',
},
],
});
get '/ajax/content/report/subnets' => require_login sub {
my $subnet = param('subnet') || '0.0.0.0/32';
my $agenot = param('age_invert') || '0';
my ( $start, $end ) = param('daterange') =~ /(\d+-\d+-\d+)/gmx;
my $daterange = param('daterange')
|| ('1970-01-01 to '. strftime('%Y-%m-%d', gmtime));
my ( $start, $end ) = $daterange =~ /(\d+-\d+-\d+)/gmx;
$start = $start . ' 00:00:00';
$end = $end . ' 23:59:59';
@@ -29,13 +48,11 @@ get '/ajax/content/report/subnets' => require_login sub {
return unless scalar @results;
if ( request->is_ajax ) {
template 'ajax/report/subnets.tt', { results => \@results },
{ layout => undef };
template 'ajax/report/subnets.tt', { results => \@results };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/subnets_csv.tt', { results => \@results },
{ layout => undef };
template 'ajax/report/subnets_csv.tt', { results => \@results };
}
};

7
lib/App/Netdisco/Web/Plugin/Report/VlanInventory.pm
View File

@@ -11,6 +11,7 @@ register_report(
tag => 'vlaninventory',
label => 'VLAN Inventory',
provides_csv => 1,
api_endpoint => 1,
}
);
@@ -36,13 +37,11 @@ get '/ajax/content/report/vlaninventory' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json (\@results);
template 'ajax/report/vlaninventory.tt', { results => $json },
{ layout => undef };
template 'ajax/report/vlaninventory.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/report/vlaninventory_csv.tt', { results => \@results },
{ layout => undef };
template 'ajax/report/vlaninventory_csv.tt', { results => \@results };
}
};

54
lib/App/Netdisco/Web/Plugin/Search/Device.pm
View File

@@ -8,8 +8,52 @@ use List::MoreUtils ();
use App::Netdisco::Web::Plugin;
register_search_tab(
{ tag => 'device', label => 'Device', provides_csv => 1 } );
register_search_tab({
tag => 'device',
label => 'Device',
provides_csv => 1,
api_endpoint => 1,
api_parameters => [
q => {
description => 'Partial match of Device contact, serial, module serials, location, name, description, dns, or any IP alias',
},
name => {
description => 'Partial match of the Device name',
},
location => {
description => 'Partial match of the Device location',
},
dns => {
description => 'Partial match of any of the Device IP aliases',
},
ip => {
description => 'IP or IP Prefix within which the Device must have an interface address',
},
description => {
description => 'Partial match of the Device description',
},
model => {
description => 'Exact match of the Device model',
},
os => {
description => 'Exact match of the Device operating system',
},
os_ver => {
description => 'Exact match of the Device operating system version',
},
vendor => {
description => 'Exact match of the Device vendor',
},
layers => {
description => 'OSI Layer which the device must support',
},
matchall => {
description => 'If true, all fields (except "q") must match the Device',
type => 'boolean',
default => 'false',
},
],
});
# device with various properties or a default match-all
get '/ajax/content/search/device' => require_login sub {
@@ -40,13 +84,11 @@ get '/ajax/content/search/device' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/search/device.tt', { results => $json },
{ layout => undef };
template 'ajax/search/device.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/search/device_csv.tt', { results => \@results, },
{ layout => undef };
template 'ajax/search/device_csv.tt', { results => \@results, };
}
};

52
lib/App/Netdisco/Web/Plugin/Search/Node.pm
View File

@@ -12,7 +12,51 @@ use NetAddr::MAC ();
use App::Netdisco::Web::Plugin;
use App::Netdisco::Util::Web 'sql_match';
register_search_tab({ tag => 'node', label => 'Node' });
register_search_tab({
tag => 'node',
label => 'Node',
api_endpoint => 1,
api_parameters => [
q => {
description => 'MAC Address or IP Address or Hostname (without Domain Suffix) of a Node (supports SQL or "*" wildcards)',
required => 1,
},
partial => {
description => 'Partially match the "q" parameter (wildcard characters not required)',
type => 'boolean',
default => 'false',
},
deviceports => {
description => 'MAC Address search will include Device Port MACs',
type => 'boolean',
default => 'true',
},
show_vendor => {
description => 'Include interface Vendor in results',
type => 'boolean',
default => 'false',
},
archived => {
description => 'Include archived records in results',
type => 'boolean',
default => 'false',
},
daterange => {
description => 'Date Range in format "YYYY-MM-DD to YYYY-MM-DD"',
},
age_invert => {
description => 'Date Range is NOT within the supplied range',
type => 'boolean',
default => 'false',
},
# mac_format is used only in the template (will be IEEE) in results
#mac_format => {
#},
# stamps param is used only in the template (they will be included)
#stamps => {
#},
],
});
# nodes matching the param as an IP or DNS hostname or MAC
ajax '/ajax/content/search/node' => require_login sub {
@@ -144,7 +188,7 @@ ajax '/ajax/content/search/node' => require_login sub {
ports => $ports,
wireless => $wireless,
netbios => $netbios,
}, { layout => undef };
};
}
else {
my $ports = param('deviceports')
@@ -157,7 +201,7 @@ ajax '/ajax/content/search/node' => require_login sub {
ports => $ports,
wireless => $wireless,
netbios => $netbios,
}, { layout => undef };
};
}
}
@@ -200,7 +244,7 @@ ajax '/ajax/content/search/node' => require_login sub {
template 'ajax/search/node_by_ip.tt', {
macs => $set,
archive_filter => {@active},
}, { layout => undef };
};
};
true;

34
lib/App/Netdisco/Web/Plugin/Search/Port.pm
View File

@@ -7,7 +7,33 @@ use Dancer::Plugin::Auth::Extensible;
use App::Netdisco::Web::Plugin;
use App::Netdisco::Util::Web 'sql_match';
register_search_tab( { tag => 'port', label => 'Port', provides_csv => 1 } );
register_search_tab({
tag => 'port',
label => 'Port',
provides_csv => 1,
api_endpoint => 1,
api_parameters => [
q => {
description => 'Port name or VLAN or MAC address',
required => 1,
},
partial => {
description => 'Search for a partial match on parameter "q"',
type => 'boolean',
default => 'true',
},
uplink => {
description => 'Include uplinks in results',
type => 'boolean',
default => 'false',
},
ethernet => {
description => 'Only Ethernet type interfaces in results',
type => 'boolean',
default => 'true',
},
],
});
# device ports with a description (er, name) matching
get '/ajax/content/search/port' => require_login sub {
@@ -67,13 +93,11 @@ get '/ajax/content/search/port' => require_login sub {
if ( request->is_ajax ) {
my $json = to_json( \@results );
template 'ajax/search/port.tt', { results => $json },
{ layout => undef };
template 'ajax/search/port.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/search/port_csv.tt', { results => \@results },
{ layout => undef };
template 'ajax/search/port_csv.tt', { results => \@results };
}
};

19
lib/App/Netdisco/Web/Plugin/Search/VLAN.pm
View File

@@ -6,7 +6,18 @@ use Dancer::Plugin::Auth::Extensible;
use App::Netdisco::Web::Plugin;
register_search_tab( { tag => 'vlan', label => 'VLAN', provides_csv => 1 } );
register_search_tab({
tag => 'vlan',
label => 'VLAN',
provides_csv => 1,
api_endpoint => 1,
api_parameters => [
q => {
description => 'VLAN name or number',
required => 1,
},
],
});
# devices carrying vlan xxx
get '/ajax/content/search/vlan' => require_login sub {
@@ -28,13 +39,11 @@ get '/ajax/content/search/vlan' => require_login sub {
if (request->is_ajax) {
my $json = to_json( \@results );
template 'ajax/search/vlan.tt', { results => $json },
{ layout => undef };
template 'ajax/search/vlan.tt', { results => $json };
}
else {
header( 'Content-Type' => 'text/comma-separated-values' );
template 'ajax/search/vlan_csv.tt', { results => \@results },
{ layout => undef };
template 'ajax/search/vlan_csv.tt', { results => \@results };
}
};

2
lib/App/Netdisco/Web/Report.pm
View File

@@ -51,7 +51,7 @@ get '/report/*' => require_login sub {
ssid_list => $ssid_list,
type_list => $type_list,
vendor_list => $vendor_list,
};
}, { layout => 'main' };
};
true;

2
lib/App/Netdisco/Web/Search.pm
View File

@@ -95,7 +95,7 @@ get '/search' => require_login sub {
os_list => $os_list,
os_ver_list => $os_ver_list,
vendor_list => $vendor_list,
};
}, { layout => 'main' };
};
true;