Help web extraparams gl ES - ctt-gob-es/clienteafirma GitHub Wiki

Propiedades de configuración dos formatos de firma

Asinas CAdES

A seguir se listan as propiedades de configuración admitidas polas firmas CAdES. Algunhas destas opcións poden non ter efecto en casos de firma nas que non apliquen, como no caso das contrafirmas.

  • mode:
    • explicit: A firma resultante non incluirá os datos asinados. Se non se indica o parámetro mode configúrase automaticamente este comportamento.
    • implicit: A firma resultante non incluirá os datos asinados. A firma resultante incluirá internamente unha copia dos datos asinados. O uso deste valor podería xerar firmas de gran tamaño. Nas cofirmas, este parámetro ignorarase se os datos xa estaban contidos na firma orixinal ou se non se proporcionan os datos.
  • contentTypeOid:
    • Identificador do tipo de dato asinado.
  • contentDescription:
    • Descrición textual do tipo de datos asinado.
  • policyIdentifier:
    • Identificador da política de firma, necesario para xerar asinas CAdES-EPES.
  • policyIdentifierHash:
    • Cadea Base 64 coa pegada dixital da política de firma. É obrigatorio indicar este parámetro se de indicou tamén policyIdentifier, do mesmo xeito que é obrigatorio tamén dar valor ao parámetro policyIdentifierHashAlgorithm.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA1.
    • SHA-256: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-256.
    • SHA-384: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-384.
    • SHA-512: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-512.
  • policyQualifier:
    • URL accesible cara ao documento (normalmente PDF) que contén unha descrición textual da política de firma. Este parámetro é opcional mesmo se se desexa xerar asinas CAdES-EPES.
  • includeOnlySignningCertificate:
    • true: Indica que debe incluírse na firma unicamente o certificado do asinante.
    • false: Indica que debe incluírse na firma toda a cadea de certificación do certificado asinante. Valor por defecto.
  • policyQualifier:
    • URL accesible cara ao documento (normalmente PDF) que contén unha descrición textual da política de firma. Este parámetro é opcional mesmo se se desexa xerar asinas CAdES-EPES.
  • signatureProductionCity:
    • Agrega á firma un campo coa cidade na que se realiza a firma. A codificación debe ser UTF-8.
  • signatureProductionPostalCode:
    • Agrega á firma un campo co código postal onde se realiza a firma. A codificación debe ser UTF-8.
  • signatureProductionCountry:
    • Agrega á firma un campo co país na que se realiza a firma. A codificación debe ser UTF-8.
  • signerClaimedRoles:
    • Agrega á firma campos cos cargos atribuídos ao asinante. Deben separarse os cargos co carácter "|" (e este non pode estar no propio texto de ningún cargo).
  • commitmentTypeIndications:
    • Número de CommitmentTypeIndications que se van a declarar. Estes son os motivos que se declaran para a firma. Os valores concretos especifícanse con commitmentTypeIndicationnIdentifier e commitmentTypeIndicationnDescription, onde ‘n’ vai desde 0 ata o valor indicado nesta propiedade menos 1.
  • commitmentTypeIndicationnIdentifier:
    • 1: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de orixe".
    • 2: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de recepción".
    • 3: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de entrega".
    • 4: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de envío".
    • 5: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de aprobación".
    • 6: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de creación".
  • commitmentTypeIndicationnCommitmentTypeQualifiers:
    • Lista de indicadores textuais separados polo carácter '|' que se achegan como calificadores adicionais do CommitmentTypeIndication número n (atributo opcional). Normalmente son OID. Os elementos da lista non poden conter o carácter '|' (xa que este úsase como separador).
  • commitmentTypeIndicationnIdentifier:
    • true: Incluirase o atributo SigningCertificateV2 na firma.
    • false (Ou outro valor): Incluirase o atributo SigningCertificate na firma.
    • Sen especificar: Incluirase SigningCertificate se a firma utiliza un algoritmo de firma SHA1 e SigningCertificateV2 para o resto de algoritmos.

Firmas XAdES

A seguir se listan as propiedades de configuración admitidas polas firmas XAdES. Algunhas destas opcións poden non ter efecto en casos de firma nas que non apliquen, como no caso das contrafirmas.

  • insertEnvelopedSignatureOnNodeByXPath:
    • Expresión XPath (v1) que indica o nodo baixo o cal debe inserirse o nodo de firma no caso dunha firma Enveloped. Se a expresión devolve máis dun nodo, úsase só o primeiro. Se a expresión non devolve nodos ou está mal construída lanzarase unha excepción. Este parámetro só ten efecto en firmas Enveloped.
  • useManifest:
    • true: Usa un Manifest de XMLDSig coas referencias de firma no canto de asinar directamente estas referencias. Ignórase na operación de cofirma. Isto permite que sexa opcional a comprobación do destino e pegadas dixitais das referencias.
    • false: Xera as firmas normalmente, sen Manifest (comportamento por defecto).
  • urin:
    • URI que referencia aos datos que se desexan sinatura dentro dunha firma manifest. ‘n’ indica o número de referencia de entre as que se queren asinar, empezando en ‘1’.
  • precalculatedHashAlgorithm:
    • SHA1: Indica que as pegadas dixitais dos datos referenciados no manifest calculáronse mediante o algoritmo SHA1.
    • SHA-256: Indica que as pegadas dixitais dos datos referenciados no manifest calculáronse mediante o algoritmo SHA-256.
    • SHA-384: Indica que as pegadas dixitais dos datos referenciados no manifest calculáronse mediante o algoritmo SHA-284.
    • SHA-512: Indica que as pegadas dixitais dos datos referenciados no manifest calculáronse mediante o algoritmo SHA-512.
  • mdn:
    • Base 64 coa pegada dixital dos datos asociados á referencia ‘n’. O algoritmo de pegada será o indicado en precalculatedHashAlgorithm
  • mimetypen:
    • CONSINTA-Type dos datos asociados á referencia ‘n’ nunha firma manifest. Se non se indica este parámetro, utilizarase o tipo ‘application/octet-stream’.
  • contentTypeOidn:
    • OID ou URN do tipo de dato asinado para a referencia número ‘n’ nunha firma manifest. Este parámetro é complementario (que non excluínte) ao parámetro mimetypen.
  • encodingn:
    • Codificación dos datos asociados á referencia número ‘n’ nunha firma manifest. Un uso incorrecto deste parámetro pode provocar a xeración dunha firma inválida.
  • addKeyInfoKeyValue:
    • true: Inclúe o nodo KeyValue dentro de KeyInfo de XAdES (comportamento por defecto).
    • false: Non inclúe o nodo KeyValue dentro de KeyInfo de XAdES.
  • addKeyInfoKeyName:
    • true: Inclúe o nodo KeyName dentro de KeyInfo de XAdES.
    • false: Non inclúe o nodo KeyName dentro de KeyInfo de XAdES (comportamento por defecto).
  • avoidXpathExtraTransformsOnEnveloped:
    • true: Evita a inclusión da transformación XPATH2 que normalmente se engade para posibilitar as cofirmas e que elimina todas as firmas do documento para deixar unicamente o contido. ADVERTENCIA: A cofirma dun documento no que polo menos unha das firmas non inclúe a transformación XPATH, dará lugar a un documento de firma que potencialmente será validado incorrectamente polos validadores de firma. Por este motivo, só se permite o uso deste parámetro na operación de firma (non na de cofirma).
    • false: Inclúe a transformación XPATH2 posibilita as cofirmas eliminando todas as firmas do documento para deixar unicamente o contido (comportamento por defecto).
  • format:
    • XAdES Enveloping: Xera firmas en formato Enveloping. Este é o formato que se utiliza por defecto cando non se indica ningún.
    • XAdES Enveloped: Xera firmas en formato Enveloped.
    • XAdES Detached: Xera firmas en formato Internally Detached.
    • XAdES Externally Detached:Xera firmas en formato Externally Detached.
  • includeOnlySignningCertificate:
    • true: Indica que debe incluírse na firma unicamente o certificado do asinante.
    • false: Indica que debe incluírse na firma toda a cadea de certificación do certificado asinante. Valor por defecto.
  • policyIdentifier:
    • Identificador da política de firma (normalmente un URL cara á política en formato XML procesable), necesario para xerar asinas XAdES-EPES.
  • policyIdentifierHash:
    • Cadea Base 64 coa pegada dixital da política de firma. É obrigatorio indicar este parámetro se de indicou tamén policyIdentifier, do mesmo xeito que é obrigatorio tamén dar valor ao parámetro policyIdentifierHashAlgorithm.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA1.
    • SHA-256: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-256.
    • SHA-256: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-256.
    • SHA-512: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-512.
  • policyQualifier:
    • URL accesible cara ao documento (normalmente PDF) que contén unha descrición textual da política de firma. Este parámetro é opcional mesmo se se desexa xerar asinas XAdES-EPES.
  • policyDescription:
    • Descrición textual da política de firma. No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado. Este parámetro é opcional mesmo se se desexa xerar asinas XAdES-EPES.
  • signerClaimedRoles:
    • Agrega á firma campos cos cargos atribuídos ao asinante. Deben separarse os cargos co carácter "|" (e este non pode estar no propio texto de ningún cargo). No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado.
  • signatureProductionCity:
    • Agrega á firma un campo coa cidade na que se realiza a firma. No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado.
  • signatureProductionProvince:
    • Agrega á firma un campo coa provincia na que se realiza a firma. No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado.
  • signatureProductionPostalCode:
    • Agrega á firma un campo co código postal no que se realiza a firma. No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado.
  • signatureProductionCountry:
    • Agrega á firma un campo co país no que se realiza a firma. No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado.
  • referencesDigestMethod:
    • http://www.w3.org/2000/09/xmldsig#SHA1: Usa o algoritmo SHA1 para o cálculo das pegadas dixitais das referencias XML asinadas.
    • http://www.w3.org/2001/04/xmlenc#xa256: Usa o algoritmo SHA-256 para o cálculo das pegadas dixitais das referencias XML asinadas.
    • http://www.w3.org/2001/04/xmlenc#xa512: Usa o algoritmo SHA-512 para o cálculo das pegadas dixitais das referencias XML asinadas. Este é o comportamento por defecto.
  • mimeType:
    • CONSINTA-Type dos datos a asinar. Se non se indica este parámetro o sistema tenta auto-detectar o tipo, establecendo o máis aproximado (que pode non ser o estritamente correcto).
  • encoding:
    • URI coa codificación dos datos a asinar (ver a documentación do elemento Object de XMLDSig para máis información). Un uso incorrecto deste parámetro pode provocar a xeración dunha firma inválida. Se se proporcionan datos a asinar previamente codificados en Base64 pero se desexa sexan considerados como a súa forma descodificada, debe establecerse este valor a http://www.w3.org/2000/09/xmldsig#base64 e especificarse o tipo real no parámetro mimeType. Por exemplo, para asinar unha imaxe PNG facendo que a firma se refira á súa forma binaria directa, pode proporcionarse a imaxe directamente codificada en Base64 indicando o encoding como http://www.w3.org/2000/09/xmldsig#base64 e o mimeType como image/png. O valor debe ser sempre un URI.
  • outputXmlEncoding:
    • Codificación do XML de saída. Se non se indica este valor téntase auto-detectar a partir do XML de entrada (se os datos a asinar son un XML).
  • contentTypeOid:
    • OID ou URN de tipo OID co identificador do tipo de dato asinado. Este parámetro é complementario (que non excluínte) ao parámetro mimeType.
  • canonicalizationAlgorithm:
    • http://www.w3.org/tr/2001/rec-xml-c14n-20010315: Asínase o XML con canonizado XML 1.0 inclusivo (valor por defecto).
    • http://www.w3.org/tr/2001/rec-xml-c14n-20010315#WithComments: Asínase o XML con canonizado XML 1.0 inclusivo con comentarios.
    • http://www.w3.org/2001/10/xml-exc-c14n#: Asínase o XML con canonizado XML 1.0 exclusivo.
    • http://www.w3.org/2001/10/xml-exc-c14n#WithComments: Asínase o XML con canonizado XML 1.0 exclusivo con comentarios.
  • xadesNamespace:
    • http://uri.etsi.org/01903/v1.3.2#: URL de definición do espazo de nomes de XAdES correspondente á versión 1.3.2 de XAdES. Este é o valor por defecto.
    • http://uri.etsi.org/01903/v1.4.1#: URL de definición do espazo de nomes de XAdES correspondente á versión 1.4.1 de XAdES. Se se establece este parámetro é posible que se necesite establecer tamén o parámetro signedPropertiesTypeUrl para evitar incoherencias na versión de XAdES.
  • signedPropertiesTypeUrl:
    • http://uri.etsi.org/01903#SignedProperties: URL de definición do tipo das propiedades asinadas (Signed Properties) de XAdES. Este é o valor por defecto.
    • http://uri.etsi.org/01903/1.3.2#SignedProperties: URL de definición do tipo das propiedades asinadas (Signed Properties) de XAdES v1.3.2.
    • http://uri.etsi.org/01903/1.4.1#SignedProperties: URL de definición do tipo das propiedades asinadas (Signed Properties) de XAdES v1.4.1. Se se establece este parámetro é posible que se necesite establecer tamén o parámetro xadesNamespace para evitar incoherencias na versión de XAdES.
  • ignoreStyleSheets:
    • true: Se se asina un XML con follas de estilo, ignora estas deixándoas sen asinar.
    • false: Se se asina un XML con follas de estilo, firma tamén as follas de estilo (valor por defecto, consultar notas adicionais sobre sinatura de follas de estilo).
  • avoidBase64Transforms:
    • true: Non declara transformacións Base64 mesmo se son necesarias.
    • false: Declara as transformacións Base64 cando se codificaron internamente os datos a asinar en Base64 (valor por defecto).
  • headless:
    • true: Evita que se mostren diálogos gráficos adicionais ao usuario (como por exemplo, para a dereferenciación de follas de estilo enlazadas con rutas relativas).
    • false: Permite que se mostren diálogos gráficos adicionais ao usuario.
  • xmlTransforms:
    • Número de transformacións a aplicar ao contido asinado. Debe indicarse posteriormente igual número de parámetros xmlTransformnType, substituíndo n por un ordinal consecutivo, comezando en 0 (ver notas adicionais sobre indicación de transformacións adicionais).
  • xmlTransformnType:
    • http://www.w3.org/2000/09/xmldsig#base64: Indica que os datos que se proporcionan para asinar xa están codificados en Base64 e débese declarar esta transformación adicional para que se decodifiquen antes de asinalos. Esta transformación Base64 é adicional á transformación necesaria para pasar os datos a través dos métodos de sinatura de Autofirma.
    • http://www.w3.org/tr/1999/rec-xpath-19991116: O contido débese procesar mediante esta transformación XPATH antes de ser asinado. unicamente é aplicable cando se asina contido XML.
    • http://www.w3.org/2002/06/xmldsig-filter2: O contido débese procesar mediante esta transformación XPATH2 antes de ser asinado. unicamente é aplicable cando se asina contido XML.
  • xmlTransformnSubtype:
    • Subtipo da transformación n. Os valores aceptados e as súas funcionalidades dependen do valor indicado en xmlTransformnType.
  • xmlTransformnBody:
    • Corpo da transformación n. Os valores aceptados e as súas funcionalidades dependen dos valores indicados en xmlTransformnType e en xmlTransformnSubtype.
  • nodeToSign:
    • Identificador do nodo (establecido mediante o atributo "Ide") que se desexa asinar dentro dun XML.
  • commitmentTypeIndications:
    • Número de CommitmentTypeIndications que se van a declarar. Estes son os motivos que se declaran para a firma. Os valores concretos especifícanse con commitmentTypeIndicationnIdentifier e commitmentTypeIndicationnDescription, onde ‘n’ vai desde 0 ata o valor menos 1 indicado nesta propiedade.
  • commitmentTypeIndicationnIdentifier:
    • 1: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de orixe".
    • 2: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de recepción".
    • 3: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de entrega".
    • 4: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de envío".
    • 5: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de aprobación".
    • 6: Establece que o CommitmentTypeIndications número n (contando desde cero) é "Proba de creación".
  • commitmentTypeIndicationnDescription:
    • Establece a descrición do CommitmentTypeIndications número n. Este atributo é opcional.
  • commitmentTypeIndicationnDocumentationReferences:
    • Lista de URL separadas polo carácter '|' que se achegan como referencias documentais do CommitmentTypeIndication número n (atributo opcional). O URL da lista non poden conter o carácter '|' (xa que este úsase como separador).
  • commitmentTypeIndicationnCommitmentTypeQualifiers:
    • Lista de indicadores textuais separados polo carácter '|' que se achegan como calificadores adicionais do CommitmentTypeIndication número n (atributo opcional). Normalmente son OID. Os elementos da lista non poden conter o carácter '|' (xa que este úsase como separador).

Asinas Factura Electrónica

A seguir se listan as propiedades de configuración admitidas polas firmas de factura electrónica (Facturae).

  • signatureProductionCity:
    • Agrega á firma un campo coa cidade na que se realiza a firma. No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado.
  • signatureProductionProvince:
    • Agrega á firma un campo coa provincia na que se realiza a firma. No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado.
  • signatureProductionPostalCode:
    • Agrega á firma un campo co código postal no que se realiza a firma. No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado.
  • signatureProductionCountry:
    • Agrega á firma un campo co país no que se realiza a firma. No caso de que se asine un XML, a codificación do texto usado debe adecuarse ao XML asinado.
  • xadesNamespace:
    • URL de definición do espazo de nomes de XAdES (o uso deste parámetro pode condicionar a declaración de versión de XAdES). Se se establece este parámetro é posible que se necesite establecer tamén o parámetro signedPropertiesTypeUrl para evitar incoherencias na versión de XAdES.
  • signedPropertiesTypeUrl:
    • URL de definición do tipo das propiedades asinadas (Signed Properties) de XAdES. Se se establece este parámetro é posible que se necesite establecer tamén o parámetro xadesNamespace para evitar incoherencias na versión de XAdES. Se non se establece úsase o valor por defecto: http://uri.etsi.org/01903#SignedProperties.
  • signerClaimedRoles:
    • emisor: Declara que o asinante é o emisor da factura. Este é o valor por defecto.
    • receptor: Declara que o asinante é o receptor da factura.
    • terceiro: Declara que o asinante é un terceiro con respecto á factura.
    • supplier: Declara que o asinante é o emisor da factura.
    • customer: Declara que o asinante é o receptor da factura.
    • third party: Declara que o asinante é un terceiro con respecto á factura.
  • policyIdentifier:
    • http://www.facturae.es/politica_de_firma_formato_facturae/politica_de_firma_formato_facturae_v3_1.pdf: Identificador da política de firma 3.1. Este é o valor por defecto.
  • policyIdentifierHash:
    • Ohixl6upD6av8N7pEvDABhEL6hM=: Pegada dixital para configurar a política de firma 3.1. Este é o valor por defecto.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA1.
    • SHA-256: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-256.
    • SHA-256: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-256.
    • SHA-512: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-512.

Asinas PAdES

A seguir se listan as propiedades de configuración admitidas polas firmas PAdES.

  • includeOnlySignningCertificate:
    • true: Indica que debe incluírse na firma unicamente o certificado do asinante.
    • false: Indica que debe incluírse na firma toda a cadea de certificación do certificado asinante. Valor por defecto.
  • alwaysCreateRevision:
    • true: Sempre creará unha revisión ao asinar. Require que o documento cumpra a especificación PDF 1.7 (ISO 32000-1:2008)
    • false: Non creará revisión na primeira firma e si nas seguintes.
  • signatureField:
    • Nome do campo de firma preexistente no que inserir a firma.
  • signaturePages:
    • Indica as páxinas nas que debe aparecer visible a firma.
    • Admite os seguintes valores:
      • all: Para indicar que a firma visible apareza en todas as páxinas do documento, deberáselle de dar este valor.
      • append: Se a firma visible debe de aparecer nunha nova páxina en branco engadida ao final do documento, deberáselle de dar este valor.
      • Páxina ou listaxe de páxinas: Nesta opción permítese seleccionar a páxina ou rango de páxinas onde aparecerá a firma visible. Se se desexa indicar unha páxina ou varias páxinas onde estampar a firma visible, é posible indicando páxina a páxina cunha separación de comas (1,4,7: Estámpase nas páxinas 1, 4 e 7) ou indicando un rango de páxinas a través dun guión (1-8: Estámpase nas páxinas desde a 1 ata a 8). Tal e como se explica no parágrafo anterior, permítese indicar as páxinas cun valor negativo, onde se comezará desde o final (1,-1: Estamparase na primeira e última páxina).
  • signaturePositionOnPageLowerLeftX:
    • Número enteiro coa coordenada horizontal desde a esquina inferior esquerda da páxina á esquina inferior esquerda do campo de firma visible.
  • signaturePositionOnPageLowerLeftY:
    • Número enteiro coa coordenada vertical desde a esquina inferior esquerda da páxina á esquina inferior esquerda do campo de firma visible.
  • signaturePositionOnPageUpperRightX:
    • Número enteiro coa coordenada horizontal desde a esquina inferior esquerda da páxina á esquina superior dereita do campo de firma visible.
  • signaturePositionOnPageUpperRightY:
    • Número enteiro coa coordenada vertical desde a esquina inferior esquerda da páxina á esquina superior dereita do campo de firma visible.
  • signatureRubricImage:
    • Ruta do ficheiro coa imaxe JPEG da imaxe a mostrar aplicar na firma visible PDF. Tamén pode indicarse directamente a Base 64 da imaxe.
  • layer2Text:
    • Texto que mostrar no campo de firma visible.
  • layer2FontFamily:
    • 0: O texto da firma visible mostrarase con fonte Courier. Este é o valor por defecto.
    • 1: O texto da firma visible mostrarase con fonte Helvética.
    • 2: O texto da firma visible mostrarase con fonte Times Roman.
    • 3: O texto da firma visible mostrarase con fonte Symbol.
    • 4: O texto da firma visible mostrarase con fonte ZapfDingBats.
  • layer2FontSize:
    • Tamaño de fonte do texto da firma visible.
  • layer2FontStyle:
    • 0: Texto da firma visible sen estilo. Valor por defecto.
    • 1: Texto da firma visible en negrita.
    • 2: Texto da firma visible en cursiva.
    • 4: Texto da firma visible subliñado.
    • 8: Texto da firma visible tachado.
  • layer2FontColor:
    • black: Texto da firma visible sen estilo. Valor por defecto.
    • white: O texto da firma visible será de cor branca.
    • gray: O texto da firma visible será de cor gris.
    • lightGray: O texto da firma visible será de cor gris claro.
    • darkGray: O texto da firma visible será de cor gris escuro.
    • rede: O texto da firma visible será de cor vermella.
    • pink: O texto da firma visible será de cor rosa.
  • obfuscateCertText:
    • true: Se ofuscan os identificadores de usuario extraídos do CN ou DN do certificado e mostrados na firma visible PDF. Non se ofuscan os datos dos certificados de pseudónimo. Este é o valor por defecto.
    • false: Non se ofusca a información dos certificados.
  • obfuscationMask:
    • Criterios de ofuscación dos identificadores de usuario nas firmas visibles PDF. Debe mostrar o seguinte patrón:
      • carácter;longitudDigitos;posicións;desprazamento
    • Neste patrón:
      • carácter: É o carácter que usar para ofuscar caracteres.
      • longitudDigitos: Número mínimo de díxitos que debe ter unha cadea de texto para que se considere que debe ofuscarse.
      • posicións: Listaxe de posicións que indica que caracteres deben mostrarse. A listaxe exprésase cunha sucesión de true/false separados por comas (','), onde true indica que o carácter debe mostrarse e false que non.
      • desprazamento: Indica se se admite o desprazamento de posicións da máscara para mostrar todos os caracteres indicados (true) ou se esta debe respectarse (false).
  • visibleSignature:
    • default: Realizarase firma visible PDF se se proporcionaron os parámetros coa área e a páxina de firma. Este é o valor por defecto.
    • want: O usuario debe seleccionar a área de firma visible. En caso de cancelar o proceso:
      • Se o pedimento tamén inclúe os parámetros de área de firma visible (posición e páxina), usaranse estes parámetros e continuarase co proceso de firma.
      • Se o pedimento non inclúe os parámetros de área de firma visible, cancelarase o proceso de firma.
    • optional: O usuario poderá elixir se desexa incluír ou non a área de firma visible. En caso de cancelar o proceso:
      • Se o pedimento tamén inclúe os parámetros de área de firma visible (posición e páxina), usaranse estes parámetros e continuarase co proceso de firma.
      • Se o pedimento non inclúe os parámetros de área de firma visible, realizarase unha firma non visible.
  • visibleAppearance:
    • default: Aplicarase o aspecto por defecto para a firma visible PDF ou, se se proporcionaron os parámetros de aspecto, o aspecto configurado. Este é o valor por defecto.
    • custom: O usuario pode elixir o aspecto da firma visible. En caso de cancelar o proceso, usarase o aspecto por defecto.
  • signatureRotation:
    • 0: Non rota o texto do campo de firma. Este é o valor por defecto.
    • 90: Rota 90 graos en sentido horario o texto do campo de firma. Ignorarase calquera configuración de imaxe de firma.
    • 180: Rota 180 graos en sentido horario o texto do campo de firma. Ignorarase calquera configuración de imaxe de firma.
    • 270: Rota 270 graos en sentido horario o texto do campo de firma. Ignorarase calquera configuración de imaxe de firma.
  • includeQuestionMark:
    • true: Permitirse ao lector de PDF mostrar xunto á firma visible unha marca que índique o resultado obtido ao validala. A aparencia desta marca depende completamente do lector de PDF utilizado e é este o que decide se se mostra. Por exemplo, a marca podería non mostrarse cando se definise unha imaxe de fondo na firma.
    • false: Non permite mostrar a marca co resultado da validación. Este é o valor por defecto.
  • image:
    • Ruta do ficheiro de imaxe JPEG que inserir no documento antes de asinalo. Tamén pode indicarse directamente a Base 64 da imaxe. Este parámetro só se pode utilizar na primeira sinatura do documento.
  • imagePage:
    • Número da páxina do documento PDF na que inserir a imaxe.
    • 0: Inserir en todas as páxinas
    • -1: Inserir imaxe na última páxina.
  • imagePositionOnPageLowerLeftX:
    • Número enteiro coa coordenada horizontal desde a esquina inferior esquerda da páxina á esquina inferior esquerda da imaxe.
  • imagePositionOnPageLowerLeftY:
    • Número enteiro coa coordenada vertical desde a esquina inferior esquerda da páxina á esquina inferior esquerda da imaxe.
  • imagePositionOnPageUpperRightX:
    • Número enteiro coa coordenada horizontal desde a esquina inferior esquerda da páxina á esquina superior dereita da imaxe.
  • imagePositionOnPageUpperRightY:
    • Número enteiro coa coordenada vertical desde a esquina inferior esquerda da páxina á esquina superior dereita da imaxe.
  • attach:
    • Ruta do ficheiro co contido a engadir como adxunto ao PDF. Tamén pode indicarse directamente a Base 64 dos datos. Require establecer attachFileName.
  • attachFileName:
    • Nome do que asignar ao ficheiro adxunto.
  • attachDescription:
    • Descrición do documento adxunto.
  • certificationLevel:
    • 0: Firma sen certificar. Esta sería unha sinatura de aprobación. É o valor por defecto.
    • 1: Firma certificada de autor. Tras este tipo de firma certificada, non se permite ningún cambio posterior no documento (non se poden agregar firmas, nin encher formularios).
    • 2: Firma certificada de autor para formularios. Tras este tipo de firma certificada, só se permite o recheo dos campos de formulario (non se poden agregar firmas).
    • 3: Firma certificada común. Tras este tipo de firma certificada, só se permite o recheo dos campos de formulario e a creación de firmas de aprobación.
  • compressPdf:
    • true: Comprime o PDF asinado para que ocupe menos tamaño. Só se aplica se se trata dun PDF v4 ou superior. Este é o valor por defecto.
    • false: Nunca se comprime o PDF asinado.
  • pdfVersion:
    • 2: Declárase que a versión do PDF de saída é 1.2.
    • 3: Declárase que a versión do PDF de saída é 1.3.
    • 4: Declárase que a versión do PDF de saída é 1.4.
    • 5: Declárase que a versión do PDF de saída é 1.5.
    • 6: Declárase que a versión do PDF de saída é 1.6.
    • 7: Declárase que a versión do PDF de saída é 1.7.
  • signatureSubFilter:
    • Subfiltro declarado. Por defecto utilízase o das firmas básicas (adbe.pkcs7.detached). Pode usarse a cadea "ETSI.CAdES.detached" para crear asinas BES.
  • signReason:
    • Razón pola que se realiza a firma.
  • signatureProductionCity:
    • Cidade na que se realiza a firma.
  • signerContact:
    • Información de contacto do asinante.
  • signerClaimedRoles:
    • Listaxe de roles declarados polo asinante (separados por "|").
  • policyIdentifier:
    • Identificador da política de firma (normalmente un URL cara á política en formato XML procesable), necesario para xerar asinas XAdES-EPES.
  • policyIdentifierHash:
    • Texto Base 64 coa pegada dixital da política de firma. É obrigatorio indicar este parámetro se o valor indicado en policyIdentifier non é universalmente accesible. Se se dá valor a este parámetro é obrigatorio tamén dar valor ao parámetro policyIdentifierHashAlgorithm.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA1.
    • SHA-256: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-256.
    • SHA-256: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-256.
    • SHA-512: Indica que a pegada dixital indicada no parámetro policyIdentifierHash calculouse mediante o algoritmo SHA-512.
  • policyQualifier:
    • URL cara ao documento que contén unha descrición textual da política de firma.
  • ownerPassword:
    • Contrasinal de apertura do PDF. Non se soporta a sinatura de documentos PDF cifrados con certificados ou algoritmo AES-256.
  • headless:
    • true: Non interrompe o proceso de firma solicitando interacción do usuario.
    • false: Mostra diálogos ao usuario se require da súa autorización ou algún dato adicional para asinar. Este é o valor por defecto.
  • allowSigningCertifiedPdfs:
    • true: Permite a sinatura de documentos PDF certificados. O resultado podería invalidar firmas anteriores do PDF.
    • false: Produce un erro ao asinar documentos PDF certificados.
    • Se omite: En caso de detectar que o documento PDF de entrada está certificado, advertirase ao usuario de que a firma podería invalidar firmas anteriores e permitiráselle elixir se asinar ou cancelar a operación.
  • allowSigningCertifiedPdfs:
    • true: Permite a sinatura de documentos PDF certificados. O resultado podería invalidar firmas anteriores do PDF.
    • false: Produce un erro ao asinar documentos PDF certificados.
    • Se omite: En caso de detectar que o documento PDF de entrada está certificado, advertirase ao usuario de que a firma podería invalidar firmas anteriores e permitiráselle elixir se asinar ou cancelar a operación.
  • allowCosigningUnregisteredSignatures:
    • true: Permite asinar documentos PDF con firmas previas non rexistradas.
    • false: Non permite asinar documentos PDF con firmas previas non rexistradas.
  • signingCertificateV2:
    • true: Utilízase o atributo signingCertificateV2 nas firmas.
    • false: Utilízase o atributo signingCertificateV1 nas firmas.
    • Se omite: Utilízase o atributo signingCertificateV1 nas firmas SHA1withRSA e signingCertificateV2 no resto.
  • signReservedSize:
    • Tamaño máximo en bytes da firma que se incorporará ao PDF. Por defecto, 27000.
  • signingCertificateV2:
    • true: Utilízase o atributo signingCertificateV2 nas firmas.
    • false: Utilízase o atributo signingCertificateV1 nas firmas.
    • Se omite: Utilízase o atributo signingCertificateV1 nas firmas SHA1withRSA e signingCertificateV2 no resto.
  • allowShadowAttack:
    • true: Non se realizará a comprobación de PDF Xadow Attack durante a validación das firmas previas.
    • false: Realizarase a comprobación de PDF Xadow Attack durante a validación das firmas previas e, en caso de detectarse, darase a firma por inválida.
    • Se omite: Realizarase a comprobación de PDF Xadow Attack durante a validación das firmas previas e, en caso de detectarse, consultarase ao usuario se se debe continuar coa operación.
  • allowModifiedForm:
    • true: Non se realizará a comprobación de cambios nos formularios do documento nin PDF Xadow Attack durante a validación das firmas previas.
    • false: Realizarase a comprobación de cambios nos formularios do documento durante a validación das firmas previas e, en caso de detectarse, darase a firma por inválida.
    • Se omite: Realizarase a comprobación de cambios nos formularios do documento durante a validación das firmas previas e, en caso de detectarse, consultarase ao usuario se se debe continuar coa operación.
⚠️ **GitHub.com Fallback** ⚠️