io.spiffe.spiffeid.SpiffeIdUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-spiffe-core Show documentation
Core functionality to fetch, process and validate X.509 and JWT SVIDs and Bundles from the Workload API.
There is a newer version: 0.8.11
package io.spiffe.spiffeid;

import com.google.common.collect.Sets;
import lombok.val;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Collections;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import static org.apache.commons.lang3.StringUtils.isBlank;

/**
 * Utility class with methods to read SPIFFE IDs using different mechanisms.
 */
public final class SpiffeIdUtils {

    private static final char DEFAULT_CHAR_SEPARATOR = '|';

    private static final Set SUPPORTED_SEPARATORS = Sets.newHashSet(DEFAULT_CHAR_SEPARATOR, ' ');

    private SpiffeIdUtils() {
        throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
    }

    /**
     * Reads a file containing a list of SPIFFE IDs and parses them to {@link SpiffeId} instances.
     * 
     * The file should have one SPIFFE ID per line.
     *
     * @param spiffeIdsFile the path to the file containing a list of SPIFFE IDs
     * @return a List of {@link SpiffeId} parsed from the file provided
     * @throws IOException              if the given spiffeIdsFile cannot be read
     * @throws IllegalArgumentException if any of the SPIFFE IDs in the file cannot be parsed
     */
    public static Set getSpiffeIdSetFromFile(final Path spiffeIdsFile) throws IOException {
        try (val lines = Files.lines(spiffeIdsFile)) {
            return lines
                    .map(SpiffeId::parse)
                    .collect(Collectors.toSet());
        }
    }

    /**
     * Parses a string representing a list of SPIFFE IDs and returns a list of instances of {@link SpiffeId}.
     *
     * @param spiffeIds a list of SPIFFE IDs represented in a string
     * @param separator used to separate the SPIFFE IDs in the string. Only the pipe character and the blank space
     *                  are valid separators
     * @return a list of {@link SpiffeId} instances.
     * @throws IllegalArgumentException is the separator provided is not valid
     */
    public static Set toSetOfSpiffeIds(final String spiffeIds, final char separator) {
        if (isBlank(spiffeIds)) {
            return Collections.emptySet();
        }

        if (!SUPPORTED_SEPARATORS.contains(separator)) {
            throw new IllegalArgumentException("Separator character is not supported.");
        }

        val array = parseArray(spiffeIds, separator);
        return Arrays.stream(array)
                .map(SpiffeId::parse)
                .collect(Collectors.toSet());
    }

    /**
     * Return the list of the SPIFFE IDs parsed from the String parameter, using the default separator (pipe character).
     *
     * @param spiffeIds a String representing a list of SPIFFE IDs separated by the pipe character
     * @return a list of {@link SpiffeId} instances
     * @throws IllegalArgumentException is the string provided is blank
     */
    public static Set toSetOfSpiffeIds(final String spiffeIds) {
        return toSetOfSpiffeIds(spiffeIds, DEFAULT_CHAR_SEPARATOR);
    }

    private static String[] parseArray(final String spiffeIds, final char separator) {
        val regex = Pattern.quote(String.valueOf(separator));
        return spiffeIds.trim().split(regex);
    }

}