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

Propietats de configuració dels formats de signatura

Signes CAdES

A continuació es llisten les propietats de configuració admeses per les signatures CAdES. Algunes d'estes opcions poden no tindre efecte en casos de signatura en les quals no apliquen, com en el cas de les contrafirmes.

  • mode:
    • explicit: La signatura resultant no inclourà les dades signades. Si no s'indica el paràmetre mode es configura automàticament este comportament.
    • implicit: La signatura resultant no inclourà les dades signades. La signatura resultant inclourà internament una còpia de les dades signades. L'ús d'este valor podria generar signatures de gran grandària. En les cosignatures, este paràmetre s'ignorarà si les dades ja estaven continguts en la signatura original o si no es proporcionen les dades.
  • contentTypeOid:
    • Identificador del tipus de dada signada.
  • contentDescription:
    • Descripció textual del tipus de dades signat.
  • policyIdentifier:
    • Identificador de la política de signatura, necessari per a generar signes CAdES-EPES.
  • policyIdentifierHash:
    • Cadena Base 64 amb l'empremta digital de la política de signatura. És obligatori indicar este paràmetre si de va indicar també policyIdentifier, igual que és obligatori també donar valor al paràmetre policyIdentifierHashAlgorithm.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA1.
    • SHA-256: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-256.
    • SHA-384: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-384.
    • SHA-512: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-512.
  • policyQualifier:
    • URL accessible cap al document (normalment PDF) que conté una descripció textual de la política de signatura. Este paràmetre és opcional fins i tot si es desitja generar signes CAdES-EPES.
  • includeOnlySignningCertificate:
    • true: Indica que ha d'incloure's en la signatura únicament el certificat del signant.
    • false: Indica que ha d'incloure's en la signatura tota la cadena de certificació del certificat signant. Valor per defecte.
  • policyQualifier:
    • URL accessible cap al document (normalment PDF) que conté una descripció textual de la política de signatura. Este paràmetre és opcional fins i tot si es desitja generar signes CAdES-EPES.
  • signatureProductionCity:
    • Agrega a la signatura un camp amb la ciutat en la qual es realitza la signatura. La codificació ha de ser UTF-8.
  • signatureProductionPostalCode:
    • Agrega a la signatura un camp amb el codi postal on es realitza la signatura. La codificació ha de ser UTF-8.
  • signatureProductionCountry:
    • Agrega a la signatura un camp amb el país en la qual es realitza la signatura. La codificació ha de ser UTF-8.
  • signerClaimedRoles:
    • Agrega a la signatura camps amb els càrrecs atribuïts al signant. Han de separar-se els càrrecs amb el caràcter "|" (i este no pot estar en el propi text de cap càrrec).
  • commitmentTypeIndications:
    • Número de CommitmentTypeIndications que es declararan. Estos són els motius que es declaren per a la signatura. Els valors concrets s'especifiquen amb commitmentTypeIndicationnIdentifier i commitmentTypeIndicationnDescription, on ‘n’ va des de 0 fins al valor indicat en esta propietat menys 1.
  • commitmentTypeIndicationnIdentifier:
    • 1: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova d'origen".
    • 2: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova de recepció".
    • 3: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova de lliurament".
    • 4: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova d'enviament".
    • 5: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova d'aprovació".
    • 6: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova de creació".
  • commitmentTypeIndicationnCommitmentTypeQualifiers:
    • Llista d'indicadors textuals separats pel caràcter '|' que s'aporten com a qualificadors addicionals del CommitmentTypeIndication número n (atribut opcional). Normalment són OID. Els elements de la llista no poden contindre el caràcter '|' (ja que este s'usa com a separador).
  • commitmentTypeIndicationnIdentifier:
    • true: S'inclourà l'atribut SigningCertificateV2 en la signatura.
    • false (O un altre valor): S'inclourà l'atribut SigningCertificate en la signatura.
    • Sense especificar: S'inclourà SigningCertificate si la signatura utilitza un algorisme de signatura SHA1 i SigningCertificateV2 per a la resta d'algorismes.

Signatures XAdES

A continuació es llisten les propietats de configuració admeses per les signatures XAdES. Algunes d'estes opcions poden no tindre efecte en casos de signatura en les quals no apliquen, com en el cas de les contrafirmes.

  • insertEnvelopedSignatureOnNodeByXPath:
    • Expressió XPath (v1) que indica el node sota el qual ha d'inserir-se el node de signatura en el cas d'una signatura Enveloped. Si l'expressió retorna més d'un node, s'usa només el primer. Si l'expressió no retorna nodes o està mal construïda es llançarà una excepció. Este paràmetre només té efecte en signatures Enveloped.
  • useManifest:
    • true: Usa un Manifest de XMLDSig amb les referències de signatura en comptes de signar directament estes referències. S'ignora en l'operació de cosignatura. Això permet que siga opcional la comprovació de la destinació i empremtes digitals de les referències.
    • false: Genera les signatures normalment, sense Manifest (comportament per defecte).
  • urin:
    • URI que referencia a les dades que es desitgen signatura dins d'una signatura manifest. ‘n’ indica el número de referència d'entre les que es volen signar, començant en ‘1’.
  • precalculatedHashAlgorithm:
    • SHA1: Indica que les empremtes digitals de les dades referenciades en el manifest es van calcular mitjançant l'algorisme SHA1.
    • SHA-256: Indica que les empremtes digitals de les dades referenciades en el manifest es van calcular mitjançant l'algorisme SHA-256.
    • SHA-384: Indica que les empremtes digitals de les dades referenciades en el manifest es van calcular mitjançant l'algorisme SHA-284.
    • SHA-512: Indica que les empremtes digitals de les dades referenciades en el manifest es van calcular mitjançant l'algorisme SHA-512.
  • mdn:
    • Base 64 amb l'empremta digital de les dades associades a la referència ‘n’. L'algorisme de petjada serà l'indicat en precalculatedHashAlgorithm
  • mimetypen:
    • ACARONE-Type de les dades associades a la referència ‘n’ en una signatura manifest. Si no s'indica este paràmetre, s'utilitzarà el tipus ‘application/octet-stream’.
  • contentTypeOidn:
    • OID o URN del tipus de dada signada per a la referència número ‘n’ en una signatura manifest. Este paràmetre és complementari (que no excloent) al paràmetre mimetypen.
  • encodingn:
    • Codificació de les dades associades a la referència número ‘n’ en una signatura manifest. Un ús incorrecte d'este paràmetre pot provocar la generació d'una signatura invàlida.
  • addKeyInfoKeyValue:
    • true: Inclou el node KeyValue dins de KeyInfo de XAdES (comportament per defecte).
    • false: No inclou el node KeyValue dins de KeyInfo de XAdES.
  • addKeyInfoKeyName:
    • true: Inclou el node KeyName dins de KeyInfo de XAdES.
    • false: No inclou el node KeyName dins de KeyInfo de XAdES (comportament per defecte).
  • avoidXpathExtraTransformsOnEnveloped:
    • true: Evita la inclusió de la transformació XPATH2 que normalment s'afig per a possibilitar les cosignatures i que elimina totes les signatures del document per a deixar únicament el contingut. ADVERTIMENT: La cosignatura d'un document en el qual almenys una de les signatures no inclou la transformació XPATH, donarà lloc a un document de signatura que potencialment serà validat incorrectament pels validadors de signatura. Per este motiu, només es permet l'ús d'este paràmetre en l'operació de signatura (no en la de cosignatura).
    • false: Inclou la transformació XPATH2 possibilita les cosignatures eliminant totes les signatures del document per a deixar únicament el contingut (comportament per defecte).
  • format:
    • XAdES Enveloping: Genera signatures en format Enveloping. Este és el format que s'utilitza per defecte quan no s'indica cap.
    • XAdES Enveloped: Genera signatures en format Enveloped.
    • XAdES Detached: Genera signatures en format Internally Detached.
    • XAdES Externally Detached:Genera signatures en format Externally Detached.
  • includeOnlySignningCertificate:
    • true: Indica que ha d'incloure's en la signatura únicament el certificat del signant.
    • false: Indica que ha d'incloure's en la signatura tota la cadena de certificació del certificat signant. Valor per defecte.
  • policyIdentifier:
    • Identificador de la política de signatura (normalment una URL cap a la política en format XML procesable), necessari per a generar signes XAdES-EPES.
  • policyIdentifierHash:
    • Cadena Base 64 amb l'empremta digital de la política de signatura. És obligatori indicar este paràmetre si de va indicar també policyIdentifier, igual que és obligatori també donar valor al paràmetre policyIdentifierHashAlgorithm.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA1.
    • SHA-256: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-256.
    • SHA-384: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-384.
    • SHA-512: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-512.
  • policyQualifier:
    • URL accessible cap al document (normalment PDF) que conté una descripció textual de la política de signatura. Este paràmetre és opcional fins i tot si es desitja generar signes XAdES-EPES.
  • policyDescription:
    • Descripció textual de la política de signatura. En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat. Este paràmetre és opcional fins i tot si es desitja generar signes XAdES-EPES.
  • signerClaimedRoles:
    • Agrega a la signatura camps amb els càrrecs atribuïts al signant. Han de separar-se els càrrecs amb el caràcter "|" (i este no pot estar en el propi text de cap càrrec). En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat.
  • signatureProductionCity:
    • Agrega a la signatura un camp amb la ciutat en la qual es realitza la signatura. En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat.
  • signatureProductionProvince:
    • Agrega a la signatura un camp amb la província en la qual es realitza la signatura. En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat.
  • signatureProductionPostalCode:
    • Agrega a la signatura un camp amb el codi postal en el qual es realitza la signatura. En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat.
  • signatureProductionCountry:
    • Agrega a la signatura un camp amb el país en el qual es realitza la signatura. En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat.
  • referencesDigestMethod:
    • http://www.w3.org/2000/09/xmldsig#sha1: Usa l'algorisme SHA1 per al càlcul de les empremtes digitals de les referències XML signades.
    • http://www.w3.org/2001/04/xmlenc#sha256: Usa l'algorisme SHA-256 per al càlcul de les empremtes digitals de les referències XML signades.
    • http://www.w3.org/2001/04/xmlenc#sha512: Usa l'algorisme SHA-512 per al càlcul de les empremtes digitals de les referències XML signades. Este és el comportament per defecte.
  • mimeType:
    • ACARONE-Type de les dades a signar. Si no s'indica este paràmetre el sistema intenta acte-detectar el tipus, establint el més aproximat (que pot no ser l'estrictament correcte).
  • encoding:
    • URI amb la codificació de les dades a signar (veure la documentació de l'element Object de XMLDSig per a més informació). Un ús incorrecte d'este paràmetre pot provocar la generació d'una signatura invàlida. Si es proporcionen dades a signar prèviament codificats en Base64 però es desitja siguen considerats com la seua forma descodificada, ha d'establir-se este valor a http://www.w3.org/2000/09/xmldsig#base64 i especificar-se el tipus real en el paràmetre mimeType. Per exemple, per a signar una imatge PNG fent que la signatura es referisca a la seua forma binària directa, pot proporcionar-se la imatge directament codificada en Base64 indicant l'encoding com http://www.w3.org/2000/09/xmldsig#base64 i el mimeType com image/png. El valor ha de ser sempre una URI.
  • outputXmlEncoding:
    • Codificació del XML d'eixida. Si no s'indica este valor s'intenta acte-detectar a partir del XML d'entrada (si les dades a signar són un XML).
  • contentTypeOid:
    • OID o URN de tipus OID amb l'identificador del tipus de dada signada. Este paràmetre és complementari (que no excloent) al paràmetre mimeType.
  • canonicalizationAlgorithm:
    • http://www.w3.org/tr/2001/rec-xml-c14n-20010315: Se signa el XML amb canonitzat XML 1.0 inclusiu (valor per defecte).
    • http://www.w3.org/tr/2001/rec-xml-c14n-20010315#WithComments: Se signa el XML amb canonitzat XML 1.0 inclusiu amb comentaris.
    • http://www.w3.org/2001/10/xml-exc-c14n#: Se signa el XML amb canonitzat XML 1.0 exclusiu.
    • http://www.w3.org/2001/10/xml-exc-c14n#WithComments: Se signa el XML amb canonitzat XML 1.0 exclusiu amb comentaris.
  • xadesNamespace:
    • http://uri.etsi.org/01903/v1.3.2#: URL de definició de l'espai de noms de XAdES corresponent a la versió 1.3.2 de XAdES. Este és el valor per defecte.
    • http://uri.etsi.org/01903/v1.4.1#: URL de definició de l'espai de noms de XAdES corresponent a la versió 1.4.1 de XAdES. Si s'establix este paràmetre és possible que es necessite establir també el paràmetre signedPropertiesTypeUrl per a evitar incoherències en la versió de XAdES.
  • signedPropertiesTypeUrl:
    • http://uri.etsi.org/01903#SignedProperties: URL de definició del tipus de les propietats signades (Signed Properties) de XAdES. Este és el valor per defecte.
    • http://uri.etsi.org/01903/1.3.2#SignedProperties: URL de definició del tipus de les propietats signades (Signed Properties) de XAdES v1.3.2.
    • http://uri.etsi.org/01903/1.4.1#SignedProperties: URL de definició del tipus de les propietats signades (Signed Properties) de XAdES v1.4.1. Si s'establix este paràmetre és possible que es necessite establir també el paràmetre xadesNamespace per a evitar incoherències en la versió de XAdES.
  • ignoreStyleSheets:
    • true: Si se signa un XML amb fulles d'estil, ignora aquestes deixant-les sense signar.
    • false: Si se signa un XML amb fulles d'estil, signatura també les fulles d'estil (valor per defecte, consultar notes addicionals sobre signatura de fulles d'estil).
  • avoidBase64Transforms:
    • true: No declara transformacions Base64 fins i tot si són necessàries.
    • false: Declara les transformacions Base64 quan s'han codificat internament les dades a signar en Base64 (valor per defecte).
  • headless:
    • true: Evita que es mostren diàlegs gràfics addicionals a l'usuari (com per exemple, per a la dereferenciación de fulles d'estil enllaçades amb rutes relatives).
    • false: Permet que es mostren diàlegs gràfics addicionals a l'usuari.
  • xmlTransforms:
    • Nombre de transformacions a aplicar al contingut signat. Ha d'indicar-se posteriorment igual nombre de paràmetres xmlTransformnType, substituint n per un ordinal consecutiu, començant en 0 (veure notes addicionals sobre indicació de transformacions addicionals).
  • xmlTransformnType:
    • http://www.w3.org/2000/09/xmldsig#base64: Indica que les dades que es proporcionen per a signar ja estan codificats en Base64 i s'ha de declarar esta transformació addicional perquè es decodifiquen abans de signar-los. Esta transformació Base64 és addicional a la transformació necessària per a passar les dades a través dels mètodes de signatura d'Autofirma.
    • http://www.w3.org/tr/1999/rec-xpath-19991116: El contingut s'ha de processar mitjançant esta transformació XPATH abans de ser signat. únicament és aplicable quan se signa contingut XML.
    • http://www.w3.org/2002/06/xmldsig-filter2: El contingut s'ha de processar mitjançant esta transformació XPATH2 abans de ser signat. únicament és aplicable quan se signa contingut XML.
  • xmlTransformnSubtype:
    • Subtipus de la transformació n. Els valors acceptats i les seues funcionalitats depenen del valor indicat en xmlTransformnType.
  • xmlTransformnBody:
    • Cos de la transformació n. Els valors acceptats i les seues funcionalitats depenen del valors indicats en xmlTransformnType i en xmlTransformnSubtype.
  • nodeToSign:
    • Identificador del node (establit mitjançant l'atribut "Aneu") que es desitja signar dins d'un XML.
  • commitmentTypeIndications:
    • Número de CommitmentTypeIndications que es declararan. Estos són els motius que es declaren per a la signatura. Els valors concrets s'especifiquen amb commitmentTypeIndicationnIdentifier i commitmentTypeIndicationnDescription, on ‘n’ va des de 0 fins al valor menys 1 indicat en esta propietat.
  • commitmentTypeIndicationnIdentifier:
    • 1: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova d'origen".
    • 2: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova de recepció".
    • 3: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova de lliurament".
    • 4: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova d'enviament".
    • 5: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova d'aprovació".
    • 6: Establix que el CommitmentTypeIndications número n (comptant des de zero) és "Prova de creació".
  • commitmentTypeIndicationnDescription:
    • Establix la descripció del CommitmentTypeIndications número n. Este atribut és opcional.
  • commitmentTypeIndicationnDocumentationReferences:
    • Llista d'URL separades pel caràcter '|' que s'aporten com a referències documentals del CommitmentTypeIndication número n (atribut opcional). Les URL de la llista no poden contindre el caràcter '|' (ja que este s'usa com a separador).
  • commitmentTypeIndicationnCommitmentTypeQualifiers:
    • Llista d'indicadors textuals separats pel caràcter '|' que s'aporten com a qualificadors addicionals del CommitmentTypeIndication número n (atribut opcional). Normalment són OID. Els elements de la llista no poden contindre el caràcter '|' (ja que este s'usa com a separador).

Signes Factura Electrònica

A continuació es llisten les propietats de configuració admeses per les signatures de factura electrònica (FacturaE).

  • signatureProductionCity:
    • Agrega a la signatura un camp amb la ciutat en la qual es realitza la signatura. En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat.
  • signatureProductionProvince:
    • Agrega a la signatura un camp amb la província en la qual es realitza la signatura. En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat.
  • signatureProductionPostalCode:
    • Agrega a la signatura un camp amb el codi postal en el qual es realitza la signatura. En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat.
  • signatureProductionCountry:
    • Agrega a la signatura un camp amb el país en el qual es realitza la signatura. En el cas que se signe un XML, la codificació del text usat ha d'adequar-se al XML signat.
  • xadesNamespace:
    • URL de definició de l'espai de noms de XAdES (l'ús d'este paràmetre pot condicionar la declaració de versió de XAdES). Si s'establix este paràmetre és possible que es necessite establir també el paràmetre signedPropertiesTypeUrl per a evitar incoherències en la versió de XAdES.
  • signedPropertiesTypeUrl:
    • URL de definició del tipus de les propietats signades (Signed Properties) de XAdES. Si s'establix este paràmetre és possible que es necessite establir també el paràmetre xadesNamespace per a evitar incoherències en la versió de XAdES. Si no s'establix s'usa el valor per defecte: http://uri.etsi.org/01903#SignedProperties.
  • signerClaimedRoles:
    • emissor: Declara que el signant és l'emissor de la factura. Este és el valor per defecte.
    • receptor: Declara que el signant és el receptor de la factura.
    • tercer: Declara que el signant és un tercer respecte a la factura.
    • supplier: Declara que el signant és l'emissor de la factura.
    • customer: Declara que el signant és el receptor de la factura.
    • third party: Declara que el signant és un tercer respecte 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 signatura 3.1. Este és el valor per defecte.
  • policyIdentifierHash:
    • Ohixl6upD6av8N7pEvDABhEL6hM=: Empremta digital per a configurar la política de signatura 3.1. Este és el valor per defecte.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA1.
    • SHA-256: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-256.
    • SHA-384: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-384.
    • SHA-512: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-512.

Signes PAdES

A continuació es llisten les propietats de configuració admeses per les signatures PAdES.

  • includeOnlySignningCertificate:
    • true: Indica que ha d'incloure's en la signatura únicament el certificat del signant.
    • false: Indica que ha d'incloure's en la signatura tota la cadena de certificació del certificat signant. Valor per defecte.
  • alwaysCreateRevision:
    • true: Sempre crearà una revisió en signar. Requereix que el document complisca l'especificació PDF 1.7 (ISO 32000-1:2008)
    • false: No crearà revisió en la primera signatura i sí en les següents.
  • signatureField:
    • Nom del camp de signatura preexistent en el qual inserir la signatura.
  • signaturePages:
    • Indica les pàgines en les quals ha d'aparéixer visible la signatura.
    • Admet els següents valors:
      • all: Per a indicar que la signatura visible aparega en totes les pàgines del document, se li haurà de donar este valor.
      • append: Si la signatura visible ha d'aparéixer en una nova pàgina en blanc afegida al final del document, se li haurà de donar este valor.
      • Pàgina o llistat de pàgines: En esta opció es permet seleccionar la pàgina o rang de pàgines on apareixerà la signatura visible. Si es desitja indicar una pàgina o diverses pàgines on estampar la signatura visible, és possible indicant pàgina a pàgina amb una separació de comes (1,4,7: S'estampa en les pàgines 1, 4 i 7) o indicant un rang de pàgines a través d'un guió (1-8: S'estampa en les pàgines des de la 1 fins a la 8). Tal com s'explica en el paràgraf anterior, es permet indicar les pàgines amb un valor negatiu, on es començarà des del final (1,-1: S'estamparà en la primera i última pàgina).
  • signaturePositionOnPageLowerLeftX:
    • Nombre enter amb la coordenada horitzontal des de la cantonada inferior esquerra de la pàgina a la cantonada inferior esquerra del camp de signatura visible.
  • signaturePositionOnPageLowerLeftY:
    • Nombre enter amb la coordenada vertical des de la cantonada inferior esquerra de la pàgina a la cantonada inferior esquerra del camp de signatura visible.
  • signaturePositionOnPageUpperRightX:
    • Nombre enter amb la coordenada horitzontal des de la cantonada inferior esquerra de la pàgina a la cantonada superior dreta del camp de signatura visible.
  • signaturePositionOnPageUpperRightY:
    • Nombre enter amb la coordenada vertical des de la cantonada inferior esquerra de la pàgina a la cantonada superior dreta del camp de signatura visible.
  • signatureRubricImage:
    • Ruta del fitxer amb la imatge JPEG de la imatge a mostrar aplicar en la signatura visible PDF. També pot indicar-se directament el Base 64 de la imatge.
  • layer2Text:
    • Text que mostrar en el camp de signatura visible.
  • layer2FontFamily:
    • 0: El text de la signatura visible es mostrarà amb font Courier. Este és el valor per defecte.
    • 1: El text de la signatura visible es mostrarà amb font Helvètica.
    • 2: El text de la signatura visible es mostrarà amb font Times Roman.
    • 3: El text de la signatura visible es mostrarà amb font Symbol.
    • 4: El text de la signatura visible es mostrarà amb font ZapfDingBats.
  • layer2FontSize:
    • Grandària de font del text de la signatura visible.
  • layer2FontStyle:
    • 0: Text de la signatura visible sense estil. Valor per defecte.
    • 1: Text de la signatura visible en negreta.
    • 2: Text de la signatura visible en cursiva.
    • 4: Text de la signatura visible subratllat.
    • 8: Text de la signatura visible ratllat.
  • layer2FontColor:
    • black: Text de la signatura visible sense estil. Valor per defecte.
    • white: El text de la signatura visible serà de color blanc.
    • gray: El text de la signatura visible serà de color gris.
    • lightGray: El text de la signatura visible serà de color gris clar.
    • darkGray: El text de la signatura visible serà de color gris fosc.
    • xarxa: El text de la signatura visible serà de color roig.
    • pink: El text de la signatura visible serà de color rosa.
  • obfuscateCertText:
    • true: S'ofusquen els identificadors d'usuari extrets del CN o DN del certificat i mostrats en la signatura visible PDF. No s'ofusquen les dades dels certificats de pseudònim. Este és el valor per defecte.
    • false: No s'ofusca la informació dels certificats.
  • obfuscationMask:
    • Criteris d'ofuscació dels identificadors d'usuari en les signatures visibles PDF. Ha de mostrar el següent patró:
      • caràcter;longitudDigitos;posicions;desplaçament
    • En este patró:
      • caràcter: És el caràcter que usar per a ofuscar caràcters.
      • longitudDigitos: Nombre mínim de dígits que ha de tindre una cadena de text perquè es considere que ha d'ofuscar-se.
      • posiciones: Llistat de posicions que indica quins caràcters han de mostrar-se. El llistat s'expressa amb una successió de true/false separats per comes (','), on true indica que el caràcter ha de mostrar-se i false que no.
      • desplaçament: Indica si s'admet el desplaçament de posicions de la màscara per a mostrar tots els caràcters indicats (true) o si esta ha de respectar-se (false).
  • visibleSignature:
    • default: Es realitzarà signatura visible PDF si s'han proporcionat els paràmetres amb l'àrea i la pàgina de signatura. Este és el valor per defecte.
    • want: L'usuari ha de seleccionar l'àrea de signatura visible. En cas de cancel·lar el procés:
      • Si la petició també inclou els paràmetres d'àrea de signatura visible (posició i pàgina), s'usaran aquests paràmetres i es continuarà amb el procés de signatura.
      • Si la petició no inclou els paràmetres d'àrea de signatura visible, es cancel·larà el procés de signatura.
    • optional: L'usuari podrà triar si desitja incloure o no l'àrea de signatura visible. En cas de cancel·lar el procés:
      • Si la petició també inclou els paràmetres d'àrea de signatura visible (posició i pàgina), s'usaran aquests paràmetres i es continuarà amb el procés de signatura.
      • Si la petició no inclou els paràmetres d'àrea de signatura visible, es realitzarà una signatura no visible.
  • visibleAppearance:
    • default: S'aplicarà l'aspecte per defecte per a la signatura visible PDF o, si es van proporcionar els paràmetres d'aspecte, l'aspecte configurat. Este és el valor per defecte.
    • custom: L'usuari pot triar l'aspecte de la signatura visible. En cas de cancel·lar el procés, s'usarà l'aspecte per defecte.
  • signatureRotation:
    • 0: No trencada el text del camp de signatura. Este és el valor per defecte.
    • 90: Rota 90 graus en sentit horari el text del camp de signatura. S'ignorarà qualsevol configuració d'imatge de signatura.
    • 180: Rota 180 graus en sentit horari el text del camp de signatura. S'ignorarà qualsevol configuració d'imatge de signatura.
    • 270: Rota 270 graus en sentit horari el text del camp de signatura. S'ignorarà qualsevol configuració d'imatge de signatura.
  • includeQuestionMark:
    • true: Permetre's al lector de PDF mostrar al costat de la signatura visible una marca que índique el resultat obtingut en validar-la. L'aparença d'esta marca depén completament del lector de PDF utilitzat i és este el que decideix si es mostra. Per exemple, la marca podria no mostrar-se quan es definira una imatge de fons en la signatura.
    • false: No permet mostrar la marca amb el resultat de la validació. Este és el valor per defecte.
  • image:
    • Ruta del fitxer d'imatge JPEG que inserir en el document abans de signar-lo. També pot indicar-se directament el Base 64 de la imatge. Este paràmetre només es pot utilitzar en la primera signatura del document.
  • imagePage:
    • Número de la pàgina del document PDF en la qual inserir la imatge.
    • 0: Inserir en totes les pàgines
    • -1: Inserir imatge en l'última pàgina.
  • imagePositionOnPageLowerLeftX:
    • Nombre enter amb la coordenada horitzontal des de la cantonada inferior esquerra de la pàgina a la cantonada inferior esquerra de la imatge.
  • imagePositionOnPageLowerLeftY:
    • Nombre enter amb la coordenada vertical des de la cantonada inferior esquerra de la pàgina a la cantonada inferior esquerra de la imatge.
  • imagePositionOnPageUpperRightX:
    • Nombre enter amb la coordenada horitzontal des de la cantonada inferior esquerra de la pàgina a la cantonada superior dreta de la imatge.
  • imagePositionOnPageUpperRightY:
    • Nombre enter amb la coordenada vertical des de la cantonada inferior esquerra de la pàgina a la cantonada superior dreta de la imatge.
  • attach:
    • Ruta del fitxer amb el contingut a afegir com a adjunt al PDF. També pot indicar-se directament el Base 64 de les dades. Requereix establir attachFileName.
  • attachFileName:
    • Nom del qual assignar al fitxer adjunt.
  • attachDescription:
    • Descripció del document adjunt.
  • certificationLevel:
    • 0: Signatura sense certificar. Esta seria una signatura d'aprovació. És el valor per defecte.
    • 1: Signatura certificada d'autor. Després d'esta mena de signatura certificada, no es permet cap canvi posterior en el document (no es poden agregar signatures, ni emplenar formularis).
    • 2: Signatura certificada d'autor per a formularis. Després d'esta mena de signatura certificada, només es permet el farciment dels camps de formulari (no es poden agregar signatures).
    • 3: Signatura certificada comuna. Després d'esta mena de signatura certificada, només es permet el farciment dels camps de formulari i la creació de signatures d'aprovació.
  • compressPdf:
    • true: Comprimeix el PDF signat perquè ocupe menys grandària. Només s'aplica si es tracta d'un PDF v4 o superior. Este és el valor per defecte.
    • false: Mai es comprimeix el PDF signat.
  • pdfVersion:
    • 2: Es declara que la versió del PDF d'eixida és 1.2.
    • 3: Es declara que la versió del PDF d'eixida és 1.3.
    • 4: Es declara que la versió del PDF d'eixida és 1.4.
    • 5: Es declara que la versió del PDF d'eixida és 1.5.
    • 6: Es declara que la versió del PDF d'eixida és 1.6.
    • 7: Es declara que la versió del PDF d'eixida és 1.7.
  • signatureSubFilter:
    • Subfiltro declarat. Per defecte s'utilitza el de les signatures bàsiques (adbe.pkcs7.detached). Pot usar-se la cadena "ETSI.CAdES.detached" per a crear signes BES.
  • signReason:
    • Raó per la qual es realitza la signatura.
  • signatureProductionCity:
    • Ciutat en la qual es realitza la signatura.
  • signerContact:
    • Informació de contacte del signant.
  • signerClaimedRoles:
    • Llistat de rols declarats pel signant (separats per "|").
  • policyIdentifier:
    • Identificador de la política de signatura (normalment una URL cap a la política en format XML procesable), necessari per a generar signes XAdES-EPES.
  • policyIdentifierHash:
    • Text Base 64 amb l'empremta digital de la política de signatura. És obligatori indicar este paràmetre si el valor indicat en policyIdentifier no és universalment accessible. Si es dóna valor a este paràmetre és obligatori també donar valor al paràmetre policyIdentifierHashAlgorithm.
  • policyIdentifierHashAlgorithm:
    • SHA1: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA1.
    • SHA-256: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-256.
    • SHA-384: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-384.
    • SHA-512: Indica que l'empremta digital indicada en el paràmetre policyIdentifierHash es va calcular mitjançant l'algorisme SHA-512.
  • policyQualifier:
    • URL cap al document que conté una descripció textual de la política de signatura.
  • ownerPassword:
    • Contrasenya d'obertura del PDF. No se suporta la signatura de documents PDF xifrats amb certificats o algorisme AES-256.
  • headless:
    • true: No interromp el procés de signatura sol·licitant interacció de l'usuari.
    • false: Mostra diàlegs a l'usuari si requereix de la seua autorització o alguna dada addicional per a signar. Este és el valor per defecte.
  • allowSigningCertifiedPdfs:
    • true: Permet la signatura de documents PDF certificats. El resultat podria invalidar signatures anteriors del PDF.
    • false: Produïx un error en signar documents PDF certificats.
    • S'omet: En cas de detectar que el document PDF d'entrada està certificat, s'advertirà a l'usuari que la signatura podria invalidar signatures anteriors i se li permetrà triar si signar o cancel·lar l'operació.
  • allowSigningCertifiedPdfs:
    • true: Permet la signatura de documents PDF certificats. El resultat podria invalidar signatures anteriors del PDF.
    • false: Produïx un error en signar documents PDF certificats.
    • S'omet: En cas de detectar que el document PDF d'entrada està certificat, s'advertirà a l'usuari que la signatura podria invalidar signatures anteriors i se li permetrà triar si signar o cancel·lar l'operació.
  • allowCosigningUnregisteredSignatures:
    • true: Permet signar documents PDF amb signatures prèvies no registrades.
    • false: No permet signar documents PDF amb signatures prèvies no registrades.
  • signingCertificateV2:
    • true: S'utilitza l'atribut signingCertificateV2 en les signatures.
    • false: S'utilitza l'atribut signingCertificateV1 en les signatures.
    • S'omet: S'utilitza l'atribut signingCertificateV1 en les signatures SHA1withRSA i signingCertificateV2 en la resta.
  • signReservedSize:
    • Grandària màxima en bytes de la signatura que s'incorporarà al PDF. Per defecte, 27000.
  • signingCertificateV2:
    • true: S'utilitza l'atribut signingCertificateV2 en les signatures.
    • false: S'utilitza l'atribut signingCertificateV1 en les signatures.
    • S'omet: S'utilitza l'atribut signingCertificateV1 en les signatures SHA1withRSA i signingCertificateV2 en la resta.
  • allowShadowAttack:
    • true: No es realitzarà la comprovació de PDF Shadow Attack durant la validació de les signatures prèvies.
    • false: Es realitzarà la comprovació de PDF Shadow Attack durant la validació de les signatures prèvies i, en cas de detectar-se, es donarà la signatura per invàlida.
    • S'omet: Es realitzarà la comprovació de PDF Shadow Attack durant la validació de les signatures prèvies i, en cas de detectar-se, es consultarà a l'usuari si s'ha de continuar amb l'operació.
  • allowModifiedForm:
    • true: No es realitzarà la comprovació de canvis en els formularis del document ni PDF Shadow Attack durant la validació de les signatures prèvies.
    • false: Es realitzarà la comprovació de canvis en els formularis del document durant la validació de les signatures prèvies i, en cas de detectar-se, es donarà la signatura per invàlida.
    • S'omet: Es realitzarà la comprovació de canvis en els formularis del document durant la validació de les signatures prèvies i, en cas de detectar-se, es consultarà a l'usuari si s'ha de continuar amb l'operació.

Español | Català | Euskera | Galego | Valencià | English

⚠️ **GitHub.com Fallback** ⚠️