PKCS11PublicKeyGenParams.java

/***********************************************************
 * $Id: PKCS11PublicKeyGenParams.java 33 2007-01-26 19:37:44Z wolfgang.glas $
 * 
 * PKCS11 provider of the OpenSC project http://www.opensc-project.org
 *
 * Copyright (C) 2002-2006 ev-i Informationstechnologie GmbH
 *
 * Created: Jan 25, 2007
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 * 
 ***********************************************************/

package org.opensc.pkcs11.spec;

import java.security.spec.DSAParameterSpec;
import java.security.spec.RSAKeyGenParameterSpec;

import javax.crypto.spec.DHGenParameterSpec;

import org.opensc.pkcs11.spi.PKCS11KeyPairGeneratorSpi;

/**
 * This interface is implemented by all subclasses of
 * {@link RSAKeyGenParameterSpec}, {@link DSAParameterSpec} or
 * {@link DHGenParameterSpec} which are used to initialize a key
 * pair generator.
 * 
 * @see PKCS11KeyPairGeneratorSpi
 * 
 * @author wglas
 */
public interface PKCS11PublicKeyGenParams
{
    /**
     * Get the encryption flag.
     * Default value: <code>false</code> 
     *
     * @return Whether the generated public key my be used for encryption.
     */
    public boolean isEncrypt();
    
    /**
     * @param encrypt Set whether the generated public key may be used for encryption.
     */
    public void setEncrypt(boolean encrypt);
    
    /**
     * Get the verification flag.
     * Default value: <code>true</code> 
     *
     * @return Whether the generated public key may be used for signature verification.
     */
    public boolean isVerify();
    
    /**
     * @param verify Set whether the generated public key may be used for signature verification.
     */
    public void setVerify(boolean verify);
    
    /**
     * Get the wrap flag.
     * Default value: <code>true</code> 
     *
     * @return Whether the generated public key may be used to wrap keys.
     */
    public boolean isWrap();
    
    /**
     * @param wrap Set whether the generated public key may be used to wrap keys.
     */
    public void setWrap(boolean wrap);
    
    /**
     * Get the trusted flag.
     * Default value: <code>true</code> 
     *
     * Trusted public keys may be used to wrap private key with the
     * wrapWithTrusted flag set to <code>true</code>.
     *
     * @return Whether the generated public key is trusted.
     * 
     * @see PKCS11PrivateKeyGenParams#isWrapWithTrusted()
     */
    public boolean isTrusted();
    
    /**
     * @param trusted Set whether the generated public is trusted.
     */
    public void setTrusted(boolean trusted);
}