com.github.triceo.robozonky.common.secrets.KeyStoreSecretProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of robozonky-common Show documentation
The newest version!
/*
 * Copyright 2017 The RoboZonky Project
 *
 * Licensed 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 com.github.triceo.robozonky.common.secrets;

import java.io.CharArrayReader;
import java.io.IOException;
import java.io.Reader;
import java.time.OffsetDateTime;
import java.util.Optional;

import com.github.triceo.robozonky.util.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Every set*() operation must result in a {@link KeyStoreHandler#save()} call.
 */
final class KeyStoreSecretProvider implements SecretProvider {

    private static final Logger LOGGER = LoggerFactory.getLogger(KeyStoreSecretProvider.class);
    private static final String ALIAS_PASSWORD = "pwd";
    private static final String ALIAS_USERNAME = "usr";
    private static final String ALIAS_TOKEN = "tkn";
    private static final String ALIAS_TOKEN_DATE = "tknd";

    private static String getSecretIdentifier(final String secretId) {
        return "sct-" + secretId;
    }

    private final KeyStoreHandler ksh;

    public KeyStoreSecretProvider(final KeyStoreHandler ksh) {
        if (ksh == null) {
            throw new IllegalArgumentException("KeyStoreHandler must be provided.");
        }
        this.ksh = ksh;
    }

    /**
     * Set a key in the key store.
     * @param alias Alias to store the key under.
     * @param valueStream Will be converted to a {@link String} and stored.
     * @return True if success.
     */
    private boolean set(final String alias, final Reader valueStream) {
        return this.set(alias, IOUtils.toString(valueStream));
    }

    /**
     * Set a key in the key store.
     * @param alias Alias to store the key under.
     * @param value Will be stored.
     * @return True if success.
     */
    private boolean set(final String alias, final String value) {
        return this.set(alias, value.toCharArray());
    }

    /**
     * Set a key in the key store.
     * @param alias Alias to store the key under.
     * @param value Will be stored.
     * @return True if success.
     */
    private boolean set(final String alias, final char[] value) {
        try {
            final boolean result = this.ksh.set(alias, value);
            this.ksh.save();
            return result;
        } catch (final IOException ex) {
            KeyStoreSecretProvider.LOGGER.warn("Failed saving keystore.", ex);
            return false;
        }
    }

    @Override
    public char[] getPassword() {
        return this.ksh.get(KeyStoreSecretProvider.ALIAS_PASSWORD)
                .orElseThrow(() -> new IllegalStateException("Password not present in KeyStore."));
    }

    @Override
    public String getUsername() {
        return new String(this.ksh.get(KeyStoreSecretProvider.ALIAS_USERNAME)
                                  .orElseThrow(() -> new IllegalStateException("Username not present in KeyStore.")));
    }

    public boolean setPassword(final char[] password) {
        return this.set(KeyStoreSecretProvider.ALIAS_PASSWORD, password);
    }

    public boolean setUsername(final String username) {
        return this.set(KeyStoreSecretProvider.ALIAS_USERNAME, username);
    }

    @Override
    public Optional getToken() {
        final Optional stored = this.ksh.get(KeyStoreSecretProvider.ALIAS_TOKEN);
        return stored.map(CharArrayReader::new);
    }

    @Override
    public boolean setToken(final Reader token) {
        final boolean firstSuccessful = this.set(KeyStoreSecretProvider.ALIAS_TOKEN, token);
        final boolean secondSuccessful = this.set(KeyStoreSecretProvider.ALIAS_TOKEN_DATE,
                                                  OffsetDateTime.now().toString());
        return firstSuccessful && secondSuccessful;
    }

    @Override
    public Optional getSecret(final String secretId) {
        return this.ksh.get(KeyStoreSecretProvider.getSecretIdentifier(secretId));
    }

    @Override
    public boolean setSecret(final String secretId, final char... secret) {
        return this.set(KeyStoreSecretProvider.getSecretIdentifier(secretId), secret);
    }

    @Override
    public boolean deleteToken() {
        boolean result = this.ksh.delete(KeyStoreSecretProvider.ALIAS_TOKEN);
        result = this.ksh.delete(KeyStoreSecretProvider.ALIAS_TOKEN_DATE) && result;
        try {
            this.ksh.save();
            return result;
        } catch (final IOException ex) {
            KeyStoreSecretProvider.LOGGER.warn("Failed saving keystore.", ex);
            return false;
        }
    }

    @Override
    public boolean isPersistent() {
        return true;
    }
}