org.firebirdsql.gds.ng.wire.crypt.KnownServerKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
There is a newer version: 6.0.0-beta-1
/*
 * Firebird Open Source JDBC Driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program 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
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a source control history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.gds.ng.wire.crypt;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.regex.Pattern;

import static java.util.Collections.emptyMap;
import static java.util.Collections.unmodifiableList;
import static java.util.Collections.unmodifiableMap;
import static java.util.Objects.requireNonNull;

/**
 * Class to hold server keys known to the client.
 *
 * @author Mark Rotteveel
 * @since 3.0
 */
public final class KnownServerKey {

    private static final Pattern CRYPT_PLUGIN_LIST_SPLIT = Pattern.compile("[ \t,;]+");

    private final String keyType;
    private final List plugins;
    private final Map specificData;

    private KnownServerKey(String keyType, List plugins, Map specificData) {
        this.keyType = requireNonNull(keyType, "keyType");
        this.plugins = unmodifiableList(new ArrayList<>(requireNonNull(plugins, "plugins")));
        this.specificData = specificData == null || specificData.isEmpty()
                ? emptyMap()
                : unmodifiableMap(specificData);
    }

    public KnownServerKey(String keyType, String plugins, Map specificData) {
        this(keyType, Arrays.asList(CRYPT_PLUGIN_LIST_SPLIT.split(plugins)), specificData);
    }

    public List getPluginSpecificData() {
        List pluginSpecificData = new ArrayList<>(plugins.size());
        for (String plugin : plugins) {
            EncryptionIdentifier identifier = new EncryptionIdentifier(keyType, plugin);
            pluginSpecificData.add(new PluginSpecificData(identifier, specificData.get(plugin)));
        }
        return pluginSpecificData;
    }

    public void clear() {
        specificData.values().stream()
                .filter(Objects::nonNull)
                .forEach(b -> Arrays.fill(b, (byte) 0));
    }

    /**
     * Class to hold plugin specific data.
     *
     * @since 5
     */
    public static final class PluginSpecificData {

        private final EncryptionIdentifier encryptionIdentifier;
        private final byte[] specificData;

        private PluginSpecificData(EncryptionIdentifier encryptionIdentifier, byte[] specificData) {
            this.encryptionIdentifier = requireNonNull(encryptionIdentifier, "encryptionIdentifier");
            this.specificData = specificData;
        }

        public EncryptionIdentifier getEncryptionIdentifier() {
            return encryptionIdentifier;
        }

        /**
         * @return plugin specific data (can be {@code null})
         */
        public byte[] getSpecificData() {
            return specificData;
        }

    }
}