Skip to content

Parámetros de configuración de los formatos de firma

Jump to bottom
Carlos Gamuci edited this page Sep 16, 2022 · 1 revision

Opciones de configuración de firmas CAdES

A continuación se listan las propiedades de configuración admitidas por las firmas CAdES. Algunas de estas opciones pueden no tener efecto en casos de firma en las que no apliquen, como en el caso de las contrafirmas.

  • mode:
    • explicit: La firma resultante no incluirá los datos firmados. Si no se indica el parámetro mode se configura automáticamente este comportamiento.
    • implicit: La firma resultante no incluirá los datos firmados. La firma resultante incluirá internamente una copia de los datos firmados. El uso de este valor podría generar firmas de gran tamaño. En las cofirmas, este parámetro se ignorará si los datos ya estaban contenidos en la firma original o si no se proporcionan los datos.
  • contentTypeOid:
    • Identificador del tipo de dato firmado.
  • contentDescription:
    • Descripción textual del tipo de datos firmado.
  • policyIdentifier:
    • Identificador de la política de firma, necesario para generar firmas CAdES-EPES.
  • policyIdentifierHash:
    • Cadena Base 64 con la huella digital de la política de firma. Es obligatorio indicar este parámetro si de indicó también policyIdentifier, al igual que es obligatorio también dar valor al parámetro policyIdentifierHashAlgorithm.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA1.
    • SHA-256: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-256.
    • SHA-384: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-384.
    • SHA-512: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-512.
  • policyQualifier:
    • URL accesible hacia el documento (normalmente PDF) que contiene una descripción textual de la política de firma. Este parámetro es opcional incluso si se desea generar firmas CAdES-EPES.
  • includeOnlySignningCertificate:
    • true: Indica que debe incluirse en la firma únicamente el certificado del firmante.
    • false: Indica que debe incluirse en la firma toda la cadena de certificación del certificado firmante. Valor por defecto.
  • policyQualifier:
    • URL accesible hacia el documento (normalmente PDF) que contiene una descripción textual de la política de firma. Este parámetro es opcional incluso si se desea generar firmas CAdES-EPES.
  • signatureProductionCity:
    • Agrega a la firma un campo con la ciudad en la que se realiza la firma. La codificación debe ser UTF-8.
  • signatureProductionPostalCode:
    • Agrega a la firma un campo con el código postal en donde se realiza la firma. La codificación debe ser UTF-8.
  • signatureProductionCountry:
    • Agrega a la firma un campo con el país en la que se realiza la firma. La codificación debe ser UTF-8.
  • signerClaimedRoles:
    • Agrega a la firma campos con los cargos atribuidos al firmante. Deben separarse los cargos con el carácter "|" (y este no puede estar en el propio texto de ningún cargo).
  • commitmentTypeIndications:
    • Número de CommitmentTypeIndications que se van a declarar. Estos son los motivos que se declaran para la firma. Los valores concretos se especifican con commitmentTypeIndicationnIdentifier y commitmentTypeIndicationnDescription, donde ‘n’ va desde 0 hasta el valor indicado en esta propiedad menos 1.
  • commitmentTypeIndicationnIdentifier:
    • 1: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de origen".
    • 2: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de recepción".
    • 3: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de entrega".
    • 4: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de envío".
    • 5: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de aprobación".
    • 6: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de creación".
  • commitmentTypeIndicationnCommitmentTypeQualifiers:
    • Lista de indicadores textuales separados por el carácter '|' que se aportan como calificadores adicionales del CommitmentTypeIndication número n (atributo opcional). Normalmente son OID. Los elementos de la lista no pueden contener el carácter '|' (ya que este se usa como separador).
  • commitmentTypeIndicationnIdentifier:
    • true: Se incluirá el atributo SigningCertificateV2 en la firma.
    • false (U otro valor): Se incluirá el atributo SigningCertificate en la firma.
    • Sin especificar: Se incluirá SigningCertificate si la firma utiliza un algoritmo de firma SHA1 y SigningCertificateV2 para el resto de algoritmos.

Opciones de configuración de firmas XAdES

A continuación se listan las propiedades de configuración admitidas por las firmas XAdES. Algunas de estas opciones pueden no tener efecto en casos de firma en las que no apliquen, como en el caso de las contrafirmas.

  • insertEnvelopedSignatureOnNodeByXPath:
    • Expresión XPath (v1) que indica el nodo bajo el cual debe insertarse el nodo de firma en el caso de una firma Enveloped. Si la expresión devuelve más de un nodo, se usa solo el primero. Si la expresión no devuelve nodos o está mal construida se lanzará una excepción. Este parámetro solo tiene efecto en firmas Enveloped.
  • useManifest:
    • true: Usa un Manifest de XMLDSig con las referencias de firma en vez de firmar directamente estas referencias. Se ignora en la operación de cofirma. Esto permite que sea opcional la comprobación del destino y huellas digitales de las referencias.
    • false: Genera las firmas normalmente, sin Manifest (comportamiento por defecto).
  • urin:
    • URI que referencia a los datos que se desean firma dentro de una firma manifest. ‘n’ indica el número de referencia de entre las que se quieren firmar, empezando en ‘1’.
  • precalculatedHashAlgorithm:
    • SHA1: Indica que las huellas digitales de los datos referenciados en el manifest se calcularon mediante el algoritmo SHA1.
    • SHA-256: Indica que las huellas digitales de los datos referenciados en el manifest se calcularon mediante el algoritmo SHA-256.
    • SHA-384: Indica que las huellas digitales de los datos referenciados en el manifest se calcularon mediante el algoritmo SHA-284.
    • SHA-512: Indica que las huellas digitales de los datos referenciados en el manifest se calcularon mediante el algoritmo SHA-512.
  • mdn:
    • Base 64 con la huella digital de los datos asociados a la referencia ‘n’. El algoritmo de huella será el indicado en precalculatedHashAlgorithm
  • mimetypen:
    • MIME-Type de los datos asociados a la referencia ‘n’ en una firma manifest. Si no se indica este parámetro, se utilizará el tipo ‘application/octet-stream’.
  • contentTypeOidn:
    • OID o URN del tipo de dato firmado para la referencia número ‘n’ en una firma manifest. Este parámetro es complementario (que no excluyente) al parámetro mimetypen.
  • encodingn:
    • Codificación de los datos asociados a la referencia número ‘n’ en una firma manifest. Un uso incorrecto de este parámetro puede provocar la generación de una firma inválida.
  • addKeyInfoKeyValue:
    • true: Incluye el nodo KeyValue dentro de KeyInfo de XAdES (comportamiento por defecto).
    • false: No incluye el nodo KeyValue dentro de KeyInfo de XAdES.
  • addKeyInfoKeyName:
    • true: Incluye el nodo KeyName dentro de KeyInfo de XAdES.
    • false: No incluye el nodo KeyName dentro de KeyInfo de XAdES (comportamiento por defecto).
  • avoidXpathExtraTransformsOnEnveloped:
    • true: Evita la inclusión de la transformación XPATH2 que normalmente se añade para posibilitar las cofirmas y que elimina todas las firmas del documento para dejar únicamente el contenido. ADVERTENCIA: La cofirma de un documento en el que al menos una de las firmas no incluye la transformación XPATH, dará lugar a un documento de firma que potencialmente será validado incorrectamente por los validadores de firma. Por este motivo, sólo se permite el uso de este parámetro en la operación de firma (no en la de cofirma).
    • false: Incluye la transformación XPATH2 posibilita las cofirmas eliminando todas las firmas del documento para dejar únicamente el contenido (comportamiento por defecto).
  • format:
    • XAdES Enveloping: Genera firmas en formato Enveloping. Este es el formato que se utiliza por defecto cuando no se indica ninguno.
    • XAdES Enveloped: Genera firmas en formato Enveloped.
    • XAdES Detached: Genera firmas en formato Internally Detached.
    • XAdES Externally Detached:Genera firmas en formato Externally Detached.
  • includeOnlySignningCertificate:
    • true: Indica que debe incluirse en la firma únicamente el certificado del firmante.
    • false: Indica que debe incluirse en la firma toda la cadena de certificación del certificado firmante. Valor por defecto.
  • policyIdentifier:
    • Identificador de la política de firma (normalmente una URL hacia la política en formato XML procesable), necesario para generar firmas XAdES-EPES.
  • policyIdentifierHash:
    • Cadena Base 64 con la huella digital de la política de firma. Es obligatorio indicar este parámetro si de indicó también policyIdentifier, al igual que es obligatorio también dar valor al parámetro policyIdentifierHashAlgorithm.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA1.
    • SHA-256: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-256.
    • SHA-384: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-384.
    • SHA-512: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-512.
  • policyQualifier:
    • URL accesible hacia el documento (normalmente PDF) que contiene una descripción textual de la política de firma. Este parámetro es opcional incluso si se desea generar firmas XAdES-EPES.
  • policyDescription:
    • Descripción textual de la política de firma. En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado. Este parámetro es opcional incluso si se desea generar firmas XAdES-EPES.
  • signerClaimedRoles:
    • Agrega a la firma campos con los cargos atribuidos al firmante. Deben separarse los cargos con el carácter "|" (y este no puede estar en el propio texto de ningún cargo). En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado.
  • signatureProductionCity:
    • Agrega a la firma un campo con la ciudad en la que se realiza la firma. En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado.
  • signatureProductionProvince:
    • Agrega a la firma un campo con la provincia en la que se realiza la firma. En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado.
  • signatureProductionPostalCode:
    • Agrega a la firma un campo con el código postal en el que se realiza la firma. En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado.
  • signatureProductionCountry:
    • Agrega a la firma un campo con el país en el que se realiza la firma. En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado.
  • referencesDigestMethod:
    • http://www.w3.org/2000/09/xmldsig#sha1: Usa el algoritmo SHA1 para el cálculo de las huellas digitales de las referencias XML firmadas.
    • http://www.w3.org/2001/04/xmlenc#sha256: Usa el algoritmo SHA-256 para el cálculo de las huellas digitales de las referencias XML firmadas.
    • http://www.w3.org/2001/04/xmlenc#sha512: Usa el algoritmo SHA-512 para el cálculo de las huellas digitales de las referencias XML firmadas. Este es el comportamiento por defecto.
  • mimeType:
    • MIME-Type de los datos a firmar. Si no se indica este parámetro el sistema intenta auto-detectar el tipo, estableciendo el más aproximado (que puede no ser el estrictamente correcto).
  • encoding:
    • URI con la codificación de los datos a firmar (ver la documentación del elemento Object de XMLDSig para más información). Un uso incorrecto de este parámetro puede provocar la generación de una firma inválida. Si se proporcionan datos a firmar previamente codificados en Base64 pero se desea sean considerados como su forma descodificada, debe establecerse este valor a http://www.w3.org/2000/09/xmldsig#base64 y especificarse el tipo real en el parámetro mimeType. Por ejemplo, para firmar una imagen PNG haciendo que la firma se refiera a su forma binaria directa, puede proporcionarse la imagen directamente codificada en Base64 indicando el encoding como http://www.w3.org/2000/09/xmldsig#base64 y el mimeType como image/png. El valor debe ser siempre una URI.
  • outputXmlEncoding:
    • Codificación del XML de salida. Si no se indica este valor se intenta auto-detectar a partir del XML de entrada (si los datos a firmar son un XML).
  • contentTypeOid:
    • OID o URN de tipo OID con el identificador del tipo de dato firmado. Este parámetro es complementario (que no excluyente) al parámetro mimeType.
  • canonicalizationAlgorithm:
    • http://www.w3.org/TR/2001/REC-xml-c14n-20010315: Se firma el XML con canonizado XML 1.0 inclusivo (valor por defecto).
    • http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments: Se firma el XML con canonizado XML 1.0 inclusivo con comentarios.
    • http://www.w3.org/2001/10/xml-exc-c14n#: Se firma el XML con canonizado XML 1.0 exclusivo.
    • http://www.w3.org/2001/10/xml-exc-c14n#WithComments: Se firma el XML con canonizado XML 1.0 exclusivo con comentarios.
  • xadesNamespace:
    • http://uri.etsi.org/01903/v1.3.2#: URL de definición del espacio de nombres de XAdES correspondiente a la versión 1.3.2 de XAdES. Este es el valor por defecto.
    • http://uri.etsi.org/01903/v1.4.1#: URL de definición del espacio de nombres de XAdES correspondiente a la versión 1.4.1 de XAdES. Si se establece este parámetro es posible que se necesite establecer también el parámetro signedPropertiesTypeUrl para evitar incoherencias en la versión de XAdES.
  • signedPropertiesTypeUrl:
    • http://uri.etsi.org/01903#SignedProperties: URL de definición del tipo de las propiedades firmadas (Signed Properties) de XAdES. Este es el valor por defecto.
    • http://uri.etsi.org/01903/1.3.2#SignedProperties: URL de definición del tipo de las propiedades firmadas (Signed Properties) de XAdES v1.3.2.
    • http://uri.etsi.org/01903/1.4.1#SignedProperties: URL de definición del tipo de las propiedades firmadas (Signed Properties) de XAdES v1.4.1. Si se establece este parámetro es posible que se necesite establecer también el parámetro xadesNamespace para evitar incoherencias en la versión de XAdES.
  • ignoreStyleSheets:
    • true: Si se firma un XML con hojas de estilo, ignora éstas dejándolas sin firmar.
    • false: Si se firma un XML con hojas de estilo, firma también las hojas de estilo (valor por defecto, consultar notas adicionales sobre firma de hojas de estilo).
  • avoidBase64Transforms:
    • true: No declara transformaciones Base64 incluso si son necesarias.
    • false: Declara las transformaciones Base64 cuando se han codificado internamente los datos a firmar en Base64 (valor por defecto).
  • headless:
    • true: Evita que se muestren diálogos gráficos adicionales al usuario (como por ejemplo, para la dereferenciación de hojas de estilo enlazadas con rutas relativas).
    • false: Permite que se muestren diálogos gráficos adicionales al usuario.
  • xmlTransforms:
    • Número de transformaciones a aplicar al contenido firmado. Debe indicarse posteriormente igual número de parámetros xmlTransformnType, sustituyendo n por un ordinal consecutivo, comenzando en 0 (ver notas adicionales sobre indicación de transformaciones adicionales).
  • xmlTransformnType:
    • http://www.w3.org/2000/09/xmldsig#base64: Indica que los datos que se proporcionan para firmar ya están codificados en Base64 y se debe declarar esta transformación adicional para que se decodifiquen antes de firmarlos. Esta transformación Base64 es adicional a la transformación necesaria para pasar los datos a través de los métodos de firma del cliente.
    • http://www.w3.org/TR/1999/REC-xpath-19991116: El contenido se debe procesar mediante esta transformación XPATH antes de ser firmado. únicamente es aplicable cuando se firma contenido XML.
    • http://www.w3.org/2002/06/xmldsig-filter2: El contenido se debe procesar mediante esta transformación XPATH2 antes de ser firmado. únicamente es aplicable cuando se firma contenido XML.
  • xmlTransformnSubtype:
    • Subtipo de la transformación n. Los valores aceptados y sus funcionalidades dependen del valor indicado en xmlTransformnType.
  • xmlTransformnBody:
    • Cuerpo de la transformación n. Los valores aceptados y sus funcionalidades dependen del valores indicados en xmlTransformnType y en xmlTransformnSubtype.
  • nodeToSign:
    • Identificador del nodo (establecido mediante el atributo "Id") que se desea firmar dentro de un XML.
  • commitmentTypeIndications:
    • Número de CommitmentTypeIndications que se van a declarar. Estos son los motivos que se declaran para la firma. Los valores concretos se especifican con commitmentTypeIndicationnIdentifier y commitmentTypeIndicationnDescription, donde ‘n’ va desde 0 hasta el valor menos 1 indicado en esta propiedad.
  • commitmentTypeIndicationnIdentifier:
    • 1: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de origen".
    • 2: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de recepción".
    • 3: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de entrega".
    • 4: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de envío".
    • 5: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de aprobación".
    • 6: Establece que el CommitmentTypeIndications número n (contando desde cero) es "Prueba de creación".
  • commitmentTypeIndicationnDescription:
    • Establece la descripción del CommitmentTypeIndications número n. Este atributo es opcional.
  • commitmentTypeIndicationnDocumentationReferences:
    • Lista de URL separadas por el carácter '|' que se aportan como referencias documentales del CommitmentTypeIndication número n (atributo opcional). Las URL de la lista no pueden contener el carácter '|' (ya que este se usa como separador).
  • commitmentTypeIndicationnCommitmentTypeQualifiers:
    • Lista de indicadores textuales separados por el carácter '|' que se aportan como calificadores adicionales del CommitmentTypeIndication número n (atributo opcional). Normalmente son OID. Los elementos de la lista no pueden contener el carácter '|' (ya que este se usa como separador).

Opciones de configuración de firmas de Factura Electrónica

A continuación se listan las propiedades de configuración admitidas por las firmas de factura electrónica (FacturaE).

  • signatureProductionCity:
    • Agrega a la firma un campo con la ciudad en la que se realiza la firma. En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado.
  • signatureProductionProvince:
    • Agrega a la firma un campo con la provincia en la que se realiza la firma. En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado.
  • signatureProductionPostalCode:
    • Agrega a la firma un campo con el código postal en el que se realiza la firma. En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado.
  • signatureProductionCountry:
    • Agrega a la firma un campo con el país en el que se realiza la firma. En el caso de que se firme un XML, la codificación del texto usado debe adecuarse al XML firmado.
  • xadesNamespace:
    • URL de definición del espacio de nombres de XAdES (el uso de este parámetro puede condicionar la declaración de versión de XAdES). Si se establece este parámetro es posible que se necesite establecer también el parámetro signedPropertiesTypeUrl para evitar incoherencias en la versión de XAdES.
  • signedPropertiesTypeUrl:
    • URL de definición del tipo de las propiedades firmadas (Signed Properties) de XAdES. Si se establece este parámetro es posible que se necesite establecer también el parámetro xadesNamespace para evitar incoherencias en la versión de XAdES. Si no se establece se usa el valor por defecto: http://uri.etsi.org/01903#SignedProperties.
  • signerClaimedRoles:
    • emisor: Declara que el firmante es el emisor de la factura. Este es el valor por defecto.
    • receptor: Declara que el firmante es el receptor de la factura.
    • tercero: Declara que el firmante es un tercero con respecto a la factura.
    • supplier: Declara que el firmante es el emisor de la factura.
    • customer: Declara que el firmante es el receptor de la factura.
    • third party: Declara que el firmante es un tercero con respecto a la factura.
  • policyIdentifier:
    • http://www.facturae.es/politica_de_firma_formato_facturae/politica_de_firma_formato_facturae_v3_1.pdf: Identificador de la política de firma 3.1. Este es el valor por defecto.
  • policyIdentifierHash:
    • Ohixl6upD6av8N7pEvDABhEL6hM=: Huella digital para configurar la política de firma 3.1. Este es el valor por defecto.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA1.
    • SHA-256: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-256.
    • SHA-384: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-384.
    • SHA-512: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-512.

Opciones de configuración de firmas PAdES

A continuación se listan las propiedades de configuración admitidas por las firmas PAdES.

  • includeOnlySignningCertificate:
    • true: Indica que debe incluirse en la firma únicamente el certificado del firmante.
    • false: Indica que debe incluirse en la firma toda la cadena de certificación del certificado firmante. Valor por defecto.
  • alwaysCreateRevision:
    • true: Siempre creará una revisión al firmar. Requiere que el documento cumpla la especificación PDF 1.7 (ISO 32000-1:2008)
    • false: No creará revisión en la primera firma y sí en las siguientes.
  • signatureField:
    • Nombre del campo de firma preexistente en el que insertar la firma.
  • signaturePages:
    • Indica las páginas en las que debe aparecer visible la firma.
    • Admite los siguientes valores:
      • all: Para indicar que la firma visible aparezca en todas las páginas del documento, se le deberá de dar este valor.
      • append: Si la firma visible debe de aparecer en una nueva página en blanco añadida al final del documento, se le deberá de dar este valor.
      • Página o listado de páginas: En esta opción se permite seleccionar la página o rango de páginas donde aparecerá la firma visible. Si se desea indicar una página o varias páginas donde estampar la firma visible, es posible indicando página a página con una separación de comas (1,4,7: Se estampa en las páginas 1, 4 y 7) o indicando un rango de páginas a través de un guión (1-8: Se estampa en las páginas desde la 1 hasta la 8). Tal y como se explica en el párrafo anterior, se permite indicar las páginas con un valor negativo, donde se comenzará desde el final (1,-1: Se estampará en la primera y última página).
  • signaturePositionOnPageLowerLeftX:
    • Número entero con la coordenada horizontal desde la esquina inferior izquierda de la página a la esquina inferior izquierda del campo de firma visible.
  • signaturePositionOnPageLowerLeftY:
    • Número entero con la coordenada vertical desde la esquina inferior izquierda de la página a la esquina inferior izquierda del campo de firma visible.
  • signaturePositionOnPageUpperRightX:
    • Número entero con la coordenada horizontal desde la esquina inferior izquierda de la página a la esquina superior derecha del campo de firma visible.
  • signaturePositionOnPageUpperRightY:
    • Número entero con la coordenada vertical desde la esquina inferior izquierda de la página a la esquina superior derecha del campo de firma visible.
  • signatureRubricImage:
    • Ruta del fichero con la imagen JPEG de la imagen a mostrar aplicar en la firma visible PDF. También puede indicarse directamente el Base 64 de la imagen.
  • layer2Text:
    • Texto que mostrar en el campo de firma visible.
  • layer2FontFamily:
    • 0: El texto de la firma visible se mostrará con fuente Courier. Este es el valor por defecto.
    • 1: El texto de la firma visible se mostrará con fuente Helvética.
    • 2: El texto de la firma visible se mostrará con fuente Times Roman.
    • 3: El texto de la firma visible se mostrará con fuente Symbol.
    • 4: El texto de la firma visible se mostrará con fuente ZapfDingBats.
  • layer2FontSize:
    • Tamaño de fuente del texto de la firma visible.
  • layer2FontStyle:
    • 0: Texto de la firma visible sin estilo. Valor por defecto.
    • 1: Texto de la firma visible en negrita.
    • 2: Texto de la firma visible en cursiva.
    • 4: Texto de la firma visible subrayado.
    • 8: Texto de la firma visible tachado.
  • layer2FontColor:
    • black: Texto de la firma visible sin estilo. Valor por defecto.
    • white: El texto de la firma visible será de color blanco.
    • gray: El texto de la firma visible será de color gris.
    • lightGray: El texto de la firma visible será de color gris claro.
    • darkGray: El texto de la firma visible será de color gris oscuro.
    • red: El texto de la firma visible será de color rojo.
    • pink: El texto de la firma visible será de color rosa.
  • obfuscateCertText:
    • true: Se ofuscan los identificadores de usuario extraidos del CN o DN del certificado y mostrados en la firma visible PDF. No se ofuscan los datos de los certificados de seudónimo. Este es el valor por defecto.
    • false: No se ofusca la información de los certificados.
  • obfuscationMask:
    • Criterios de ofuscación de los identificadores de usuario en las firmas visibles PDF. Debe mostrar el siguiente patrón:
      • caracter;longitudDigitos;posiciones;desplazamiento
    • En este patrón:
      • caracter: Es el carácter que usar para ofuscar caracteres.
      • longitudDigitos: Número mínimo de dígitos que debe tener una cadena de texto para que se considere que debe ofuscarse.
      • posiciones: Listado de posiciones que indica qué caracteres deben mostrarse. El listado se expresa con una sucesión de true/false separados por comas (','), en donde true indica que el carácter debe mostrarse y false que no.
      • desplazamiento: Indica si se admite el desplazamiento de posiciones de la máscara para mostrar todos los caracteres indicados (true) o si esta debe respetarse (false).
  • visibleSignature:
    • default: Se realizará firma visible PDF si se han proporcionado los parámetros con el área y la página de firma. Este es el valor por defecto.
    • want: El usuario debe seleccionar el área de firma visible. En caso de cancelar el proceso:
      • Si la petición también incluye los parámetros de área de firma visible (posición y página), se usarán dichos parámetros y se continuará con el proceso de firma.
      • Si la petición no incluye los parámetros de área de firma visible, se cancelará el proceso de firma.
    • optional: El usuario podrá elegir si desea incluir o no el área de firma visible. En caso de cancelar el proceso:
      • Si la petición también incluye los parámetros de área de firma visible (posición y página), se usarán dichos parámetros y se continuará con el proceso de firma.
      • Si la petición no incluye los parámetros de área de firma visible, se realizará una firma no visible.
  • visibleAppearance:
    • default: Se aplicará el aspecto por defecto para la firma visible PDF o, si se proporcionaron los parámetros de aspecto, el aspecto configurado. Este es el valor por defecto.
    • custom: El usuario puede elegir el aspecto de la firma visible. En caso de cancelar el proceso, se usará el aspecto por defecto.
  • signatureRotation:
    • 0: No rota el texto del campo de firma. Este es el valor por defecto.
    • 90: Rota 90 grados en sentido horario el texto del campo de firma. Se ignorará cualquier configuración de imagen de firma.
    • 180: Rota 180 grados en sentido horario el texto del campo de firma. Se ignorará cualquier configuración de imagen de firma.
    • 270: Rota 270 grados en sentido horario el texto del campo de firma. Se ignorará cualquier configuración de imagen de firma.
  • includeQuestionMark:
    • true: Permitirse al lector de PDF mostrar junto a la firma visible una marca que índique el resultado obtenido al validarla. La apariencia de esta marca depende completamente del lector de PDF utilizado y es este el que decide si se muestra. Por ejemplo, la marca podría no mostrarse cuando se definiese una imagen de fondo en la firma.
    • false: No permite mostrar la marca con el resultado de la validación. Este es el valor por defecto.
  • image:
    • Ruta del fichero de imagen JPEG que insertar en el documento antes de firmarlo. También puede indicarse directamente el Base 64 de la imagen. Este parámetro sólo se puede utilizar en la primera firma del documento.
  • imagePage:
    • Número de la página del documento PDF en la que insertar la imagen.
    • 0: Insertar en todas las páginas
    • -1: Insertar imagen en la última página.
  • imagePositionOnPageLowerLeftX:
    • Número entero con la coordenada horizontal desde la esquina inferior izquierda de la página a la esquina inferior izquierda de la imagen.
  • imagePositionOnPageLowerLeftY:
    • Número entero con la coordenada vertical desde la esquina inferior izquierda de la página a la esquina inferior izquierda de la imagen.
  • imagePositionOnPageUpperRightX:
    • Número entero con la coordenada horizontal desde la esquina inferior izquierda de la página a la esquina superior derecha de la imagen.
  • imagePositionOnPageUpperRightY:
    • Número entero con la coordenada vertical desde la esquina inferior izquierda de la página a la esquina superior derecha de la imagen.
  • attach:
    • Ruta del fichero con el contenido a añadir como adjunto al PDF. También puede indicarse directamente el Base 64 de los datos. Requiere establecer attachFileName.
  • attachFileName:
    • Nombre del que asignar al fichero adjunto.
  • attachDescription:
    • Descripción del documento adjunto.
  • certificationLevel:
    • 0: Firma sin certificar. Esta sería una firma de aprobación. Es el valor por defecto.
    • 1: Firma certificada de autor. Tras este tipo de firma certificada, no se permite ningún cambio posterior en el documento (no se pueden agregar firmas, ni rellenar formularios).
    • 2: Firma certificada de autor para formularios. Tras este tipo de firma certificada, sólo se permite el relleno de los campos de formulario (no se pueden agregar firmas).
    • 3: Firma certificada común. Tras este tipo de firma certificada, sólo se permite el relleno de los campos de formulario y la creación de firmas de aprobación.
  • compressPdf:
    • true: Comprime el PDF firmado para que ocupe menos tamaño. Sólo se aplica si se trata de un PDF v4 o superior. Este es el valor por defecto.
    • false: Nunca se comprime el PDF firmado.
  • pdfVersion:
    • 2: Se declara que la versión del PDF de salida es 1.2.
    • 3: Se declara que la versión del PDF de salida es 1.3.
    • 4: Se declara que la versión del PDF de salida es 1.4.
    • 5: Se declara que la versión del PDF de salida es 1.5.
    • 6: Se declara que la versión del PDF de salida es 1.6.
    • 7: Se declara que la versión del PDF de salida es 1.7.
  • signatureSubFilter:
    • Subfiltro declarado. Por defecto se utiliza el de las firmas básicas (adbe.pkcs7.detached). Puede usarse la cadena "ETSI.CAdES.detached" para crear firmas BES.
  • signReason:
    • Razón por la que se realiza la firma.
  • signatureProductionCity:
    • Ciudad en la que se realiza la firma.
  • signerContact:
    • Información de contacto del firmante.
  • signerClaimedRoles:
    • Listado de roles declarados por el firmante (separados por "|").
  • policyIdentifier:
    • Identificador de la política de firma (normalmente una URL hacia la política en formato XML procesable), necesario para generar firmas XAdES-EPES.
  • policyIdentifierHash:
    • Texto Base 64 con la huella digital de la política de firma. Es obligatorio indicar este parámetro si el valor indicado en policyIdentifier no es universalmente accesible. Si se da valor a este parámetro es obligatorio también dar valor al parámetro policyIdentifierHashAlgorithm.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA1.
    • SHA-256: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-256.
    • SHA-384: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-384.
    • SHA-512: Indica que la huella digital indicada en el parámetro policyIdentifierHash se calculó mediante el algoritmo SHA-512.
  • policyQualifier:
    • URL hacia el documento que contiene una descripción textual de la política de firma.
  • ownerPassword:
    • Contraseña de apertura del PDF. No se soporta la firma de documentos PDF cifrados con certificados o algoritmo AES-256.
  • headless:
    • true: No interrumpe el proceso de firma solicitando interacción del usuario.
    • false: Muestra diálogos al usuario si requiere de su autorización o algún dato adicional para firmar. Este es el valor por defecto.
  • allowSigningCertifiedPdfs:
    • true: Permite la firma de documentos PDF certificados. El resultado podría invalidar firmas anteriores del PDF.
    • false: Produce un error al firmar documentos PDF certificados.
    • Se omite: En caso de detectar que el documento PDF de entrada está certificado, se advertirá al usuario de que la firma podría invalidar firmas anteriores y se le permitirá elegir si firmar o cancelar la operación.
  • allowSigningCertifiedPdfs:
    • true: Permite la firma de documentos PDF certificados. El resultado podría invalidar firmas anteriores del PDF.
    • false: Produce un error al firmar documentos PDF certificados.
    • Se omite: En caso de detectar que el documento PDF de entrada está certificado, se advertirá al usuario de que la firma podría invalidar firmas anteriores y se le permitirá elegir si firmar o cancelar la operación.
  • allowCosigningUnregisteredSignatures:
    • true: Permite firmar documentos PDF con firmas previas no registradas.
    • false: No permite firmar documentos PDF con firmas previas no registradas.
  • signingCertificateV2:
    • true: Se utiliza el atributo signingCertificateV2 en las firmas.
    • false: Se utiliza el atributo signingCertificateV1 en las firmas.
    • Se omite: Se utiliza el atributo signingCertificateV1 en las firmas SHA1withRSA y signingCertificateV2 en el resto.
  • signReservedSize:
    • Tamaño máximo en bytes de la firma que se incorporará al PDF. Por defecto, 27000.
  • signingCertificateV2:
    • true: Se utiliza el atributo signingCertificateV2 en las firmas.
    • false: Se utiliza el atributo signingCertificateV1 en las firmas.
    • Se omite: Se utiliza el atributo signingCertificateV1 en las firmas SHA1withRSA y signingCertificateV2 en el resto.
  • allowShadowAttack:
    • true: No se realizará la comprobación de PDF Shadow Attack durante la validación de las firmas previas.
    • false: Se realizará la comprobación de PDF Shadow Attack durante la validación de las firmas previas y, en caso de detectarse, se dará la firma por inválida.
    • Se omite: Se realizará la comprobación de PDF Shadow Attack durante la validación de las firmas previas y, en caso de detectarse, se consultará al usuario si se debe continuar con la operación.
  • allowModifiedForm:
    • true: No se realizará la comprobación de cambios en los formularios del documento ni PDF Shadow Attack durante la validación de las firmas previas.
    • false: Se realizará la comprobación de cambios en los formularios del documento durante la validación de las firmas previas y, en caso de detectarse, se dará la firma por inválida.
    • Se omite: Se realizará la comprobación de cambios en los formularios del documento durante la validación de las firmas previas y, en caso de detectarse, se consultará al usuario si se debe continuar con la operación.
Clone this wiki locally