/*
 * =============================================================================
 * 
 *   Copyright (c) 2007-2010, The JASYPT team (http://www.jasypt.org)
 * 
 *   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 org.jasypt.encryption;

import java.math.BigInteger;



Common interface for all Encryptors which receive a 
BigInteger (arbitrary precision) message and return a BigInteger result.


Important: The size of the result of encrypting a number, depending
on the algorithm, may be much bigger (in bytes) than the size of the 
encrypted number itself. For example, encrypting a 4-byte integer can
result in an encrypted 16-byte number. This can lead the user into 
problems if the encrypted values are to be stored and not enough room 
has been provided.

Author:
Daniel Fernández
Since:
1.2/**
 * <p>
 * Common interface for all Encryptors which receive a 
 * BigInteger (arbitrary precision) message and return a BigInteger result.
 * </p>
 * <p>
 * <b>Important</b>: The size of the result of encrypting a number, depending
 * on the algorithm, may be much bigger (in bytes) than the size of the 
 * encrypted number itself. For example, encrypting a 4-byte integer can
 * result in an encrypted 16-byte number. This can lead the user into 
 * problems if the encrypted values are to be stored and not enough room 
 * has been provided.
 * </p>
 * 
 * @since 1.2
 * 
 * @author Daniel Fern&aacute;ndez
 * 
 */
public interface BigIntegerEncryptor {
    
    
    
Encrypt the input message
Params:
message – the message to be encrypted
Returns:
the result of encryption/**
     * Encrypt the input message
     * 
     * @param message the message to be encrypted
     * @return the result of encryption
     */
    public BigInteger encrypt(BigInteger message);
    
    
    
Decrypt an encrypted message
Params:
encryptedMessage – the encrypted message to be decrypted
Returns:
the result of decryption/**
     * Decrypt an encrypted message
     * 
     * @param encryptedMessage the encrypted message to be decrypted
     * @return the result of decryption
     */
    public BigInteger decrypt(BigInteger encryptedMessage);
    
}