org.apache.sshd.common.config.keys.PrivateKeyEntryResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 34.0.0.Final

Show newest version

/*
 * 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;

import java.io.IOException;
import java.security.GeneralSecurityException;
import java.security.PrivateKey;
import java.security.spec.InvalidKeySpecException;

import org.apache.sshd.common.session.SessionContext;

/**
 * @author Apache MINA SSHD Project
 */
@FunctionalInterface
public interface PrivateKeyEntryResolver {
    /**
     * A resolver that ignores all input
     */
    PrivateKeyEntryResolver IGNORING = new PrivateKeyEntryResolver() {
        @Override
        public PrivateKey resolve(SessionContext session, String keyType, byte[] keyData)
                throws IOException, GeneralSecurityException {
            return null;
        }

        @Override
        public String toString() {
            return "IGNORING";
        }
    };

    /**
     * A resolver that fails on all input
     */
    PrivateKeyEntryResolver FAILING = new PrivateKeyEntryResolver() {
        @Override
        public PrivateKey resolve(SessionContext session, String keyType, byte[] keyData)
                throws IOException, GeneralSecurityException {
            throw new InvalidKeySpecException("Failing resolver on key type=" + keyType);
        }

        @Override
        public String toString() {
            return "FAILING";
        }
    };

    /**
     * @param  session                  The {@link SessionContext} for invoking this load command - may be {@code null}
     *                                  if not invoked within a session context (e.g., offline tool or session unknown).
     * @param  keyType                  The {@code OpenSSH} reported key type
     * @param  keyData                  The {@code OpenSSH} encoded key data
     * @return                          The extracted {@link PrivateKey} - ignored if {@code null}
     * @throws IOException              If failed to parse the key data
     * @throws GeneralSecurityException If failed to generate the key
     */
    PrivateKey resolve(SessionContext session, String keyType, byte[] keyData)
            throws IOException, GeneralSecurityException;
}