org.apache.sshd.common.cipher.CipherInformation 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).

The 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.cipher;

import org.apache.sshd.common.AlgorithmNameProvider;
import org.apache.sshd.common.keyprovider.KeySizeIndicator;

/**
 * The reported algorithm name refers to the cipher base name - e.g., "AES", "ARCFOUR", etc.
 *
 * @author Apache MINA SSHD Project
 */
public interface CipherInformation extends AlgorithmNameProvider, KeySizeIndicator {
    /**
     * @return The actual transformation used - e.g., AES/CBC/NoPadding
     */
    String getTransformation();

    /**
     * @return Size of the initialization vector (in bytes)
     */
    int getIVSize();

    /**
     * @return Size of the authentication tag (AT) in bytes or 0 if this cipher does not support authentication
     */
    int getAuthenticationTagSize();

    /**
     * @return Size of block data used by the cipher (in bytes). For stream ciphers this value is (currently) used to
     *         indicate some average work buffer size to be used for the automatic re-keying mechanism described in
     *         RFC 4253 - Section 9
     */
    int getCipherBlockSize();

    /**
     * @return The block size (in bytes) used to derive the secret key for this cipher
     */
    int getKdfSize();
}