1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<?php declare(strict_types = 0);
/*
** Zabbix
** Copyright (C) 2001-2023 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
/**
* A class for load secrets from HashiCorp Vault secret manager.
*/
class CVaultHelper {
/**
* Vault API endpoint.
*
* @var string
*/
protected $api_endpoint = '';
/**
* Vault access token.
*
* @var string
*/
protected $token = '';
public function __construct(string $api_endpoint, string $token) {
if (self::validateVaultApiEndpoint($api_endpoint)) {
$this->api_endpoint = rtrim(trim($api_endpoint), '/');
}
if (self::validateVaultToken($token)) {
$this->token = $token;
}
}
/**
* Function returns Vault secret. Assumes given $path is correct.
*
* @param string $path Path to secret.
*
* @throws Exception in case of configuration is not set.
*
* @return array
*/
public function loadSecret(string $path): array {
if ($this->token === '') {
throw new Exception(_('Incorrect Vault token.'));
}
$options = [
'http' => [
'method' => 'GET',
'header' => "X-Vault-Token: $this->token\r\n",
'ignore_errors' => true
]
];
try {
$url = $this->getURL($path);
}
catch (Exception $e) {
error($e->getMessage());
return [];
}
$secret = @file_get_contents($url, false, stream_context_create($options));
if ($secret === false) {
return [];
}
$secret = json_decode($secret, true);
if (is_array($secret) && array_key_exists('data', $secret) && is_array($secret['data'])
&& array_key_exists('data', $secret['data']) && is_array($secret['data']['data'])) {
return $secret['data']['data'];
}
else {
return [];
}
}
/**
* Function validates if given string is valid API endpoint.
*
* @param string $api_endpoint
*
* @return bool
*/
public static function validateVaultApiEndpoint(string $api_endpoint): bool {
$url_parts = parse_url($api_endpoint);
if (!$url_parts || !array_key_exists('host', $url_parts)) {
error(_s('Provided URL "%1$s" is invalid.', $api_endpoint));
return false;
}
return true;
}
/**
* Function validates if token is not empty string.
*
* @param string $token
*
* @return bool
*/
public static function validateVaultToken(string $token): bool {
return (trim($token) !== '');
}
/**
* Function returns Vault API request URL including path to secret.
*
* @param string $secret_path
*
* @throws Exception in case of configuration is not set.
*
* @return string
*/
public function getURL(string $path): string {
if ($this->api_endpoint === '') {
throw new Exception(_('Incorrect Vault API endpoint.'));
}
$path = explode('/', $path);
array_splice($path, 1, 0, 'data');
return $this->api_endpoint.'/v1/'.implode('/', $path);
}
}
|
