Interface: HttpJwtAuth

A JSON Web Token the host signs for each request: the claims in payload, under secret (HS256, HS384, HS512) or the PEM privateKey (RS* and PS*, an RSA key of 2048 bits or more; ES*, a key on the algorithm's curve), with jwtHeaders beside alg in its header. Sent as authorization: <headerPrefix><token>, or as the query parameter paramName.

Properties

addTo?

optional addTo?: HttpAuthAddTo;

---

algorithm?

optional algorithm?: HttpJwtAlgorithm;

HS256 by default.

---

authType

authType: "jwt";

---

headerPrefix?

optional headerPrefix?: string;

By default Bearer and a space.

---

isSecretBase64Encoded?

optional isSecretBase64Encoded?: boolean;

secret is base64 text, decoded to the key's bytes.

---

jwtHeaders?

optional jwtHeaders?: Record<string, unknown>;

Header parameters besides alg (kid, typ...).

---

paramName?

optional paramName?: string;

token by default.

---

payload?

optional payload?: Record<string, unknown>;

The claims, as given: the host adds none. iat, nbf and exp may be text relative to the signing time, 'now', '5m' or '-30s' (seconds, minutes, hours or days).

---

privateKey?

optional privateKey?: string;

The PEM private key, for RS*, PS* and ES*: ctx.secret(name).

---

secret?

optional secret?: string;

The HMAC secret, for HS*: ctx.secret(name).