El comando xmlsignature-sign | xsign toma como entrada un documento XML y crea un documento con firma XML de salida usando las opciones de firma especificadas.
Windows | RaptorXMLXBRL xmlsignature-sign [opciones] --output=Archivo --signature-type=Valor
--signature-canonicalization-method=Valor --certname=Value|hmackey=Valor ArchivoEntrada |
Linux | raptorxmlxbrl xmlsignature-sign [opciones] --output=Archivo --signature-type=Valor
--signature-canonicalization-method=Valor --certname=Value|hmackey=Valor ArchivoEntrada |
Mac | raptorxmlxbrl xmlsignature-sign [opciones] --output=Archivo --signature-type=Valor
--signature-canonicalization-method=Valor --certname=Value|hmackey=Valor ArchivoEntrada |
El argumento ArchivoEntrada es el documento XML que se debe firmar. La opción --output especifica la ubicación del documento que contiene la firma XML.
Ejemplos
•raptorxmlxbrl xsign --output=c:\ArchivoFirmado.xml --signature-type=enveloped --signature-canonicalization-method=xml-c14n11 c:\ArchivoSinFirmar.xml
RaptorXMLXBRL (y RaptorXMLXBRLServer para comandos administrativos) en Windows raptorxmlxbrl (y raptorxmlxbrlserver para comandos administrativos) en Windows y Unix (Linux, Mac) * Las minúsculas (raptorxmlxbrl y raptorxmlxbrlserver) funcionan en todas las plataformas (Windows, Linux y Mac), mientras que las mayúsculas (RaptorXMLXBRL) funcionan solamente en Windows y Mac. * Use la barra diagonal en Linux y Mac y la barra diagonal inversa en Windows. |
En sistemas Windows: si hay espacios o caracteres especiales (por ejemplo en los nombres de archivos o de carpetas, empresas, personas o productos) debe usar comillas: por ejemplo, "Mi archivo". Sin embargo, debe tener en cuenta que una barra diagonal inversa seguida de comillas dobles (por ejemplo, "C:\Mi Directorio\") es posible que no se lea correctamente. Esto se debe a que la barra diagonal inversa también se usa para empezar secuencias de escape y la secuencia de escape \" también usa las comillas dobles. Para evitar secuencia de caracteres puede añadir otra barra diagonal inversa: \\". En resumen: si necesita escribir una ruta que contenga espacios y una barra diagonal inversa, esta es la mejor forma de hacerlo: "C:\Mi Directorio\\". |
Opciones
Las opciones del comando aparecen más abajo divididas en grupos. Los valores se pueden dar sin comillas excepto en estos dos casos: (i) cuando la cadena de valor contiene espacios y (ii) cuando en la descripción de la opción se indique explícitamente que es necesario el uso de comillas. Si una opción toma un valor booleano y no se indica ningún valor, entonces el valor predeterminado de la opción es TRUE. Use la opción --h, --help para ver información sobre el comando.
output = ARCHIVO La URL del documento de salida que se crea con la nueva firma XML. |
--verbose = true|false Si el valor es true, se genera información adicional durante la validación. Valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
|
--absolute-reference-uri = true|false Especifica si el URI del documento firmado debe leerse como absoluto (true) o relativo (false). El valor predeterminado es false. Nota: si no se especifica un valor para la opción, el valor booleano de la opción se establece en true. |
--certname, --certificate-name = VALOR El nombre del certificado utilizado para firmar. Windows Se trata del nombre Subject de un certificado del almacén de certificados (--certificate-store) seleccionado. Ejemplo para enumerar los certificados (bajo PowerShell) % ls cert://UsuarioActual/My PSParentPath: Microsoft.PowerShell.Security\Certificate::UsuarioActual\My Thumbprint Subject ---------- ------- C9DF64BB0AAF5FA73474D78B7CCFFC37C95BFC6C CN=certificate1 ... CN=... Ejemplo: --certificate-name==certificado1 Linux/macOS --certname especifica el nombre de archivo de un certificado X.509v3 con cifrado PEM con la clave privada. Estos archivos suelen tener la extensión .pem. Ejemplo: --certificate-name==/ruta/de/certificado1.pem |
--certstore, --certificate-store = VALOR La ubicación donde está almacenado el certificado especificado con --certificate-name. Windows Nombre de un almacén de certificados situado dentro de cert://UsuarioActual. Los almacenes de certificados disponibles se pueden enumerar (bajo PowerShell) usando % ls cert://UsuarioActual/. Los certificados se enumerarán de la siguiente manera: Nombre : TrustedPublisher Nombre : ClientAuthIssuer Nombre : Root Nombre : UserDS Nombre : CA Nombre : ACRS Nombre : REQUEST Nombre : AuthRoot Nombre : MSIEHistoryJournal Nombre : TrustedPeople Nombre : MyCertStore Nombre : Local NonRemovable Certificates Nombre : SmartCardRoot Nombre : Trust Nombre : Disallowed Ejemplo: --certificate-store==MiAlmacénCertificados Linux/MacOS La opción --certstore no es compatible por ahora. |
--digest, --digest-method = sha1|sha256|sha384|sha512 El algoritmo que se usa para computar el valor del resumen (digest) dentro del archivo XML de entrada. Los valores disponibles son: sha1|sha256|sha384|sha512. |
--hmackey, --hmac-secret-key = VALOR La clave secreta compartida HMAC. Debe tener una longitud mínima de seis caracteres. Ejemplo: --hmackey=contraseñaSecreta |
--hmaclen, --hmac-output-length = LONGITUD Trunca el resultado del algoritmo HMAC hasta el número de bits indicado por LONGITUD. Si se especifica, este valor debe ser: •múltiplo de 8, •mayor que 80 y •mayor que la mitad de la longitud de salida del algoritmo hash subyacente. |
--keyinfo, --append-keyinfo = true|false Especifica si se debe incluir el elemento KeyInfo en la firma o no. El valor predeterminado es false. |
--sigc14nmeth, --signature-canonicalization-method = VALOR Especifica el algoritmo de canonización que se debe aplicar al elemento SignedInfo. El valor debe ser uno de estos tres valores: •REC-xml-c14n-20010315 •xml-c14n11 •xml-exc-c14n# |
--sigmeth, --signature-method = VALOR Especifica el algoritmo que se debe usar para generar la firma. Cuando se usa un certificadoSi se especificó un certificado, entonces --signature-method es opcional y el valor para este parámetro se deriva del certificado. Debe coincidir con el algoritmo utilizado por el certificado. Ejemplo: --signature-method=rsa-sha256 Cuando se usa --hmac-secret-keySi se usa la opción --hmac-secret-key, entonces esta opción es obligatoria. El valor debe ser uno de los algoritmos HMAC compatibles: •hmac-sha256 •hmac-sha386 •hmac-sha512 •hmac-sha1 (no recomendable según la especificación) Ejemplo: --signature-method=hmac-sha256 |
--sigtype, --signature-type = detached | enveloping | enveloped Especifica el tipo de firma que se debe generar (separada, envolvente o envuelta). |
--transforms = VALOR Especifica las transformaciones de firma XML aplicadas al documento de entrada. Los valores compatibles son: •REC-xml-c14n-20010315 para Canonical XML 1.0 (sin comentarios) •xml-c14n11 para Canonical XML 1.1 (sin comentarios) •xml-exc-c14n# para Exclusive XML Canonicalization 1.0 (sin comentarios) •REC-xml-c14n-20010315#WithComments para Canonical XML 1.0 (con comentarios) •xml-c14n11#WithComments para Canonical XML 1.1 (con comentarios) •xml-exc-c14n#WithComments para Exclusive XML Canonicalization 1.0 (con comentarios) •base64 •Extensión de Altova strip-whitespaces Ejemplo: --transforms=xml-c14n11 Nota: Esta opción se puede especificar más de una vez. Si se especifica varias veces, el orden en que se especifica es importante. La primera transformación especificada recibe el documento de entrada. La última se utiliza inmediatamente antes de calcular el valor implícito. |
--write-default-attributes = true|false Especifica si se deben incluir los valores de atributo predeterminados de la DTD en el documento firmado. |
|
|
--help Muestra el texto de ayuda para el comando. Por ejemplo valany --h. (Otra opción es usar el comando help con un argumento. Por ejemplo: help valany). |
--version Muestra el número de versión de RaptorXML+XBRL Server. Si se utiliza con un comando, escriba la opción --version antes del comando. |
|
