com.springcryptoutils.core.cipher.symmetric.Base64EncodedCiphererWithStaticKey Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 Mirko Caserta
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this software 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.springcryptoutils.core.cipher.symmetric;

/**
 * An interface for performing symmetric encryption/decryption with
 * a key configured in the underlying implementation. The encryption/decription
 * mode also depends on the configuration of the underlying implementation.
 *
 * @author Mirko Caserta ([email protected])
 */
public interface Base64EncodedCiphererWithStaticKey {

    /**
     * Encrypts/decrypts a message using a symmetric key which is
     * configured in the underlying implementation.
     *
     * @param message if in encryption mode, the clear-text message to encrypt,
     *                otherwise a base64 encoded version of the raw byte array containing the
     *                message to decrypt
     * @return if in encryption mode, returns a base64 encoded version of the
     *         encrypted message, otherwise returns the clear-text message
     */
    String encrypt(String message);

}