br.gov.frameworkdemoiselle.certificate.signer.Signer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of demoiselle-certificate-signer Show documentation
Demoiselle Signer Component
There is a newer version: 1.2.8
Show newest version
/*
 * Demoiselle Framework
 * Copyright (C) 2010 SERPRO
 * ----------------------------------------------------------------------------
 * This file is part of Demoiselle Framework.
 *
 * Demoiselle Framework is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License version 3
 * along with this program; if not,  see 
 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA  02110-1301, USA.
 * ----------------------------------------------------------------------------
 * Este arquivo é parte do Framework Demoiselle.
 *
 * O Framework Demoiselle é um software livre; você pode redistribuí-lo e/ou
 * modificá-lo dentro dos termos da GNU LGPL versão 3 como publicada pela Fundação
 * do Software Livre (FSF).
 *
 * Este programa é distribuído na esperança que possa ser útil, mas SEM NENHUMA
 * GARANTIA; sem uma garantia implícita de ADEQUAÇÃO a qualquer MERCADO ou
 * APLICAÇÃO EM PARTICULAR. Veja a Licença Pública Geral GNU/LGPL em português
 * para maiores detalhes.
 *
 * Você deve ter recebido uma cópia da GNU LGPL versão 3, sob o título
 * "LICENCA.txt", junto com esse programa. Se não, acesse 
 * ou escreva para a Fundação do Software Livre (FSF) Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02111-1301, USA.
 */
package br.gov.frameworkdemoiselle.certificate.signer;

import java.security.PrivateKey;
import java.security.Provider;
import java.security.PublicKey;

/**
 * Especificação básica para implementação de assinaturas digitais.
 */
public interface Signer {

    /**
     * Indica qual o Provider será utilizado.
     *
     * @param provider
     */
    abstract public void setProvider(Provider provider);

    /**
     * Chave privada necessária para a criptografia assimétrica
     *
     * @param privateKey
     */
    abstract public void setPrivateKey(PrivateKey privateKey);

    /**
     * Chave publica necessária para a criptografia assimétrica
     *
     * @param publicKey
     */
    abstract public void setPublicKey(PublicKey publicKey);

    /**
     * Algoritmo de Assinatura. Ex: SHA1withRSA
     *
     * @param algorithm
     */
    abstract public void setAlgorithm(String algorithm);

    /**
     * Algoritmo pré-defido no enum. Compatíveis com ICP-Brasil
     *
     * @param algorithm
     */
    abstract public void setAlgorithm(SignerAlgorithmEnum algorithm);

    /**
     * Método de assinatura digital.
     *
     * @param content
     * @return
     */
    abstract public byte[] signer(byte[] content);

    /**
     * Método de validação da assinatura.
     *
     * @param content
     * @param signed
     * @return
     */
    abstract public boolean check(byte[] content, byte[] signed);

    /**
     * Retorna o provider.
     *
     * @return
     */
    abstract public Provider getProvider();

    /**
     * Retorna a chave privada.
     *
     * @return
     */
    abstract public PrivateKey getPrivateKey();

    /**
     * Retorna o algoritmo.
     *
     * @return
     */
    abstract public String getAlgorithm();

    /**
     * Retorna a chave publica.
     *
     * @return
     */
    abstract public PublicKey getPublicKey();

}