Skip to content

Commit d8c5e41

Browse files
lippserdlippserd
committed
Rename blacklist to denylist
1 parent 42b3b54 commit d8c5e41

File tree

5 files changed

+44
-44
lines changed

5 files changed

+44
-44
lines changed

‎configuration.php

+16-16
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,12 @@
118118
);
119119

120120
$this->provideRestriction(
121-
'icingadb/blacklist/routes',
121+
'icingadb/denylist/routes',
122122
$this->translate('Prevent access to routes that are part of the list')
123123
);
124124

125125
$this->provideRestriction(
126-
'icingadb/blacklist/variables',
126+
'icingadb/denylist/variables',
127127
$this->translate('Hide custom variables of Icinga objects that are part of the list')
128128
);
129129

@@ -333,15 +333,15 @@
333333
'icon' => 'cog'
334334
]);
335335
$auth = Auth::getInstance();
336-
$routeBlacklist = [];
336+
$routeDenylist = [];
337337
if ($auth->isAuthenticated() && ! $auth->getUser()->isUnrestricted()) {
338338
// The empty array is for PHP pre 7.4, older versions require at least a single param for array_merge
339-
$routeBlacklist = array_flip(array_merge([], ...array_map(function ($restriction) {
339+
$routeDenylist = array_flip(array_merge([], ...array_map(function ($restriction) {
340340
return StringHelper::trimSplit($restriction);
341-
}, $auth->getRestrictions('icingadb/blacklist/routes'))));
341+
}, $auth->getRestrictions('icingadb/denylist/routes'))));
342342
}
343343

344-
if (! array_key_exists('hostgroups', $routeBlacklist)) {
344+
if (! array_key_exists('hostgroups', $routeDenylist)) {
345345
$overviewSection->add(N_('Host Groups'), [
346346
'description' => $this->translate('List host groups'),
347347
'url' => 'icingadb/hostgroups',
@@ -350,7 +350,7 @@
350350
]);
351351
}
352352

353-
if (! array_key_exists('servicegroups', $routeBlacklist)) {
353+
if (! array_key_exists('servicegroups', $routeDenylist)) {
354354
$overviewSection->add(N_('Service Groups'), [
355355
'description' => $this->translate('List service groups'),
356356
'url' => 'icingadb/servicegroups',
@@ -359,7 +359,7 @@
359359
]);
360360
}
361361

362-
if (! array_key_exists('usergroups', $routeBlacklist)) {
362+
if (! array_key_exists('usergroups', $routeDenylist)) {
363363
$overviewSection->add(N_('User Groups'), [
364364
'description' => $this->translate('List user groups'),
365365
'url' => 'icingadb/usergroups',
@@ -368,7 +368,7 @@
368368
]);
369369
}
370370

371-
if (! array_key_exists('users', $routeBlacklist)) {
371+
if (! array_key_exists('users', $routeDenylist)) {
372372
$overviewSection->add(N_('Users'), [
373373
'description' => $this->translate('List users'),
374374
'url' => 'icingadb/users',
@@ -463,15 +463,15 @@
463463

464464

465465
$auth = Auth::getInstance();
466-
$routeBlacklist = [];
466+
$routeDenylist = [];
467467
if ($auth->isAuthenticated() && ! $auth->getUser()->isUnrestricted()) {
468468
// The empty array is for PHP pre 7.4, older versions require at least a single param for array_merge
469-
$routeBlacklist = array_flip(array_merge([], ...array_map(function ($restriction) {
469+
$routeDenylist = array_flip(array_merge([], ...array_map(function ($restriction) {
470470
return StringHelper::trimSplit($restriction);
471-
}, $auth->getRestrictions('icingadb/blacklist/routes'))));
471+
}, $auth->getRestrictions('icingadb/denylist/routes'))));
472472
}
473473

474-
if (! array_key_exists('hostgroups', $routeBlacklist)) {
474+
if (! array_key_exists('hostgroups', $routeDenylist)) {
475475
$section->add(N_('Host Groups'), [
476476
'url' => 'icingadb/hostgroups',
477477
'priority' => 50,
@@ -480,7 +480,7 @@
480480
]);
481481
}
482482

483-
if (! array_key_exists('servicegroups', $routeBlacklist)) {
483+
if (! array_key_exists('servicegroups', $routeDenylist)) {
484484
$section->add(N_('Service Groups'), [
485485
'url' => 'icingadb/servicegroups',
486486
'priority' => 60,
@@ -489,7 +489,7 @@
489489
]);
490490
}
491491

492-
if (! array_key_exists('usergroups', $routeBlacklist)) {
492+
if (! array_key_exists('usergroups', $routeDenylist)) {
493493
$section->add(N_('User Groups'), [
494494
'url' => 'icingadb/usergroups',
495495
'priority' => 70,
@@ -498,7 +498,7 @@
498498
]);
499499
}
500500

501-
if (! array_key_exists('users', $routeBlacklist)) {
501+
if (! array_key_exists('users', $routeDenylist)) {
502502
$section->add(N_('Users'), [
503503
'url' => 'icingadb/users',
504504
'priority' => 80,

‎doc/04-Security.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -61,25 +61,25 @@ unrestricted. It should be one or more [filter expressions](#filter-expressions)
6161
`icingadb/filter/services` will only allow users to access matching services. Other objects remain unrestricted.
6262
It should be one or more [filter expressions](#filter-expressions).
6363

64-
### Blacklists
64+
### Denylists
6565

66-
Blacklists prevent users from accessing information and in some cases will block them entirely from it.
66+
Denylists prevent users from accessing information and in some cases will block them entirely from it.
6767

6868
> **Note:**
6969
>
70-
> Blacklists from multiple roles will further limit access.
70+
> Denylists from multiple roles will further limit access.
7171
7272
Name | Description
7373
-----------------------------|------------------------------------------------------------------
74-
icingadb/blacklist/routes | Prevent access to routes that are part of the list
75-
icingadb/blacklist/variables | Hide custom variables of Icinga objects that are part of the list
74+
icingadb/denylist/routes | Prevent access to routes that are part of the list
75+
icingadb/denylist/variables | Hide custom variables of Icinga objects that are part of the list
7676

77-
`icingadb/blacklist/routes` will block users from accessing defined routes and from related information elsewhere.
77+
`icingadb/denylist/routes` will block users from accessing defined routes and from related information elsewhere.
7878
For example, if `hostgroups` are part of the list a user won't have access to the hostgroup overview nor to a host's
7979
groups shown in its detail area. This should be a comma separated list. Possible values are: hostgroups, servicegroups,
8080
contacts, contactgroups
8181

82-
`icingadb/blacklist/variables` will block users from accessing certain custom variables. A user affected by this won't
82+
`icingadb/denylist/variables` will block users from accessing certain custom variables. A user affected by this won't
8383
see that those variables even exist. This should be a comma separated list of [variable paths](#variable-paths). It is
8484
possible to use [match patterns](#match-patterns).
8585

@@ -89,7 +89,7 @@ Protections prevent users from accessing actual data. They will know that there
8989

9090
> **Note:**
9191
>
92-
> Blacklists from multiple roles will further limit access.
92+
> Denylists from multiple roles will further limit access.
9393
9494
Name | Description
9595
---------------------------|-----------------------------------------------------------------------------

‎doc/10-Migration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ or support for them has been dropped. Check the table below for details:
118118

119119
### `monitoring/blacklist/properties`
120120

121-
This is now `icingadb/blacklist/variables`. However, it does not accept the same rules as
121+
This is now `icingadb/denylist/variables`. However, it does not accept the same rules as
122122
`monitoring/blacklist/properties`. It still accepts a comma separated list of GLOB like filters,
123123
but with some features removed:
124124

@@ -133,5 +133,5 @@ Check the [security chapter](04-Security.md#variable-paths) for more details.
133133
The command permissions have not changed. It is only the module identifier that has changed of course:
134134
`monitoring.command.*` is now `icingadb.command.*`
135135

136-
The `no-monitoring/contacts` permission (or *fake refusal*) is now a restriction: `icingadb/blacklist/routes`.
136+
The `no-monitoring/contacts` permission (or *fake refusal*) is now a restriction: `icingadb/denylist/routes`.
137137
Add `users,usergroups` to it to achieve the same effect.

‎library/Icingadb/Common/Auth.php

+12-12
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ public function isPermittedRoute(string $name): bool
3737
}
3838

3939
// The empty array is for PHP pre 7.4, older versions require at least a single param for array_merge
40-
$routeBlacklist = array_flip(array_merge([], ...array_map(function ($restriction) {
40+
$routeDenylist = array_flip(array_merge([], ...array_map(function ($restriction) {
4141
return StringHelper::trimSplit($restriction);
42-
}, $this->getAuth()->getRestrictions('icingadb/blacklist/routes'))));
42+
}, $this->getAuth()->getRestrictions('icingadb/denylist/routes'))));
4343

44-
return ! array_key_exists($name, $routeBlacklist);
44+
return ! array_key_exists($name, $routeDenylist);
4545
}
4646

4747
/**
@@ -105,7 +105,7 @@ public function isMatchedOn(string $queryString, Model $object): bool
105105
* This will apply `icingadb/filter/objects` in any case. `icingadb/filter/services` is only
106106
* applied to queries fetching services and `icingadb/filter/hosts` is applied to queries
107107
* fetching either hosts or services. It also applies custom variable restrictions and
108-
* obfuscations. (`icingadb/blacklist/variables` and `icingadb/protect/variables`)
108+
* obfuscations. (`icingadb/denylist/variables` and `icingadb/protect/variables`)
109109
*
110110
* @param Query $query
111111
*
@@ -145,8 +145,8 @@ public function applyRestrictions(Query $query)
145145
$roleFilter = Filter::all();
146146

147147
if ($customVarRelationName !== false) {
148-
if (($restriction = $role->getRestrictions('icingadb/blacklist/variables'))) {
149-
$roleFilter->add($this->parseBlacklist(
148+
if (($restriction = $role->getRestrictions('icingadb/denylist/variables'))) {
149+
$roleFilter->add($this->parseDenylist(
150150
$restriction,
151151
$customVarRelationName
152152
? $resolver->qualifyColumn('flatname', $customVarRelationName)
@@ -155,7 +155,7 @@ public function applyRestrictions(Query $query)
155155
}
156156

157157
if (($restriction = $role->getRestrictions('icingadb/protect/variables'))) {
158-
$obfuscationRules->add($this->parseBlacklist(
158+
$obfuscationRules->add($this->parseDenylist(
159159
$restriction,
160160
$customVarRelationName
161161
? $resolver->qualifyColumn('flatname', $customVarRelationName)
@@ -316,17 +316,17 @@ function ($k, $v) {
316316
}
317317

318318
/**
319-
* Parse the given blacklist
319+
* Parse the given denylist
320320
*
321-
* @param string $blacklist Comma separated list of column names
322-
* @param string $column The column which should not equal any of the blacklisted names
321+
* @param string $denylist Comma separated list of column names
322+
* @param string $column The column which should not equal any of the denylisted names
323323
*
324324
* @return Filter\None
325325
*/
326-
protected function parseBlacklist(string $blacklist, string $column): Filter\None
326+
protected function parseDenylist(string $denylist, string $column): Filter\None
327327
{
328328
$filter = Filter::none();
329-
foreach (explode(',', $blacklist) as $value) {
329+
foreach (explode(',', $denylist) as $value) {
330330
$filter->add(Filter::like($column, trim($value)));
331331
}
332332

‎library/Icingadb/Common/ObjectInspectionDetail.php

+6-6
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ protected function createLastCheckResult()
8080
$command = join(' ', array_map('escapeshellarg', $command));
8181
}
8282

83-
$blacklist = [
83+
$denylist = [
8484
'command',
8585
'output',
8686
'type',
@@ -92,7 +92,7 @@ protected function createLastCheckResult()
9292
new HtmlElement('pre', null, Text::create($command)),
9393
new HtmlElement('h2', null, Text::create(t('Execution Details'))),
9494
$this->createNameValueTable(
95-
array_diff_key($this->attrs['last_check_result'], array_flip($blacklist)),
95+
array_diff_key($this->attrs['last_check_result'], array_flip($denylist)),
9696
[
9797
'execution_end' => [$this, 'formatTimestamp'],
9898
'execution_start' => [$this, 'formatTimestamp'],
@@ -126,14 +126,14 @@ protected function createRedisInfo(): array
126126
return [$title, sprintf('Failed to decode redis data: %s', $e->getMessage())];
127127
}
128128

129-
$blacklist = [
129+
$denylist = [
130130
'commandline',
131131
'environment_id',
132132
'id'
133133
];
134134

135135
return [$title, $this->createNameValueTable(
136-
array_diff_key($data, array_flip($blacklist)),
136+
array_diff_key($data, array_flip($denylist)),
137137
[
138138
'last_state_change' => [$this, 'formatMillisecondTimestamp'],
139139
'last_update' => [$this, 'formatMillisecondTimestamp'],
@@ -152,7 +152,7 @@ protected function createRedisInfo(): array
152152

153153
protected function createAttributes(): array
154154
{
155-
$blacklist = [
155+
$denylist = [
156156
'name',
157157
'__name',
158158
'host_name',
@@ -171,7 +171,7 @@ protected function createAttributes(): array
171171
return [
172172
new HtmlElement('h2', null, Text::create(t('Object Attributes'))),
173173
$this->createNameValueTable(
174-
array_diff_key($this->attrs, array_flip($blacklist)),
174+
array_diff_key($this->attrs, array_flip($denylist)),
175175
[
176176
'acknowledgement_expiry' => [$this, 'formatTimestamp'],
177177
'acknowledgement_last_change' => [$this, 'formatTimestamp'],

0 commit comments

Comments
 (0)