@nathapp/nestjs-captcha 4.0.2 → 4.0.3
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/.turbo/turbo-build.log +1 -1
- package/README.md +53 -4
- package/dist/extractor/extractor.js +3 -3
- package/dist/guard/captcha.guard.d.ts +1 -0
- package/dist/guard/captcha.guard.js +26 -2
- package/dist/guard/captcha.guard.js.map +1 -1
- package/dist/module/captcha-module.factory.js +1 -1
- package/dist/module/captcha-module.factory.js.map +1 -1
- package/dist/module/captcha-module.interface.d.ts +1 -0
- package/dist/module/captcha-module.validator.js +4 -0
- package/dist/module/captcha-module.validator.js.map +1 -1
- package/dist/module/captcha.module.d.ts +1 -1
- package/dist/provider/provider.factory.d.ts +3 -0
- package/dist/provider/provider.factory.js +30 -0
- package/dist/provider/provider.factory.js.map +1 -1
- package/dist/provider/provider.interface.d.ts +2 -2
- package/dist/provider/provider.js +2 -2
- package/dist/provider/provider.js.map +1 -1
- package/package.json +8 -5
- package/tsconfig.test.json +16 -0
package/.turbo/turbo-build.log
CHANGED
package/README.md
CHANGED
|
@@ -1,7 +1,57 @@
|
|
|
1
1
|
# nestjs-captcha Library
|
|
2
2
|
|
|
3
|
+
## Configuration
|
|
3
4
|
|
|
4
|
-
|
|
5
|
+
```typescript
|
|
6
|
+
import { CaptchaModule, CaptchaType } from '@nathapp/nestjs-captcha';
|
|
7
|
+
|
|
8
|
+
@Module({
|
|
9
|
+
imports: [
|
|
10
|
+
CaptchaModule.register({
|
|
11
|
+
enabled: true,
|
|
12
|
+
extract: { type: 'header', key: 'x-captcha-token' },
|
|
13
|
+
type: CaptchaType.Recaptcha,
|
|
14
|
+
options: {
|
|
15
|
+
secret: process.env.CAPTCHA_SECRET,
|
|
16
|
+
// reCAPTCHA v3 score policy: reject responses scoring below 0.9.
|
|
17
|
+
threshold: 0.9,
|
|
18
|
+
// Exact hostname the upstream response must report.
|
|
19
|
+
expectedHostname: 'api.example.com',
|
|
20
|
+
},
|
|
21
|
+
}),
|
|
22
|
+
],
|
|
23
|
+
})
|
|
24
|
+
export class AppModule {}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Both policies are optional but validated at provider construction, so a
|
|
28
|
+
misconfigured `threshold` (must be a finite number within `[0, 1]`) or an
|
|
29
|
+
empty/whitespace `expectedHostname` fails application bootstrap rather than the
|
|
30
|
+
first guarded request. When an enabled `recaptcha` provider sets neither
|
|
31
|
+
policy, a one-time warning is logged at construction (never including the
|
|
32
|
+
secret or a token).
|
|
33
|
+
|
|
34
|
+
### reCAPTCHA v3 score checks vs. scoreless v2 / Turnstile
|
|
35
|
+
|
|
36
|
+
- **reCAPTCHA v3:** set `threshold` to enforce the `score` returned by Google.
|
|
37
|
+
The guard rejects a missing, non-numeric, non-finite, or out-of-`[0, 1]`
|
|
38
|
+
score whenever a threshold is configured. `threshold: 0` is honored — a score
|
|
39
|
+
of `0` passes, but a missing/invalid score still fails. With no `threshold`,
|
|
40
|
+
scoreless reCAPTCHA v2 responses are accepted on `success` alone.
|
|
41
|
+
- **reCAPTCHA v2:** do not set `threshold`; there is no score to check, so the
|
|
42
|
+
guard verifies `success` only.
|
|
43
|
+
- **Turnstile:** there is no score policy. Turnstile responses are accepted on
|
|
44
|
+
`success` alone; `threshold` does not apply.
|
|
45
|
+
- **`expectedHostname`:** applies to both reCAPTCHA and Turnstile. When set, the
|
|
46
|
+
upstream `hostname` must match **exactly** (`api.example.com`); a different
|
|
47
|
+
domain, a subdomain, a suffix host, or an absent hostname is rejected. There
|
|
48
|
+
is no wildcard matching and no request-`Host`-derived allowlist.
|
|
49
|
+
- In every case the guard requires `success === true`; a truthy non-boolean
|
|
50
|
+
value (such as the string `"true"`) is not treated as success.
|
|
51
|
+
|
|
52
|
+
## DefaultCaptchaModuleFactory
|
|
53
|
+
|
|
54
|
+
`DefaultCaptchaModuleFactory` reads configuration from `ConfigService` (env):
|
|
5
55
|
|
|
6
56
|
1. CAPTCHA_ENABLED = true/false, 1/0
|
|
7
57
|
2. CAPTCHA_TYPE = recaptcha, turnstile
|
|
@@ -9,6 +59,5 @@
|
|
|
9
59
|
4. CAPTCHA_ENDPOINT = custom endpoint
|
|
10
60
|
5. CAPTCHA_THRESHOLD = for recaptcha
|
|
11
61
|
|
|
12
|
-
DefaultCaptchaModuleFactory
|
|
13
|
-
|
|
14
|
-
chatbot: 0
|
|
62
|
+
`DefaultCaptchaModuleFactory` extracts the token from the header with key
|
|
63
|
+
`x-captcha-token`.
|
|
@@ -4,7 +4,7 @@ exports.Extract = void 0;
|
|
|
4
4
|
exports.Extract = {
|
|
5
5
|
fromHeader: (header_name) => {
|
|
6
6
|
return (request) => {
|
|
7
|
-
|
|
7
|
+
let token = null;
|
|
8
8
|
if (request.headers[header_name]) {
|
|
9
9
|
token = request.headers[header_name];
|
|
10
10
|
}
|
|
@@ -13,7 +13,7 @@ exports.Extract = {
|
|
|
13
13
|
},
|
|
14
14
|
fromBodyField: (field_name) => {
|
|
15
15
|
return (request) => {
|
|
16
|
-
|
|
16
|
+
let token = null;
|
|
17
17
|
if (request.body && request.body[field_name]) {
|
|
18
18
|
token = request.body[field_name];
|
|
19
19
|
}
|
|
@@ -22,7 +22,7 @@ exports.Extract = {
|
|
|
22
22
|
},
|
|
23
23
|
fromUrlQueryParameter: (param_name) => {
|
|
24
24
|
return (request) => {
|
|
25
|
-
|
|
25
|
+
let token = null;
|
|
26
26
|
if (request.query && request.query[param_name]) {
|
|
27
27
|
token = request.query[param_name];
|
|
28
28
|
}
|
|
@@ -6,5 +6,6 @@ export declare class CaptchaGuard implements CanActivate {
|
|
|
6
6
|
private readonly captchaProvider;
|
|
7
7
|
constructor(options: CaptchaModuleOptions, captchaProvider: CaptchaProvider);
|
|
8
8
|
canActivate(context: ExecutionContext): Promise<boolean>;
|
|
9
|
+
private enforceVerificationPolicy;
|
|
9
10
|
private extractToken;
|
|
10
11
|
}
|
|
@@ -20,6 +20,7 @@ const nestjs_common_1 = require("@nathapp/nestjs-common");
|
|
|
20
20
|
const extractor_1 = require("../extractor");
|
|
21
21
|
const nestjs_common_2 = require("@nathapp/nestjs-common");
|
|
22
22
|
const common_2 = require("@nathapp/common");
|
|
23
|
+
const enum_1 = require("../enum");
|
|
23
24
|
let CaptchaGuard = class CaptchaGuard {
|
|
24
25
|
constructor(options, captchaProvider) {
|
|
25
26
|
this.options = options;
|
|
@@ -35,18 +36,41 @@ let CaptchaGuard = class CaptchaGuard {
|
|
|
35
36
|
}
|
|
36
37
|
const ip = (0, nestjs_common_1.getClientIp)(request);
|
|
37
38
|
const token = this.extractToken(request);
|
|
38
|
-
if ((0, common_2.isUndefinedOrNullOrEmpty)(token)) {
|
|
39
|
+
if (typeof token !== 'string' || (0, common_2.isUndefinedOrNullOrEmpty)(token)) {
|
|
39
40
|
throw new nestjs_common_2.CaptchaException();
|
|
40
41
|
}
|
|
41
42
|
const tokenResult = await this.captchaProvider.verify({
|
|
42
43
|
token,
|
|
43
44
|
ip,
|
|
44
45
|
});
|
|
45
|
-
if (
|
|
46
|
+
if (tokenResult.success !== true) {
|
|
46
47
|
throw new nestjs_common_2.CaptchaException();
|
|
47
48
|
}
|
|
49
|
+
this.enforceVerificationPolicy(tokenResult);
|
|
48
50
|
return true;
|
|
49
51
|
}
|
|
52
|
+
enforceVerificationPolicy(tokenResult) {
|
|
53
|
+
var _a, _b;
|
|
54
|
+
const expectedHostname = (_a = this.options.options) === null || _a === void 0 ? void 0 : _a.expectedHostname;
|
|
55
|
+
if (expectedHostname !== undefined && tokenResult.hostname !== expectedHostname) {
|
|
56
|
+
throw new nestjs_common_2.CaptchaException();
|
|
57
|
+
}
|
|
58
|
+
if (this.options.type !== enum_1.CaptchaType.Recaptcha) {
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
const threshold = (_b = this.options.options) === null || _b === void 0 ? void 0 : _b.threshold;
|
|
62
|
+
if (threshold === undefined) {
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
const score = tokenResult.score;
|
|
66
|
+
if (typeof score !== 'number' ||
|
|
67
|
+
!Number.isFinite(score) ||
|
|
68
|
+
score < 0 ||
|
|
69
|
+
score > 1 ||
|
|
70
|
+
score < threshold) {
|
|
71
|
+
throw new nestjs_common_2.CaptchaException();
|
|
72
|
+
}
|
|
73
|
+
}
|
|
50
74
|
extractToken(request) {
|
|
51
75
|
if (typeof this.options.extract === 'function') {
|
|
52
76
|
return this.options.extract(request);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"captcha.guard.js","sourceRoot":"","sources":["../../lib/guard/captcha.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAmF;AACnF,sCAA2F;AAC3F,mDAAuD;
|
|
1
|
+
{"version":3,"file":"captcha.guard.js","sourceRoot":"","sources":["../../lib/guard/captcha.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAmF;AACnF,sCAA2F;AAC3F,mDAAuD;AAEvD,0DAAqD;AACrD,4CAAuC;AACvC,0DAA0D;AAC1D,4CAA2D;AAC3D,kCAAsC;AAG/B,IAAM,YAAY,GAAlB,MAAM,YAAY;IACvB,YACkD,OAA6B,EAC5D,eAAgC;QADD,YAAO,GAAP,OAAO,CAAsB;QAC5D,oBAAe,GAAf,eAAe,CAAiB;IAAG,CAAC;IAEvD,KAAK,CAAC,WAAW,CAAC,OAAyB;QAGzC,IAAI,OAAO,CAAC,OAAO,EAAE,KAAK,MAAM,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QAEpD,IAAG,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,EAAE,GAAG,IAAA,2BAAW,EAAC,OAAO,CAAC,CAAC;QAEhC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAEzC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAA,iCAAwB,EAAC,KAAK,CAAC,EAAE,CAAC;YACjE,MAAM,IAAI,gCAAgB,EAAE,CAAA;QAC9B,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;YACpD,KAAK;YACL,EAAE;SACH,CAAC,CAAC;QAIH,IAAG,WAAW,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YAChC,MAAM,IAAI,gCAAgB,EAAE,CAAA;QAC9B,CAAC;QAED,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACd,CAAC;IAUO,yBAAyB,CAAC,WAAgC;;QAChE,MAAM,gBAAgB,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,OAAO,0CAAE,gBAAgB,CAAC;QAEhE,IAAG,gBAAgB,KAAK,SAAS,IAAI,WAAW,CAAC,QAAQ,KAAK,gBAAgB,EAAE,CAAC;YAC/E,MAAM,IAAI,gCAAgB,EAAE,CAAA;QAC9B,CAAC;QAED,IAAG,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,kBAAW,CAAC,SAAS,EAAE,CAAC;YAC/C,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,MAAC,IAAI,CAAC,OAAO,CAAC,OAAuC,0CAAE,SAAS,CAAC;QAEnF,IAAG,SAAS,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;QAEhC,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YACvB,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,SAAS,EACjB,CAAC;YACD,MAAM,IAAI,gCAAgB,EAAE,CAAA;QAC9B,CAAC;IACH,CAAC;IAEO,YAAY,CAAC,OAAY;QAC/B,IAAG,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;aAAK,CAAC;YACL,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YAE3C,QAAO,IAAI,EAAE,CAAC;gBACZ,KAAK,QAAQ;oBACX,OAAO,mBAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;gBAC1C,KAAK,MAAM;oBACT,OAAO,mBAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;gBAC7C,KAAK,OAAO;oBACV,OAAO,mBAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;gBACrD;oBACE,OAAO,IAAI,CAAC;YAChB,CAAC;QACJ,CAAC;IACF,CAAC;CACF,CAAA;AAjGY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,mBAAU,GAAE;IAGR,WAAA,IAAA,eAAM,EAAC,+BAAsB,CAAC,CAAA;6CACG,0BAAe;GAHxC,YAAY,CAiGxB"}
|
|
@@ -31,7 +31,7 @@ let DefaultCaptchaModuleFactory = class DefaultCaptchaModuleFactory {
|
|
|
31
31
|
}
|
|
32
32
|
parseOption(key, defaultValue) {
|
|
33
33
|
const str = this.configService.get(key);
|
|
34
|
-
if ((0, common_2.isUndefinedOrNullOrEmpty)(str)) {
|
|
34
|
+
if (typeof str !== 'string' || (0, common_2.isUndefinedOrNullOrEmpty)(str)) {
|
|
35
35
|
return defaultValue;
|
|
36
36
|
}
|
|
37
37
|
return str.toLowerCase() == 'true' || str == '1';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"captcha-module.factory.js","sourceRoot":"","sources":["../../lib/module/captcha-module.factory.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAE5C,2CAA+C;AAC/C,4CAA2D;AAIpD,IAAM,2BAA2B,GAAjC,MAAM,2BAA2B;IAItC,YAA6B,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;
|
|
1
|
+
{"version":3,"file":"captcha-module.factory.js","sourceRoot":"","sources":["../../lib/module/captcha-module.factory.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAE5C,2CAA+C;AAC/C,4CAA2D;AAIpD,IAAM,2BAA2B,GAAjC,MAAM,2BAA2B;IAItC,YAA6B,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;QAKvD,IAAI,CAAC,OAAO,GAAG;YACb,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,IAAI,CAAC;YAClD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,GAAG,EAAE,iBAAiB;aACvB;YACD,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAc,cAAc,CAAC;YACzD,OAAO,EAAE;gBACP,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,gBAAgB,CAAC;gBACxD,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,kBAAkB,CAAC;aAC7D;SACsB,CAAC;IAC5B,CAAC;IAEO,WAAW,CAAC,GAAW,EAAE,YAAqB;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,GAAG,CAAC,CAAC;QAChD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,IAAA,iCAAwB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC7D,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,OAAO,GAAG,CAAC,WAAW,EAAE,IAAI,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC;IACnD,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CAEF,CAAA;AAnCY,kEAA2B;sCAA3B,2BAA2B;IADvC,IAAA,mBAAU,GAAE;qCAKiC,sBAAa;GAJ9C,2BAA2B,CAmCvC"}
|
|
@@ -15,5 +15,9 @@ function validateCaptchaModuleOptions(options) {
|
|
|
15
15
|
if (!((_a = options.options) === null || _a === void 0 ? void 0 : _a.secret)) {
|
|
16
16
|
throw new Error(`Missing CAPTCHA_SECRET. A secret is required when captcha verification is enabled (CAPTCHA_TYPE="${options.type}").`);
|
|
17
17
|
}
|
|
18
|
+
if (!options.extract) {
|
|
19
|
+
throw new Error(`Missing captcha token extractor: "extract" is required when captcha verification is enabled. ` +
|
|
20
|
+
`Provide an ExtractOptions object or a TokenExtractFunction (CAPTCHA_EXTRACT config).`);
|
|
21
|
+
}
|
|
18
22
|
}
|
|
19
23
|
//# sourceMappingURL=captcha-module.validator.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"captcha-module.validator.js","sourceRoot":"","sources":["../../lib/module/captcha-module.validator.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"captcha-module.validator.js","sourceRoot":"","sources":["../../lib/module/captcha-module.validator.ts"],"names":[],"mappings":";;AAYA,oEA6BC;AAzCD,kCAAsC;AAYtC,SAAgB,4BAA4B,CAAC,OAA6B;;IACxE,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAA,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAW,CAAC,CAAC;IAElD,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CACb,0BAA0B,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,sBAAsB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;YAC1F,oFAAoF,CACrF,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,MAAM,CAAA,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,oGAAoG,OAAO,CAAC,IAAI,KAAK,CACtH,CAAC;IACJ,CAAC;IAKD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,+FAA+F;YAC/F,sFAAsF,CACvF,CAAC;IACJ,CAAC;AACH,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { CaptchaModuleOptions } from "./captcha-module.interface";
|
|
2
|
-
declare const CaptchaModule_base: import("@nathapp/nestjs-common").ConfigurableModuleCls<CaptchaModuleOptions, "register", "createOptions",
|
|
2
|
+
declare const CaptchaModule_base: import("@nathapp/nestjs-common").ConfigurableModuleCls<CaptchaModuleOptions, "register", "createOptions", object>;
|
|
3
3
|
export declare class CaptchaModule extends CaptchaModule_base {
|
|
4
4
|
}
|
|
5
5
|
export {};
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { CaptchaOptions } from "../module";
|
|
2
2
|
import { CaptchaProvider } from "./provider";
|
|
3
3
|
export declare class CaptchaProviderFactory {
|
|
4
|
+
private static readonly logger;
|
|
4
5
|
static createProvider(options: CaptchaOptions): CaptchaProvider;
|
|
6
|
+
private static validateRecaptchaPolicy;
|
|
7
|
+
private static validateExpectedHostname;
|
|
5
8
|
}
|
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.CaptchaProviderFactory = void 0;
|
|
4
|
+
const common_1 = require("@nestjs/common");
|
|
4
5
|
const enum_1 = require("../enum");
|
|
5
6
|
const provider_1 = require("./provider");
|
|
6
7
|
class CaptchaProviderFactory {
|
|
7
8
|
static createProvider(options) {
|
|
8
9
|
switch (options.type) {
|
|
9
10
|
case enum_1.CaptchaType.Turnstile:
|
|
11
|
+
CaptchaProviderFactory.validateExpectedHostname(options.options);
|
|
10
12
|
return new provider_1.TurnstileCaptchaProvider(options['options']);
|
|
11
13
|
case enum_1.CaptchaType.Recaptcha:
|
|
14
|
+
CaptchaProviderFactory.validateRecaptchaPolicy(options);
|
|
12
15
|
return new provider_1.RecaptchaCaptchaProvider(options['options']);
|
|
13
16
|
default: {
|
|
14
17
|
const unsupportedType = options === null || options === void 0 ? void 0 : options.type;
|
|
@@ -16,6 +19,33 @@ class CaptchaProviderFactory {
|
|
|
16
19
|
}
|
|
17
20
|
}
|
|
18
21
|
}
|
|
22
|
+
static validateRecaptchaPolicy(options) {
|
|
23
|
+
const { threshold, expectedHostname } = options.options;
|
|
24
|
+
if (threshold !== undefined) {
|
|
25
|
+
if (typeof threshold !== 'number' ||
|
|
26
|
+
!Number.isFinite(threshold) ||
|
|
27
|
+
threshold < 0 ||
|
|
28
|
+
threshold > 1) {
|
|
29
|
+
throw new Error(`Invalid CAPTCHA_THRESHOLD: "${threshold}". Threshold must be a finite number within [0, 1].`);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
CaptchaProviderFactory.validateExpectedHostname(options.options);
|
|
33
|
+
if (threshold === undefined && expectedHostname === undefined) {
|
|
34
|
+
CaptchaProviderFactory.logger.warn('reCAPTCHA is enabled without a score threshold or an expected hostname; ' +
|
|
35
|
+
'responses are accepted on success alone, with no score or hostname enforcement. ' +
|
|
36
|
+
'Configure a threshold and/or expectedHostname to enforce a verification policy.');
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
static validateExpectedHostname(options) {
|
|
40
|
+
const { expectedHostname } = options;
|
|
41
|
+
if (expectedHostname === undefined) {
|
|
42
|
+
return;
|
|
43
|
+
}
|
|
44
|
+
if (typeof expectedHostname !== 'string' || expectedHostname.trim().length === 0) {
|
|
45
|
+
throw new Error('Invalid expectedHostname: a non-empty hostname string is required when configured.');
|
|
46
|
+
}
|
|
47
|
+
}
|
|
19
48
|
}
|
|
20
49
|
exports.CaptchaProviderFactory = CaptchaProviderFactory;
|
|
50
|
+
CaptchaProviderFactory.logger = new common_1.Logger(CaptchaProviderFactory.name);
|
|
21
51
|
//# sourceMappingURL=provider.factory.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.factory.js","sourceRoot":"","sources":["../../lib/provider/provider.factory.ts"],"names":[],"mappings":";;;AAAA,kCAAsC;AAEtC,yCAAiG;AAEjG,MAAa,sBAAsB;
|
|
1
|
+
{"version":3,"file":"provider.factory.js","sourceRoot":"","sources":["../../lib/provider/provider.factory.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,kCAAsC;AAEtC,yCAAiG;AAEjG,MAAa,sBAAsB;IAGjC,MAAM,CAAC,cAAc,CAAC,OAAuB;QAC3C,QAAO,OAAO,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,kBAAW,CAAC,SAAS;gBACxB,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjE,OAAO,IAAI,mCAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;YAC1D,KAAK,kBAAW,CAAC,SAAS;gBACxB,sBAAsB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;gBACxD,OAAO,IAAI,mCAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;YAC1D,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,eAAe,GAAI,OAA8B,aAA9B,OAAO,uBAAP,OAAO,CAAyB,IAAI,CAAC;gBAC9D,MAAM,IAAI,KAAK,CACb,8BAA8B,eAAe,2BAA2B,MAAM,CAAC,MAAM,CAAC,kBAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACjH,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,OAAyB;QAC9D,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;QAExD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IACE,OAAO,SAAS,KAAK,QAAQ;gBAC7B,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAC3B,SAAS,GAAG,CAAC;gBACb,SAAS,GAAG,CAAC,EACb,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,+BAA+B,SAAS,qDAAqD,CAC9F,CAAC;YACJ,CAAC;QACH,CAAC;QAED,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEjE,IAAI,SAAS,KAAK,SAAS,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAC9D,sBAAsB,CAAC,MAAM,CAAC,IAAI,CAChC,0EAA0E;gBACxE,kFAAkF;gBAClF,iFAAiF,CACpF,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,OAA6B;QACnE,MAAM,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;QAErC,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO;QACT,CAAC;QAED,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,gBAAgB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjF,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAC;QACJ,CAAC;IACH,CAAC;;AA3DH,wDA4DC;AA3DyB,6BAAM,GAAG,IAAI,eAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC"}
|
|
@@ -52,7 +52,7 @@ class TurnstileCaptchaProvider extends CaptchaProvider {
|
|
|
52
52
|
signal: AbortSignal.timeout(timeoutMs),
|
|
53
53
|
});
|
|
54
54
|
}
|
|
55
|
-
catch (
|
|
55
|
+
catch (_error) {
|
|
56
56
|
return TIMED_OUT_RESULT;
|
|
57
57
|
}
|
|
58
58
|
if (!response.ok) {
|
|
@@ -98,7 +98,7 @@ class RecaptchaCaptchaProvider {
|
|
|
98
98
|
signal: AbortSignal.timeout(timeoutMs),
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
|
-
catch (
|
|
101
|
+
catch (_error) {
|
|
102
102
|
return TIMED_OUT_RESULT;
|
|
103
103
|
}
|
|
104
104
|
if (!response.ok) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../lib/provider/provider.ts"],"names":[],"mappings":";;;AAEA,iCAAiC;AAEpB,QAAA,iCAAiC,GAAG,IAAI,CAAC;AAUtD,MAAM,gBAAgB,GAAwB;IAC5C,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,SAAS;IACnB,UAAU,EAAE,CAAC,0BAA0B,CAAC;CACzC,CAAC;AAOF,MAAM,gBAAgB,GAAG,CAAC,UAAoB,EAAuB,EAAE,CAAC,CAAC;IACvE,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,SAAS;IACnB,UAAU;CACX,CAAC,CAAC;AAEH,MAAsB,eAAe;CAEpC;AAFD,0CAEC;AAED,MAAa,wBAAyB,SAAQ,eAAe;IAG3D,YAAY,OAAoC;QAC9C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,YAAgC;QAC3C,MAAM,GAAG,GACP,IAAI,CAAC,OAAO,CAAC,QAAQ;YACrB,2DAA2D,CAAC;QAE9D,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW;YAC7C,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE;YACrB,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;QAExE,IAAI,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACrE,OAAO,MAAM,CAAC;QAChB,CAAC;QAGD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;IAC5D,CAAC;IAEO,KAAK,CAAC,UAAU,CACtB,GAAW,EACX,YAAgC,EAChC,cAAuB;;QAEvB,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,SAAS,mCAAI,yCAAiC,CAAC;QAE9E,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;oBAC3B,QAAQ,EAAE,YAAY,CAAC,KAAK;oBAC5B,QAAQ,EAAE,YAAY,CAAC,EAAE;oBACzB,eAAe,EAAE,cAAc;iBAChC,CAAC;gBACF,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;aACvC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,
|
|
1
|
+
{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../lib/provider/provider.ts"],"names":[],"mappings":";;;AAEA,iCAAiC;AAEpB,QAAA,iCAAiC,GAAG,IAAI,CAAC;AAUtD,MAAM,gBAAgB,GAAwB;IAC5C,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,SAAS;IACnB,UAAU,EAAE,CAAC,0BAA0B,CAAC;CACzC,CAAC;AAOF,MAAM,gBAAgB,GAAG,CAAC,UAAoB,EAAuB,EAAE,CAAC,CAAC;IACvE,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,SAAS;IACnB,UAAU;CACX,CAAC,CAAC;AAEH,MAAsB,eAAe;CAEpC;AAFD,0CAEC;AAED,MAAa,wBAAyB,SAAQ,eAAe;IAG3D,YAAY,OAAoC;QAC9C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,YAAgC;QAC3C,MAAM,GAAG,GACP,IAAI,CAAC,OAAO,CAAC,QAAQ;YACrB,2DAA2D,CAAC;QAE9D,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW;YAC7C,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE;YACrB,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;QAExE,IAAI,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACrE,OAAO,MAAM,CAAC;QAChB,CAAC;QAGD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;IAC5D,CAAC;IAEO,KAAK,CAAC,UAAU,CACtB,GAAW,EACX,YAAgC,EAChC,cAAuB;;QAEvB,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,SAAS,mCAAI,yCAAiC,CAAC;QAE9E,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;oBAC3B,QAAQ,EAAE,YAAY,CAAC,KAAK;oBAC5B,QAAQ,EAAE,YAAY,CAAC,EAAE;oBACzB,eAAe,EAAE,cAAc;iBAChC,CAAC;gBACF,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;aACvC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YAEhB,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,gBAAgB,CAAC,CAAC,YAAY,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,MAAW,CAAC;QAChB,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACjC,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,gBAAgB,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACrD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,WAAW,EAAE,MAAM,CAAC,YAAY;YAChC,UAAU,EAAE,MAAM,CAAC,aAAa,CAAC;SAClC,CAAC;IACJ,CAAC;CACF;AAxED,4DAwEC;AAED,MAAa,wBAAwB;IAGnC,YAAY,OAAoC;QAC9C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,YAAgC;;QAC3C,MAAM,GAAG,GACP,IAAI,CAAC,OAAO,CAAC,QAAQ;YACrB,iDAAiD,CAAC;QAEpD,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,SAAS,mCAAI,yCAAiC,CAAC;QAE9E,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;oBAC3B,QAAQ,EAAE,YAAY,CAAC,KAAK;oBAC5B,QAAQ,EAAE,YAAY,CAAC,EAAE;iBAC1B,CAAC;gBACF,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;aACvC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YAEhB,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,gBAAgB,CAAC,CAAC,YAAY,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,MAAW,CAAC;QAChB,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACjC,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,gBAAgB,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACrD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,WAAW,EAAE,MAAM,CAAC,YAAY;YAChC,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,UAAU,EAAE,MAAM,CAAC,aAAa,CAAC;SAClC,CAAC;IACJ,CAAC;CACF;AArDD,4DAqDC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nathapp/nestjs-captcha",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.3",
|
|
4
4
|
"description": "nestjs-captcha",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -10,9 +10,10 @@
|
|
|
10
10
|
"test": "jest --config ./test/jest-test.json",
|
|
11
11
|
"test:cov": "jest --config ./test/jest-test.json --coverage",
|
|
12
12
|
"test:watch": "jest --config ./test/jest-test.json --watch",
|
|
13
|
-
"lint": "eslint -c .eslintrc.js",
|
|
13
|
+
"lint": "eslint -c .eslintrc.js \"lib/**/*.ts\" \"test/**/*.ts\"",
|
|
14
14
|
"type-check": "tsc --noEmit -p tsconfig.json",
|
|
15
|
-
"lint:fix": "eslint -c .eslintrc.js --fix"
|
|
15
|
+
"lint:fix": "eslint -c .eslintrc.js --fix \"lib/**/*.ts\" \"test/**/*.ts\"",
|
|
16
|
+
"type-check:test": "tsc --noEmit -p tsconfig.test.json"
|
|
16
17
|
},
|
|
17
18
|
"author": "William Khoo",
|
|
18
19
|
"license": "MIT",
|
|
@@ -22,7 +23,7 @@
|
|
|
22
23
|
"devDependencies": {
|
|
23
24
|
"@golevelup/ts-jest": "^3.0.0",
|
|
24
25
|
"@nathapp/eslint-config": "1.0.1",
|
|
25
|
-
"@nathapp/nestjs-common": "^4.0.
|
|
26
|
+
"@nathapp/nestjs-common": "^4.0.3",
|
|
26
27
|
"@nathapp/typescript-config": "1.0.1",
|
|
27
28
|
"@nestjs/platform-express": "^11.0.0",
|
|
28
29
|
"@nestjs/platform-fastify": "^11.0.0",
|
|
@@ -43,7 +44,9 @@
|
|
|
43
44
|
"directories": {
|
|
44
45
|
"lib": "lib"
|
|
45
46
|
},
|
|
46
|
-
"dependencies": {
|
|
47
|
+
"dependencies": {
|
|
48
|
+
"@nathapp/common": "^0.1.14"
|
|
49
|
+
},
|
|
47
50
|
"peerDependencies": {
|
|
48
51
|
"@nathapp/nestjs-common": "^4.0.0-rc.0",
|
|
49
52
|
"@nestjs/common": "^10.0.0 || ^11.0.0 || ^12.0.0",
|