org.graylog2.migrations.V20191129134600_CreateInitialUrlWhitelist Maven / Gradle / Ivy
/**
* This file is part of Graylog.
*
* Graylog 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 3 of the License, or
* (at your option) any later version.
*
* Graylog 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 Graylog. If not, see If no such services are configured yet, an empty whitelist is created.
*/
public class V20191129134600_CreateInitialUrlWhitelist extends Migration {
private static final Logger log = LoggerFactory.getLogger(V20191129134600_CreateInitialUrlWhitelist.class);
private final ClusterConfigService configService;
private final UrlWhitelistService whitelistService;
private final DBDataAdapterService dataAdapterService;
private final DBNotificationService notificationService;
private final RegexHelper regexHelper;
@Inject
public V20191129134600_CreateInitialUrlWhitelist(final ClusterConfigService clusterConfigService,
UrlWhitelistService whitelistService, DBDataAdapterService dataAdapterService,
DBNotificationService notificationService, RegexHelper regexHelper) {
this.configService = clusterConfigService;
this.whitelistService = whitelistService;
this.dataAdapterService = dataAdapterService;
this.notificationService = notificationService;
this.regexHelper = regexHelper;
}
@Override
public ZonedDateTime createdAt() {
return ZonedDateTime.parse("2019-11-29T13:46:00Z");
}
@Override
public void upgrade() {
final MigrationCompleted migrationCompleted = configService.get(MigrationCompleted.class);
if (migrationCompleted != null) {
log.debug("Migration already completed.");
return;
}
UrlWhitelist whitelist = createWhitelist();
whitelistService.saveWhitelist(whitelist);
configService.write(MigrationCompleted.create(whitelist.toString()));
}
private UrlWhitelist createWhitelist() {
final Set entries = new HashSet<>();
dataAdapterService.findAll()
.stream()
.map(this::extractFromDataAdapter)
.forEach(e -> e.ifPresent(entries::add));
try (final Stream notificationsStream = notificationService.streamAll()) {
notificationsStream.map(this::extractFromNotification)
.forEach(e -> e.ifPresent(entries::add));
}
log.info("Created {} whitelist entries from URLs configured in data adapters and event notifications.",
entries.size());
final UrlWhitelist whitelist = UrlWhitelist.createEnabled(new ArrayList<>(entries));
log.debug("Resulting whitelist: {}.", whitelist);
return whitelist;
}
private Optional extractFromNotification(NotificationDto notificationDto) {
final EventNotificationConfig config = notificationDto.config();
String url = "";
if (config instanceof HTTPEventNotificationConfig) {
url = ((HTTPEventNotificationConfig) config).url();
} else if (config instanceof LegacyAlarmCallbackEventNotificationConfig) {
url = Objects.toString(((LegacyAlarmCallbackEventNotificationConfig) config).configuration()
.get("url"), "");
}
if (StringUtils.isNotBlank(url)) {
return defaultIfNotMatching(LiteralWhitelistEntry.create(UUID.randomUUID().toString(),
"\"" + notificationDto.title() + "\" alert notification", url), url);
} else {
return Optional.empty();
}
}
private Optional extractFromDataAdapter(DataAdapterDto dataAdapterDto) {
final LookupDataAdapterConfiguration config = dataAdapterDto.config();
if (config instanceof DSVHTTPDataAdapter.Config) {
final String url = ((DSVHTTPDataAdapter.Config) config).url();
return defaultIfNotMatching(LiteralWhitelistEntry.create(UUID.randomUUID().toString(),
"\"" + dataAdapterDto.title() + "\" data adapter", url), url);
} else if (config instanceof HTTPJSONPathDataAdapter.Config) {
final String url = StringUtils.strip(((HTTPJSONPathDataAdapter.Config) config).url());
// Quote all parts around the ${key} template parameter( and replace the ${key} template param with a
// wildcard match
String regex = regexHelper.createRegexForUrlTemplate(url, "${key}");
return defaultIfNotMatching(RegexWhitelistEntry.create(UUID.randomUUID().toString(),
"\"" + dataAdapterDto.title() + "\" data adapter", regex), url);
}
return Optional.empty();
}
private Optional defaultIfNotMatching(WhitelistEntry entry, String url) {
if (!entry.isWhitelisted(url)) {
log.error("Unable to create matching URL whitelist entry for URL <{}>. Please configure your URL " +
"whitelist manually.", url);
return Optional.empty();
}
return Optional.of(entry);
}
@JsonAutoDetect
@AutoValue
@WithBeanGetter
public static abstract class MigrationCompleted {
@JsonProperty("created_whitelist")
public abstract String createdWhitelist();
@JsonCreator
public static MigrationCompleted create(@JsonProperty("created_whitelist") String createdWhitelist) {
return new AutoValue_V20191129134600_CreateInitialUrlWhitelist_MigrationCompleted(createdWhitelist);
}
}
}