Interface: HttpSign

A signature the host computes over the final request and sets as header: the HMAC of prefix + the body bytes as sent + suffix, under a secret of the install or a literal key. In prefix and suffix the host fills the ctx.secret(name) placeholders and the request as it goes out, in one pass: {{request:method}}, {{request:target}} (the path and the query exactly as sent, an auth's query parameters included) and {{request:host}} (the host header). A request whose headers or auth set header already is refused.

Properties

algorithm

algorithm: HmacAlgorithm;

---

encoding?

optional encoding?: "base64" | "hex";

The signature's encoding in the header: hex (the default) or base64.

---

header

header: string;

---

key

key: HmacKey;

---

keyEncoding?

optional keyEncoding?: HmacKeyEncoding;

How the key's text becomes bytes (HmacKeyEncoding): utf8 by default.

---

prefix?

optional prefix?: string;

---

suffix?

optional suffix?: string;