Package br.ufsc.labsec.signature

Class SignerRequest<Info extends ExtraInformation>

java.lang.Object

br.ufsc.labsec.signature.SignerRequest<Info>

public class SignerRequest<Info extends ExtraInformation>
extends Object

Representa a montagem de uma requisição de assinatura(s) em documento(s) Os valores obrigatórios passados são:

• Nome do arquivo recebido pela requisição
• InputStream do documento a ser assinado
• Informações do KeyStore para realização da assinatura
• Tipo de assinatura a ser realizada
• Formato da assinatura a ser realizada
• Suite de assinatura a ser utilizada

O retorno de sign() é uma lista de SignatureDataWrapper dos documentos passados por parâmetro de uma requisição

Field Summary

Fields

Modifier and Type	Field	Description
protected Application	app	Aplicação responsável pelo o funcionamento do do Signer e do Verifier (ou algum gerado para teste)
protected List<byte[]>	attributeCertificates	Valor opcional da lista de certificados de atributo para serem utilizados na assinatura
protected static AbstractComponentConfiguration	configuration	Configuração definida automaticamente ou definida pelo usuário para o componente de assinatura
protected Info	extraInformation	Valor opcional para informações extras a serem passadas para a assinatura (rua, cidade, codigo postal, pais e etc.)
protected String	filename	Indica o nome do arquivo recebido pela requisição
protected List<jakarta.servlet.http.Part>	files	Valor obrigatorio para chamada do método sign().
protected FileToBeSigned<? extends ExtraInformation>	fileToBeSigned	Arquivo a ser assinado gerado a partir da dos bytes lidos para cada arquivo selecionado
protected FileFormat	format	Formato da assinatura a ser realizada (attached, detached, internally_detached, enveloped)
protected KeyStoreInformation	ksInfo	Informações da KeyStore para realização da assinatura
protected SignerParameters	parameters	Parâmetros passados para a requisição de assinatura
protected SignerType	policy	Tipo de assinatura a ser realizada (CMS, PDF, XML, JSON, CAdES, PAdES, XAdES ou JAdES)
protected List<String>	signedAttributes	Valores opcionais para caso de assinatura com escolha livre de atributos são passados separadamente os atributos assinados e não assinados para realização da assinatura
protected String	signerType	Valor do tipo de assinatura definido na requisição dentre as simples e avançadas.
protected String	suite	Suite de assinatura a ser utilizada a partir das possíveis na classe SingletonSuiteMapper
protected InputStream	toBeSigned	ArrayInputStream do documento a ser assinado
protected List<String>	unsignedAttributes

Constructor Summary

Constructors

Constructor	Description
SignerRequest()

Method Summary

Modifier and Type	Method	Description
SignerRequest<Info>	build()	Retorna um objeto SignatureRequest com os valores passados utilizado para realizar requisições de assinatura
protected static String	fileExtension(SignerType sigPol)	Retorna a extensão de arquivo relacionada com o tipo de assinatura
List<byte[]>	getAttributeCertificates()
Info	getExtraInformation()
String	getFilename()
FileFormat	getFormat()
KeyStoreInformation	getKeyStoreInformation()
SignerType	getPolicy()
List<String>	getSignedAttributes()
String	getSuite()
InputStream	getToBeSigned()
List<String>	getUnsignedAttributes()
SignerRequest<Info>	setExtraInformation(Info extraInformation)
SignerRequest<Info>	setFilename(String filename)
SignerRequest<Info>	setFiles(List<jakarta.servlet.http.Part> files)
SignerRequest<Info>	setFormat(FileFormat format)
SignerRequest<Info>	setKeyStoreInformation(KeyStoreInformation ksInfo)
SignerRequest<Info>	setParameters(SignerParameters parameters)
SignerRequest<Info>	setPolicy(SignerType policy)
SignerRequest<Info>	setSignedAttributes(List<String> signedAttributes)
SignerRequest<Info>	setSignerType(String signerType)
SignerRequest<Info>	setSuite(String suite)
SignerRequest<Info>	setToBeSigned(InputStream toBeSigned)
SignerRequest<Info>	setUnsignedAttributes(List<String> unsignedAttributes)
List<SignatureDataWrapper>	sign()	Função estática auxiliar para todos os endpoints assinarem utilizando a mesma estrutura
SignerRequest<Info>	withApplication(Application app)
SignerRequest<Info>	withConfiguration(AbstractComponentConfiguration configuration)
SignerRequest<Info>	withParameters(SignerParameters parameters, KeyStoreInformation ksInfo, List<jakarta.servlet.http.Part> files)	Seta todos os parâmetros da requisição para a futura realização da assinatura.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

configuration

protected static AbstractComponentConfiguration configuration

Configuração definida automaticamente ou definida pelo usuário para o componente de assinatura

app

protected Application app

Aplicação responsável pelo o funcionamento do do Signer e do Verifier (ou algum gerado para teste)

parameters

protected SignerParameters parameters

Parâmetros passados para a requisição de assinatura

files

protected List<jakarta.servlet.http.Part> files

Valor obrigatorio para chamada do método sign().

filename

protected String filename

Indica o nome do arquivo recebido pela requisição

toBeSigned

protected InputStream toBeSigned

ArrayInputStream do documento a ser assinado

ksInfo

protected KeyStoreInformation ksInfo

Informações da KeyStore para realização da assinatura

policy

protected SignerType policy

Tipo de assinatura a ser realizada (CMS, PDF, XML, JSON, CAdES, PAdES, XAdES ou JAdES)

format

protected FileFormat format

Formato da assinatura a ser realizada (attached, detached, internally_detached, enveloped)

suite

protected String suite

Suite de assinatura a ser utilizada a partir das possíveis na classe SingletonSuiteMapper

signerType

protected String signerType

Valor do tipo de assinatura definido na requisição dentre as simples e avançadas.

signedAttributes

protected List<String> signedAttributes

Valores opcionais para caso de assinatura com escolha livre de atributos são passados separadamente os atributos assinados e não assinados para realização da assinatura

unsignedAttributes

protected List<String> unsignedAttributes

attributeCertificates

protected final List<byte[]> attributeCertificates

Valor opcional da lista de certificados de atributo para serem utilizados na assinatura

fileToBeSigned

protected FileToBeSigned<? extends ExtraInformation> fileToBeSigned

Arquivo a ser assinado gerado a partir da dos bytes lidos para cada arquivo selecionado

extraInformation

protected Info extends ExtraInformation extraInformation

Valor opcional para informações extras a serem passadas para a assinatura (rua, cidade, codigo postal, pais e etc.)

Constructor Details

SignerRequest

public SignerRequest()

Method Details

fileExtension

protected static String fileExtension(SignerType sigPol)
                               throws SignatureException

Retorna a extensão de arquivo relacionada com o tipo de assinatura

Parameters:

sigPol - A política da assinatura

Returns:

A extensão de arquivo

Throws:

SignatureException

setExtraInformation

public SignerRequest<Info> setExtraInformation(Info extraInformation)

setFilename

public SignerRequest<Info> setFilename(String filename)

setFiles

public SignerRequest<Info> setFiles(List<jakarta.servlet.http.Part> files)

setSignerType

public SignerRequest<Info> setSignerType(String signerType)

setParameters

public SignerRequest<Info> setParameters(SignerParameters parameters)

withParameters

public SignerRequest<Info> withParameters(SignerParameters parameters,
KeyStoreInformation ksInfo,
List<jakarta.servlet.http.Part> files)

Seta todos os parâmetros da requisição para a futura realização da assinatura. No momento da assinatura, a classe possui todas as informações necessárias

setToBeSigned

public SignerRequest<Info> setToBeSigned(InputStream toBeSigned)

withApplication

public SignerRequest<Info> withApplication(Application app)

setKeyStoreInformation

public SignerRequest<Info> setKeyStoreInformation(KeyStoreInformation ksInfo)

setPolicy

public SignerRequest<Info> setPolicy(SignerType policy)

setFormat

public SignerRequest<Info> setFormat(FileFormat format)

setSuite

public SignerRequest<Info> setSuite(String suite)

setSignedAttributes

public SignerRequest<Info> setSignedAttributes(List<String> signedAttributes)

setUnsignedAttributes

public SignerRequest<Info> setUnsignedAttributes(List<String> unsignedAttributes)

withConfiguration

public SignerRequest<Info> withConfiguration(AbstractComponentConfiguration configuration)

build

public SignerRequest<Info> build()
                          throws IllegalArgumentException,
IOException

Retorna um objeto SignatureRequest com os valores passados utilizado para realizar requisições de assinatura

Throws:

IllegalArgumentException

IOException

sign

public List<SignatureDataWrapper> sign()
                                throws SignerException,
IOException,
CertificationPathException,
XPathExpressionException,
ParserConfigurationException,
SAXException,
SignatureException,
VerificationException

Função estática auxiliar para todos os endpoints assinarem utilizando a mesma estrutura

Throws:

CertificationPathException - Se houver alguma exceção no caminho de certificação

SignerException - Se houver algum erro ao assinar o documento

IOException - Se não conseguir gerar o arquivo e/ou pegar writer de request

XPathExpressionException - Se houver algum erro ao executar a expressão XPath

ParserConfigurationException - Se houver algum erro ao configurar o parser

SAXException - Se houver algum erro ao fazer o parse do XML

SignatureException - Se houver algum erro ao assinar o documento

VerificationException

getFilename

public String getFilename()

getToBeSigned

public InputStream getToBeSigned()

getKeyStoreInformation

public KeyStoreInformation getKeyStoreInformation()

getPolicy

public SignerType getPolicy()

getFormat

public FileFormat getFormat()

getSuite

public String getSuite()

getSignedAttributes

public List<String> getSignedAttributes()

getUnsignedAttributes

public List<String> getUnsignedAttributes()

getAttributeCertificates

public List<byte[]> getAttributeCertificates()

getExtraInformation

public Info getExtraInformation()