@celljs/jwt 4.3.0 → 4.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -3,14 +3,14 @@
3
3
  `JwtService` signs, verifies and decodes JSON Web Tokens with `node:crypto` (no third-party dependency). Algorithms: `HS256/384/512`, `RS256/384/512`, `PS256/384/512`, `ES256/384/512`, and `none` only when listed in `algorithms`.
4
4
 
5
5
  ```yaml
6
- backend:
7
- cell:
8
- jwt:
9
- secret: ${env.JWT_SECRET} # or privateKey / publicKey (PEM)
10
- signOptions:
11
- expiresIn: 2h
6
+ jwt:
7
+ secret: ${env.JWT_SECRET} # or privateKey / publicKey (PEM)
8
+ signOptions:
9
+ expiresIn: 2h
12
10
  ```
13
11
 
14
12
  The options, defaults, checks and error messages are those of the `jsonwebtoken` package, so tokens made by either verify with the other: `expiresIn` / `notBefore` / `maxAge` take seconds or `'2h'`, `'7 days'`; `verify` checks `audience` (strings or RegExps), `issuer`, `subject`, `jwtid`, `nonce`, with `clockTolerance`. Failures are `JsonWebTokenError`, `TokenExpiredError` (`expiredAt`) and `NotBeforeError` (`date`). The key must fit the algorithm: an HMAC secret for `HS*`, an RSA key of at least 2048 bits for `RS*` / `PS*` (`allowInsecureKeySizes` to allow less), an EC key on the matching curve for `ES*`.
15
13
 
14
+ An HMAC `secret` shorter than 32 bytes (without `privateKey`) is reported as `CELL_SECURITY_WEAK_JWT_SECRET` by `cell check` and by a production start (`securityChecks` of `@celljs/core`): a short secret can be brute-forced from one token. Use `openssl rand -base64 48`, or an RSA / EC key pair.
15
+
16
16
  `JwtUtil.sign / verify / decode` do the same without the container.
@@ -0,0 +1,29 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "properties": {
4
+ "jwt": {
5
+ "type": "object",
6
+ "description": "JSON Web Tokens.",
7
+ "properties": {
8
+ "secret": {
9
+ "type": "string",
10
+ "description": "Secret of HS* signatures."
11
+ },
12
+ "publicKey": {
13
+ "type": "string"
14
+ },
15
+ "privateKey": {
16
+ "type": "string"
17
+ },
18
+ "signOptions": {
19
+ "type": "object",
20
+ "additionalProperties": true
21
+ },
22
+ "verifyOptions": {
23
+ "type": "object",
24
+ "additionalProperties": true
25
+ }
26
+ }
27
+ }
28
+ }
29
+ }
@@ -3,3 +3,4 @@ export * from './jwt-service.js';
3
3
  export * from './errors.js';
4
4
  export * from './jwt-secret-service.js';
5
5
  export * from './jwt-util.js';
6
+ export * from './jwt-security-check.js';
package/esm/node/index.js CHANGED
@@ -3,4 +3,5 @@ export * from './jwt-service.js';
3
3
  export * from './errors.js';
4
4
  export * from './jwt-secret-service.js';
5
5
  export * from './jwt-util.js';
6
+ export * from './jwt-security-check.js';
6
7
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAAA,cAAc,sBAAsB,CAAC"}
@@ -31,7 +31,7 @@ let jwtSecretService = class jwtSecretService {
31
31
  }
32
32
  };
33
33
  __decorate([
34
- Value('cell.jwt'),
34
+ Value('jwt'),
35
35
  __metadata("design:type", Object)
36
36
  ], jwtSecretService.prototype, "jwtOptions", void 0);
37
37
  jwtSecretService = __decorate([
@@ -1 +1 @@
1
- {"version":3,"file":"jwt-secret-service.js","sourceRoot":"","sources":["../../src/node/jwt-secret-service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAC3E,OAAO,EAAc,gBAAgB,EAAU,MAAM,gBAAgB,CAAC;AAG/D,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAKzB,KAAK,CAAC,YAAY;;;QACd,MAAM,MAAM,SAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,SAAS,mCAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACrE,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,sBAAsB,EAAE,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,aAAa;;;QACf,MAAM,MAAM,SAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,UAAU,mCAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACtE,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,uBAAuB,EAAE,CAAC;IACxC,CAAC;CACJ,CAAA;AAjBsB;IADlB,KAAK,CAAC,UAAU,CAAC;;oDACyB;AAHlC,gBAAgB;IAD5B,SAAS,CAAC,gBAAgB,CAAC;GACf,gBAAgB,CAoB5B"}
1
+ {"version":3,"file":"jwt-secret-service.js","sourceRoot":"","sources":["../../src/node/jwt-secret-service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAC3E,OAAO,EAAc,gBAAgB,EAAU,MAAM,gBAAgB,CAAC;AAG/D,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAKzB,KAAK,CAAC,YAAY;;;QACd,MAAM,MAAM,SAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,SAAS,mCAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACrE,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,sBAAsB,EAAE,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,aAAa;;;QACf,MAAM,MAAM,SAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,UAAU,mCAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACtE,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,uBAAuB,EAAE,CAAC;IACxC,CAAC;CACJ,CAAA;AAjBsB;IADlB,KAAK,CAAC,KAAK,CAAC;;oDAC8B;AAHlC,gBAAgB;IAD5B,SAAS,CAAC,gBAAgB,CAAC;GACf,gBAAgB,CAoB5B"}
@@ -0,0 +1,9 @@
1
+ import { SecurityCheck, SecurityWarning } from '@celljs/core';
2
+ import { JwtOptions } from './jwt-protocol.js';
3
+ /** 256 bits, the size of the HS256 hash: a shorter HMAC secret can be brute-forced from one token. */
4
+ export declare const MIN_JWT_SECRET_BYTES = 32;
5
+ /** `jwt.secret` as an HMAC key (no `privateKey`, not a PEM key) must be long enough to resist guessing. */
6
+ export declare class JwtSecurityCheck implements SecurityCheck {
7
+ protected readonly jwtOptions?: JwtOptions;
8
+ check(): SecurityWarning[];
9
+ }
@@ -0,0 +1,40 @@
1
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
2
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
3
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
4
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
5
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
6
+ };
7
+ var __metadata = (this && this.__metadata) || function (k, v) {
8
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
9
+ };
10
+ import { Component, SecurityCheck, Value } from '@celljs/core';
11
+ /** 256 bits, the size of the HS256 hash: a shorter HMAC secret can be brute-forced from one token. */
12
+ export const MIN_JWT_SECRET_BYTES = 32;
13
+ /** `jwt.secret` as an HMAC key (no `privateKey`, not a PEM key) must be long enough to resist guessing. */
14
+ let JwtSecurityCheck = class JwtSecurityCheck {
15
+ check() {
16
+ var _a, _b;
17
+ const secret = (_a = this.jwtOptions) === null || _a === void 0 ? void 0 : _a.secret;
18
+ if (!secret || ((_b = this.jwtOptions) === null || _b === void 0 ? void 0 : _b.privateKey) || (typeof secret === 'string' && secret.includes('-----BEGIN'))) {
19
+ return [];
20
+ }
21
+ const bytes = typeof secret === 'string' ? Buffer.byteLength(secret) : secret.length;
22
+ if (bytes >= MIN_JWT_SECRET_BYTES) {
23
+ return [];
24
+ }
25
+ return [{
26
+ code: 'CELL_SECURITY_WEAK_JWT_SECRET',
27
+ message: `jwt.secret has ${bytes} bytes; an HMAC secret shorter than ${MIN_JWT_SECRET_BYTES} bytes can be brute-forced from a single token, and then anyone can sign tokens.`,
28
+ hint: 'Use a random secret of at least 32 bytes from the environment (secret: "${env.JWT_SECRET}", JWT_SECRET from openssl rand -base64 48), or an RSA / EC key pair.'
29
+ }];
30
+ }
31
+ };
32
+ __decorate([
33
+ Value('jwt'),
34
+ __metadata("design:type", Object)
35
+ ], JwtSecurityCheck.prototype, "jwtOptions", void 0);
36
+ JwtSecurityCheck = __decorate([
37
+ Component(SecurityCheck)
38
+ ], JwtSecurityCheck);
39
+ export { JwtSecurityCheck };
40
+ //# sourceMappingURL=jwt-security-check.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jwt-security-check.js","sourceRoot":"","sources":["../../src/node/jwt-security-check.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAmB,KAAK,EAAE,MAAM,cAAc,CAAC;AAGhF,sGAAsG;AACtG,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEvC,2GAA2G;AAEpG,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAKzB,KAAK;;QACD,MAAM,MAAM,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACvC,IAAI,CAAC,MAAM,KAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,UAAU,CAAA,IAAI,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;YAC1G,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;QACrF,IAAI,KAAK,IAAI,oBAAoB,EAAE,CAAC;YAChC,OAAO,EAAE,CAAC;QACd,CAAC;QACD,OAAO,CAAC;gBACJ,IAAI,EAAE,+BAA+B;gBACrC,OAAO,EAAE,kBAAkB,KAAK,uCAAuC,oBAAoB,kFAAkF;gBAC7K,IAAI,EAAE,gKAAgK;aACzK,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;AAjBsB;IADlB,KAAK,CAAC,KAAK,CAAC;;oDAC8B;AAHlC,gBAAgB;IAD5B,SAAS,CAAC,aAAa,CAAC;GACZ,gBAAgB,CAoB5B"}
@@ -29,7 +29,7 @@ let JwtServiceImpl = class JwtServiceImpl {
29
29
  }
30
30
  };
31
31
  __decorate([
32
- Value('cell.jwt'),
32
+ Value('jwt'),
33
33
  __metadata("design:type", Object)
34
34
  ], JwtServiceImpl.prototype, "jwtOptions", void 0);
35
35
  __decorate([
@@ -1 +1 @@
1
- {"version":3,"file":"jwt-service.js","sourceRoot":"","sources":["../../src/node/jwt-service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAyC,gBAAgB,EAAE,UAAU,EAAsC,MAAM,gBAAgB,CAAC;AACzI,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAG9B,IAAM,cAAc,GAApB,MAAM,cAAc;IAQvB,KAAK,CAAC,IAAI,CAAC,OAAiC,EAAE,OAAqB,EAAE,UAAmB;;QACpF,MAAM,aAAa,GAAG,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC;QACtE,MAAM,MAAM,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC;QACzE,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,MAAM,CAAyB,KAAa,EAAE,OAAuB,EAAE,SAA2B;;QACpG,MAAM,aAAa,GAAG,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;QACxE,MAAM,MAAM,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACvE,OAAO,OAAO,CAAC,MAAM,CAAI,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAuB;;QAC/C,aAAO,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,mCAAI,SAAS,CAAC;IACvD,CAAC;CAEJ,CAAA;AArBsB;IADlB,KAAK,CAAC,UAAU,CAAC;;kDACyB;AAGxB;IADlB,SAAS,CAAC,gBAAgB,CAAC;;wDAC0B;AAN7C,cAAc;IAD1B,SAAS,CAAC,UAAU,CAAC;GACT,cAAc,CAwB1B"}
1
+ {"version":3,"file":"jwt-service.js","sourceRoot":"","sources":["../../src/node/jwt-service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAyC,gBAAgB,EAAE,UAAU,EAAsC,MAAM,gBAAgB,CAAC;AACzI,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAG9B,IAAM,cAAc,GAApB,MAAM,cAAc;IAQvB,KAAK,CAAC,IAAI,CAAC,OAAiC,EAAE,OAAqB,EAAE,UAAmB;;QACpF,MAAM,aAAa,GAAG,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC;QACtE,MAAM,MAAM,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC;QACzE,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,MAAM,CAAyB,KAAa,EAAE,OAAuB,EAAE,SAA2B;;QACpG,MAAM,aAAa,GAAG,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;QACxE,MAAM,MAAM,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACvE,OAAO,OAAO,CAAC,MAAM,CAAI,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAuB;;QAC/C,aAAO,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,mCAAI,SAAS,CAAC;IACvD,CAAC;CAEJ,CAAA;AArBsB;IADlB,KAAK,CAAC,KAAK,CAAC;;kDAC8B;AAGxB;IADlB,SAAS,CAAC,gBAAgB,CAAC;;wDAC0B;AAN7C,cAAc;IAD1B,SAAS,CAAC,UAAU,CAAC;GACT,cAAc,CAwB1B"}
@@ -3,4 +3,5 @@ export * from './jwt-service';
3
3
  export * from './errors';
4
4
  export * from './jwt-secret-service';
5
5
  export * from './jwt-util';
6
+ export * from './jwt-security-check';
6
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAAA,cAAc,sBAAsB,CAAC"}
package/lib/node/index.js CHANGED
@@ -19,4 +19,5 @@ __exportStar(require("./jwt-service"), exports);
19
19
  __exportStar(require("./errors"), exports);
20
20
  __exportStar(require("./jwt-secret-service"), exports);
21
21
  __exportStar(require("./jwt-util"), exports);
22
+ __exportStar(require("./jwt-security-check"), exports);
22
23
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,gDAA8B;AAC9B,2CAAyB;AACzB,uDAAqC;AACrC,6CAA2B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/node/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,gDAA8B;AAC9B,2CAAyB;AACzB,uDAAqC;AACrC,6CAA2B;AAAA,uDAAqC"}
@@ -35,7 +35,7 @@ let jwtSecretService = class jwtSecretService {
35
35
  };
36
36
  exports.jwtSecretService = jwtSecretService;
37
37
  __decorate([
38
- (0, core_1.Value)('cell.jwt'),
38
+ (0, core_1.Value)('jwt'),
39
39
  __metadata("design:type", Object)
40
40
  ], jwtSecretService.prototype, "jwtOptions", void 0);
41
41
  exports.jwtSecretService = jwtSecretService = __decorate([
@@ -1 +1 @@
1
- {"version":3,"file":"jwt-secret-service.js","sourceRoot":"","sources":["../../src/node/jwt-secret-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAgD;AAChD,qCAA2E;AAC3E,iDAAsE;AAG/D,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAKzB,KAAK,CAAC,YAAY;;;QACd,MAAM,MAAM,SAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,SAAS,mCAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACrE,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,+BAAsB,EAAE,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,aAAa;;;QACf,MAAM,MAAM,SAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,UAAU,mCAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACtE,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,gCAAuB,EAAE,CAAC;IACxC,CAAC;CACJ,CAAA;;AAjBsB;IADlB,IAAA,YAAK,EAAC,UAAU,CAAC;;oDACyB;2BAHlC,gBAAgB;IAD5B,IAAA,gBAAS,EAAC,+BAAgB,CAAC;GACf,gBAAgB,CAoB5B"}
1
+ {"version":3,"file":"jwt-secret-service.js","sourceRoot":"","sources":["../../src/node/jwt-secret-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAgD;AAChD,qCAA2E;AAC3E,iDAAsE;AAG/D,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAKzB,KAAK,CAAC,YAAY;;;QACd,MAAM,MAAM,SAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,SAAS,mCAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACrE,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,+BAAsB,EAAE,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,aAAa;;;QACf,MAAM,MAAM,SAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,UAAU,mCAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACtE,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,gCAAuB,EAAE,CAAC;IACxC,CAAC;CACJ,CAAA;;AAjBsB;IADlB,IAAA,YAAK,EAAC,KAAK,CAAC;;oDAC8B;2BAHlC,gBAAgB;IAD5B,IAAA,gBAAS,EAAC,+BAAgB,CAAC;GACf,gBAAgB,CAoB5B"}
@@ -0,0 +1,10 @@
1
+ import { SecurityCheck, SecurityWarning } from '@celljs/core';
2
+ import { JwtOptions } from './jwt-protocol';
3
+ /** 256 bits, the size of the HS256 hash: a shorter HMAC secret can be brute-forced from one token. */
4
+ export declare const MIN_JWT_SECRET_BYTES = 32;
5
+ /** `jwt.secret` as an HMAC key (no `privateKey`, not a PEM key) must be long enough to resist guessing. */
6
+ export declare class JwtSecurityCheck implements SecurityCheck {
7
+ protected readonly jwtOptions?: JwtOptions;
8
+ check(): SecurityWarning[];
9
+ }
10
+ //# sourceMappingURL=jwt-security-check.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jwt-security-check.d.ts","sourceRoot":"","sources":["../../src/node/jwt-security-check.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,aAAa,EAAE,eAAe,EAAS,MAAM,cAAc,CAAC;AAChF,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,sGAAsG;AACtG,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC,2GAA2G;AAC3G,qBACa,gBAAiB,YAAW,aAAa;IAGlD,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;IAE3C,KAAK,IAAI,eAAe,EAAE,CAczB;CACJ"}
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.JwtSecurityCheck = exports.MIN_JWT_SECRET_BYTES = void 0;
13
+ const core_1 = require("@celljs/core");
14
+ /** 256 bits, the size of the HS256 hash: a shorter HMAC secret can be brute-forced from one token. */
15
+ exports.MIN_JWT_SECRET_BYTES = 32;
16
+ /** `jwt.secret` as an HMAC key (no `privateKey`, not a PEM key) must be long enough to resist guessing. */
17
+ let JwtSecurityCheck = class JwtSecurityCheck {
18
+ check() {
19
+ var _a, _b;
20
+ const secret = (_a = this.jwtOptions) === null || _a === void 0 ? void 0 : _a.secret;
21
+ if (!secret || ((_b = this.jwtOptions) === null || _b === void 0 ? void 0 : _b.privateKey) || (typeof secret === 'string' && secret.includes('-----BEGIN'))) {
22
+ return [];
23
+ }
24
+ const bytes = typeof secret === 'string' ? Buffer.byteLength(secret) : secret.length;
25
+ if (bytes >= exports.MIN_JWT_SECRET_BYTES) {
26
+ return [];
27
+ }
28
+ return [{
29
+ code: 'CELL_SECURITY_WEAK_JWT_SECRET',
30
+ message: `jwt.secret has ${bytes} bytes; an HMAC secret shorter than ${exports.MIN_JWT_SECRET_BYTES} bytes can be brute-forced from a single token, and then anyone can sign tokens.`,
31
+ hint: 'Use a random secret of at least 32 bytes from the environment (secret: "${env.JWT_SECRET}", JWT_SECRET from openssl rand -base64 48), or an RSA / EC key pair.'
32
+ }];
33
+ }
34
+ };
35
+ exports.JwtSecurityCheck = JwtSecurityCheck;
36
+ __decorate([
37
+ (0, core_1.Value)('jwt'),
38
+ __metadata("design:type", Object)
39
+ ], JwtSecurityCheck.prototype, "jwtOptions", void 0);
40
+ exports.JwtSecurityCheck = JwtSecurityCheck = __decorate([
41
+ (0, core_1.Component)(core_1.SecurityCheck)
42
+ ], JwtSecurityCheck);
43
+ //# sourceMappingURL=jwt-security-check.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jwt-security-check.js","sourceRoot":"","sources":["../../src/node/jwt-security-check.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAgF;AAGhF,sGAAsG;AACzF,QAAA,oBAAoB,GAAG,EAAE,CAAC;AAEvC,2GAA2G;AAEpG,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAKzB,KAAK;;QACD,MAAM,MAAM,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,CAAC;QACvC,IAAI,CAAC,MAAM,KAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,UAAU,CAAA,IAAI,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;YAC1G,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;QACrF,IAAI,KAAK,IAAI,QAAA,oBAAoB,EAAE,CAAC;YAChC,OAAO,EAAE,CAAC;QACd,CAAC;QACD,OAAO,CAAC;gBACJ,IAAI,EAAE,+BAA+B;gBACrC,OAAO,EAAE,kBAAkB,KAAK,uCAAuC,QAAA,oBAAoB,kFAAkF;gBAC7K,IAAI,EAAE,gKAAgK;aACzK,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;;AAjBsB;IADlB,IAAA,YAAK,EAAC,KAAK,CAAC;;oDAC8B;2BAHlC,gBAAgB;IAD5B,IAAA,gBAAS,EAAC,oBAAa,CAAC;GACZ,gBAAgB,CAoB5B"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=jwt-security-check.spec.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jwt-security-check.spec.d.ts","sourceRoot":"","sources":["../../src/node/jwt-security-check.spec.ts"],"names":[],"mappings":""}
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const bun_test_1 = require("bun:test");
4
+ const chai_1 = require("chai");
5
+ const jwt_security_check_1 = require("./jwt-security-check");
6
+ function codes(jwtOptions) {
7
+ return Object.assign(new jwt_security_check_1.JwtSecurityCheck(), { jwtOptions }).check().map(warning => warning.code);
8
+ }
9
+ (0, bun_test_1.describe)('JwtSecurityCheck', () => {
10
+ (0, bun_test_1.it)('warns about an HMAC secret shorter than 32 bytes', () => {
11
+ (0, chai_1.expect)(codes({ secret: 'secret' })).to.deep.equal(['CELL_SECURITY_WEAK_JWT_SECRET']);
12
+ (0, chai_1.expect)(codes({ secret: Buffer.alloc(16) })).to.deep.equal(['CELL_SECURITY_WEAK_JWT_SECRET']);
13
+ });
14
+ (0, bun_test_1.it)('accepts long secrets, key pairs and no JWT configuration', () => {
15
+ (0, chai_1.expect)(codes({ secret: 'x'.repeat(32) })).to.deep.equal([]);
16
+ (0, chai_1.expect)(codes({ secret: 'short', privateKey: 'pem' })).to.deep.equal([]);
17
+ (0, chai_1.expect)(codes({ secret: '-----BEGIN PUBLIC KEY-----\n...' })).to.deep.equal([]);
18
+ (0, chai_1.expect)(codes(undefined)).to.deep.equal([]);
19
+ });
20
+ });
21
+ //# sourceMappingURL=jwt-security-check.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jwt-security-check.spec.js","sourceRoot":"","sources":["../../src/node/jwt-security-check.spec.ts"],"names":[],"mappings":";;AAAA,uCAAwC;AACxC,+BAA8B;AAC9B,6DAAwD;AAGxD,SAAS,KAAK,CAAC,UAAuB;IAClC,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,qCAAgB,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AACtG,CAAC;AAED,IAAA,mBAAQ,EAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,IAAA,aAAE,EAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,IAAA,aAAM,EAAC,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC;QACrF,IAAA,aAAM,EAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC;IACjG,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,0DAA0D,EAAE,GAAG,EAAE;QAChE,IAAA,aAAM,EAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC5D,IAAA,aAAM,EAAC,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACxE,IAAA,aAAM,EAAC,KAAK,CAAC,EAAE,MAAM,EAAE,iCAAiC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC/E,IAAA,aAAM,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -33,7 +33,7 @@ let JwtServiceImpl = class JwtServiceImpl {
33
33
  };
34
34
  exports.JwtServiceImpl = JwtServiceImpl;
35
35
  __decorate([
36
- (0, core_1.Value)('cell.jwt'),
36
+ (0, core_1.Value)('jwt'),
37
37
  __metadata("design:type", Object)
38
38
  ], JwtServiceImpl.prototype, "jwtOptions", void 0);
39
39
  __decorate([
@@ -1 +1 @@
1
- {"version":3,"file":"jwt-service.js","sourceRoot":"","sources":["../../src/node/jwt-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAA2D;AAC3D,iDAAyI;AACzI,yCAAqC;AAG9B,IAAM,cAAc,GAApB,MAAM,cAAc;IAQvB,KAAK,CAAC,IAAI,CAAC,OAAiC,EAAE,OAAqB,EAAE,UAAmB;;QACpF,MAAM,aAAa,GAAG,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC;QACtE,MAAM,MAAM,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC;QACzE,OAAO,kBAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,MAAM,CAAyB,KAAa,EAAE,OAAuB,EAAE,SAA2B;;QACpG,MAAM,aAAa,GAAG,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;QACxE,MAAM,MAAM,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACvE,OAAO,kBAAO,CAAC,MAAM,CAAI,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAuB;;QAC/C,aAAO,kBAAO,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,mCAAI,SAAS,CAAC;IACvD,CAAC;CAEJ,CAAA;;AArBsB;IADlB,IAAA,YAAK,EAAC,UAAU,CAAC;;kDACyB;AAGxB;IADlB,IAAA,gBAAS,EAAC,+BAAgB,CAAC;;wDAC0B;yBAN7C,cAAc;IAD1B,IAAA,gBAAS,EAAC,yBAAU,CAAC;GACT,cAAc,CAwB1B"}
1
+ {"version":3,"file":"jwt-service.js","sourceRoot":"","sources":["../../src/node/jwt-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAA2D;AAC3D,iDAAyI;AACzI,yCAAqC;AAG9B,IAAM,cAAc,GAApB,MAAM,cAAc;IAQvB,KAAK,CAAC,IAAI,CAAC,OAAiC,EAAE,OAAqB,EAAE,UAAmB;;QACpF,MAAM,aAAa,GAAG,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC;QACtE,MAAM,MAAM,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC;QACzE,OAAO,kBAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,MAAM,CAAyB,KAAa,EAAE,OAAuB,EAAE,SAA2B;;QACpG,MAAM,aAAa,GAAG,EAAE,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;QACxE,MAAM,MAAM,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACvE,OAAO,kBAAO,CAAC,MAAM,CAAI,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAuB;;QAC/C,aAAO,kBAAO,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,mCAAI,SAAS,CAAC;IACvD,CAAC;CAEJ,CAAA;;AArBsB;IADlB,IAAA,YAAK,EAAC,KAAK,CAAC;;kDAC8B;AAGxB;IADlB,IAAA,gBAAS,EAAC,+BAAgB,CAAC;;wDAC0B;yBAN7C,cAAc;IAD1B,IAAA,gBAAS,EAAC,yBAAU,CAAC;GACT,cAAc,CAwB1B"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celljs/jwt",
3
- "version": "4.3.0",
3
+ "version": "4.4.1",
4
4
  "description": "",
5
5
  "keywords": [
6
6
  "cell-component"
@@ -23,7 +23,7 @@
23
23
  "lib",
24
24
  "esm",
25
25
  "src",
26
- "cell.yml"
26
+ "cell.schema.json"
27
27
  ],
28
28
  "scripts": {
29
29
  "build": "tsc -b && bun ../../scripts/build-esm.ts",
@@ -32,7 +32,7 @@
32
32
  "watch": "tsc -b -w --preserveWatchOutput"
33
33
  },
34
34
  "dependencies": {
35
- "@celljs/core": "4.3.0"
35
+ "@celljs/core": "4.4.1"
36
36
  },
37
37
  "publishConfig": {
38
38
  "access": "public"
package/src/node/index.ts CHANGED
@@ -2,4 +2,4 @@ export * from './jwt-protocol';
2
2
  export * from './jwt-service';
3
3
  export * from './errors';
4
4
  export * from './jwt-secret-service';
5
- export * from './jwt-util';
5
+ export * from './jwt-util';export * from './jwt-security-check';
@@ -5,7 +5,7 @@ import { JwtOptions, JwtSecretService, Secret } from './jwt-protocol';
5
5
  @Component(JwtSecretService)
6
6
  export class jwtSecretService implements JwtSecretService {
7
7
 
8
- @Value('cell.jwt')
8
+ @Value('jwt')
9
9
  protected readonly jwtOptions?: JwtOptions;
10
10
 
11
11
  async getPublicKey(): Promise<string | Buffer> {
@@ -0,0 +1,22 @@
1
+ import { describe, it } from 'bun:test';
2
+ import { expect } from 'chai';
3
+ import { JwtSecurityCheck } from './jwt-security-check';
4
+ import { JwtOptions } from './jwt-protocol';
5
+
6
+ function codes(jwtOptions?: JwtOptions): string[] {
7
+ return Object.assign(new JwtSecurityCheck(), { jwtOptions }).check().map(warning => warning.code);
8
+ }
9
+
10
+ describe('JwtSecurityCheck', () => {
11
+ it('warns about an HMAC secret shorter than 32 bytes', () => {
12
+ expect(codes({ secret: 'secret' })).to.deep.equal(['CELL_SECURITY_WEAK_JWT_SECRET']);
13
+ expect(codes({ secret: Buffer.alloc(16) })).to.deep.equal(['CELL_SECURITY_WEAK_JWT_SECRET']);
14
+ });
15
+
16
+ it('accepts long secrets, key pairs and no JWT configuration', () => {
17
+ expect(codes({ secret: 'x'.repeat(32) })).to.deep.equal([]);
18
+ expect(codes({ secret: 'short', privateKey: 'pem' })).to.deep.equal([]);
19
+ expect(codes({ secret: '-----BEGIN PUBLIC KEY-----\n...' })).to.deep.equal([]);
20
+ expect(codes(undefined)).to.deep.equal([]);
21
+ });
22
+ });
@@ -0,0 +1,29 @@
1
+ import { Component, SecurityCheck, SecurityWarning, Value } from '@celljs/core';
2
+ import { JwtOptions } from './jwt-protocol';
3
+
4
+ /** 256 bits, the size of the HS256 hash: a shorter HMAC secret can be brute-forced from one token. */
5
+ export const MIN_JWT_SECRET_BYTES = 32;
6
+
7
+ /** `jwt.secret` as an HMAC key (no `privateKey`, not a PEM key) must be long enough to resist guessing. */
8
+ @Component(SecurityCheck)
9
+ export class JwtSecurityCheck implements SecurityCheck {
10
+
11
+ @Value('jwt')
12
+ protected readonly jwtOptions?: JwtOptions;
13
+
14
+ check(): SecurityWarning[] {
15
+ const secret = this.jwtOptions?.secret;
16
+ if (!secret || this.jwtOptions?.privateKey || (typeof secret === 'string' && secret.includes('-----BEGIN'))) {
17
+ return [];
18
+ }
19
+ const bytes = typeof secret === 'string' ? Buffer.byteLength(secret) : secret.length;
20
+ if (bytes >= MIN_JWT_SECRET_BYTES) {
21
+ return [];
22
+ }
23
+ return [{
24
+ code: 'CELL_SECURITY_WEAK_JWT_SECRET',
25
+ message: `jwt.secret has ${bytes} bytes; an HMAC secret shorter than ${MIN_JWT_SECRET_BYTES} bytes can be brute-forced from a single token, and then anyone can sign tokens.`,
26
+ hint: 'Use a random secret of at least 32 bytes from the environment (secret: "${env.JWT_SECRET}", JWT_SECRET from openssl rand -base64 48), or an RSA / EC key pair.'
27
+ }];
28
+ }
29
+ }
@@ -5,7 +5,7 @@ import { JwtUtil } from './jwt-util';
5
5
  @Component(JwtService)
6
6
  export class JwtServiceImpl implements JwtService {
7
7
 
8
- @Value('cell.jwt')
8
+ @Value('jwt')
9
9
  protected readonly jwtOptions?: JwtOptions;
10
10
 
11
11
  @Autowired(JwtSecretService)
package/cell.yml DELETED
@@ -1,3 +0,0 @@
1
- # cell:
2
- # jwt:
3
- # secret: your secret