add(plugin) HashiCorp Vault RestAPI (#3054)

This commit is contained in:
Thibault S 2021-09-06 21:31:25 +02:00 committed by GitHub
parent 4cd16708e7
commit cb92f87772
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 623 additions and 0 deletions

View File

@ -0,0 +1,297 @@
#
# Copyright 2021 Centreon (http://www.centreon.com/)
#
# Centreon is a full-fledged industry-strength solution that meets
# the needs in IT infrastructure and application monitoring for
# service performance.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
package apps::hashicorp::vault::restapi::custom::api;
use strict;
use warnings;
use centreon::plugins::http;
use centreon::plugins::statefile;
use JSON::XS;
use Digest::MD5 qw(md5_hex);
sub new {
my ($class, %options) = @_;
my $self = {};
bless $self, $class;
if (!defined($options{output})) {
print "Class Custom: Need to specify 'output' argument.\n";
exit 3;
};
if (!defined($options{options})) {
$options{output}->add_option_msg(short_msg => "Class Custom: Need to specify 'options' argument.");
$options{output}->option_exit();
};
if (!defined($options{noptions})) {
$options{options}->add_options(arguments => {
'api-version:s' => { name => 'api_version' },
'critical-http-status:s' => { name => 'critical_http_status' },
'hostname:s' => { name => 'hostname' },
'port:s' => { name => 'port' },
'proto:s' => { name => 'proto' },
'warning-http-status:s' => { name => 'warning_http_status' },
'auth-method:s' => { name => 'auth_method', default => 'token' },
'auth-settings:s%' => { name => 'auth_settings' },
'unknown-http-status:s' => { name => 'unknown_http_status' },
'vault-token:s' => { name => 'vault_token'}
});
};
$options{options}->add_help(package => __PACKAGE__, sections => 'REST API OPTIONS', once => 1);
$self->{output} = $options{output};
$self->{http} = centreon::plugins::http->new(%options);
$self->{cache} = centreon::plugins::statefile->new(%options);
return $self;
}
sub set_options {
my ($self, %options) = @_;
$self->{option_results} = $options{option_results};
}
sub set_defaults {}
sub check_options {
my ($self, %options) = @_;
if ($self->{option_results}->{auth_method} eq 'token' && (!defined($self->{option_results}->{vault_token}) || $self->{option_results}->{vault_token} eq '')) {
$self->{output}->add_option_msg(short_msg => "Please set the --vault-token option");
$self->{output}->option_exit();
};
$self->{hostname} = (defined($self->{option_results}->{hostname})) ? $self->{option_results}->{hostname} : '';
$self->{port} = (defined($self->{option_results}->{port})) ? $self->{option_results}->{port} : 8200;
$self->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'http';
$self->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 10;
$self->{auth_method} = lc($self->{option_results}->{auth_method});
$self->{auth_settings} = defined($self->{option_results}->{auth_settings}) && $self->{option_results}->{auth_settings} ne '' ? $self->{option_results}->{auth_settings} : {};
$self->{vault_token} = $self->{option_results}->{vault_token};
$self->{api_version} = (defined($self->{option_results}->{api_version})) ? $self->{option_results}->{api_version} : 'v1';
$self->{unknown_http_status} = (defined($self->{option_results}->{unknown_http_status})) ? $self->{option_results}->{unknown_http_status} : '%{http_code} < 200 or %{http_code} >= 300';
$self->{warning_http_status} = (defined($self->{option_results}->{warning_http_status})) ? $self->{option_results}->{warning_http_status} : '';
$self->{critical_http_status} = (defined($self->{option_results}->{critical_http_status})) ? $self->{option_results}->{critical_http_status} : '';
$self->{reload_cache_time} = (defined($self->{option_results}->{reload_cache_time})) ? $self->{option_results}->{reload_cache_time} : 180;
$self->{cache}->check_options(option_results => $self->{option_results});
if (lc($self->{auth_method}) !~ m/azure|cert|github|ldap|okta|radius|userpass|token/ ) {
$self->{output}->add_option_msg(short_msg => "Incorrect or unsupported authentication method set in --auth-method");
$self->{output}->option_exit();
};
return 0;
}
sub build_options_for_httplib {
my ($self, %options) = @_;
$self->{option_results}->{hostname} = $self->{hostname};
$self->{option_results}->{timeout} = $self->{timeout};
$self->{option_results}->{port} = $self->{port};
$self->{option_results}->{proto} = $self->{proto};
$self->{option_results}->{timeout} = $self->{timeout};
$self->{option_results}->{basic} = 1;
}
sub settings {
my ($self, %options) = @_;
return if (defined($self->{settings_done}));
$self->build_options_for_httplib();
$self->{http}->add_header(key => 'Accept', value => 'application/json');
if (defined($self->{option_results}->{auth_method}) && $self->{option_results}->{auth_method} ne 'token') {
$self->{vault_token} = $self->get_access_token(statefile => $self->{cache});
};
if (defined($self->{vault_token})) {
$self->{http}->add_header(key => 'X-Vault-Token', value => $self->{vault_token});
};
$self->{http}->set_options(%{$self->{option_results}});
$self->{settings_done} = 1;
}
sub get_hostname {
my ($self, %options) = @_;
return $self->{hostname};
}
sub get_access_token {
my ($self, %options) = @_;
my $has_cache_file = $options{statefile}->read(statefile => 'vault_restapi_' . md5_hex($self->{hostname}) . '_' . md5_hex($self->{auth_method}));
my $expires_on = $options{statefile}->get(name => 'expires_on');
my $access_token = $options{statefile}->get(name => 'access_token');
if ( $has_cache_file == 0 || !defined($access_token) || (($expires_on - time()) < 10) ) {
my $decoded;
my $login = $self->parse_auth_method(method => $self->{auth_method}, settings => $self->{auth_settings});
my $post_json = JSON::XS->new->utf8->encode($login);
my $url_path = '/' . $self->{api_version} . '/auth/'. $self->{auth_method} . '/login/';
$url_path .= $self->{auth_settings}->{username} if (defined($self->{auth_settings}->{username}) && $self->{auth_method} =~ 'userpass|login') ;
my $content = $self->{http}->request(
hostname => $self->{hostname},
port => $self->{port},
proto => $self->{proto},
method => 'POST',
header => ['Content-type: application/json'],
query_form_post => $post_json,
url_path => $url_path
);
if (!defined($content) || $content eq '') {
$self->{output}->add_option_msg(short_msg => "Authentication endpoint returns empty content [code: '" . $self->{http}->get_code() . "'] [message: '" . $self->{http}->get_message() . "']");
$self->{output}->option_exit();
};
eval {
$decoded = JSON::XS->new->utf8->decode($content);
};
if ($@) {
$self->{output}->output_add(long_msg => $content, debug => 1);
$self->{output}->add_option_msg(short_msg => "Cannot decode response (add --debug option to display returned content)");
$self->{output}->option_exit();
};
if (defined($decoded->{errors}[0])) {
$self->{output}->output_add(long_msg => "Error message : " . $decoded->{errors}[0], debug => 1);
$self->{output}->add_option_msg(short_msg => "Authentication endpoint returns error code '" . $decoded->{errors}[0] . "' (add --debug option for detailed message)");
$self->{output}->option_exit();
};
$access_token = $decoded->{auth}->{client_token};
my $datas = { last_timestamp => time(), access_token => $decoded->{access_token}, expires_on => time() + 3600 };
$options{statefile}->write(data => $datas);
};
return $access_token;
}
sub parse_auth_method {
my ($self, %options) = @_;
my $login_settings;
my $settings_mapping = {
azure => [ 'role', 'jwt' ],
cert => [ 'name' ],
github => [ 'token' ],
ldap => [ 'username', 'password' ],
okta => [ 'username', 'password', 'totp' ],
radius => [ 'username', 'password' ],
userpass => [ 'username', 'password' ]
};
foreach (@{$settings_mapping->{$options{method}}}) {
if (!defined($options{settings}->{$_})) {
$self->{output}->add_option_msg(short_msg => 'Missing authentication setting: ' . $_);
$self->{output}->option_exit();
}
$login_settings->{$_} = $options{settings}->{$_};
};
return $login_settings;
}
sub request_api {
my ($self, %options) = @_;
$self->settings(%options);
my ($json, $response);
$response = $self->{http}->request(
method => 'GET',
url_path => '/' . $self->{api_version} . '/sys/' . $options{url_path}
);
$self->{output}->output_add(long_msg => $response, debug => 1);
eval {
$json = JSON::XS->new->utf8->decode($response);
};
if ($@) {
$self->{output}->add_option_msg(short_msg => "Cannot decode Vault JSON response: $@");
$self->{output}->option_exit();
};
return $json;
}
1;
__END__
=head1 NAME
HashiCorp Vault Rest API
=head1 REST API OPTIONS
HashiCorp Vault Rest API
=over 8
=item B<--hostname>
HashiCorp Vault hostname.
=item B<--port>
Port used (Default: 8200)
=item B<--proto>
Specify https if needed (Default: 'http')
=item B<--api-version>
Specify the Vault API version (Default: 'v1')
=item B<--vault-token>
Specify the Vault access token (only for the 'token' authentication method)
=item B<--auth-method>
Specify the Vault authentication method (Default: 'token').
Can be: 'azure', 'cert', 'github', 'ldap', 'okta', 'radius', 'userpass', 'token'
If different from 'token' the "--auth-settings" options must be set.
=item B<--auth-settings>
Specify the Vault authentication specific settings.
Syntax: --auth-settings='<setting>=<value>'.Example for the 'userpass' method:
--auth-method='userpass' --auth-settings='username=my_account' --auth-settings='password=my_password'
=item B<--timeout>
Set timeout in seconds (Default: 10).
=back
=head1 DESCRIPTION
B<custom>.
=cut

View File

@ -0,0 +1,122 @@
#
# Copyright 2021 Centreon (http://www.centreon.com/)
#
# Centreon is a full-fledged industry-strength solution that meets
# the needs in IT infrastructure and application monitoring for
# service performance.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
package apps::hashicorp::vault::restapi::mode::health;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold_ng);
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'vault_cluster', type => 1, cb_prefix_output => 'custom_prefix_output'},
];
$self->{maps_counters}->{vault_cluster} = [
{ label => 'seal-status', type => 2, critical_default => '%{sealed} ne "unsealed"', set => {
key_values => [ { name => 'sealed' } ],
output_template => "seal status : %s",
closure_custom_perfdata => sub { return 0; },
closure_custom_threshold_check => \&catalog_status_threshold_ng
}
},
{ label => 'init-status', type => 2, critical_default => '%{init} ne "initialized"', set => {
key_values => [ { name => 'init' } ],
output_template => "init status : %s",
closure_custom_perfdata => sub { return 0; },
closure_custom_threshold_check => \&catalog_status_threshold_ng
}
}
];
}
sub custom_prefix_output {
my ($self, %options) = @_;
return 'Server ' . $options{instance_value}->{cluster_name} . ' ';
}
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options, force_new_perfdata => 1);
bless $self, $class;
$options{options}->add_options(arguments => {});
return $self;
}
sub set_options {
my ($self, %options) = @_;
}
sub manage_selection {
my ($self, %options) = @_;
my $code_param = '?sealedcode=200&uninitcode=200'; # By default API will return error codes if sealed or uninit
my $result = $options{custom}->request_api(url_path => 'health' . $code_param);
my $cluster_name = defined($result->{cluster_name}) ? $result->{cluster_name} : $self->{option_results}->{hostname};
$self->{vault_cluster}->{$cluster_name} = {
cluster_name => $cluster_name,
sealed => $result->{sealed} ? 'sealed' : 'unsealed',
init => $result->{initialized} ? 'initialized' : 'not initialized',
};
}
1;
__END__
=head1 MODE
Check Hashicorp Vault Health status.
Example:
perl centreon_plugins.pl --plugin=apps::hashicorp::vault::restapi::plugin --mode=health
--hostname=10.0.0.1 --vault-token='s.aBCD123DEF456GHI789JKL012' --verbose
More information on'https://www.vaultproject.io/api-docs/system/health'.
=over 8
=item B<--warning-seal-status>
Set warning threshold for seal status (Default: none).
=item B<--critical-seal-status>
Set critical threshold for seal status (Default: '%{sealed} ne "unsealed"').
=item B<--warning-init-status>
Set warning threshold for initialization status (Default: none).
=item B<--critical-init-status>
Set critical threshold for initialization status (Default: '%{init} ne "initialized"').
=back
=cut

View File

@ -0,0 +1,155 @@
#
# Copyright 2021 Centreon (http://www.centreon.com/)
#
# Centreon is a full-fledged industry-strength solution that meets
# the needs in IT infrastructure and application monitoring for
# service performance.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
package apps::hashicorp::vault::restapi::mode::raftstorage;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'global', type => 0 },
{ name => 'boltdb', type => 1, cb_prefix_output => 'prefix_boltdb_output', message_multiple => 'All Bolt Databases are ok' }
];
$self->{maps_counters}->{global} = [
{ label => 'commit-time', nlbalel => 'vault.raftstorage.committime.seconds', set => {
key_values => [ { name => 'commit_time' } ],
output_template => "commit time : %.2fs",
perfdatas => [ { template => '%.2f', unit => 'ms', min => 0 } ]
}
}
];
$self->{maps_counters}->{boltdb} = [
{ label => 'spill-time', nlabel => 'vault.raftstorage.spilltime.seconds', set => {
key_values => [ { name => 'spill_time' }, { name => 'display' } ],
output_template => 'spill time: %.2fms',
perfdatas => [ { template => '%d', unit => 'ms', min => 0, cast_int => 1, label_extra_instance => 1, instance_use => 'display' } ]
}
},
{ label => 'rebalance-time', nlabel => 'vault.raftstorage.rebalance_time.seconds', set => {
key_values => [ { name => 'rebalance_time' }, { name => 'display' } ],
output_template => 'rebalance time: %.2fms',
perfdatas => [ { template => '%d', unit => 'ms', min => 0, cast_int => 1, label_extra_instance => 1, instance_use => 'display' } ]
}
},
{ label => 'write-time', nlabel => 'vault.raftstorage.write_time.seconds', set => {
key_values => [ { name => 'write_time' }, { name => 'display' } ],
output_template => 'write time: %.2fms',
perfdatas => [ { template => '%d', unit => 'ms', min => 0, cast_int => 1, label_extra_instance => 1, instance_use => 'display' } ]
}
}
];
}
sub prefix_boltdb_output {
my ($self, %options) = @_;
return "Database '" . $options{instance_value}->{display} . "' ";
}
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options, force_new_perfdata => 1);
bless $self, $class;
$options{options}->add_options(arguments => {});
return $self;
}
sub set_options {
my ($self, %options) = @_;
}
sub manage_selection {
my ($self, %options) = @_;
my $result = $options{custom}->request_api(url_path => 'metrics');
foreach (@{$result->{Samples}}) {
$_->{Name} =~ s/\.|\-/_/g;
if (defined($_->{Labels}->{database})) {
$_->{Name} =~ s/vault_raft_storage_bolt_//g;
$self->{raftstorage}->{boltdb}->{ $_->{Labels}->{database} }->{ $_->{Name} } = {
rate => $_->{Rate},
cluster => $_->{Labels}->{cluster}
}
} else {
$self->{raftstorage}->{global}->{ $_->{Name} } = {
rate => $_->{Rate},
}
}
};
$self->{global} = {
commit_time => defined($self->{raftstorage}->{global}->{'vault.raft.commitTime'}) ? $self->{global}->{raftstorage}->{'vault.raft.commitTime'}->{rate} : 0
};
foreach my $database (keys %{$self->{raftstorage}->{boltdb}}) {
$self->{boltdb}->{$database} = {
display => $database,
rebalance_time => $self->{raftstorage}->{boltdb}->{$database}->{rebalance_time},
spill_time => $self->{raftstorage}->{boltdb}->{$database}->{spill_time},
write_time => $self->{raftstorage}->{boltdb}->{$database}->{write_time}
}
};
if (scalar(keys %{$self->{boltdb}}) <= 0) {
$self->{output}->add_option_msg(short_msg => "No Bolt DB found.");
$self->{output}->option_exit();
};
}
1;
__END__
=head1 MODE
Check Hashicorp Vault Raft Storage status.
Example:
perl centreon_plugins.pl --plugin=apps::hashicorp::vault::restapi::plugin --mode=raft-storage
--hostname=10.0.0.1 --vault-token='s.aBCD123DEF456GHI789JKL012' --verbose
More information on'https://www.vaultproject.io/api-docs/system/health'.
=over 8
=item B<--warning-*>
Warning threshold where '*' can be:
'commit-time', 'spill-time', 'rebalance-time', 'write-time'
=item B<--critical-*>
Critical threshold where '*' can be:
'commit-time', 'spill-time', 'rebalance-time', 'write-time'
=back
=cut

View File

@ -0,0 +1,49 @@
#
# Copyright 2021 Centreon (http://www.centreon.com/)
#
# Centreon is a full-fledged industry-strength solution that meets
# the needs in IT infrastructure and application monitoring for
# service performance.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
package apps::hashicorp::vault::restapi::plugin;
use strict;
use warnings;
use base qw(centreon::plugins::script_custom);
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options);
bless $self, $class;
$self->{version} = '1.0';
$self->{modes} = {
'health' => 'apps::hashicorp::vault::restapi::mode::health',
'raft-storage' => 'apps::hashicorp::vault::restapi::mode::raftstorage'
};
$self->{custom_modes}->{api} = 'apps::hashicorp::vault::restapi::custom::api';
return $self;
}
1;
__END__
=head1 PLUGIN DESCRIPTION
Check HashiCorp Vault using RestAPI.
=cut