execCommand corrupts multi-byte UTF-8 output split across channel data chunks

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#487 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
78/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
nodejs, typescript
Domaine
networking

Piste de recherche

Le bogue se trouve dans execCommand de src/index.ts (lignes 394-401), où les gestionnaires data de channel et channel.stderr appellent chunk.toString(options.encoding) sur chaque morceau séparément. Commence par exécuter le script de reproduction du ticket et lis ces gestionnaires avec le wrapper exec qui appelle execCommand. C'est terminé lorsque la reproduction affiche equal: true avec une longueur de 12000 et que stdout ne contient plus de U+FFFD autour du point de coupure.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

execCommand (and exec, which calls it) decodes each SSH channel data chunk on its own with chunk.toString(options.encoding), so any multi-byte UTF-8 character whose bytes straddle two SSH packets (for example at the default 32 KiB channel packet boundary) turns into U+FFFD replacement characters.

Save as repro.mjs and run npm install [email protected] && node repro.mjs:

import ssh2 from "ssh2";
import { NodeSSH } from "node-ssh";

const expected = "日".repeat(12000); // 36,000 UTF-8 bytes (> 32 KiB SSH packet size)
const hostKey = ssh2.utils.generateKeyPairSync("ed25519").private;
const server = new ssh2.Server({ hostKeys: [hostKey] }, (client) => {
  client.on("authentication", (ctx) => ctx.accept());
  client.on("session", (accept) => accept().on("exec", (accept) => {
    const ch = accept();
    ch.write(expected);
    ch.exit(0);
    ch.end();
  }));
});
await new Promise((r) => server.listen(0, "127.0.0.1", r));

const ssh = new NodeSSH();
await ssh.connect({ host: "127.0.0.1", port: server.address().port, username: "u", password: "p" });
const { stdout } = await ssh.execCommand("cat file.txt");
console.log({
  equal: stdout === expected,
  length: stdout.length,
  codePointsAroundSplit: [...stdout.slice(10921, 10925)].map((c) => c.codePointAt(0).toString(16)),
});
ssh.dispose();
server.close();

Actual:

{
  equal: false,
  length: 12001,
  codePointsAroundSplit: [ '65e5', 'fffd', 'fffd', '65e5' ]
}

Expected:

{
  equal: true,
  length: 12000,
  codePointsAroundSplit: [ '65e5', '65e5', '65e5', '65e5' ]
}

In src/index.ts lines 394-401, channel and channel.stderr convert each chunk via chunk.toString(options.encoding) instead of collecting the Buffer chunks for Buffer.concat(chunks).toString(options.encoding) (or using StringDecoder).

Version: [email protected] ([email protected]), also reproduced on main (fca27fa), Node.js v26.13.0.

Credit: https://ucsbplse.github.io/

Langage dominant
TypeScript
Étoiles
1k
Forks
94
Aucune PR mergée en 30 j

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de steelbrain/node-ssh

Toutes les issues de steelbrain/node-ssh

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.