Enforce SHA-384 signatures in Node SDK

Offen
  • Stimmt etwas nicht?
#400 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

  • #401 von @tim-kos — ohne Merge geschlossen

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
65/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
node.js, typescript
Bereich
api, authentication, security

Rechercherichtung

Finde _calcSignature() und den öffentlichen Einstiegspunkt calcSignature(), und untersuche anschließend die vorhandenen Signaturtests und die README. Bestätige die aktuelle Verarbeitung des Algorithmus und füge Abdeckung für ein zusätzliches Algorithmusargument hinzu; als abgeschlossen gilt die Aufgabe, wenn signierte Anfragen und das dokumentierte Verhalten von calcSignature() konsistent sha384 verwenden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Problem

Our API keys default to sha384 signatures, but the SDK's private _calcSignature() currently accepts an algorithm argument. That makes it possible for consumers (or downstream wrappers) to generate sha1 signatures from the SDK surface, which can fail against accounts/keys configured for sha384 and causes avoidable auth failures.

Expected behavior

The SDK should consistently generate sha384 signatures for signed requests.

Proposed fix

  • Remove algorithm override support from _calcSignature() and always sign with sha384.
  • Add a regression test to ensure we keep emitting sha384 even if an extra algorithm argument is passed.
  • Document in README that calcSignature() returns sha384 signatures.

Context

This aligns SDK behavior with modern API key defaults and avoids signature-algorithm drift in downstream integrations.

Vorherrschende Sprache
TypeScript
Sterne
73
Forks
26
Ø Merge
6 Std. 26 Min.
Gemergte PRs (30 T.)
71

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus transloadit/node-sdk

Alle Issues in transloadit/node-sdk

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.