Copyright (c) 2008 Sonatype, Inc. All rights reserved.
This program is licensed to you under the Apache License Version 2.0,
and you may not use this file except in compliance with the Apache License Version 2.0.
You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing,
software distributed under the Apache License Version 2.0 is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
/**
 * Copyright (c) 2008 Sonatype, Inc. All rights reserved.
 *
 * This program is licensed to you under the Apache License Version 2.0,
 * and you may not use this file except in compliance with the Apache License Version 2.0.
 * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the Apache License Version 2.0 is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
 */
package org.sonatype.plexus.components.cipher;

Author:
Oleg Gusakov/**
 * @author Oleg Gusakov
 */
public interface PlexusCipher
{
    public static final char ENCRYPTED_STRING_DECORATION_START = '{';

    public static final char ENCRYPTED_STRING_DECORATION_STOP = '}';

    
encrypt given string with the given passPhrase and encode it into base64
Params:
str – 
passPhrase – 
Throws:
PlexusCipherException – 
Returns:
/**
     * encrypt given string with the given passPhrase and encode it into base64
     * 
     * @param str
     * @param passPhrase
     * @return
     * @throws PlexusCipherException
     */
    String encrypt( String str, String passPhrase )
        throws PlexusCipherException;

    
encrypt given string with the given passPhrase, encode it into base64 and return result, wrapped into { }
decorations
Params:
str – 
passPhrase – 
Throws:
PlexusCipherException – 
Returns:
/**
     * encrypt given string with the given passPhrase, encode it into base64 and return result, wrapped into { }
     * decorations
     * 
     * @param str
     * @param passPhrase
     * @return
     * @throws PlexusCipherException
     */
    String encryptAndDecorate( String str, String passPhrase )
        throws PlexusCipherException;

    
decrypt given base64 encrypted string
Params:
str – 
passPhrase – 
Throws:
PlexusCipherException – 
Returns:
/**
     * decrypt given base64 encrypted string
     * 
     * @param str
     * @param passPhrase
     * @return
     * @throws PlexusCipherException
     */
    String decrypt( String str, String passPhrase )
        throws PlexusCipherException;

    
decrypt given base64 encoded encrypted string. If string is decorated, decrypt base64 encoded string inside
decorations
Params:
str – 
passPhrase – 
Throws:
PlexusCipherException – 
Returns:
/**
     * decrypt given base64 encoded encrypted string. If string is decorated, decrypt base64 encoded string inside
     * decorations
     * 
     * @param str
     * @param passPhrase
     * @return
     * @throws PlexusCipherException
     */
    String decryptDecorated( String str, String passPhrase )
        throws PlexusCipherException;

    
check if given string is decorated
Params:
str – 
Returns:
/**
     * check if given string is decorated
     * 
     * @param str
     * @return
     */
    public boolean isEncryptedString( String str );

    
return string inside decorations
Params:
str – 
Throws:
PlexusCipherException – 
Returns:
/**
     * return string inside decorations
     * 
     * @param str
     * @return
     * @throws PlexusCipherException
     */
    public String unDecorate( String str )
        throws PlexusCipherException;

    
decorated given string with { and }
Params:
str – 
Returns:
/**
     * decorated given string with { and }
     * 
     * @param str
     * @return
     */
    public String decorate( String str );

}