La commande xmlsignature-sign | xsign prend un document XML en tant qu'entrée et crée un document de sortie à signature XML utilisant les options de signature spécifiées.
raptorxmlxbrl xmlsignature-sign [options] --output=File --signature-type=Value --signature-canonicalization-method=Value --certname=Value|hmackey=Value InputFile |
•L'argument InputFile est le document XML à signer.
•L'option --output spécifie l'emplacement du document qui contient la signature XML.
Exemples
Exemples de la commande xmlsignature-sign :
•raptorxmlxbrl xsign --output=c:\SignedFile.xml --signature-type=enveloped --signature-canonicalization-method=xml-c14n11 --hmackey=secretpassword c:\SomeUnsigned.xml
RaptorXMLXBRL( et RaptorXMLXBRLServer pour des commandes d'administration) sur Windows raptorxmlxbrl( et raptorxmlxbrlserver pour des commandes d'administration) sur Windows et Unix (Linux, Mac) * Veuillez noter que la casse minuscule (raptorxmlxbrl et raptorxmlxbrlserver) fonctionne sur toutes les plate-formes (Windows, Linux et Mac), alors que la casse majuscule (RaptorXMLXBRL) fonctionne uniquement sur Windows et Mac. * Utiliser des barres obliques basculée vers l'avant sur Linux et Mac, des barres obliques basculées vers l'arrière sur Windows. |
Dans les systèmes Windows : lorsque des espaces se produisent (par exemple, dans les noms de fichier ou de dossier, ou les noms d'entreprise, de personne ou de produit), utiliser des guillemets : par exemple, "My File". Veuillez noter, néanmoins qu'une barre oblique inversée suivie par un double guillemet (par exemple, "C:\My directory\") peut ne pas être lue correctement. Cela est dû au fait que le caractère de barre oblique inversée est également utilisé pour indiquer le début d'une séquence d'échappement, et la séquence d'échappement \" représente le caractère de marque de double guillemet. Si vous souhaitez échapper cette séquence des caractères, utiliser une barre oblique inversée précédente comme ceci : \\". Pour résumer : Si vous souhaitez écrire un chemin de fichier qui contient des espaces et des barre oblique inversée de fin, l'écrire comme ceci : "C:\My Directory\\". |
Options
Les options sont recensées dans la forme abrégée (si disponible) et dans la forme longue. Vous pouvez utiliser un ou deux tirets pour les formes abrégées et longues. Une option peut ou ne peut pas prendre une valeur. Si elle prend une valeur, elle est écrite comme ceci : --option=value. Des valeurs peuvent être spécifiées sans guillemets sauf dans deux cas : (i) si le string valeur contient des espace, ou (ii) s'il est explicitement indiqué dans la description que des guillemets sont exigés. Si une option prend une valeur booléenne et qu'aucune valeur n'est spécifiée, alors la valeur par défaut de l'option est TRUE. Utiliser l'option --h, --help pour afficher des informations à propos de la commande.
.
output = FILE L'URL du document de sortie qui est créé avec la nouvelle signature XML. |
--verbose = true|false Une valeur de true permet la sortie d'informations supplémentaires pendant la validation. La valeur par défaut est false. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
|
--absolute-reference-uri = true|false Spécifie si l'URI du document signé doit être lu en tant qu'absolu (true) ou relatif (false). La valeur par défaut est false. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
--certname, --certificate-name = VALUE Le nom du certificat utilisé pour signer. Windows Il s'agit du nom du Sujet d'un certificat depuis le --certificate-store sélectionné. Exemple de liste des certificats (sous PowerShell) % ls cert://CurrentUser/My PSParentPath: Microsoft.PowerShell.Security\Certificate::CurrentUser\My Thumbprint Subject ---------- ------- C9DF64BB0AAF5FA73474D78B7CCFFC37C95BFC6C CN=certificate1 ... CN=... Exemple : --certificate-name==certificate1 Linux/MacOS --certname spécifie le nom de fichier d'un certificat X.509v3 à encodage PEM avec la clé privée. Ces fichiers portent généralement l'extension .pem. Exemple : --certificate-name==/path/to/certificate1.pem |
--certstore, --certificate-store = VALUE L'emplacement où le certificat spécifié par --certificate-name est stocké. Windows Le nom d'un magasin de certificat sous cert://CurrentUser. Les magasins de certificat disponibles peuvent être listés (sous PowerShell) à l'aide de % ls cert://CurrentUser/. Les certificats seraient donc listés comme suit : Name : TrustedPublisher Name : ClientAuthIssuer Name : Root Name : UserDS Name : CA Name : ACRS Name : REQUEST Name : AuthRoot Name : MSIEHistoryJournal Name : TrustedPeople Name : MyCertStore Name : Local NonRemovable Certificates Name : SmartCardRoot Name : Trust Name : Disallowed Exemple : --certificate-store==MyCertStore Linux/MacOS L'option --certstore n'est actuellement pas prise en charge. |
--digest, --digest-method = sha1|sha256|sha384|sha512 L'algorithme utilisé pour calculer la valeur de digest par rapport au fichier XML d'entrée. |
--hmackey, --hmac-secret-key = VALUE La clé secrète partagée HMAC ; doit avoir une longueur minimum de six caractères. Exemple : --hmackey=secretpassword |
--hmaclen, --hmac-output-length = LENGTH Tronque la sortie de l'algorithme HMAC à des bits LENGTH. Si spécifiée, cette valeur doit être •un multiple de 8 •supérieur à 80 •supérieur à la moitié de la longueur de sortie de l'algorithme hash sous-jacent |
--keyinfo, --append-keyinfo = true|false Spécifie si vous souhaitez inclure l'élément KeyInfo dans la signature ou pas. La valeur par défaut est false. |
--sigc14nmeth, --signature-canonicalization-method = VALUE Spécifie l'algorithme de canonicalisation à appliquer à l'élément SignedInfo. La valeur doit être une des suivantes : •REC-xml-c14n-20010315 •xml-c14n11 •xml-exc-c14n# |
--sigmeth, --signature-method = VALUE Spécifie l'algorithme à utiliser pour générer la signature. Lorsqu'un certificat est utiliséSi un certificat est spécifié, alors--signature-method est optionnel et la valeur pour ce paramètre est dérivé du certificat. Lorsqu'il est spécifié, il doit correspondre à l'algorithme utilisé par le certificat. Exemple : --signature-method=rsa-sha256 Lorsque --hmac-secret-key est utiliséLorsque --hmac-secret-key est utilisé, cette option est obligatoire. La valeur doit être un des algorithmes HMAC pris en charge : •hmac-sha256 •hmac-sha386 •hmac-sha512 •hmac-sha1 (découragé par la spécification) Exemple : --signature-method=hmac-sha256 |
--sigtype, --signature-type = detached | enveloping | enveloped Spécifie le type de signature à générer. |
--transforms = VALUE Spécifie les transformations de Signature XML appliquées au document d'entrée. Cette option peut être spécifiée plusieurs fois. Dans ce cas, l'ordre de la spécification est important. La première transformation spécifiée reçoit le document d'entrée. La dernière transformation spécifiée est utilisée immédiatement avant le calcul de la valeur digest. Les valeurs prises en charge sont : •REC-xml-c14n-20010315 pour Canonical XML 1.0 (sans commentaires) •xml-c14n11 pour Canonical XML 1.1 (sans comments) •xml-exc-c14n# pour Exclusive XML Canonicalization 1.0 (sans commentaires) •REC-xml-c14n-20010315#WithComments pour Canonical XML 1.0 (avec commentaires) •xml-c14n11#WithComments pour Canonical XML 1.1 (avec commentaires) •xml-exc-c14n#WithComments pour Exclusive XML Canonicalization 1.0 (avec commentaires) •base64 •strip-whitespaces extension Altova Exemple : --transforms=xml-c14n11 Note: Cette option peut être spécifiée plusieurs fois. Si elle est spécifiée plusieurs fois, l'ordre de spécification est significatif. La première transformation spécifiée reçoit le document d'entrée. La dernière transformation spécifiée est utilisée juste avant le calcul de la valeur de digest. |
--write-default-attributes = true|false Spécifie s'il faut inclure les valeur d'attribut par défaut depuis le DTD dans le document signé. |
|
--help Affiche le texte d'aide pour la commande. Par exemple, valany --h. (en alternative, la commande help peut être utilisée avec un argument. Par exemple : help valany.) |
--version Affiche la version de RaptorXML+XBRL Server. Si utilisé avec une commande, placer --version avant la commande. |
|
