metron-streaming/Metron-DataLoads/src/main/java/org/apache/metron/dataloads/extractor/stix/types/AddressHandler.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.metron.dataloads.extractor.stix.types;

import com.google.common.base.Splitter;
import org.apache.metron.dataloads.extractor.stix.StixExtractor;
import org.apache.metron.threatintel.ThreatIntelKey;
import org.apache.metron.threatintel.ThreatIntelResults;
import org.mitre.cybox.common_2.ConditionApplicationEnum;
import org.mitre.cybox.common_2.ConditionTypeEnum;
import org.mitre.cybox.common_2.StringObjectPropertyType;
import org.mitre.cybox.objects.Address;
import org.mitre.cybox.objects.CategoryTypeEnum;

import java.io.IOException;
import java.util.*;

public class AddressHandler extends AbstractObjectTypeHandler<Address> {
    public static final String SPECIFIC_CATEGORY_CONFIG = "stix_address_categories";
    public static final EnumSet<CategoryTypeEnum> SUPPORTED_CATEGORIES = EnumSet.of(CategoryTypeEnum.E_MAIL
                                                                                   ,CategoryTypeEnum.IPV_4_ADDR
                                                                                   ,CategoryTypeEnum.IPV_6_ADDR
                                                                                   ,CategoryTypeEnum.MAC
                                                               ) ;
    public AddressHandler() {
        super(Address.class);
    }

    @Override
    public Iterable<ThreatIntelResults> extract(final Address type, Map<String, Object> config) throws IOException {
        List<ThreatIntelResults> ret = new ArrayList<>();
        final CategoryTypeEnum category= type.getCategory();
        if(!SUPPORTED_CATEGORIES.contains(category)) {
           return ret;
        }
        if(config != null && config.containsKey(SPECIFIC_CATEGORY_CONFIG)) {
            List<CategoryTypeEnum> categories = new ArrayList<>();
            for(String c : Splitter.on(",").split(config.get(SPECIFIC_CATEGORY_CONFIG).toString())) {
                categories.add(CategoryTypeEnum.valueOf(c));
            }
            EnumSet<CategoryTypeEnum> specificCategories = EnumSet.copyOf(categories);
            if(!specificCategories.contains(category)) {
                return ret;
            }

        }
        StringObjectPropertyType value = type.getAddressValue();
        for(String token : StixExtractor.split(value)) {
            ThreatIntelResults results = new ThreatIntelResults(new ThreatIntelKey(token),
                                                                    new HashMap<String, String>() {{
                                                                        put("source-type", "STIX");
                                                                        put("indicator-type", "Address");
                                                                        put("source", type.toXMLString());
                                                                    }}
                                                                   );
                ret.add(results);
        }
        return ret;
    }
}