org.apache.sshd.common.config.keys.loader.openssh.OpenSSHParserContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wildfly-elytron
WildFly Security SPIs
There is a newer version: 2.4.1.Final
/*
 * 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.sshd.common.config.keys.loader.openssh;

import java.io.IOException;
import java.io.StreamCorruptedException;
import java.security.GeneralSecurityException;
import java.util.function.Predicate;

import org.apache.sshd.common.NamedResource;
import org.apache.sshd.common.session.SessionContext;
import org.apache.sshd.common.util.GenericUtils;

/**
 * @author Apache MINA SSHD Project
 */
public class OpenSSHParserContext implements OpenSSHKeyDecryptor {
    public static final String NONE_CIPHER = "none";
    public static final Predicate IS_NONE_CIPHER = c -> GenericUtils.isEmpty(c) || NONE_CIPHER.equalsIgnoreCase(c);

    private String cipherName;
    private OpenSSHKdfOptions kdfOptions;

    public OpenSSHParserContext() {
        super();
    }

    public OpenSSHParserContext(String cipherName, OpenSSHKdfOptions kdfOptions) {
        setCipherName(cipherName);
        setKdfOptions(kdfOptions);
    }

    @Override
    public boolean isEncrypted() {
        if (!IS_NONE_CIPHER.test(getCipherName())) {
            return true;
        }

        OpenSSHKdfOptions options = getKdfOptions();
        return (options != null) && options.isEncrypted();
    }

    public String getCipherName() {
        return cipherName;
    }

    public void setCipherName(String cipherName) {
        this.cipherName = cipherName;
    }

    public OpenSSHKdfOptions getKdfOptions() {
        return kdfOptions;
    }

    public void setKdfOptions(OpenSSHKdfOptions kdfOptions) {
        this.kdfOptions = kdfOptions;
    }

    @Override
    public byte[] decodePrivateKeyBytes(
            SessionContext session, NamedResource resourceKey, String cipherName, byte[] privateDataBytes, String password)
            throws IOException, GeneralSecurityException {
        OpenSSHKdfOptions options = getKdfOptions();
        if (options == null) {
            throw new StreamCorruptedException("No KDF options available for decrypting " + resourceKey);
        }

        return options.decodePrivateKeyBytes(session, resourceKey, cipherName, privateDataBytes, password);
    }

    @Override
    public String toString() {
        return getClass().getSimpleName()
               + "[cipher=" + getCipherName()
               + ", kdfOptions=" + getKdfOptions()
               + "]";
    }
}