forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
IPinfo ASN and Country (elastic#114192)
Adding the building blocks to support IPinfo ASN and Country data
- Loading branch information
Showing
9 changed files
with
495 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
235 changes: 235 additions & 0 deletions
235
modules/ingest-geoip/src/main/java/org/elasticsearch/ingest/geoip/IpinfoIpDataLookups.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,235 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the "Elastic License | ||
| * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side | ||
| * Public License v 1"; you may not use this file except in compliance with, at | ||
| * your election, the "Elastic License 2.0", the "GNU Affero General Public | ||
| * License v3.0 only", or the "Server Side Public License, v 1". | ||
| */ | ||
|
|
||
| package org.elasticsearch.ingest.geoip; | ||
|
|
||
| import com.maxmind.db.DatabaseRecord; | ||
| import com.maxmind.db.MaxMindDbConstructor; | ||
| import com.maxmind.db.MaxMindDbParameter; | ||
| import com.maxmind.db.Reader; | ||
|
|
||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.network.InetAddresses; | ||
| import org.elasticsearch.common.network.NetworkAddress; | ||
| import org.elasticsearch.core.Nullable; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.InetAddress; | ||
| import java.util.HashMap; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * A collection of {@link IpDataLookup} implementations for IPinfo databases | ||
| */ | ||
| final class IpinfoIpDataLookups { | ||
|
|
||
| private IpinfoIpDataLookups() { | ||
| // utility class | ||
| } | ||
|
|
||
| private static final Logger logger = LogManager.getLogger(IpinfoIpDataLookups.class); | ||
|
|
||
| /** | ||
| * Lax-ly parses a string that (ideally) looks like 'AS123' into a Long like 123L (or null, if such parsing isn't possible). | ||
| * @param asn a potentially empty (or null) ASN string that is expected to contain 'AS' and then a parsable long | ||
| * @return the parsed asn | ||
| */ | ||
| static Long parseAsn(final String asn) { | ||
| if (asn == null || Strings.hasText(asn) == false) { | ||
| return null; | ||
| } else { | ||
| String stripped = asn.toUpperCase(Locale.ROOT).replaceAll("AS", "").trim(); | ||
| try { | ||
| return Long.parseLong(stripped); | ||
| } catch (NumberFormatException e) { | ||
| logger.trace("Unable to parse non-compliant ASN string [{}]", asn); | ||
| return null; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public record AsnResult( | ||
| Long asn, | ||
| @Nullable String country, // not present in the free asn database | ||
| String domain, | ||
| String name, | ||
| @Nullable String type // not present in the free asn database | ||
| ) { | ||
| @SuppressWarnings("checkstyle:RedundantModifier") | ||
| @MaxMindDbConstructor | ||
| public AsnResult( | ||
| @MaxMindDbParameter(name = "asn") String asn, | ||
| @Nullable @MaxMindDbParameter(name = "country") String country, | ||
| @MaxMindDbParameter(name = "domain") String domain, | ||
| @MaxMindDbParameter(name = "name") String name, | ||
| @Nullable @MaxMindDbParameter(name = "type") String type | ||
| ) { | ||
| this(parseAsn(asn), country, domain, name, type); | ||
| } | ||
| } | ||
|
|
||
| public record CountryResult( | ||
| @MaxMindDbParameter(name = "continent") String continent, | ||
| @MaxMindDbParameter(name = "continent_name") String continentName, | ||
| @MaxMindDbParameter(name = "country") String country, | ||
| @MaxMindDbParameter(name = "country_name") String countryName | ||
| ) { | ||
| @MaxMindDbConstructor | ||
| public CountryResult {} | ||
| } | ||
|
|
||
| static class Asn extends AbstractBase<AsnResult> { | ||
| Asn(Set<Database.Property> properties) { | ||
| super(properties, AsnResult.class); | ||
| } | ||
|
|
||
| @Override | ||
| protected Map<String, Object> transform(final Result<AsnResult> result) { | ||
| AsnResult response = result.result; | ||
| Long asn = response.asn; | ||
| String organizationName = response.name; | ||
| String network = result.network; | ||
|
|
||
| Map<String, Object> data = new HashMap<>(); | ||
| for (Database.Property property : this.properties) { | ||
| switch (property) { | ||
| case IP -> data.put("ip", result.ip); | ||
| case ASN -> { | ||
| if (asn != null) { | ||
| data.put("asn", asn); | ||
| } | ||
| } | ||
| case ORGANIZATION_NAME -> { | ||
| if (organizationName != null) { | ||
| data.put("organization_name", organizationName); | ||
| } | ||
| } | ||
| case NETWORK -> { | ||
| if (network != null) { | ||
| data.put("network", network); | ||
| } | ||
| } | ||
| case COUNTRY_ISO_CODE -> { | ||
| if (response.country != null) { | ||
| data.put("country_iso_code", response.country); | ||
| } | ||
| } | ||
| case DOMAIN -> { | ||
| if (response.domain != null) { | ||
| data.put("domain", response.domain); | ||
| } | ||
| } | ||
| case TYPE -> { | ||
| if (response.type != null) { | ||
| data.put("type", response.type); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return data; | ||
| } | ||
| } | ||
|
|
||
| static class Country extends AbstractBase<CountryResult> { | ||
| Country(Set<Database.Property> properties) { | ||
| super(properties, CountryResult.class); | ||
| } | ||
|
|
||
| @Override | ||
| protected Map<String, Object> transform(final Result<CountryResult> result) { | ||
| CountryResult response = result.result; | ||
|
|
||
| Map<String, Object> data = new HashMap<>(); | ||
| for (Database.Property property : this.properties) { | ||
| switch (property) { | ||
| case IP -> data.put("ip", result.ip); | ||
| case COUNTRY_ISO_CODE -> { | ||
| String countryIsoCode = response.country; | ||
| if (countryIsoCode != null) { | ||
| data.put("country_iso_code", countryIsoCode); | ||
| } | ||
| } | ||
| case COUNTRY_NAME -> { | ||
| String countryName = response.countryName; | ||
| if (countryName != null) { | ||
| data.put("country_name", countryName); | ||
| } | ||
| } | ||
| case CONTINENT_CODE -> { | ||
| String continentCode = response.continent; | ||
| if (continentCode != null) { | ||
| data.put("continent_code", continentCode); | ||
| } | ||
| } | ||
| case CONTINENT_NAME -> { | ||
| String continentName = response.continentName; | ||
| if (continentName != null) { | ||
| data.put("continent_name", continentName); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return data; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Just a little record holder -- there's the data that we receive via the binding to our record objects from the Reader via the | ||
| * getRecord call, but then we also need to capture the passed-in ip address that came from the caller as well as the network for | ||
| * the returned DatabaseRecord from the Reader. | ||
| */ | ||
| public record Result<T>(T result, String ip, String network) {} | ||
|
|
||
| /** | ||
| * The {@link IpinfoIpDataLookups.AbstractBase} is an abstract base implementation of {@link IpDataLookup} that | ||
| * provides common functionality for getting a {@link IpinfoIpDataLookups.Result} that wraps a record from a {@link IpDatabase}. | ||
| * | ||
| * @param <RESPONSE> the record type that will be wrapped and returned | ||
| */ | ||
| private abstract static class AbstractBase<RESPONSE> implements IpDataLookup { | ||
|
|
||
| protected final Set<Database.Property> properties; | ||
| protected final Class<RESPONSE> clazz; | ||
|
|
||
| AbstractBase(final Set<Database.Property> properties, final Class<RESPONSE> clazz) { | ||
| this.properties = Set.copyOf(properties); | ||
| this.clazz = clazz; | ||
| } | ||
|
|
||
| @Override | ||
| public Set<Database.Property> getProperties() { | ||
| return this.properties; | ||
| } | ||
|
|
||
| @Override | ||
| public final Map<String, Object> getData(final IpDatabase ipDatabase, final String ipAddress) { | ||
| final Result<RESPONSE> response = ipDatabase.getResponse(ipAddress, this::lookup); | ||
| return (response == null || response.result == null) ? Map.of() : transform(response); | ||
| } | ||
|
|
||
| @Nullable | ||
| private Result<RESPONSE> lookup(final Reader reader, final String ipAddress) throws IOException { | ||
| final InetAddress ip = InetAddresses.forString(ipAddress); | ||
| final DatabaseRecord<RESPONSE> record = reader.getRecord(ip, clazz); | ||
| final RESPONSE data = record.getData(); | ||
| return (data == null) ? null : new Result<>(data, NetworkAddress.format(ip), record.getNetwork().toString()); | ||
| } | ||
|
|
||
| /** | ||
| * Extract the configured properties from the retrieved response | ||
| * @param response the non-null response that was retrieved | ||
| * @return a mapping of properties for the ip from the response | ||
| */ | ||
| protected abstract Map<String, Object> transform(Result<RESPONSE> response); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.