cClaude.rocks ☕ Le blog

Au hasard d’une mise à jour de Linux Mint, j’ai découvert l’existence de la commande xxd.

A quoi sert commande xxd ?

Elle permet de faire un hexdump d’un fichier ou de reconstituer un fichier à partir d’un hexdump. De manière plus générale, elle convertit un flux en représentation hexadécimale et inversement.

C’est quoi un hexdump

Littéralement c’est le fait de déverser un fichier sous la forme hexadécimale.

Voici un exemple xxd FICHIER :

00000000: 4a42 414b 450a 3d3d 3d3d 3d0a 0a2a 2a4a  JBAKE.=====..**J
00000010: 4261 6b65 2a2a 2069 7320 6120 4a61 7661  Bake** is a Java
00000020: 2062 6173 6564 2c20 6f70 656e 2073 6f75   based, open sou
00000030: 7263 652c 2073 7461 7469 6320 7369 7465  rce, static site
00000040: 2f62 6c6f 6720 6765 6e65 7261 746f 7220  /blog generator
00000050: 666f 7220 6465 7665 6c6f 7065 7273 2026  for developers &
00000060: 2064 6573 6967 6e65 7273 0a0a 0a54 6f20   designers...To
00000070: 6275 696c 6420 7468 6520 626c 6f67 2066  build the blog f
00000080: 726f 6d20 736f 7572 6365 2060 6a62 616b  rom source `jbak
00000090: 6560 2069 7320 7265 7175 6972 6564 2e20  e` is required.
000000a0: 5369 6e63 6520 606a 6261 6b65 6020 6973  Since `jbake` is

Et concrètement, ça sert à quoi ?

xxd crée un fichier (ou un flux sur la sortie standard) contenant la représentation hexadécimale d’un fichier binaire ou de l’entrée standard.

xxd permet également de convertir un fichier de codes hexadécimaux en un fichier binaire.

Comme uuencode et uudecode il permet la transmission de données binaires dans une représentation ASCII compatible avec le courrier électronique, mais a l’avantage de décoder la sortie standard.

L’aspect le plus intéressant de la commande xxd est qu’elle peut être utilisée pour appliquer des rustines (patch) à des fichiers binaires. En gros cela permet de « bidouiller » des fichiers binaires.

Elle permet de générer très simplement le code C équivalent au fichier donné.

Une vraie commande de geek

Une commande vraiment étrange dans ces comportements, il est nécessaire de bien lire le manuel…

D’abord une mise en garde, la gestion des erreurs est très incomplète. Donc ce n’est sans doute pas une bonne idée que de l’utiliser dans une chaîne de traitement, tout du moins, sans prendre de précaution.

Pour la lecture des paramètres, un analyseur simplifié (lasy) est utilisé. Il ne vérifie pas au-delà de la première lettre de l’option, à moins que cette dernière ne requiert un paramètre. L’espace entre l’option et son paramètre est optionnel.

Les paramètres des options peuvent être spécifiés en notation décimale, hexadécimale ou octale. Ainsi -c8, -c 8, -c 010 et -cols 8 sont tous équivalents.

Manuel

SYNOPSIS

xxd -h[elp]
xxd [options] [fichier_entree [fichier_sortie]]
xxd -r[evert] [options] [fichier_entree [fichier_sortie]]

OPTIONS

• Si aucun fichier_entree n’est spécifié, l’entrée standard est utilisée.
• Si fichier_entree correspond au caractère ’-’ l’entrée standard est utilisée comme source des données.
• Si aucun fichier_sortie n’est spécifié (ou qu’un caractère ’-’ est donné à sa place), le résultat est envoyé sur la sortie standard.

-a | -autoskip

Active la fonctionnalité « autoskip » : le caractère ’*’ remplace les lignes d’octets nuls. Désactivée par défaut.

-b | -bits

Convertis en binaires plutôt qu’en hexadécimal. Cette option écrit les octets comme une séquence de « 1 » et de « 0 » au lieu d’une conversion en hexadécimal traditionnel. Chaque ligne est précédée par un numéro de ligne en hexadécimal et suivie de la représentation ASCII (ou EBCDIC) correspondante. Les options -r, -p, -i ne fonctionnent pas dans ce mode.

-c cols | -cols cols

Place « cols » octets par ligne. 16 par défaut (-i : 12, -ps : 30, -b : 6). Maximum 256.

-E | -EBCDIC

Passe le codage des caractères de la colonne de droite de ASCII à EBCDIC. Cela ne change pas la représentation hexadécimale. Cette option est sans effet quand elle est utilisée avec -r, -p or -i.

-g octets | -groupsize octets

Regroupe les octets (deux chiffres hexadécimaux ou huit chiffres binaires) par groupe de « octets » séparés par des espaces blancs. Spécifiez -g 0 pour supprimer le regroupement. « octets » vaut 2 par défaut dans le mode normal et 1 en représentation binaire. Le regroupement ne s’applique pas aux styles Postscript et Include.

-h | -help

Affiche un résumé des commandes disponibles et quitte. Aucune conversion n’est effectuée.

-i | -include

Produit une sortie dans le style #include (fichier C à inclure). La définition complète d’un tableau statique est écrite et est nommée d’après le fichier d’origine, à moins que xxd lise depuis l’entrée standard.

-l long | -len long

Arrête après l’écriture de « long » octets.

-p | -ps | -postscript | -plain

Produit une conversion continue dans le style Postscript (postscript continuous hexdumd style). Également connu sous le nom de « conversion brute » (plain hexdump style).

-r | -revert

Opération inverse : convertis un fichier hexadécimal en un fichier binaire (ou applique une rustine à un fichier binaire).

Si l’écriture n’a pas lieu sur la sortie standard, xxd écrit dans le fichier qu’il produit sans le tronquer. Utilisez la combinaison -r -p pour lire de l’hexadécimal brut sans information sur le numéro des lignes et sans format de colonnes particulier. Des espaces blancs et coupures de lignes supplémentaires sont autorisés à n’importe quel endroit.

-seek décalage

Utilisé après l’option -r inverse la conversion en ajoutant « décalage » aux positions dans le fichier donné dans le code hexadécimal.

-s [+][-]décalage

Débute au « décalage » absolu ou relatif dans fichier_entree. + indique que le décalage est relatif à la position courante dans l’entrée standard (sans effet si la lecture n’a pas lieu sur l’entrée standard). - indique un décalage en caractères depuis la fin de l’entrée (utilisé avec +, désigne la position avant la position actuelle de l’entrée standard). Sans l’option -s, xxd démarre à la position courante du fichier.

-u

Utilise des chiffres hexadécimaux majuscules. La casse par défaut est minuscule.

-v | -version

Affiche la version de xxd.

MISE EN GARDE

xxd -r effectue des opérations internes un peu obscures lors de l’évaluation des informations sur les numéros de lignes. Si le fichier de sortie est adressable, alors les numéros de lignes au début de chaque ligne d’hexadécimal peuvent être désordonnées, des lignes peuvent manquer ou se chevaucher. Dans ces cas, xxd utilisera lseek(2) pour déterminer la prochaine position. Si le fichier n’est pas adressable, seuls les vides sont autorisés, et ils seront comblés par des octets nuls.

xxd -r ne génère aucune erreur lors de l’analyse. Le problème sont passés silencieusement.

Lors de l’édition de la représentation hexadécimale, veuillez noter que xxd -r ignore tout ce qui se trouve sur la ligne après avoir lu suffisamment de données hexadécimales (voir l’option -c). Cela signifie également que les modifications dans la colonne ASCII (ou EBCDIC) sont toujours ignorées. La conversion inverse de données hexadécimales brutes (postscript) avec xxd -r -p ne dépend pas d’un nombre correct de colonnes. Dans ce cas, tout ce qui ressemble à une paire de chiffres hexadécimaux est interprété.

Remarquez la différence entre :

xxd -i fichier

et

xxd -i < fichier

xxd -s +seek peut différer de xxd -s seek, car lseek(2) est utilisé pour « revenir en arrière ». Le ’+’ fait une différence quand la source des données est l’entrée standard et si la position dans le fichier de l’entrée standard n’est pas au début du fichier lorsque xxd est démarré et qu’il reçoit ses données. L’exemple suivant peut vous aider à comprendre (ou bien vous perdre davantage encore !)…

Remettre l’entrée standard au départ avant de lire ; nécessaire car ’cat’ a déjà lu jusqu’à la fin de l’entrée standard.

sh -c cat > donnees_binaires; xxd -s 0 > donnees_hexa < fichier

Convertir à partir de la position 0x480 (= 1024 + 128) du fichier. Le symbole ’+’ signifie « relativement à la position actuelle », ainsi 128 est ajouté aux 1024 octets comptabilisés pour dd.

sh -c dd of=donnees_binaires bs=1k count=1; xxd -s +128 > donnees_hexa < fichier

Convertir de fichier depuis la position 0x100 (= 1024 — 768) du fichier.

sh -c dd of=donnees_binaires bs=1k count=1; xxd -s +-768 > donnees_hexa < fichier

Toutefois, cette situation est peu fréquente et l’utilisation de ’+’ est rarement requise. L’auteur préfère surveiller les effets de xxd avec strace(1) ou truss(1) quand -s est employé.

EXEMPLES

Afficher la totalité du fichier sauf les trois premières lignes (0x30 octets en hexadécimal).

xxd -s 0x30 fichier

Afficher les trois dernières lignes (0x30 octets en hexadécimal) du fichier

xxd -s -0x30 fichier

Afficher 120 octets convertis en continu, avec 20 octets par ligne.

xxd -l 120 -ps -c 20 xxd.1

2e54482058584420312022616ffb742031393936
22202250616765206465206d616e75656c20706f
757220787864220a2e5c220a2e5c222032317374
204d617920313939360a2e5c22204d616e207061
676520617574686f723a0a2e5c2220202020546f
6e79204e7567656e74203c746f6e79407363746e
204e7567656e74203c746f6e79407363746e7567
2e54482058584420312022417567757374203139

Convertir les 120 premiers octets de cette page de manuel avec 12 octets par ligne.

xxd -l 120 -c 12 xxd.1

0000000: 2e54 4820 5858 4420 3120 2241  .TH XXD 1 "A
000000c: 7567 7573 7420 3139 3936 2220  ugust 1996"
0000018: 224d 616e 7561 6c20 7061 6765  "Manual page
0000024: 2066 6f72 2078 7864 220a 2e5c   for xxd"..\
0000030: 220a 2e5c 2220 3231 7374 204d  "..\" 21st M
000003c: 6179 2031 3939 360a 2e5c 2220  ay 1996..\"
0000048: 4d61 6e20 7061 6765 2061 7574  Man page aut
0000054: 686f 723a 0a2e 5c22 2020 2020  hor:..\"
0000060: 546f 6e79 204e 7567 656e 7420  Tony Nugent
000006c: 3c74 6f6e 7940 7363 746e 7567  <tony@sctnug

Afficher la date écrite au début du fichier xxd.1.

xxd -s 0x38 -l 13 -c 13 xxd.1

0000036: 3231 7374 204d 6179 2031 3939 36  21st May 1996

Copier fichier_entree vers fichier_sortie en ajoutant 100 octets de valeur 0x00 avant.

xxd fichier_entree | xxd -r -s 100 > fichier_sortie

Patcher la date dans le fichier xxd.1

echo "0000037: 3574 68" | xxd -r - xxd.1
xxd -s 0x36 -l 13 -c 13 xxd.1

0000036: 3235 7468 204d 6179 2031 3939 36  25th May 1996

Créer un fichier de 65 537 octets tous nuls (0x00), sauf le dernier qui vaut ’A’ (0x41 en hexadécimal).

echo 010000: 41 | xxd -r > fichier

Convertir le fichier de l’exemple précédent avec la fonctionnalité « autoskip ».

xxd -a -c 12 fichier

0000000: 0000 0000 0000 0000 0000 0000  ............
*
000fffc: 0000 0000 40                   ....A

Créer un fichier d’un octet, contenant seulement le caractère 'A'. Les nombres après -r -s s’ajoutent aux numéros de lignes trouvées dans le fichier ; les octets initiaux sont supprimés.

echo 010000: 41 | xxd -r -s -0x10000 > fichier

Utiliser xxd comme filtre dans un éditeur tel que vim(1) pour convertir une zone comprise entre les marques ’a’ et ’z’.

:a,z!xxd

Utiliser xxd comme filtre dans un éditeur tel que vim(1) pour récupérer une conversion binaire comprise entre les marques ’a’ et ’z’.

:a,z!xxd -r

Utiliser xxd comme filtre dans un éditeur tel que vim(1) pour récupérer une ligne convertie. Placez le curseur sur la ligne et tapez :

!!xxd -r

Lire des caractères depuis une connexion série :

xxd -c1 < /dev/term/b &
stty < /dev/term/b -echo -opost -isig -icanon min 1
echo -n foo > /dev/term/b

VALEURS DE RETOUR

Les erreurs suivantes sont rapportées :

AVERTISSEMENTS

L’étrangeté de cet outil reflète celle du cerveau de ses créateurs. Utilisez cet outil à vos risques et périls. Dupliquez vos fichiers. Surveillez l’outil. Devenez un gourou.

Références

• Man page xxd,
• Le système hexadécimal.

ᦿ